{ "openapi": "3.0.0", "info": { "version": "3.0.0", "title": "Didit Verification API", "description": "API верификации личности. Аутентификация выполняется с помощью заголовка x-api-key." }, "servers": [ { "url": "https://verification.didit.me" } ], "tags": [], "paths": { "/system/healthcheck": { "get": { "summary": "Проверка состояния сервиса (публичная, без аутентификации)", "description": "Публичная проба работоспособности без аутентификации. Возвращает `HTTP 200` с `{status: \"ok\", timestamp}`, когда сервис, БД, кэш и брокер работают корректно.", "operationId": "get_system_healthcheck", "x-didit-sdk": { "resource": "system", "method": "healthcheck", "auth": "public", "server": false }, "tags": [ "System" ], "security": [ {} ], "parameters": [], "responses": { "200": { "description": "Сервис исправен и принимает запросы. Тело ответа всегда имеет вид `{\"status\": \"ok\", \"timestamp\": \"\"}`.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "timestamp" ], "properties": { "status": { "type": "string", "enum": [ "ok" ], "description": "Маркер проверки живости. Всегда строковый литерал `\"ok\"` в ответе 200.", "example": "ok" }, "timestamp": { "type": "string", "format": "date-time", "description": "Серверное время выполнения проверки состояния в формате ISO 8601 с точностью до миллисекунд и суффиксом `Z` (UTC).", "example": "2026-04-21T16:42:50.445Z" } } }, "examples": { "Healthy": { "summary": "Сервис работает", "value": { "status": "ok", "timestamp": "2026-04-21T16:42:50.445Z" } } } } } }, "503": { "description": "Сервис неисправен — произошёл сбой в одном из настроенных плагинов проверки состояния (база данных, кэш, брокер). Тело ответа намеренно минимально; ключевым сигналом является HTTP-статус. Повторите попытку с экспоненциальной задержкой." }, "5XX": { "description": "Сервис верификации работает со сбоями или недоступен. Считайте любой ответ, отличный от 2xx, «неработоспособным» и повторяйте попытку с экспоненциальной задержкой." } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -i https://verification.didit.me/system/healthcheck" }, { "lang": "Python", "label": "Python (requests)", "source": "import requests\n\nresp = requests.get(\"https://verification.didit.me/system/healthcheck\", timeout=5)\nresp.raise_for_status()\nprint(resp.json()) # {'status': 'ok', 'timestamp': '2026-04-21T16:42:50.445Z'}" }, { "lang": "JavaScript", "label": "Node.js (fetch)", "source": "const res = await fetch(\"https://verification.didit.me/system/healthcheck\");\nif (!res.ok) throw new Error(`Didit unhealthy: ${res.status}`);\nconst body = await res.json();\nconsole.log(body); // { status: 'ok', timestamp: '2026-04-21T16:42:50.445Z' }" } ] } }, "/v3/email/risk/": { "post": { "summary": "Рассчитать оценку риска для адреса электронной почты", "description": "Возвращает сигналы доставки, использования одноразовых адресов, утечек, совпадений между сессиями и нормализованные аналитические данные о рисках без отправки OTP. Endpoint создаёт API-сессию и возвращает её идентификатор как `request_id`.\n\n**Решение.** Поле верхнего уровня `status` дублирует `email.status`. Обычно оно имеет значение `Approved`; оценка риска может дать `In Review` или `Declined`.\n\n**Псевдонимы для совместимости.** Ответы в продакшн-среде предоставляют нормализованный аналитический объект как в `email.email_intelligence`, так и в `email.enrichment`. Значения идентичны. Новые интеграции могут использовать `email.enrichment`. Оба ключа отсутствуют, если пригодные аналитические данные не были получены.\n\n**Биллинг.** Запросы в продакшн-среде тарифицируются по ценам Email Risk API. Запрос подлежит оплате с момента начала поиска, даже если некоторые поля, предоставляемые по возможности, недоступны.\n\n**Песочница.** Ключи песочницы валидируют запрос и возвращают детерминированные одобренные данные без отправки электронного письма, списания кредитов, создания сессии или передачи данных в Networks.\n\n**Аутентификация.** Передавайте API-ключ вашего приложения в заголовке `x-api-key`. При отсутствии или недействительности учетных данных возвращается `403` - этот API никогда не возвращает `401`.\n\n**Лимит запросов.** Общий лимит на запись составляет 300 запросов в минуту на API-ключ для всех endpoints POST/PATCH/DELETE (для создания транзакций и приёма событий действует отдельный лимит в 600).\n\n**Цифровой след в соцсетях.** Установите `enable_social` в значение `true`, чтобы добавить блок `email_social`: онлайн-платформы, на которых зарегистрирован этот адрес, с подсчётом по категориям и всеми доступными данными профиля. `profiles_registered: 0` означает, что платформы были проверены и адрес ни на одной из них не найден - это корректный, оплачиваемый ответ. Блок отсутствует, если опция не была запрошена или проверку не удалось завершить; в этом случае плата за него не взимается. При биллинге добавляется одна единица `email_social` за запрос поверх собственной цены этого endpoint.", "operationId": "post_v3email_risk", "x-didit-sdk": { "resource": "email", "method": "assess_risk", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/email/risk/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"email\": \"alice@example.com\",\n \"country_code\": \"US\",\n \"vendor_data\": \"lead-123\",\n \"metadata\": {\"source\": \"signup_prescreen\"}\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.email.assess_risk(\n email=\"alice@example.com\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.email.assessRisk({\n email: \"alice@example.com\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Email.AssessRisk(ctx, didit.EmailRiskRequest{\n\tEmail: \"alice@example.com\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.EmailRiskRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.email().assessRisk(EmailRiskRequest.builder()\n .email(\"alice@example.com\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "email->assessRisk([\n 'email' => 'alice@example.com',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.email.assess_risk(email: \"alice@example.com\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Email.AssessRiskAsync(new EmailRiskRequest\n{\n Email = \"alice@example.com\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailRiskRequest" }, "examples": { "Minimal": { "summary": "Оценить адрес со значениями по умолчанию", "value": { "email": "alice@example.com" } }, "Full context": { "summary": "Оценить с сигналами, подсказкой о стране и идентификаторами корреляции", "value": { "email": "alice@example.com", "country_code": "US", "signals": { "ip": "192.0.2.1", "device_id": "8F0B8FDD-C2CB-4387-B20A-56E9B2E5A0D2", "device_platform": "web", "os_version": "14.4", "app_version": "1.2.34", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.4 Safari/605.1.15" }, "vendor_data": "lead-123", "metadata": { "source": "signup_prescreen" } } } } } } }, "responses": { "200": { "description": "Оценка риска завершена. Проверьте `status` для получения решения; для завершённых запросов HTTP-код всегда `200`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailRiskResponse" }, "examples": { "Clean address": { "summary": "Доставляемый адрес без обнаруженных утечек данных", "value": { "request_id": "82397be9-5921-4970-a979-2d5b43e08b33", "status": "Approved", "email": { "status": "Approved", "email": "alice@example.com", "is_breached": false, "breaches": [], "is_disposable": false, "is_undeliverable": false, "verification_attempts": 0, "verified_at": null, "warnings": [], "lifecycle": [], "matches": [], "email_intelligence": { "score": 4.0, "deliverable": "high", "breach_risk_level": "Low", "breach_risk_index": 4, "is_recent_breach": false, "is_frequent_breached": false, "is_disposable": false, "is_free_domain": false, "is_breached": false, "no_of_breaches": 0, "reason_codes": [] }, "enrichment": { "score": 4.0, "deliverable": "high", "breach_risk_level": "Low", "breach_risk_index": 4, "is_recent_breach": false, "is_frequent_breached": false, "is_disposable": false, "is_free_domain": false, "is_breached": false, "no_of_breaches": 0, "reason_codes": [] } }, "vendor_data": "lead-123", "metadata": { "source": "signup_prescreen" }, "created_at": "2026-09-01T10:30:00.123456+00:00" } }, "Breached address": { "summary": "Адрес обнаружен в известных утечках данных", "value": { "request_id": "d1e5c2a8-6f30-4c1a-8b2d-3e4f5a6b7c8d", "status": "In Review", "email": { "status": "In Review", "email": "bob@example.org", "is_breached": true, "breaches": [ { "name": "ExampleBreach2023", "domain": "example.org", "breach_date": "2023-06-01", "breach_emails_count": 1200000, "description": "A data breach affecting example.org accounts.", "logo_path": "https://logos.example.org/example.png", "data_classes": [ "email_addresses", "passwords" ], "is_verified": true } ], "is_disposable": false, "is_undeliverable": false, "verification_attempts": 0, "verified_at": null, "warnings": [], "lifecycle": [], "matches": [], "email_intelligence": { "score": 58.0, "deliverable": "high", "breach_risk_level": "High", "breach_risk_index": 72, "is_recent_breach": true, "is_frequent_breached": true, "is_disposable": false, "is_free_domain": true, "is_breached": true, "no_of_breaches": 4, "reason_codes": [ { "code": "IR-F784B630", "direction": "risk", "message": "Email's digital footprint diversity is Very Low", "impact_level": "low" } ] }, "enrichment": { "score": 58.0, "deliverable": "high", "breach_risk_level": "High", "breach_risk_index": 72, "is_recent_breach": true, "is_frequent_breached": true, "is_disposable": false, "is_free_domain": true, "is_breached": true, "no_of_breaches": 4, "reason_codes": [ { "code": "IR-F784B630", "direction": "risk", "message": "Email's digital footprint diversity is Very Low", "impact_level": "low" } ] } }, "vendor_data": "lead-125", "metadata": null, "created_at": "2026-09-01T10:30:00.123456+00:00" } } } } } }, "400": { "$ref": "#/components/responses/EmailRiskValidationError" }, "403": { "$ref": "#/components/responses/RiskPermissionDenied" }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/ip/risk/": { "post": { "summary": "Рассчитать оценку риска для IP-адреса", "description": "Возвращает данные геолокации, сведения о владельце сети, флаги использования VPN/Tor и дата-центров, данные об угрозах, а также `country_mismatch` для указанного IP-адреса. Endpoint создаёт API-сессию и возвращает её идентификатор как `request_id`.\n\n**Решение.** Поле `status` принимает значение `In Review`, если определённая страна не совпадает с `claimed_country` или если адрес связан с инфраструктурой VPN, Tor или дата-центров. В остальных случаях возвращается `Approved`.\n\n**По возможности.** Обогащение данных по IP выполняется по возможности. Если ни один источник обогащения не вернул пригодных данных, endpoint возвращает одобренный ответ с `ip.ip_address: null`, `ip.country_mismatch: null` и пустым объектом `ip.threat`.\n\n**Биллинг.** Запросы в продакшн-среде тарифицируются по ценам IP Risk API. Запрос подлежит оплате с момента начала поиска.\n\n**Песочница.** Ключи песочницы валидируют запрос и возвращают детерминированные одобренные данные без списания кредитов, создания сессии или передачи данных в Networks.\n\n**Аутентификация.** Передавайте API-ключ вашего приложения в заголовке `x-api-key`. При отсутствии или недействительности учётных данных возвращается `403` - этот API никогда не возвращает `401`.\n\n**Лимит запросов.** Общий лимит на запись составляет 300 запросов в минуту на API-ключ для всех endpoint POST/PATCH/DELETE (для создания транзакций и приёма событий действует отдельный лимит в 600).", "operationId": "post_v3ip_risk", "x-didit-sdk": { "resource": "ip", "method": "assess_risk", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/ip/risk/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"ip_address\": \"8.8.8.8\",\n \"claimed_country\": \"ESP\",\n \"user_agent\": \"Mozilla/5.0\",\n \"vendor_data\": \"lead-123\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.ip.assess_risk(\n ip_address=\"8.8.8.8\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.ip.assessRisk({\n ip_address: \"8.8.8.8\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IP.AssessRisk(ctx, didit.IPRiskRequest{\n\tIPAddress: \"8.8.8.8\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.IPRiskRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.ip().assessRisk(IPRiskRequest.builder()\n .ipAddress(\"8.8.8.8\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "ip->assessRisk([\n 'ip_address' => '8.8.8.8',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.ip.assess_risk(ip_address: \"8.8.8.8\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Ip.AssessRiskAsync(new IPRiskRequest\n{\n IpAddress = \"8.8.8.8\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPRiskRequest" }, "examples": { "Minimal": { "summary": "Оценить адрес со значениями по умолчанию", "value": { "ip_address": "8.8.8.8" } }, "With claimed country": { "summary": "Оценить с заявленной страной для обнаружения несоответствий", "value": { "ip_address": "8.8.8.8", "claimed_country": "ESP", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.4 Safari/605.1.15", "vendor_data": "lead-123" } } } } } }, "responses": { "200": { "description": "Оценка риска завершена. Проверьте `status` для получения решения; для завершённых запросов HTTP-код всегда `200`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPRiskResponse" }, "examples": { "Clean residential IP": { "summary": "Адрес проживания, заявленная страна совпадает", "value": { "request_id": "9a96ed2a-721e-4b86-8cbf-d61eda529279", "status": "Approved", "ip": { "status": "Approved", "ip_address": "192.0.2.10", "ip_country": "Spain", "ip_country_code": "ES", "ip_state": "Madrid", "ip_city": "Madrid", "latitude": 40.4168, "longitude": -3.7038, "isp": "Example Telecom", "organization": "Example Telecom SA", "is_vpn_or_tor": false, "is_data_center": false, "time_zone": "Europe/Madrid", "time_zone_offset": "+0200", "asn_number": 3352, "asn_organization": "EXAMPLE-TELECOM", "connection_type": "broadband", "carrier": "Example Telecom", "proxy_type": null, "claimed_country": "ESP", "country_mismatch": false, "threat": {} }, "vendor_data": "lead-123", "metadata": null, "created_at": "2026-09-01T10:30:00.123456+00:00" } }, "Datacenter mismatch": { "summary": "Адрес дата-центра конфликтует с заявленной страной", "value": { "request_id": "5b1d4e9a-3c7b-4f8e-9a2d-1b0c9d8e7f6a", "status": "In Review", "ip": { "status": "In Review", "ip_address": "8.8.8.8", "ip_country": "United States", "ip_country_code": "US", "ip_state": "California", "ip_city": "Mountain View", "latitude": 37.386, "longitude": -122.0838, "isp": "Google", "organization": "Google LLC", "is_vpn_or_tor": true, "is_data_center": true, "time_zone": "America/Los_Angeles", "time_zone_offset": "-0700", "asn_number": 15169, "asn_organization": "GOOGLE, US", "connection_type": "hosting", "carrier": null, "proxy_type": "VPN", "claimed_country": "ESP", "country_mismatch": true, "threat": { "is_proxy": true, "is_data_center": true, "is_tor": false } }, "vendor_data": "lead-126", "metadata": null, "created_at": "2026-09-01T10:30:00.123456+00:00" } } } } } }, "400": { "$ref": "#/components/responses/IPRiskValidationError" }, "403": { "$ref": "#/components/responses/RiskPermissionDenied" }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/phone/risk/": { "post": { "summary": "Рассчитать оценку риска для номера телефона", "description": "Выполнить проверку номера телефона и вернуть данные об операторе связи, типе линии, портировании, одноразовых номерах, совпадении между сессиями и нормализованные сигналы оценки рисков без отправки OTP. Этот endpoint создаёт API-сессию и возвращает её идентификатор в `request_id`.\n\n**Решение.** Поле верхнего уровня `status` дублирует `phone.status`. Обычно оно имеет значение `Approved`; оценка риска может дать результат `In Review` или `Declined`.\n\n**Псевдонимы для совместимости.** Ответы в продакшн возвращают нормализованный объект аналитики как в `phone.phone_intelligence`, так и в `phone.enrichment`. Значения идентичны. Новые интеграции могут считывать `phone.enrichment`. Оба ключа отсутствуют, если полезные аналитические данные не были получены.\n\n**Биллинг.** Вызовы в продакшн тарифицируются по ценам Phone Risk API. Запрос подлежит оплате с момента запуска проверки, даже если некоторые поля категории best-effort недоступны.\n\n**Песочница.** Ключи песочницы валидируют запрос и возвращают детерминированные одобренные данные без отправки OTP, списания кредитов, создания сессии или передачи данных в Networks.\n\n**Аутентификация.** Передавайте API-ключ вашего приложения в заголовке `x-api-key`. При отсутствии или недействительности учетных данных возвращается `403` - этот API никогда не возвращает `401`.\n\n**Лимит запросов.** Общий лимит на запись составляет 300 запросов в минуту на один API-ключ для всех endpoints POST/PATCH/DELETE (для создания транзакций и приёма событий действует отдельный лимит в 600 запросов).\n\n**Цифровой след в социальных сетях.** Установите `enable_social` в значение `true`, чтобы добавить блок `phone_social`: платформы, на которых зарегистрирован этот номер, с количеством по категориям и доступными данными профилей. `profiles_registered: 0` означает, что платформы были проверены и номер не найден ни на одной из них - это валидный ответ, подлежащий оплате. Блок отсутствует, если дополнение не запрашивалось или проверка не удалась, и плата за него в этом случае не взимается. При биллинге добавляется одна единица `phone_social` за запрос сверх собственной цены этого endpoint.", "operationId": "post_v3phone_risk", "x-didit-sdk": { "resource": "phone", "method": "assess_risk", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/phone/risk/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"phone_number\": \"+14155552671\",\n \"country_code\": \"US\",\n \"vendor_data\": \"lead-123\",\n \"metadata\": {\"source\": \"signup_prescreen\"}\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.phone.assess_risk(\n phone_number=\"+14155552671\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.phone.assessRisk({\n phone_number: \"+14155552671\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Phone.AssessRisk(ctx, didit.PhoneRiskRequest{\n\tPhoneNumber: \"+14155552671\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.PhoneRiskRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.phone().assessRisk(PhoneRiskRequest.builder()\n .phoneNumber(\"+14155552671\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "phone->assessRisk([\n 'phone_number' => '+14155552671',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.phone.assess_risk(phone_number: \"+14155552671\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Phone.AssessRiskAsync(new PhoneRiskRequest\n{\n PhoneNumber = \"+14155552671\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneRiskRequest" }, "examples": { "Minimal": { "summary": "Оценить номер со значениями по умолчанию", "value": { "phone_number": "+14155552671" } }, "Full context": { "summary": "Оценить с сигналами, подсказкой о стране и идентификаторами корреляции", "value": { "phone_number": "+14155552671", "country_code": "US", "signals": { "ip": "192.0.2.1", "device_id": "8F0B8FDD-C2CB-4387-B20A-56E9B2E5A0D2", "device_platform": "ios", "device_model": "iPhone17,2", "os_version": "18.0.1", "app_version": "1.2.34", "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 18_0_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.0 Mobile/15E148 Safari/604.1" }, "vendor_data": "lead-123", "metadata": { "source": "signup_prescreen" } } } } } } }, "responses": { "200": { "description": "Оценка риска завершена. Проверьте `status` для получения решения; для завершённых запросов HTTP-код всегда `200`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneRiskResponse" }, "examples": { "Clean mobile number": { "summary": "Очищенный номер мобильного телефона с покрытием аналитикой", "value": { "request_id": "4fd09d2e-9bc9-4c4e-9c46-7f625ac0ab62", "status": "Approved", "phone": { "status": "Approved", "phone_number_prefix": "+1", "phone_number": "4155552671", "full_number": "+14155552671", "country_code": "US", "country_name": "United States", "carrier": { "name": "Example Mobile", "type": "mobile" }, "is_disposable": false, "is_virtual": false, "verification_method": null, "verification_attempts": 0, "verified_at": null, "warnings": [], "lifecycle": [], "matches": [], "phone_intelligence": { "score": 3.0, "phone_type_risk": "Low", "phone_trust_index": 97, "network_stability_index": 95, "is_disposable": false, "is_ported": false, "is_recently_ported": false, "carrier_type": "mobile", "reason_codes": [] }, "enrichment": { "score": 3.0, "phone_type_risk": "Low", "phone_trust_index": 97, "network_stability_index": 95, "is_disposable": false, "is_ported": false, "is_recently_ported": false, "carrier_type": "mobile", "reason_codes": [] } }, "vendor_data": "lead-123", "metadata": { "source": "signup_prescreen" }, "created_at": "2026-09-01T10:30:00.123456+00:00" } }, "Number in review": { "summary": "Одноразовый или виртуальный номер, помеченный для проверки", "value": { "request_id": "8c22e1f0-4b3d-4a3a-9d1e-2f6b7c8d9e0f", "status": "In Review", "phone": { "status": "In Review", "phone_number_prefix": "+44", "phone_number": "7700900123", "full_number": "+447700900123", "country_code": "GB", "country_name": "United Kingdom", "carrier": { "name": "Example VoIP", "type": "voip" }, "is_disposable": true, "is_virtual": true, "verification_method": null, "verification_attempts": 0, "verified_at": null, "warnings": [], "lifecycle": [], "matches": [], "phone_intelligence": { "score": 72.0, "phone_type_risk": "High", "phone_trust_index": 28, "network_stability_index": 40, "is_disposable": true, "is_ported": true, "is_recently_ported": true, "carrier_type": "voip", "reason_codes": [ { "code": "IR-5AC67A32", "direction": "risk", "message": "Phone type identified as non-mobile", "impact_level": "medium" } ] }, "enrichment": { "score": 72.0, "phone_type_risk": "High", "phone_trust_index": 28, "network_stability_index": 40, "is_disposable": true, "is_ported": true, "is_recently_ported": true, "carrier_type": "voip", "reason_codes": [ { "code": "IR-5AC67A32", "direction": "risk", "message": "Phone type identified as non-mobile", "impact_level": "medium" } ] } }, "vendor_data": "lead-124", "metadata": null, "created_at": "2026-09-01T10:30:00.123456+00:00" } } } } } }, "400": { "$ref": "#/components/responses/PhoneRiskValidationError" }, "403": { "$ref": "#/components/responses/RiskPermissionDenied" }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/": { "post": { "summary": "Создать сессию верификации", "description": "Создать сессию Проверки пользователей (KYC) или Верификации бизнеса (KYB) и получить `url` размещённой страницы верификации и `session_token`, чтобы перенаправить на неё конечного пользователя или встроить её. Параметр `workflow_id` определяет, какие шаги верификации выполняются и является ли сессия KYC или KYB.\n\nВызывайте этот endpoint из бэкенда (никогда из браузера — API-ключ является секретом) каждый раз, когда требуется проверить пользователя или компанию: при регистрации, перед выполнением конфиденциального действия или при необходимости повторной верификации. Предварительные требования: опубликованный сценарий (созданный в Console на странице [Workflows](https://docs.didit.me/ru/console/workflows)) и API-ключ приложения с доступными кредитами. Для приложений в песочнице проверка кредитов не выполняется.\n\n**Идемпотентность:** если указан `vendor_data` и незавершённая сессия (`Not Started`, `In Progress`, `Resubmitted` или `Awaiting User`) с таким же `vendor_data` уже существует в **текущей последней опубликованной версии** сценария (и для этой сессии уже создан URL размещённой страницы верификации), возвращается существующая сессия (по-прежнему с кодом `201`) вместо создания дубликата — при этом её параметры `callback` и `metadata` обновляются до вновь переданных значений. Незавершённая сессия, созданная в более старой версии сценария (которая с тех пор была переопубликована), **не** используется повторно; вместо этого создаётся новая сессия, привязанная к последней опубликованной версии. Сессии в статусах `Approved`, `Declined`, `In Review`, `Expired`, `Abandoned` или `Kyc Expired` никогда не используются повторно.\n\n**Побочные эффекты:** создаётся и сохраняется URL размещённой страницы верификации; если `contact_details.send_notification_emails` имеет значение `true` и указан адрес электронной почты, отправляется письмо с приглашением на верификацию. Срок действия сессии истекает по истечении времени жизни сессии, настроенного в сценарии. Для сценариев KYB параметры `contact_details.phone` и `expected_details` игнорируются.", "operationId": "post_v3_session_create", "x-didit-sdk": { "resource": "sessions", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "responses": { "201": { "description": "Сессия создана (или возвращена, если незавершённая сессия с теми же `vendor_data` уже существует в последней опубликованной версии сценария). Ответ содержит сериализованную сессию, включая `url` размещённой страницы верификации для перенаправления пользователя.", "content": { "application/json": { "schema": { "type": "object", "required": [ "session_id", "session_number", "session_token", "url", "vendor_data", "metadata", "status", "workflow_id", "workflow_version", "callback" ], "properties": { "session_id": { "type": "string", "format": "uuid", "description": "Уникальный идентификатор сессии верификации. Используйте этот id при вызове `GET /v3/session/{sessionId}/decision/`.", "example": "11111111-2222-3333-4444-555555555555" }, "session_number": { "type": "integer", "description": "Порядковый, удобный для восприятия номер, присвоенный сессии внутри вашего приложения. Полезен для службы поддержки и панелей управления.", "example": 43762 }, "session_token": { "type": "string", "description": "12-символьный URL-безопасный token, который авторизует конечного пользователя для доступа к размещённому сценарию верификации по адресу `url`. Действителен до тех пор, пока сессия не истекла. Относитесь к нему как к секрету: любой, у кого он есть, может открыть сценарий верификации для этой сессии.", "example": "3FaJ9wLqX2Mz" }, "url": { "type": "string", "format": "uri", "description": "Размещённый URL верификации, на который перенаправляется конечный пользователь. URL содержит `session_token` и, если настроено, использует ваш White label домен. Если запрос содержит `language`, URL включает языковой сегмент пути — `https://verify.didit.me/{language}/session/{session_token}` (например, `/es/session/...`); без `language` этот сегмент опускается.", "example": "https://verify.didit.me/session/3FaJ9wLqX2Mz" }, "vendor_data": { "type": "string", "nullable": true, "description": "Идентификатор, переданный вами в запросе для привязки сессии к пользователю или компании в вашей собственной системе. Возвращается без изменений. Null, если не указан.", "example": "user-123" }, "metadata": { "description": "Произвольный JSON payload, сохранённый с сессией при её создании. Возвращается в неизменном виде — любое переданное JSON-значение (объект, строка, число, массив) возвращается как есть, хотя рекомендуется передавать JSON-объект. Не отображается конечному пользователю. Всегда присутствует в ответах; `null`, если не было передано при создании.", "example": { "user_type": "premium", "account_id": "ABC123" } }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Теги сессии, по именам.", "example": [ "VIP", "ONBOARDING Q4" ] }, "status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Текущий статус сессии. Для только что созданных сессий возвращается `Not Started`. Если для тех же данных `vendor_data` в последней опубликованной версии сценария уже существовала незавершённая сессия, возвращаемый статус отражает состояние этой существующей сессии.", "example": "Not Started" }, "callback": { "type": "string", "format": "uri", "nullable": true, "description": "Финальный URL перенаправления, на который направляется пользователь после завершения сценария. Didit добавляет к этому URL `?verificationSessionId={session_id}&status={status}`. По умолчанию используется настроенный URL обратного вызова сценария, если он не передан в запросе; `null`, если ни один из них не задан. Если в приложении настроены разрешённые домены и данный URL является веб-URL вне их списка (например, значение по умолчанию в сценарии, заданное до изменения списка), размещённый сценарий не перенаправляет пользователя на него.", "example": "https://example.com/verification/callback" }, "workflow_id": { "type": "string", "format": "uuid", "description": "Постоянный идентификатор сценария, в рамках которого выполняется эта сессия. Всегда является постоянным идентификатором группы сценария — даже если в запросе был указан UUID конкретной версии сценария (для обратной совместимости), ответ содержит постоянный `workflow_id`. Используйте его для сопоставления сессии со сценарием, настроенным вами в консоли.", "example": "11111111-2222-3333-4444-555555555555" }, "workflow_version": { "type": "integer", "description": "Номер опубликованной версии сценария, к которой сессия была привязана при создании. Didit сопоставляет `workflow_id` с последней опубликованной версией сценария на момент создания сессии, и сессия продолжает выполняться на этой версии, даже если сценарий позже будет опубликован повторно.", "example": 3 } } }, "examples": { "KYC session": { "summary": "KYC-сессия создана", "value": { "session_id": "11111111-2222-3333-4444-555555555555", "session_number": 43762, "session_token": "3FaJ9wLqX2Mz", "url": "https://verify.didit.me/en/session/3FaJ9wLqX2Mz", "vendor_data": "user-123", "metadata": { "user_type": "premium", "account_id": "ABC123" }, "status": "Not Started", "workflow_id": "11111111-2222-3333-4444-555555555555", "workflow_version": 3, "callback": "https://example.com/verification/callback" } }, "KYB session": { "summary": "KYB-сессия создана", "value": { "session_id": "22222222-3333-4444-5555-666666666666", "session_number": 43763, "session_token": "Yk7pQ2vN8aBc", "url": "https://verify.didit.me/en/session/Yk7pQ2vN8aBc", "vendor_data": "company-acme-001", "metadata": { "tier": "enterprise" }, "status": "Not Started", "workflow_id": "33333333-4444-5555-6666-777777777777", "workflow_version": 1, "callback": "https://example.com/kyb/callback" } } } } } }, "400": { "description": "Некорректный запрос — payload не прошёл валидацию (отсутствует или неизвестен `workflow_id`, недопустимый `language`, `vendor_data` из списка блокировки, некорректный `portrait_image`, `address` без `country`/`poa_country`, недопустимый `sandbox_scenario`, документы для подписания `sign`, поля или значения, отклонённые шагом сценария «Электронная подпись», такие как `signature_document_not_supported`, `signature_document_conversion_failed`, `field_anchor_not_found` или `field_value_missing` и т. д.), либо у вашей организации недостаточно кредитов для запуска сессии.\n\nТело ответа представляет собой объект, ключами которого являются имена ошибочных полей (или `detail` для ошибок, не связанных с конкретными полями). Значения представляют собой **массив строк** для ошибок валидации входных данных (например, отсутствие обязательного поля, недопустимый язык, слишком большой размер портретного изображения) и **обычную строку** для ошибок, обнаруженных при создании сессии (неизвестный `workflow_id`, `vendor_data` из списка блокировки, отсутствие эталонного лица для сценария со Сравнением лиц). Обрабатывайте обе структуры.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке для ошибок, не связанных с конкретными полями (например, недостаточно кредитов). Для сбоев на уровне полей в качестве ключа используется имя поля со строковым значением или массивом строк.", "example": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } }, "examples": { "Missing workflow_id": { "summary": "Обязательное поле не указано (формат массива строк)", "value": { "workflow_id": [ "This field is required." ] } }, "Invalid workflow_id": { "summary": "Неизвестный workflow_id (в виде обычной строки)", "value": { "workflow_id": "Invalid workflow_id." } }, "Insufficient credits": { "summary": "У организации закончились кредиты", "value": { "detail": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } }, "Blocklisted vendor_data": { "summary": "vendor_data находится в списке блокировки", "value": { "vendor_data": "This user or business has been blocked and cannot create new verification sessions." } }, "Portrait image too large": { "summary": "portrait_image не проходит проверку размера", "value": { "portrait_image": [ "Image size exceeds 2MB." ] } }, "No stored face for vendor_data": { "summary": "Сценарий «Сравнение лиц» без portrait_image и без сохраненного лица для пользователя vendor_data", "value": { "portrait_image": "No stored face image was found for this user. Send a portrait_image, or complete an approved verification with face liveness or an ID document for this vendor_data first." } }, "Portrait image required without vendor_data": { "summary": "Сценарий «Сравнение лиц» без portrait_image и без vendor_data", "value": { "portrait_image": "A portrait image is required to perform face match for this workflow. Send a portrait_image, or provide the vendor_data of a user with a previously stored face image to reuse it." } } } } } }, "403": { "description": "Ошибка аутентификации или авторизации. Неверный, отозванный или истекший ключ возвращает `401`. Endpoint возвращает `403`, если заголовок `x-api-key` отсутствует или если API-ключ действителен, но у клиента нет разрешения на создание сессий в этом приложении (например, API-ключ принадлежит другой организации). В таких случаях тело ответа имеет вид `{\"detail\": \"You do not have permission to perform this action.\"}`. Убедитесь, что заголовок `x-api-key` присутствует и относится к нужному приложению, при необходимости запросите API-ключ приложения повторно через [Auth API](/ru/auth-api/get-credentials) и повторите попытку.\n\n**Удалённое приложение:** в течение нескольких минут после удаления приложения запрос, выполненный с одним из его API-ключей, может возвращать `{\"detail\": \"This application was deleted.\", \"code\": \"application_deleted\"}`. Не повторяйте попытку: приложение и его API-ключи больше не существуют. По истечении этих нескольких минут ключ отклоняется, как и любой другой недействительный ключ.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "You do not have permission to perform this action." }, "code": { "type": "string", "description": "Машиночитаемая причина, присутствует только при некоторых ошибках. `application_deleted`: API-ключ принадлежит приложению, которое было удалено.", "example": "application_deleted" } }, "required": [ "detail" ] }, "examples": { "Missing or invalid API key": { "summary": "Отсутствует заголовок `x-api-key` или передан недействительный API-ключ", "value": { "detail": "You do not have permission to perform this action." } }, "No permission": { "summary": "Клиент не может создавать сессии", "value": { "detail": "You do not have permission to perform this action." } }, "Application deleted": { "summary": "API-ключ удалённого приложения", "value": { "detail": "This application was deleted.", "code": "application_deleted" } } } } } }, "429": { "description": "Превышен лимит запросов — более 600 запросов на создание сессии за 60-секундное окно с одного и того же API-ключа / IP. Проверьте заголовок `Retry-After` и сделайте паузу перед повторной попыткой.\n\n**Примечание:** В исходном коде также определен `FREE_SESSION_RATE_LIMIT`, равный 10 вызовов/минуту наряду с `PAID_SESSION_RATE_LIMIT=600` (`sessions/serializers/session.py`), но этот потолок бесплатного тарифа **не применяется к данному endpoint V3** — middleware лимитирования запросов применяет `SESSION_CREATE_RATE_LIMIT`, равный 600/мин, независимо от тарифа. Лимит 600/мин является единственным, в который здесь можно упереться.", "headers": { "Retry-After": { "description": "Количество секунд, которое вызывающая сторона должна подождать перед повторной попыткой запроса.", "schema": { "type": "integer", "minimum": 1, "example": 42 } }, "X-RateLimit-Limit": { "description": "Максимальное количество запросов, разрешённое в текущем 60-секундном окне для лимита, который был превышен (600 для создания сессии). Отсутствует в варианте квоты песочницы.", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Количество запросов, всё ещё разрешённых в текущем окне для превышенного лимита. Отсутствует в варианте с квотой песочницы.", "schema": { "type": "integer", "minimum": 0, "example": 0 } }, "X-RateLimit-Reset": { "description": "Количество секунд эпохи Unix по UTC, когда текущее окно лимита запросов сбрасывается. Отсутствует в варианте квоты песочницы.", "schema": { "type": "integer", "minimum": 0, "example": 1747497600 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное объяснение нарушения лимита запросов. Используйте это сообщение, чтобы определить, какой из трёх лимитов был исчерпан.", "example": "Session creation rate limit exceeded. You can make up to 600 requests per minute." } } }, "examples": { "Session-create limit": { "summary": "Более 600 запросов на создание сессии в минуту", "value": { "detail": "Session creation rate limit exceeded. You can make up to 600 requests per minute." } }, "Sandbox session quota": { "summary": "Приложение в песочнице превысило лимит в 500 сессий за 24 часа", "value": { "detail": "Sandbox session quota exceeded (500 sessions per 24h). Wait for the window to reset. Expected available in 3600 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X POST 'https://verification.didit.me/v3/session/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"workflow_id\": \"11111111-2222-3333-4444-555555555555\",\n \"vendor_data\": \"user-123\",\n \"callback\": \"https://example.com/verification/callback\",\n \"callback_method\": \"both\",\n \"metadata\": {\"user_type\": \"premium\", \"account_id\": \"ABC123\"},\n \"language\": \"en\",\n \"contact_details\": {\n \"email\": \"john.doe@example.com\",\n \"send_notification_emails\": true,\n \"email_lang\": \"en\",\n \"phone\": \"+14155552671\"\n },\n \"expected_details\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": \"1990-05-15\",\n \"id_country\": \"USA\",\n \"expected_document_types\": [\"P\", \"ID\"]\n }\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.create(\n workflow_id=\"11111111-2222-3333-4444-555555555555\",\n vendor_data=\"user-123\",\n callback=\"https://example.com/verification/callback\",\n callback_method=\"both\",\n metadata={\"user_type\": \"premium\", \"account_id\": \"ABC123\"},\n language=\"en\",\n contact_details={\n \"email\": \"john.doe@example.com\",\n \"send_notification_emails\": True,\n \"email_lang\": \"en\",\n \"phone\": \"+14155552671\",\n },\n expected_details={\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": \"1990-05-15\",\n \"nationality\": \"USA\",\n \"id_country\": \"USA\",\n \"expected_document_types\": [\"P\", \"ID\"],\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.create({\n workflow_id: \"11111111-2222-3333-4444-555555555555\",\n vendor_data: \"user-123\",\n callback: \"https://example.com/verification/callback\",\n callback_method: \"both\",\n metadata: { user_type: \"premium\", account_id: \"ABC123\" },\n language: \"en\",\n contact_details: {\n email: \"john.doe@example.com\",\n send_notification_emails: true,\n email_lang: \"en\",\n phone: \"+14155552671\",\n },\n expected_details: {\n first_name: \"John\",\n last_name: \"Doe\",\n date_of_birth: \"1990-05-15\",\n nationality: \"USA\",\n id_country: \"USA\",\n expected_document_types: [\"P\", \"ID\"],\n },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Create(ctx, didit.SessionsCreateParams{\n\tWorkflowID: \"11111111-2222-3333-4444-555555555555\",\n\tVendorData: didit.String(\"user-123\"),\n\tCallback: didit.String(\"https://example.com/verification/callback\"),\n\tCallbackMethod: didit.Some(didit.SessionsCreateParamsCallbackMethod(\"both\")),\n\tMetadata: didit.Some[any](map[string]any{\"user_type\": \"premium\", \"account_id\": \"ABC123\"}),\n\tLanguage: didit.Some(didit.SessionsCreateParamsLanguage(\"en\")),\n\tContactDetails: didit.Some(didit.SessionsCreateParamsContactDetails{\n\t\tEmail: didit.String(\"john.doe@example.com\"),\n\t\tSendNotificationEmails: didit.Bool(true),\n\t\tEmailLang: didit.Some(didit.SessionsCreateParamsContactDetailsEmailLang(\"en\")),\n\t\tPhone: didit.String(\"+14155552671\"),\n\t}),\n\tExpectedDetails: didit.Some(didit.SessionsCreateParamsExpectedDetails{\n\t\tFirstName: didit.String(\"John\"),\n\t\tLastName: didit.String(\"Doe\"),\n\t\tDateOfBirth: didit.String(\"1990-05-15\"),\n\t\tNationality: didit.String(\"USA\"),\n\t\tIDCountry: didit.String(\"USA\"),\n\t\tExpectedDocumentTypes: didit.Some([]didit.SessionsCreateParamsExpectedDetailsExpectedDocumentTypes{\"P\", \"ID\"}),\n\t}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.LocalDate;\nimport java.util.List;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.SessionsCreateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().create(SessionsCreateParams.builder()\n .workflowId(\"11111111-2222-3333-4444-555555555555\")\n .vendorData(\"user-123\")\n .callback(\"https://example.com/verification/callback\")\n .callbackMethod(SessionsCreateParams.CallbackMethod.of(\"both\"))\n .metadata(Map.of(\"user_type\", \"premium\", \"account_id\", \"ABC123\"))\n .language(SessionsCreateParams.Language.of(\"en\"))\n .contactDetails(SessionsCreateParams.ContactDetails.builder()\n .email(\"john.doe@example.com\")\n .sendNotificationEmails(true)\n .emailLang(SessionsCreateParams.ContactDetails.EmailLang.of(\"en\"))\n .phone(\"+14155552671\")\n .build())\n .expectedDetails(SessionsCreateParams.ExpectedDetails.builder()\n .firstName(\"John\")\n .lastName(\"Doe\")\n .dateOfBirth(LocalDate.parse(\"1990-05-15\"))\n .nationality(\"USA\")\n .idCountry(\"USA\")\n .expectedDocumentTypes(List.of(SessionsCreateParams.ExpectedDetails.ExpectedDocumentTypes.of(\"P\"), SessionsCreateParams.ExpectedDetails.ExpectedDocumentTypes.of(\"ID\")))\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->create([\n 'workflow_id' => '11111111-2222-3333-4444-555555555555',\n 'vendor_data' => 'user-123',\n 'callback' => 'https://example.com/verification/callback',\n 'callback_method' => 'both',\n 'metadata' => ['user_type' => 'premium', 'account_id' => 'ABC123'],\n 'language' => 'en',\n 'contact_details' => [\n 'email' => 'john.doe@example.com',\n 'send_notification_emails' => true,\n 'email_lang' => 'en',\n 'phone' => '+14155552671',\n ],\n 'expected_details' => [\n 'first_name' => 'John',\n 'last_name' => 'Doe',\n 'date_of_birth' => '1990-05-15',\n 'nationality' => 'USA',\n 'id_country' => 'USA',\n 'expected_document_types' => ['P', 'ID'],\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.create(\n workflow_id: \"11111111-2222-3333-4444-555555555555\",\n vendor_data: \"user-123\",\n callback: \"https://example.com/verification/callback\",\n callback_method: \"both\",\n metadata: { user_type: \"premium\", account_id: \"ABC123\" },\n language: \"en\",\n contact_details: {\n email: \"john.doe@example.com\",\n send_notification_emails: true,\n email_lang: \"en\",\n phone: \"+14155552671\",\n },\n expected_details: {\n first_name: \"John\",\n last_name: \"Doe\",\n date_of_birth: \"1990-05-15\",\n nationality: \"USA\",\n id_country: \"USA\",\n expected_document_types: [\"P\", \"ID\"],\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.CreateAsync(new SessionsCreateParams\n{\n WorkflowId = \"11111111-2222-3333-4444-555555555555\",\n VendorData = \"user-123\",\n Callback = \"https://example.com/verification/callback\",\n CallbackMethod = new SessionsCreateParamsCallbackMethod(\"both\"),\n Metadata = new Dictionary { [\"user_type\"] = \"premium\", [\"account_id\"] = \"ABC123\" },\n Language = new SessionsCreateParamsLanguage(\"en\"),\n ContactDetails = new SessionsCreateParamsContactDetails\n {\n Email = \"john.doe@example.com\",\n SendNotificationEmails = true,\n EmailLang = new SessionsCreateParamsContactDetailsEmailLang(\"en\"),\n Phone = \"+14155552671\",\n },\n ExpectedDetails = new SessionsCreateParamsExpectedDetails\n {\n FirstName = \"John\",\n LastName = \"Doe\",\n DateOfBirth = \"1990-05-15\",\n Nationality = \"USA\",\n IdCountry = \"USA\",\n ExpectedDocumentTypes = new SessionsCreateParamsExpectedDetailsExpectedDocumentTypes[] { \"P\", \"ID\" },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "workflow_id" ], "properties": { "workflow_id": { "type": "string", "format": "uuid", "description": "Постоянный идентификатор сценария, который определяет, какие шаги верификации будут выполнены в сессии. Сценарии создаются и управляются на странице [Workflows](/ru/console/workflows) в консоли. Значение `workflow_id` также неявно определяет, является ли сессия KYC или KYB.", "example": "11111111-2222-3333-4444-555555555555", "x-readme-id": "0.0" }, "vendor_data": { "type": "string", "description": "Уникальный идентификатор верифицируемого пользователя, например UUID, адрес электронной почты или внутренний ID пользователя. Это поле используется для: (1) **Группировки пользователей** — сессии с одинаковым vendor_data связываются с одним профилем пользователя на вкладке Users. (2) **Обнаружения дубликатов между сессиями** — при проверке на дублирование лиц, документов, номеров телефонов, адресов электронной почты, IP-адресов или цифровых отпечатков устройств сессии с одинаковым vendor_data считаются одним и тем же пользователем и исключаются из совпадений. Без vendor_data каждая сессия рассматривается как отдельный пользователь, и отображаются все потенциальные дубликаты. Мы настоятельно рекомендуем всегда указывать vendor_data, чтобы снизить уровень шума при обнаружении дубликатов.", "example": "user-123", "x-readme-id": "0.1" }, "multi_account_segment": { "type": "string", "maxLength": 64, "description": "Необязательная область обнаружения дубликатов внутри вашей организации. Проверки на дубликаты лиц сравнивают эту сессию только с другими сессиями с тем же сегментом, поэтому раздельные базы аккаунтов (личные и корпоративные аккаунты или отдельные базы для B2B-субклиентов) не помечают человека, законно владеющего по одному аккаунту в каждой из них. Опустите это поле, чтобы использовать единую область по умолчанию, применяемую сегодня ко всем сессиям. Сопоставление со списком блокировки и белым списком игнорирует это поле.", "example": "business-accounts" }, "callback": { "type": "string", "description": "URL для перенаправления пользователя после завершения верификации. Didit автоматически добавляет `verificationSessionId` и `status` (Approved, Declined, In Review) в качестве query-параметров. Пользовательские схемы URL (например, `myapp://`) поддерживаются для мобильных обратных вызовов. Если параметр опущен, используется `callback_url` сценария по умолчанию. Если у приложения настроены разрешённые домены (`allowed_domains` в `PATCH /v3/webhook/`), обратный вызов `http` или `https` должен относиться к одному из этих источников (та же схема, хост и порт), иначе запрос вернёт ошибку 400 по полю `callback`: `callback must be on one of the application's allowed domains: https://app.example.com`. Пользовательские схемы URL принимаются всегда.", "example": "https://example.com/verification/callback", "x-readme-id": "0.2" }, "callback_method": { "type": "string", "description": "Определяет, какое устройство должно обработать перенаправление на указанный URL обратного вызова. Используйте `initiator`, чтобы перенаправить только устройство, начавшее процесс, `completer` для устройства, завершившего его, или `both`, чтобы разрешить запуск обратного вызова любому из устройств. Если вы заметите, что обратный вызов срабатывает нестабильно, мы рекомендуем установить это значение в `both`.", "enum": [ "initiator", "completer", "both" ], "default": "initiator", "example": "both", "x-readme-id": "0.3" }, "metadata": { "description": "Произвольный JSON, сохранённый с сессией и возвращаемый в ответе и событиях webhook. Допускается любое JSON-значение (объект, строка, число, массив), но рекомендуется JSON-объект с парами ключ/значение. Не отображается конечному пользователю. Используйте его для передачи собственных корреляционных ID, вариантов A/B-тестирования или контекста компании.", "example": { "user_type": "premium", "account_id": "ABC123" }, "x-readme-id": "0.4" }, "tags": { "type": "array", "items": { "type": "string", "maxLength": 50 }, "maxItems": 10, "description": "Теги, добавляемые к сессии при ее создании, по имени. До 10, каждый длиной до 50 символов. Имена нечувствительны к регистру и сохраняются в верхнем регистре. Имя, которого еще нет в приложении, создается как новый тег. Теги отображаются на сессии в консоли, где по ним можно фильтровать.", "example": [ "VIP", "ONBOARDING Q4" ] }, "language": { "type": "string", "description": "Код языка (ISO 639-1) для интерфейса процесса верификации. Определяет язык, отображаемый конечному пользователю во время верификации. Если не указан, язык браузера определяется автоматически. Ознакомиться со всеми поддерживаемыми языками можно [здесь](/ru/integration/supported-languages).", "enum": [ "en", "ar", "bg", "bn", "bs", "ca", "cnr", "cs", "da", "de", "el", "es", "et", "fa", "fi", "fr", "he", "hi", "hr", "hu", "hy", "id", "it", "ja", "ka", "kk", "ko", "ky", "lt", "lv", "mk", "mn", "ms", "nl", "no", "pl", "pt-BR", "pt", "ro", "ru", "sk", "sl", "so", "sq", "sr", "sv", "th", "tr", "uk", "uz", "vi", "zh-CN", "zh-TW", "zh" ], "example": "en", "x-readme-id": "0.5" }, "contact_details": { "type": "object", "description": "Контактная информация пользователя, которая может использоваться для уведомлений, автозаполнения форм верификации и проверки телефона. Включает адрес электронной почты, предпочтительный язык для сообщений и номер телефона.", "example": { "email": "john.doe@example.com", "send_notification_emails": true, "email_lang": "en", "phone": "+14155552671" }, "properties": { "email": { "type": "string", "format": "email", "description": "Адрес электронной почты пользователя (например, \"john.doe@example.com\"), который будет использоваться на шаге [Проверка электронной почты](/ru/core-technology/email-verification/overview). Если не указан, пользователь должен ввести его в процессе верификации.", "example": "john.doe@example.com", "x-readme-id": "1.0" }, "send_notification_emails": { "type": "boolean", "default": false, "description": "Если параметр равен true и указан адрес электронной почты, Didit асинхронно отправляет начальное письмо «Подтвердите вашу личность» при создании сессии Проверки пользователей (KYC) или Верификации бизнеса (KYB). Didit также отправляет уведомления о статусе верификации для сессий, требующих ручной проверки, на указанный адрес электронной почты (например, при смене статуса с «На проверке» на «Одобрена» или «Отклонена»). Это помогает пользователям вернуться в ваше приложение после завершения верификации. Если для сессии активирован White label, отправленное письмо также будет использовать White label.", "example": true, "x-readme-id": "1.1" }, "email_lang": { "type": "string", "description": "Код языка (ISO 639-1) для email-уведомлений. Определяет язык всех сообщений по электронной почте (например, «en», «es», «fr»). Сохранённого значения по умолчанию нет — если параметр опущен, письмо с приглашением на верификацию при отправке автоматически переключается на английский (`en`). Значения перечисления ниже являются снимком; актуальным источником достоверных данных для поддерживаемых значений служит документация по [поддерживаемым языкам](/ru/integration/supported-languages) — сверяйтесь с ней, прежде чем полагаться на конкретный код.", "enum": [ "en", "ar", "bg", "bn", "bs", "ca", "cnr", "cs", "da", "de", "el", "es", "et", "fa", "fi", "fr", "he", "hi", "hr", "hu", "hy", "id", "it", "ja", "ka", "kk", "ko", "ky", "lt", "lv", "mk", "mn", "ms", "nl", "no", "pl", "pt-BR", "pt", "ro", "ru", "sk", "sl", "so", "sq", "sr", "sv", "th", "tr", "uk", "uz", "vi", "zh-CN", "zh-TW", "zh" ], "example": "en", "x-readme-id": "1.2" }, "phone": { "type": "string", "description": "Номер телефона в формате E.164 (например, «+14155552671»), который будет использоваться на шаге [Проверка телефона](/ru/core-technology/phone-verification/overview). Если он не указан, пользователь должен будет предоставить его в процессе верификации. Игнорируется для сценариев Верификации бизнеса (KYB). **Важно:** этот номер телефона применяется только в том случае, если он является корректным номером в формате E.164. Если указанный номер некорректен или не может быть распознан, он игнорируется, и пользователь сможет ввести любой корректный номер телефона на шаге проверки телефона.", "example": "+14155552671", "x-readme-id": "1.3" } }, "x-readme-id": "0.4" }, "expected_details": { "type": "object", "description": "Ожидаемые данные пользователя, используемые для перекрёстной проверки с данными, извлечёнными из документа, удостоверяющего личность пользователя, подтверждения адреса и других шагов верификации. Несоответствия отображаются как предупреждения в решении; некоторые поля (например, `id_country`, `expected_document_types`) также изменяют сценарий для пользователя. Для сценариев верификации бизнеса (KYB) используются только поля компании (`company_name`, `registry_country`, `registration_number`) — они предварительно заполняют поиск в реестре компаний для пользователя, а все поля физических лиц игнорируются.", "example": { "first_name": "John", "last_name": "Doe", "date_of_birth": "1990-05-15", "nationality": "USA", "id_country": "USA", "expected_document_types": [ "P", "ID" ] }, "properties": { "first_name": { "type": "string", "description": "Имя пользователя. Например, `John`. При сопоставлении используется нечёткое сравнение; вы можете настроить строгость, задав порог оценки совпадения имён в Console для сценариев ID Document и Подтверждение адреса.", "example": "John", "x-readme-id": "1.0" }, "last_name": { "type": "string", "description": "Фамилия пользователя. Например, `Doe`. При сопоставлении используется нечёткое сравнение; вы можете настроить строгость, задав порог оценки совпадения имён в Console для сценариев ID Document и «Подтверждение адреса».", "example": "Doe", "x-readme-id": "1.1" }, "date_of_birth": { "type": "string", "format": "date", "description": "Дата рождения пользователя в формате YYYY-MM-DD. Например, `1990-05-15`.", "example": "1990-05-15", "x-readme-id": "1.2" }, "gender": { "type": "string", "nullable": true, "enum": [ "M", "F" ], "default": null, "description": "Пол пользователя. Должен быть 'M', 'F' или null.", "example": "M", "x-readme-id": "1.3" }, "nationality": { "type": "string", "description": "Код страны по стандарту ISO 3166-1 alpha-3, представляющий страну происхождения заявителя. Например, `USA`. См. [полный список поддерживаемых кодов стран](https://docs.didit.me/ru/core-technology/id-verification/supported-documents-id-verification#поддерживаемые-документы-по-странам).", "example": "USA", "x-readme-id": "1.4" }, "country": { "type": "string", "description": "Код страны по стандарту ISO 3166-1 alpha-3, используемый в качестве резервного значения для проверок несоответствия страны как в Верификации личности, так и в Подтверждении адреса. Обязателен, если передан параметр `address` и не заданы ни `id_country`, ни `poa_country`.", "example": "USA", "x-readme-id": "1.4.1" }, "id_country": { "type": "string", "description": "Код страны по стандарту ISO 3166-1 alpha-3, представляющий ожидаемую страну документа, удостоверяющего личность заявителя, которая может отличаться от гражданства. Например, `GBR`. Имеет приоритет над `country` при проверках несоответствия страны в верификации личности. См. [полный список поддерживаемых кодов стран](https://docs.didit.me/ru/core-technology/id-verification/supported-documents-id-verification#поддерживаемые-документы-по-странам).", "example": "GBR", "x-readme-id": "1.5" }, "poa_country": { "type": "string", "description": "Код страны по стандарту ISO 3166-1 alpha-3, представляющий ожидаемую страну документа для подтверждения адреса (Proof of Address). Например, `USA`. Имеет приоритет над `country` при проверках несоответствия страны в POA. См. [полный список поддерживаемых кодов стран](https://docs.didit.me/ru/core-technology/id-verification/supported-documents-id-verification#поддерживаемые-документы-по-странам).", "example": "USA", "x-readme-id": "1.5.1" }, "address": { "type": "string", "description": "Адрес в удобочитаемом для человека формате, содержащий как можно больше информации. Например, `123 Main St, San Francisco, CA 94105, USA`. При передаче вы также должны передать `country` или `poa_country`, иначе запрос завершится с ошибкой `400`.", "example": "123 Main St, San Francisco, CA 94105, USA", "x-readme-id": "1.6" }, "identification_number": { "type": "string", "description": "Номер документа, личный номер или налоговый номер пользователя. Например, `123456789`.", "example": "123456789", "x-readme-id": "1.7" }, "ip_address": { "type": "string", "description": "Ожидаемый IP-адрес для сессии в формате IPv4 или IPv6. Если фактический IP-адрес отличается от этого значения, в журнал будет записано предупреждение. Например, `192.168.1.100` или `2001:db8::1`.", "example": "192.168.1.100", "x-readme-id": "1.8" }, "expected_document_types": { "type": "array", "description": "Ограничивает типы документов, которые пользователь может предоставить во время шага верификации личности (OCR). Если параметр задан, на экране выбора документов отображаются только запрошенные типы, а возвращаемый список `documents_allowed` фильтруется соответствующим образом. Значения нечувствительны к регистру и дедуплицируются; неизвестные значения отклоняются с ошибкой `400`. Допустимые коды: `P` (паспорт), `ID` (национальное удостоверение личности), `DL` (водительское удостоверение), `RP` (вид на жительство), `HIC` (карта медицинского страхования), `TC` (налоговая карта), `SSC` (карта социального страхования).", "items": { "type": "string", "enum": [ "P", "ID", "DL", "RP", "HIC", "TC", "SSC" ] }, "example": [ "P", "ID" ], "x-readme-id": "1.9" }, "company_name": { "type": "string", "maxLength": 255, "description": "Ожидаемое юридическое наименование верифицируемой компании. Например, `Tesco PLC`. Автоматически заполняет поле названия компании при поиске в реестре в сценариях верификации бизнеса (KYB); если также указан `registration_number`, поиск в реестре объединяет оба идентификатора. Игнорируется для сценариев KYC.", "example": "Tesco PLC", "x-readme-id": "1.10" }, "registry_country": { "type": "string", "maxLength": 10, "description": "Двухбуквенный код страны ISO 3166-1 alpha-2, в реестре компаний которой зарегистрирован бизнес. Например, `GB`. Если реестры компаний действуют на уровне штата или провинции, добавьте код подразделения ISO 3166-2 в формате `XX-YY`: `US-CA` выбирает реестр Калифорнии. Тот же формат, что и у `country_code` в [KYB Registry Search API](https://docs.didit.me/ru/standalone-apis/kyb-registry-search). Предварительно выбирает страну реестра в сценариях верификации бизнеса (KYB); игнорируется в сценариях KYC.", "example": "US-CA", "x-readme-id": "1.11" }, "registration_number": { "type": "string", "maxLength": 100, "description": "Ожидаемый регистрационный номер компании в реестре компаний. Например, `00445790`. Автоматически заполняет поле регистрационного номера при поиске в реестре в сценариях верификации бизнеса (KYB); если также указан `company_name`, поиск в реестре объединяет оба идентификатора. Игнорируется для сценариев KYC.", "example": "00445790", "x-readme-id": "1.12" } }, "x-readme-id": "0.5" }, "portrait_image": { "type": "string", "format": "byte", "description": "Портретное изображение лица конечного пользователя в кодировке Base64 (не более 2 МБ; JPEG, PNG, WebP или TIFF). Используется в качестве эталонного изображения для сопоставления со снимком проверки живости, если используется сценарий `Biometric Authentication` с включённым Сравнением лиц или любой граф-сценарий, где Сравнение лиц выполняется до Верификации личности (OCR). Необязательно, если у пользователя из `vendor_data` уже есть сохранённое изображение лица: Didit повторно использует его автоматически, выбирая в порядке приоритета: лицо из одобренной проверки живости, фото с чипа биометрического паспорта, портрет из документа, удостоверяющего личность, лицо профиля, добавленное вручную (повторно используются только лица из одобренных сессий или лица, добавленные вами самостоятельно). При передаче `portrait_image` всегда имеет приоритет над сохранённым лицом. Если параметр опущен и сохранённое лицо отсутствует (или `vendor_data` не отправлен), создание сессии завершается ошибкой `400`. Игнорируется для других типов сценариев.", "example": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=", "x-readme-id": "0.6" }, "sandbox_scenario": { "type": "string", "description": "Слаг сценария только для песочницы. Принимается только в том случае, если API-ключ принадлежит приложению в режиме песочницы; для продакшн-приложений отклоняется. Если задан, процесс создания разворачивает встроенные магические значения сценария во входные поля сессии (contact_details, expected_details), чтобы мок-провайдеры воспроизводили результат сценария через реальный конвейер сценария верификации. Каталог сценариев см. в GET /v1/sandbox/scenarios/ или в разделе [Песочница и тестовые данные](/ru/integration/sandbox-testing). Вы также можете активировать (или повторно активировать) сценарий после создания с помощью POST /v3/session/{sessionId}/sandbox/arm/, пока сессия всё ещё находится в статусе `Not Started`. Для проверок без документов используйте `lookup_partial_match`, `lookup_no_match` или `lookup_provider_error`, чтобы протестировать настроенный лимит попыток и резервный вариант. Для кошельков идентификации используйте `wallet_cancelled`, `wallet_timeout` или `wallet_provider_error`; значение `approve` имитирует верифицированный кошелёк. Все кошельки из каталога можно тестировать в песочнице, включая схемы, недоступные в продакшн-приложениях. Плата за имитированные попытки не взимается.", "example": "decline_document_expired" }, "sign": { "type": "object", "description": "Входные данные электронной подписи для этой сессии. `documents` содержит документы для подписания для сценария, шаг электронной подписи которого берёт документы из сессии (`signature_documents_source` со значением `session` или `both`): до 20 документов и 50 MB суммарно. `field_values` заполняет поля, у которых `prefill` имеет значение `api.`, как в документах сценария, так и в документах сессии. Повторное создание сессии с теми же `workflow_id` и `vendor_data` возвращает ожидающую сессию; если этот вызов передаёт `sign`, его документы, поля и значения должны быть идентичны исходным, а любые отличия возвращают `400` с `{\"sign\": \"signature_document_changed\"}`. См. [Документы электронной подписи](/ru/sessions-api/create-session#документы-для-электронной-подписи).", "properties": { "documents": { "type": "array", "minItems": 1, "maxItems": 20, "items": { "$ref": "#/components/schemas/SessionSignDocument" } }, "field_values": { "type": "object", "description": "Значения с ключами по `` каждого источника автозаполнения `api.`: строки от 1 до 500 символов для полей `text` и `data`, булевы значения для `checkbox`. `400` с `field_value_unknown` для ключа, который не используется ни одним полем, `field_value_missing` для обязательного поля без значения и `field_value_invalid` для значения, не прошедшего валидацию своего поля.", "additionalProperties": { "oneOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "boolean" } ] }, "example": { "credit_limit": "3,000 EUR" } } } }, "user_state": { "type": "string", "maxLength": 16, "description": "Место проживания лица, если оно известно: код подразделения ISO 3166-2 (`US-IL`, `ES-M`) либо код или название штата США (`IL`, `Illinois`). Если законодательство штата требует явного согласия на обработку биометрии (Иллинойс, Техас, Колорадо), сценарий верификации запрашивает его перед захватом лица с триггером `declared_state`. Нераспознанное значение возвращает `400`. См. раздел [Согласие на обработку биометрии](/ru/getting-started/biometric-consent).", "example": "US-IL" }, "biometric_consent": { "type": "object", "description": "Явное биометрическое согласие, которое вы уже получили от человека. Оно удовлетворяет требованию, поэтому в процессе верификации повторный запрос не выполняется, а в решении оно фиксируется со статусом `status: \"given\"` и триггером `customer_collected`. Ответ, который пользователь уже дал в процессе, никогда не перезаписывается. См. [Биометрическое согласие](/ru/getting-started/biometric-consent).", "required": [ "given_at", "text_version" ], "properties": { "given_at": { "type": "string", "format": "date-time", "description": "Время предоставления человеком явного биометрического согласия (ISO 8601). Не может быть в будущем." }, "text_version": { "type": "string", "maxLength": 64, "description": "Идентификатор версии текста согласия, принятого пользователем, в вашей системе учёта." } } } }, "example": { "workflow_id": "11111111-2222-3333-4444-555555555555", "vendor_data": "user-123", "callback": "https://example.com/verification/callback", "callback_method": "both", "metadata": { "user_type": "premium", "account_id": "ABC123" }, "language": "en", "contact_details": { "email": "john.doe@example.com", "send_notification_emails": true, "email_lang": "en", "phone": "+14155552671" }, "expected_details": { "first_name": "John", "last_name": "Doe", "date_of_birth": "1990-05-15", "id_country": "USA", "expected_document_types": [ "P", "ID" ] } } }, "examples": { "Create KYC session": { "summary": "Полный payload успешного сценария для сессии проверки пользователей (KYC)", "description": "Реалистичный вызов создания, использующий все часто используемые поля: выбор сценария, привязку к вендору, маршрутизацию обратных вызовов, метаданные, локаль, предварительное заполнение контактов и ожидаемые данные пользователя. Скопируйте и вставьте это напрямую в пример cURL выше.", "value": { "workflow_id": "11111111-2222-3333-4444-555555555555", "vendor_data": "user-123", "callback": "https://example.com/verification/callback", "callback_method": "both", "metadata": { "user_type": "premium", "account_id": "ABC123" }, "language": "en", "contact_details": { "email": "john.doe@example.com", "send_notification_emails": true, "email_lang": "en", "phone": "+14155552671" }, "expected_details": { "first_name": "John", "last_name": "Doe", "date_of_birth": "1990-05-15", "nationality": "USA", "id_country": "USA", "expected_document_types": [ "P", "ID" ] } } }, "Create KYB session": { "summary": "Payload успешного сценария (happy-path) для сессии Верификации бизнеса (KYB)", "description": "Та же структура, что и у вызова KYC — именно `workflow_id` определяет сессию как KYB. Поле `vendor_data` обычно ссылается на компанию в вашей системе, а `contact_details.email` указывает на законного представителя, который будет проходить процесс. В `expected_details` передаются поля компании (`company_name`, `registry_country`, `registration_number`), которые предварительно заполняют поиск в реестре компаний; поля уровня физического лица и `contact_details.phone` для сценариев KYB игнорируются.", "value": { "workflow_id": "33333333-4444-5555-6666-777777777777", "vendor_data": "company-acme-001", "callback": "https://example.com/kyb/callback", "callback_method": "both", "metadata": { "tier": "enterprise", "company_id": "ACME-001" }, "expected_details": { "company_name": "Tesco PLC", "registry_country": "GB", "registration_number": "00445790" }, "language": "en", "contact_details": { "email": "legal-rep@acme.example.com", "send_notification_emails": true, "email_lang": "en" } } } } } } } } }, "/v3/session/imports/": { "post": { "summary": "Создать задачу импорта верификаций", "description": "Создать асинхронную задачу импорта для исторических сессий Проверки пользователей, сессий Верификации бизнеса (KYB), записей мониторинга транзакций или кастомных правил статусов сценариев. Укажите `source=provider`, чтобы выполнить миграцию от другого провайдера: Didit считывает данные из Sumsub, Onfido, Persona и ComplyCube с помощью вашего ключа только для чтения, считывает записи Veriff, iDenfy и MetaMap по идентификаторам, переданным в `file`, и импортирует файл экспорта в формате Didit для остальных провайдеров. Идентификаторы записей содержат префикс провайдера (`sumsub:`), поэтому повторный запуск пропускает всё, что уже есть в Didit, а запись, импортированная через файл с «чистым» ID провайдера, также распознаётся в обоих направлениях, благодаря чему переключение между импортом из файла и миграцией от провайдера никогда не приводит к дублированию записей. Одно приложение может выполнять до 4 задач импорта одновременно; задача, прерванная деплоем или перезапуском воркера, автоматически возобновляется с последней импортированной строки. Импорт по умолчанию отключён и должен активироваться Didit для каждой организации отдельно.", "operationId": "post_v3_session_imports_create", "x-didit-sdk": { "resource": "sessions.imports", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "import_type": { "type": "string", "enum": [ "user_verification", "business_verification", "status_rules", "transactions" ], "default": "user_verification", "description": "Что импортировать: исторические сессии проверки пользователей, исторические сессии верификации бизнеса, пользовательские правила статусов сценария или исторические записи мониторинга транзакций." }, "workflow_id": { "type": "string", "format": "uuid", "description": "UUID сценария, к которому должны быть привязаны импортированные сессии или правила статуса. Обязательно для user_verification, business_verification и status_rules. Опустите для transactions." }, "source_format": { "type": "string", "enum": [ "csv", "ndjson" ], "description": "Необязательно. Если опущено, определяется по расширению загруженного файла." }, "file": { "type": "string", "format": "binary", "description": "Канонический файл CSV или NDJSON. Для больших объёмов импорта используйте NDJSON. Максимальный размер загрузки 25 MB (для файлов большего размера используйте `source_file_url`). Нельзя использовать одновременно с `source_file_url`." }, "source_file_url": { "type": "string", "format": "uri", "description": "Альтернатива загрузке файла. Должен быть HTTPS-URL, указывающим на публичный адрес (частные/loopback-сети отклоняются). Взаимоисключающий с `file`." }, "source": { "type": "string", "enum": [ "file", "provider" ], "description": "`provider` указывает, что это миграция от другого провайдера верификации личности. Опустите для импорта файла." }, "provider": { "type": "string", "enum": [ "sumsub", "jumio", "veriff", "onfido", "persona", "metamap", "socure", "idnow", "shufti", "idenfy", "ondato", "trulioo", "au10tix", "complycube", "other" ], "description": "Источник миграции из `GET /v3/session/imports/providers/`. Обязателен, если `source` равен `provider`." }, "credentials": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Ключ провайдера только для чтения с именами полей, указанными в `credential_fields`. Зашифрован при хранении, никогда не возвращается в ответах и удаляется по завершении импорта. Передавайте его в виде JSON-строки в multipart." }, "options": { "type": "object", "properties": { "region": { "type": "string", "description": "Регион провайдера, один из его `regions` (Onfido: `eu`, `us`, `ca`)." } } }, "status_mapping": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Expired", "Not Finished", "Abandoned" ] }, "description": "Изменения стандартного сопоставления статусов провайдера: исходный статус в статус Didit. Статусы `Not Finished` и `Abandoned` пропускаются и подсчитываются, но никогда не импортируются." }, "dry_run": { "type": "boolean", "default": false, "description": "Подсчитать, что импортирует миграция (по статусу, уже в Didit, один и тот же человек, не завершено), не выполняя запись. Задача переходит в статус `READY`; запустите её с помощью `POST /v3/session/imports/{importId}/start/`." }, "face_templates": { "type": "boolean", "default": false, "description": "Создание биометрических шаблонов лиц из импортированных селфи и поиск их по лицам приложения и списку блокировки. Совпадения помечаются только для проверки. Требуется `lawful_basis_confirmed`." }, "lawful_basis_confirmed": { "type": "boolean", "default": false, "description": "Подтверждает, что у вас есть законные основания передавать эти селфи компании Didit в качестве обработчика." } } } }, "application/json": { "schema": { "type": "object", "required": [ "source_file_url" ], "properties": { "import_type": { "type": "string", "enum": [ "user_verification", "business_verification", "status_rules", "transactions" ], "default": "user_verification", "description": "Что импортировать: исторические сессии проверки пользователей, исторические сессии верификации бизнеса, пользовательские правила статусов сценария или исторические записи мониторинга транзакций." }, "workflow_id": { "type": "string", "format": "uuid", "description": "UUID сценария, к которому должны быть привязаны импортированные сессии или правила статуса. Обязательно для user_verification, business_verification и status_rules. Опустите для transactions." }, "source_format": { "type": "string", "enum": [ "csv", "ndjson" ], "description": "Необязательно. Если опущено, определяется по расширению файла в URL." }, "source_file_url": { "type": "string", "format": "uri", "description": "Альтернатива загрузке файла. Должен быть HTTPS-URL, указывающим на публичный адрес (частные/loopback-сети отклоняются). Взаимоисключающий с `file`." }, "source": { "type": "string", "enum": [ "file", "provider" ], "description": "`provider` указывает, что это миграция от другого провайдера верификации личности. Опустите для импорта файла." }, "provider": { "type": "string", "enum": [ "sumsub", "jumio", "veriff", "onfido", "persona", "metamap", "socure", "idnow", "shufti", "idenfy", "ondato", "trulioo", "au10tix", "complycube", "other" ], "description": "Источник миграции из `GET /v3/session/imports/providers/`. Обязателен, если `source` равен `provider`." }, "credentials": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Ключ провайдера только для чтения с именами полей, указанными в `credential_fields`. Зашифрован при хранении, никогда не возвращается в ответах и удаляется по завершении импорта. Передавайте его в виде JSON-строки в multipart." }, "options": { "type": "object", "properties": { "region": { "type": "string", "description": "Регион провайдера, один из его `regions` (Onfido: `eu`, `us`, `ca`)." } } }, "status_mapping": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Expired", "Not Finished", "Abandoned" ] }, "description": "Изменения стандартного сопоставления статусов провайдера: исходный статус в статус Didit. Статусы `Not Finished` и `Abandoned` пропускаются и подсчитываются, но никогда не импортируются." }, "dry_run": { "type": "boolean", "default": false, "description": "Подсчитать, что импортирует миграция (по статусу, уже в Didit, один и тот же человек, не завершено), не выполняя запись. Задача переходит в статус `READY`; запустите её с помощью `POST /v3/session/imports/{importId}/start/`." }, "face_templates": { "type": "boolean", "default": false, "description": "Создание биометрических шаблонов лиц из импортированных селфи и поиск их по лицам приложения и списку блокировки. Совпадения помечаются только для проверки. Требуется `lawful_basis_confirmed`." }, "lawful_basis_confirmed": { "type": "boolean", "default": false, "description": "Подтверждает, что у вас есть законные основания передавать эти селфи компании Didit в качестве обработчика." } } }, "examples": { "URL-based import": { "value": { "import_type": "user_verification", "workflow_id": "9f9b1234-aaaa-bbbb-cccc-1234567890ab", "source_file_url": "https://files.example.com/exports/sessions.ndjson" } } } } } }, "responses": { "201": { "description": "Задание на импорт принято. Опрашивайте возвращённый `uuid`, пока `status` не станет `COMPLETED` или `FAILED`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" }, "examples": { "Job accepted": { "value": { "uuid": "3f9c1a2b-4d5e-4f60-8a7b-9c0d1e2f3a4b", "status": "PENDING", "import_type": "user_verification", "source_format": "ndjson", "source_filename": "sessions.ndjson", "total_rows": 0, "processed_rows": 0, "checkpoint_row": 0, "created_count": 0, "updated_count": 0, "skipped_count": 0, "failed_count": 0, "total_media_bytes": 0, "last_error": null, "created_at": "2026-05-17T08:42:11Z", "updated_at": "2026-05-17T08:42:11Z", "started_at": null, "completed_at": null } } } } } }, "400": { "description": "Недопустимый сценарий, тип файла, размер файла, исходный URL-адрес или комбинация селекторов. Миграция, ключ которой отклонён провайдером, возвращает `code` (`invalid_credentials`, `missing_permission`, `wrong_region`, `provider_unavailable`, `rate_limited`, `ids_required`, `record_not_found`), `missing_permissions` и `suggested_region`.", "content": { "application/json": { "examples": { "Invalid workflow": { "value": { "workflow_id": [ "Invalid workflow_id." ] } }, "Workflow required": { "value": { "workflow_id": [ "This field is required for this import type." ] } }, "Wrong file type": { "value": { "file": [ "Only CSV and NDJSON files are supported." ] } }, "File too large": { "value": { "file": [ "Import file exceeds the maximum allowed size." ] } }, "No source": { "value": { "file": [ "Upload a file or provide source_file_url." ] } }, "Both sources": { "value": { "file": [ "Use either file or source_file_url, not both." ] } } } } } }, "403": { "description": "Импорт не включён, приложение песочницы или отсутствует API-ключ (при неверном, отозванном или истёкшем ключе возвращается `401`). Импорт верификаций по умолчанию отключён и должен быть включён Didit для каждой организации отдельно.", "content": { "application/json": { "examples": { "Imports not enabled": { "value": { "detail": "Verification imports are not enabled for this organization." } }, "Sandbox": { "value": { "detail": "Verification imports are not enabled for sandbox applications." } }, "Bad API key": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "У приложения уже есть 4 активных задания на импорт (PENDING/PROCESSING/PAUSED), это максимальное количество, которое может выполняться одновременно. Дождитесь завершения одного из них перед запуском следующего.", "content": { "application/json": { "examples": { "Active job": { "value": { "detail": "This application already has 4 active import jobs, the most it can run at once. Wait for one to finish before starting another." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.create(\n import_type=\"user_verification\",\n workflow_id=\"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n source_file_url=\"https://files.example.com/exports/sessions.ndjson\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.create({\n import_type: \"user_verification\",\n workflow_id: \"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n source_file_url: \"https://files.example.com/exports/sessions.ndjson\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.Create(ctx, didit.SessionsImportsCreateParams{\n\tImportType: didit.Some(didit.SessionsImportsCreateParamsImportType(\"user_verification\")),\n\tWorkflowID: didit.String(\"9f9b1234-aaaa-bbbb-cccc-1234567890ab\"),\n\tSourceFileURL: didit.String(\"https://files.example.com/exports/sessions.ndjson\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsImportsCreateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().create(SessionsImportsCreateParams.builder()\n .importType(SessionsImportsCreateParams.ImportType.of(\"user_verification\"))\n .workflowId(\"9f9b1234-aaaa-bbbb-cccc-1234567890ab\")\n .sourceFileUrl(\"https://files.example.com/exports/sessions.ndjson\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->create([\n 'import_type' => 'user_verification',\n 'workflow_id' => '9f9b1234-aaaa-bbbb-cccc-1234567890ab',\n 'source_file_url' => 'https://files.example.com/exports/sessions.ndjson',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.create(\n import_type: \"user_verification\",\n workflow_id: \"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n source_file_url: \"https://files.example.com/exports/sessions.ndjson\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.CreateAsync(new SessionsImportsCreateParams\n{\n ImportType = new SessionsImportsCreateParamsImportType(\"user_verification\"),\n WorkflowId = \"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n SourceFileUrl = \"https://files.example.com/exports/sessions.ndjson\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/imports/template/": { "get": { "summary": "Скачать шаблон импорта верификаций", "description": "Скачать канонический заголовок CSV для импорта верификаций. Набор столбцов определяется значением `import_type`. Первым столбцом шаблонов сессий является ключ идемпотентности `external_id`.", "operationId": "get_v3_session_imports_template", "x-didit-sdk": { "resource": "sessions.imports", "method": "retrieve_template", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "import_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "user_verification", "business_verification", "status_rules", "transactions" ], "default": "user_verification" } } ], "responses": { "200": { "description": "Файл шаблона CSV.", "content": { "text/csv": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Отсутствующий, недействительный или отозванный API-ключ, либо у ключа нет прав на скачивание шаблонов импорта. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Forbidden": { "summary": "Отсутствует, недействителен или отозван API-ключ", "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\ncontent = client.sessions.imports.retrieve_template()\nwith open(\"download.csv\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst content = await didit.sessions.imports.retrieveTemplate();\nawait writeFile(\"download.csv\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresp, err := client.Sessions.Imports.RetrieveTemplate(ctx, didit.SessionsImportsRetrieveTemplateParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.csv\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.sessions().imports().retrieveTemplate()\n .writeTo(Path.of(\"download.csv\"));" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->retrieveTemplate();\n$content->saveTo('download.csv');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ncontent = didit.sessions.imports.retrieve_template\nFile.binwrite(\"download.csv\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar content = await client.Sessions.Imports.RetrieveTemplateAsync();\nawait content.SaveToAsync(\"download.csv\");" } ] } }, "/v3/session/imports/{importId}/": { "get": { "summary": "Получить задачу импорта верификаций", "description": "Получить счетчики прогресса импорта и финальный статус для одной задачи. Опрашивайте endpoint, пока `status` не станет `COMPLETED` или `FAILED`; `failed_count` > 0 означает, что некоторые строки были отклонены — вызовите endpoint ошибок, чтобы получить их список.", "operationId": "get_v3_session_imports_retrieve", "x-didit-sdk": { "resource": "sessions.imports", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "importId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Статус задания на импорт.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "404": { "description": "Задание на импорт не найдено для этого приложения.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "403": { "description": "Отсутствующий, недействительный или отозванный API-ключ, либо у ключа нет прав на чтение задач импорта для этого приложения. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Forbidden": { "summary": "Отсутствует, недействителен или отозван API-ключ", "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.retrieve(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.retrieve(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().retrieve(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->retrieve('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.retrieve(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.RetrieveAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/imports/{importId}/errors/": { "get": { "summary": "Получить список ошибок в строках импорта верификаций", "description": "Получить список построчных ошибок для задачи импорта верификаций, отсортированных по `row_number`. Используйте этот endpoint для создания исправленного файла повторной попытки, содержащего только строки с ошибками.", "operationId": "get_v3_session_imports_errors", "x-didit-sdk": { "resource": "sessions.imports", "method": "list_errors", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "importId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Размер страницы. По умолчанию 50, если не указан." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0 }, "description": "Смещение первой возвращаемой записи, начиная с нуля." } ], "responses": { "200": { "description": "Ошибки строк с пагинацией.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Количество строк с ошибками: точное до 100, с ограничением в 100 при превышении. Опирайтесь на значение `null` в поле `next`, чтобы определить последнюю страницу." }, "next": { "type": "string", "nullable": true, "description": "Абсолютный URL следующей страницы или `null` на последней странице." }, "previous": { "type": "string", "nullable": true, "description": "Абсолютный URL предыдущей страницы или `null` на первой странице." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/SessionImportError" } } } }, "examples": { "Row errors": { "value": { "count": 1, "next": null, "previous": null, "results": [ { "uuid": "5a6b7c8d-9e0f-4a1b-8c2d-3e4f5a6b7c8d", "row_number": 17, "external_id": "ext-000017", "error": "status: invalid value 'unknown_status'", "raw_row": { "external_id": "ext-000017", "status": "unknown_status", "first_name": "Jane" }, "created_at": "2026-05-17T08:44:02Z" } ] } } } } } }, "404": { "description": "Задание на импорт не найдено для этого приложения.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "403": { "description": "Отсутствующий, недействительный или отозванный API-ключ, либо у ключа нет прав на чтение задач импорта для этого приложения. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Forbidden": { "summary": "Отсутствует, недействителен или отозван API-ключ", "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.sessions.imports.list_errors(\n \"11111111-2222-3333-4444-555555555555\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.sessions.imports.listErrors(\"11111111-2222-3333-4444-555555555555\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Sessions.Imports.ListErrorsAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsImportsListErrorsParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.sessions().imports().listErrors(\"11111111-2222-3333-4444-555555555555\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->listErrors('11111111-2222-3333-4444-555555555555') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.sessions.imports.list_errors(\"11111111-2222-3333-4444-555555555555\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Sessions.Imports.ListErrorsAsync(\"11111111-2222-3333-4444-555555555555\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] } }, "/v3/session/{sessionId}/decision/": { "get": { "summary": "Получить полное решение для сессии верификации", "description": "Получить полный отчёт о решении для сессии верификации — общий `status` сессии плюс один отчёт по каждой функции верификации, выполненной сценарием. Это канонический endpoint чтения как для сессий проверки пользователей (KYC), так и для верификации бизнеса (KYB): один и тот же путь обслуживает обе, а дискриминатор верхнего уровня `session_kind` указывает, какую именно структуру вы получили (`\"user\"` или `\"business\"`).\n\n**Каждый отчёт по функции представляет собой массив, который может содержать несколько элементов.** Сценарии V3 представляют собой графы, которые могут выполнять одну и ту же функцию несколько раз, поэтому каждый блок (`id_verifications`, `nfc_verifications`, `liveness_checks`, `face_matches`, `poa_verifications`, `document_ai_documents`, `phone_verifications`, `email_verifications`, `aml_screenings`, `ip_analyses`, `database_validations`, `questionnaire_responses`) является массивом JSON, элементы которого содержат `node_id`, определяющий создавший их узел графа сценария. Читайте данные NFC как `response.nfc_verifications[0]` — ни в коем случае не как поле в единственном числе `nfc`. Блок равен `null`, пока сценарий не выполнит эту функцию хотя бы один раз; функции, не включённые в сценарий, никогда не возвращаются с данными. Результаты электронной подписи находятся в `signatures`, присутствующем только тогда, когда сценарий включает шаг электронной подписи.\n\n**Когда вызывать.** Рекомендуемый паттерн основан на событиях: дождитесь webhook `status.updated`, отправляемого при принятии решения по сессии (`Approved`, `Declined`, `In Review`), затем вызовите этот endpoint один раз, чтобы получить полный отчёт. Периодический опрос (polling) также работает — endpoint можно вызывать на любом этапе жизненного цикла сессии, и он возвращает данные, сформированные к этому моменту, — однако подход «webhook, затем запрос» экономичнее и быстрее. URL-адреса медиафайлов в ответе (изображения документов, видео, PDF) являются временными подписанными ссылками: скачивайте их без задержек или запросите решение повторно для получения актуальных ссылок; не сохраняйте их в качестве постоянных ссылок.\n\n**Статусы.** Поле `status` верхнего уровня отражает статус жизненного цикла сессии (`Not Started`, `In Progress`, `Awaiting User`, `In Review`, `Approved`, `Declined`, `Resubmitted`, `Expired`, `Kyc Expired`, `Abandoned`). Каждый элемент функции дополнительно содержит собственный `status` уровня функции (`Not Finished`, `Approved`, `Declined`, `In Review`, ...). Сессия может быть `Approved` в целом, тогда как отдельная функция находится `In Review`, в зависимости от правил принятия решений в сценарии.\n\n**Аутентификация и видимость.** Пройдите аутентификацию с помощью API-ключа приложения в заголовке `x-api-key` (также подходит Bearer token пользователя консоли с разрешением `read:sessions`). Доступны только сессии, принадлежащие аутентифицированному приложению. Если ваш сценарий ограничивает возвращаемые атрибуты, поля, недоступные согласно ограничениям, внутри элементов функций возвращаются как `null`, тогда как `status`, `warnings` и `node_id` сохраняются всегда.\n\n**Лимиты запросов.** Запросы GET ограничены 600 запросами в минуту на API-ключ. При превышении лимита возвращается `429` с заголовками `Retry-After` и `X-RateLimit-*`.", "operationId": "get_v3_session_decision", "x-didit-sdk": { "resource": "sessions", "method": "retrieve_decision", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "responses": { "200": { "description": "Полный отчёт о решении. Поле `session_kind` определяет одну из двух структур: сессии типа `user` содержат приведённые ниже массивы функций KYC; сессии типа `business` вместо этого содержат `registry_checks`, `document_verifications` и `key_people_checks` наряду с общими массивами. Массивы функций имеют значение `null` до тех пор, пока сценарий не выполнит соответствующую функцию; URL медиафайлов представляют собой временные подписанные ссылки.", "content": { "application/json": { "examples": { "Example": { "summary": "Полный пример", "value": { "session_id": "11111111-2222-3333-4444-555555555555", "session_kind": "user", "session_number": 43762, "session_url": "https://verify.didit.me/session/11111111-2222-3333-4444-555555555555", "status": "In Review", "environment": "live", "workflow_id": "11111111-2222-3333-4444-555555555555", "features": [ "ID_VERIFICATION", "NFC", "LIVENESS", "FACE_MATCH", "POA", "PHONE", "DATABASE_VALIDATION", "AML", "IP_ANALYSIS" ], "vendor_data": "11111111-1111-1111-1111-111111111111", "metadata": { "user_type": "premium", "account_id": "ABC123" }, "expected_details": { "first_name": "Carmen", "last_name": "Española Española" }, "contact_details": { "email": "carmen@example.com", "email_lang": "es", "send_notification_emails": false, "phone": null }, "callback": "https://verify.didit.me/", "id_verifications": [ { "node_id": "feature_ocr_1", "status": "Approved", "document_type": "Identity Card", "document_subtype": "ID_CARD_GENERIC", "document_number": "CAA000000", "personal_number": "99999999R", "portrait_image": "https:///portrait.jpg", "front_image": "https:///front.jpg", "front_video": "https:///front.mp4", "back_image": "https:///back.jpg", "back_video": "https:///back.mp4", "full_front_image": "https:///full_front.jpg", "full_back_image": "https:///full_back.jpg", "front_image_camera_front": "https:///front_camera_front.jpg", "back_image_camera_front": "https:///back_camera_front.jpg", "date_of_birth": "1980-01-01", "age": 45, "expiration_date": "2031-06-02", "date_of_issue": "2021-06-02", "issuing_state": "ESP", "issuing_state_name": "Spain", "first_name": "Carmen", "last_name": "Española Española", "full_name": "Carmen Española Española", "gender": "F", "address": "Avda de Madrid 34, Madrid, Madrid", "formatted_address": "Avda de Madrid 34, Madrid, Madrid 28822, Spain", "place_of_birth": "Madrid", "marital_status": "Single", "nationality": "ESP", "extra_fields": { "dl_categories": [], "blood_group": null }, "mrz": { "surname": "ESPANOLA ESPANOLA", "name": "CARMEN", "country": "ESP", "nationality": "ESP", "birth_date": "800101", "expiry_date": "310602", "sex": "F", "document_type": "ID", "document_number": "CAA000000", "optional_data": "99999999R", "optional_data_2": "", "birth_date_hash": "4", "expiry_date_hash": "8", "document_number_hash": "4", "final_hash": "1", "personal_number": "99999999R", "warnings": [], "errors": [], "mrz_type": "TD1", "mrz_string": "IDESPCAA000000499999999R<<<<<<\n8001014F3106028ESP<<<<<<<<<<<1\nESPANOLA/match_face.jpg", "status": "Approved", "is_blocklisted": false, "is_allowlisted": false, "api_service": null, "source": "session" } ], "front_image_quality_score": { "focus_score": 85.3, "brightness_score": 92.1, "brightness_issue": "ok", "is_document_fully_visible": true, "resolution_score": 72.4, "overall_score": 88.7 }, "back_image_quality_score": { "focus_score": 79.1, "brightness_score": 90.5, "brightness_issue": "ok", "is_document_fully_visible": true, "resolution_score": 72.4, "overall_score": 85.2 }, "extra_files": [ "https:///extra_id_verification.jpg" ], "matches": [ { "session_id": "7d4f1f60-9c2e-4b8a-8f3d-2a1b5c6d7e8f", "session_number": 1234, "vendor_data": "user_ref_001", "verification_date": "2024-06-15T10:30:00Z", "user_details": { "name": "John Smith", "document_type": "ID", "document_number": "CLM148418" }, "status": "Approved", "is_blocklisted": false, "api_service": null, "front_image_url": "https:///document_front.jpg" }, { "session_id": "b2c8e4d1-6a3f-4e7b-95c0-1d8f2a6b4c9e", "session_number": 1235, "vendor_data": null, "verification_date": "2024-05-20T14:45:00Z", "user_details": { "name": "John Smith", "document_type": "ID", "document_number": "CLM148418" }, "status": "Declined", "is_blocklisted": true, "api_service": "ID_VERIFICATION", "front_image_url": "https:///document_front_2.jpg" } ], "warnings": [ { "feature": "ID_VERIFICATION", "risk": "QR_NOT_DETECTED", "additional_data": null, "log_type": "information", "short_description": "QR not detected", "long_description": "The system couldn't find or read the QR code on the document, which is necessary for document verification. This could be due to poor image quality or an unsupported document type.", "node_id": "feature_ocr_1" } ], "verification_method": "document", "assurance": "documentary", "wallet_provider": null, "fallback_from": null, "id_lookup": null, "wallet_verification": null, "document_liveness": { "portrait_replace": { "score": 96.46, "front": 96.46, "back": 98.2, "decline_threshold": 35, "review_threshold": 70, "bucket": "approve" }, "printed_copy": { "score": 91.2, "front": 91.2, "back": 93.7, "decline_threshold": 35, "review_threshold": 77, "bucket": "approve" }, "screen_replay": { "score": 99.9, "front": 99.9, "back": 99.5, "decline_threshold": 30, "review_threshold": 70, "bucket": "approve" } } }, { "node_id": "feature_ocr_2", "status": "Approved", "issuing_state": "ZAF", "issuing_state_name": "South Africa", "first_name": "Thabo", "last_name": "Mokoena", "full_name": "Thabo Mokoena", "date_of_birth": "1991-06-15", "personal_number": "9106155043088", "verification_method": "id_lookup", "assurance": "data_match", "wallet_provider": null, "fallback_from": null, "id_lookup": { "source": "Department of Home Affairs", "checked_at": "2026-09-04T09:12:44Z", "attempts": 1, "max_attempts": 2, "outcome": "match", "comparison": [ { "field": "identification_number", "label": "ID number", "provided": "9106155043088", "record": "9106155043088", "result": "match" }, { "field": "full_name", "label": "Full name", "provided": "Thabo Mokoena", "record": "Thabo Mokoena", "result": "match" }, { "field": "date_of_birth", "label": "Date of birth", "provided": "1991-06-15", "record": "1991-06-15", "result": "match" } ], "registry_portrait": "https:///registry_portrait.jpg", "face_match_score": 96.4, "source_errors": [] }, "wallet_verification": null, "warnings": [] }, { "node_id": "feature_ocr_3", "status": "Approved", "issuing_state": "DNK", "issuing_state_name": "Denmark", "first_name": "Freja", "last_name": "Nielsen", "full_name": "Freja Nielsen", "date_of_birth": "1988-03-02", "verification_method": "wallet", "assurance": "cryptographic", "wallet_provider": "mitid", "fallback_from": null, "id_lookup": null, "wallet_verification": { "provider": "mitid", "provider_name": "MitID", "issuing_authority": "Danish Agency for Digital Government", "issuing_country": "DNK", "credential_type": "person_identification", "level_of_assurance": "substantial", "verified_at": "2026-09-04T09:12:44Z", "signature_valid": true, "attributes": { "full_name": "Freja Nielsen", "date_of_birth": "1988-03-02", "cpr_alias": "b0f1c2d3-e4f5-4678-9abc-def012345678" }, "portrait": null, "face_match_score": null }, "warnings": [] } ], "nfc_verifications": [ { "node_id": "feature_nfc_1", "status": "In Review", "is_nfc_skipped": false, "skip_reason": null, "chip_protocol": "icao", "jpki": null, "portrait_image": "https:///portrait.jpg", "signature_image": "https:///signature.jpg", "chip_data": { "document_type": "ID", "issuing_country": "ESP", "document_number": "123456789", "expiration_date": "2030-01-01", "first_name": "John", "last_name": "Smith", "birth_date": "1990-05-15", "gender": "M", "nationality": "ESP", "address": "CALLE MAYOR 123 4B, MADRID, MADRID", "place_of_birth": "MADRID, MADRID" }, "authenticity": { "sod_integrity": true, "dg_integrity": true }, "certificate_summary": { "issuer": "Common Name: CSCA SPAIN, Serial Number: 3, Organization: DIRECCION GENERAL DE LA POLICIA, Country: ES", "subject": "Common Name: DS n-eID SPAIN 2, Organizational Unit: PASSPORT, Organization: DIRECCION GENERAL DE LA POLICIA, Country: ES", "serial_number": "118120836164494130086420187336801405660", "not_valid_after": "2031-02-18 10:21:11", "not_valid_before": "2020-11-18 10:21:11" }, "warnings": [ { "feature": "NFC", "risk": "DATA_INCONSISTENT", "additional_data": null, "log_type": "warning", "short_description": "OCR and NFC mrz code extracted are not the same", "long_description": "The Optical Character Recognition (OCR) data and the NFC chip data don't match, indicating potential document tampering or data inconsistency.", "node_id": "feature_nfc_1" } ] } ], "liveness_checks": [ { "node_id": "feature_liveness_1", "status": "Approved", "method": "ACTIVE_3D", "score": 89.92, "reference_image": "https:///reference.jpg", "video_url": "https:///video.mp4", "age_estimation": 24.3, "matches": [ { "session_id": "7d4f1f60-9c2e-4b8a-8f3d-2a1b5c6d7e8f", "session_number": 1234, "vendor_data": "user_ref_001", "verification_date": "2024-06-15T10:30:00Z", "user_details": { "full_name": "John Smith", "document_type": "ID", "document_number": "CLM148418" }, "status": "Approved", "is_blocklisted": false, "is_allowlisted": false, "api_service": null, "source": "session", "match_image_url": "https:///face_match.jpg", "similarity_percentage": 98.5 }, { "session_id": "3e9a7c21-5b48-4f0e-9c6a-8d2f4b1e0a35", "session_number": 1100, "vendor_data": "customer_xyz", "verification_date": "2024-04-10T09:15:00Z", "user_details": { "full_name": "John Smith", "document_type": "P", "document_number": "DZ8375806" }, "status": "Approved", "is_blocklisted": false, "is_allowlisted": false, "api_service": "PASSIVE_LIVENESS", "source": "session", "match_image_url": "https:///face_match_2.jpg", "similarity_percentage": 95.2 } ], "warnings": [ { "feature": "LIVENESS", "risk": "LOW_LIVENESS_SCORE", "additional_data": null, "log_type": "information", "short_description": "Low liveness score", "long_description": "The liveness check resulted in a low score, indicating potential use of non-live facial representations or poor-quality biometric data.", "node_id": "feature_liveness_1" } ], "face_quality": null, "face_luminance": null } ], "face_matches": [ { "node_id": "feature_face_match_1", "status": "In Review", "score": 65.43, "source_image_session_id": null, "source_image": "https:///source-image.jpg", "target_image": "https:///target-image.jpg", "warnings": [ { "feature": "FACEMATCH", "risk": "LOW_FACE_MATCH_SIMILARITY", "additional_data": null, "log_type": "warning", "short_description": "Low face match similarity", "long_description": "The facial features of the provided image don't closely match the reference image, suggesting a potential identity mismatch.", "node_id": "feature_face_match_1" } ] } ], "phone_verifications": [ { "node_id": "feature_phone_1", "status": "Approved", "phone_number_prefix": "+34", "phone_number": "600600600", "full_number": "+34600600600", "country_code": "ES", "country_name": "Spain", "carrier": { "name": "Orange", "type": "mobile" }, "is_disposable": false, "is_virtual": false, "verification_method": "sms", "verification_attempts": 1, "verified_at": "2024-07-28T06:47:35.654321Z", "lifecycle": [ { "type": "PHONE_VERIFICATION_MESSAGE_SENT", "timestamp": "2025-08-24T09:12:39.580554+00:00", "details": { "status": "Success", "reason": null, "channel": "sms", "actual_channel": "sms" }, "fee": 0.1 }, { "type": "VALID_CODE_ENTERED", "timestamp": "2025-08-24T09:12:39.662157+00:00", "details": { "code_tried": "123456", "status": "Approved" }, "fee": 0 }, { "type": "PHONE_VERIFICATION_APPROVED", "timestamp": "2025-08-24T09:12:39.684292+00:00", "details": null, "fee": 0 } ], "warnings": [], "matches": [ { "session_id": null, "session_number": null, "vendor_data": null, "verification_date": null, "phone_number": "+34600000000", "status": null, "is_blocklisted": true, "api_service": null, "source": "list_entry" } ] } ], "email_verifications": [ { "node_id": "feature_email_1", "status": "Approved", "email": "test@example.com", "is_breached": true, "breaches": [ { "name": "TAPAirPortugal", "domain": "flytap.com", "logo_path": "https://logos.example.com/TAPAirPortugal.png", "breach_date": "2022-08-25", "description": "In August 2022, the Portuguese airline TAP Air Portugal was the target of a ransomware attack perpetrated by the Ragnar Locker gang who later leaked the compromised data via a public dark web site. Over 5M unique email addresses were exposed alongside other personal data including names, genders, DoBs, phone numbers and physical addresses.", "is_verified": true, "data_classes": [ "dates_of_birth", "email_addresses", "genders", "names", "nationalities", "phone_numbers", "physical_addresses", "salutations", "spoken_languages" ], "breach_emails_count": 6083479 } ], "is_disposable": false, "is_undeliverable": false, "verification_attempts": 1, "verified_at": "2025-09-15T17:36:19.963451Z", "warnings": [ { "feature": "EMAIL", "risk": "BREACHED_EMAIL_DETECTED", "additional_data": null, "log_type": "information", "short_description": "Breached email detected", "long_description": "This email address was found in one or more known data breaches.", "node_id": "feature_email_1" } ], "lifecycle": [ { "type": "EMAIL_VERIFICATION_MESSAGE_SENT", "timestamp": "2025-09-15T17:36:19.792684+00:00", "details": { "status": "Success", "reason": null }, "fee": 0.02 }, { "type": "VALID_CODE_ENTERED", "timestamp": "2025-09-15T17:36:19.963427+00:00", "details": { "code_tried": "123456", "status": "Approved" }, "fee": 0 }, { "type": "EMAIL_VERIFICATION_DECLINED", "timestamp": "2025-09-15T17:36:20.081471+00:00", "details": { "reason": "BREACHED_EMAIL_DETECTED" }, "fee": 0 } ], "matches": [ { "session_id": null, "session_number": null, "vendor_data": null, "verification_date": null, "email": "test@example.com", "status": null, "is_blocklisted": true, "api_service": null, "source": "list_entry" } ] } ], "poa_verifications": [ { "node_id": "feature_poa_1", "status": "Declined", "document_file": "https:///poa_document.pdf", "issuing_state": "AR", "document_type": "UTILITY_BILL", "document_subtype": null, "document_language": "es", "document_metadata": { "file_size": 1000, "content_type": "application/pdf", "creation_date": "2021-01-01", "modified_date": "2021-01-01", "overlay_manipulation": null, "creator": null, "producer": "PDF Generator", "software": null, "encryption": null, "is_signed": false, "is_tampered": false, "signature_info": null, "exif_original_date": null, "exif_digitized_date": null, "processed_by_known_editor": false, "has_different_creation_mod_date": true }, "issuer": "Aguas del Norte", "issue_date": "2021-02-01", "expiration_date": null, "poa_address": "AVDA. MONSEÑOR TAVELLA N° 3396, SALTA", "poa_formatted_address": "Av. Monseñor Tavella 3396, A4400 Salta, Argentina", "poa_parsed_address": { "address_type": "Avenida", "street_1": "Avenida Monseñor Tavella 3396", "street_2": null, "city": "Salta", "region": "Salta", "country": "AR", "postal_code": "A4400", "document_location": { "latitude": -24.8208664, "longitude": -65.4131 } }, "name_on_document": "Fernando De Lima", "name_match_score_expected_details": null, "name_match_score_id_verification": 38.5, "expected_details_address": null, "expected_details_formatted_address": null, "expected_details_parsed_address": {}, "extra_fields": { "bank_account_number": "1234567890", "bank_iban": null, "bank_sort_code": null, "bank_routing_number": null, "bank_swift_bic": null, "bank_branch_name": null, "bank_branch_address": null, "document_phone_number": "+5491112345678", "additional_names": [] }, "extra_files": [ "https:///extra_poa.pdf" ], "detected_codes": [ { "type": "QR_CODE", "page_number": 1, "position": [ [ 820, 1120 ], [ 1002, 1120 ], [ 1002, 1302 ], [ 820, 1302 ] ], "x": 820, "y": 1120, "width": 182, "height": 182, "page_width": 1190, "page_height": 1684, "raw_payload": "aHR0cHM6Ly9hZ3Vhc2RlbG5vcnRlLmNvbS9mYWN0dXJhLzk5ODgxMQ==", "parsed_payload": "https://aguasdelnorte.com/factura/998811" }, { "type": "CODE_128", "page_number": 1, "position": [ [ 112, 1480 ], [ 560, 1480 ], [ 560, 1540 ], [ 112, 1540 ] ], "x": 112, "y": 1480, "width": 448, "height": 60, "page_width": 1190, "page_height": 1684, "raw_payload": "MDA5OTg4MTEwMDA0Mg==", "parsed_payload": "0099881100042" } ], "warnings": [] } ], "document_ai_documents": [ { "status": "Approved", "node_id": "feature_document_ai_1", "items": [ { "uuid": "c1a2b3c4-d5e6-7f80-9a1b-2c3d4e5f6071", "node_id": "feature_document_ai_1", "document_key": "proof_of_funds", "original_filename": "bank_statement.pdf", "file_size": 184320, "file_url": "https:///document_ai/proof_of_funds.pdf", "status": "Approved", "extracted_data": { "account_holder": "John Doe", "balance": 15230.55, "currency": "EUR", "statement_date": "2026-05-31" }, "detected_codes": [ { "type": "QR_CODE", "page_number": 2, "position": [ [ 124, 86 ], [ 306, 86 ], [ 306, 268 ], [ 124, 268 ] ], "x": 124, "y": 86, "width": 182, "height": 182, "page_width": 1190, "page_height": 1684, "raw_payload": "SU5WLTIwMjYtMDA0Mg==", "parsed_payload": "INV-2026-0042" } ], "fields": [ { "key": "account_holder", "name": "Account holder", "instruction": "Extract the full name of the account holder.", "type": "text", "required": true }, { "key": "balance", "name": "Closing balance", "instruction": "Extract the closing balance amount.", "type": "number", "required": true } ], "document_metadata": { "is_tampered": false }, "cross_check_result": null, "created_at": "2026-06-01T12:34:56Z" } ], "warnings": [] } ], "questionnaire_responses": [ { "node_id": "feature_questionnaire_1", "questionnaire_id": "9f7485e0-b00b-4d56-9d3e-7859b68d1213", "title": "Source of Funds", "description": "Reply to this questionnaire to help us understand the source of funds.", "languages": [ "en" ], "default_language": "en", "is_active": true, "is_simple_questionnaire": true, "questionnaire_group_id": "2b6a9d40-13a8-4b1e-9a6c-3f1d2e4b5a60", "version": 1, "published_at": "2025-11-02T09:14:55.000000Z", "sections": [ { "title": null, "description": null, "items": [ { "uuid": "618636d9-7d5c-41ce-b8d0-1ab2a4be20db", "value": "question_1", "element_type": "DROPDOWN", "is_required": true, "title": "What is your primary source of funds?", "description": null, "placeholder": null, "choices": [ { "label": "Salary", "value": "salary" }, { "label": "Business Income", "value": "business_income" }, { "label": "Savings", "value": "savings" }, { "label": "Investments", "value": "investments" }, { "label": "Sale of Asset", "value": "sale_of_asset" }, { "label": "Inheritance/Gift", "value": "inheritance_gift" }, { "label": "Pension", "value": "pension" }, { "label": "Crypto Proceeds", "value": "crypto_proceeds" }, { "label": "Other", "value": "other", "requires_text_input": true } ], "max_files": 1, "answer": { "value": "salary" }, "required_if": null, "repeatable_config": null }, { "uuid": "2d16b527-72be-42e0-8e96-b164b818386c", "value": "question_2", "element_type": "LONG_TEXT", "is_required": true, "title": "Provide details of the primary source.", "description": null, "placeholder": null, "choices": null, "max_files": 1, "answer": { "value": "Test answer" }, "required_if": null, "repeatable_config": null }, { "uuid": "a9239b7c-fbfb-4ea7-b7e4-c835cd4016e0", "value": "question_3", "element_type": "DROPDOWN", "is_required": true, "title": "What is your annual income range (pre-tax)?", "description": null, "placeholder": null, "choices": [ { "label": "Less than $25,000", "value": "<25k" }, { "label": "$25,000 - $50,000", "value": "25k-50k" }, { "label": "$50,001 - $100,000", "value": "50k-100k" }, { "label": "$100,001 - $250,000", "value": "100k-250k" }, { "label": "More than $250,000", "value": ">250k" } ], "max_files": 1, "answer": { "value": "<25k" }, "required_if": null, "repeatable_config": null }, { "uuid": "93dede62-6d0c-4a7f-934d-42175eb94011", "value": "question_4", "element_type": "DROPDOWN", "is_required": true, "title": "What is your approximate net worth (range)?", "description": null, "placeholder": null, "choices": [ { "label": "Less than $50,000", "value": "<50k" }, { "label": "$50,000 - $250,000", "value": "50k-250k" }, { "label": "$250,001 - $1,000,000", "value": "250k-1m" }, { "label": "$1,000,001 - $5,000,000", "value": "1m-5m" }, { "label": "More than $5,000,000", "value": ">5m" } ], "max_files": 1, "answer": { "value": "<50k" }, "required_if": null, "repeatable_config": null }, { "uuid": "2af60d6f-6961-4692-9ee7-24b3033610a6", "value": "question_5", "element_type": "LONG_TEXT", "is_required": true, "title": "For your initial deposit/funding, indicate the exact source and amount.", "description": null, "placeholder": null, "choices": null, "max_files": 1, "answer": { "value": "Test answer" }, "required_if": null, "repeatable_config": null }, { "uuid": "0ad9d1aa-736f-46cf-947b-9e1241b53e40", "value": "question_6", "element_type": "LONG_TEXT", "is_required": true, "title": "Breakdown of sources by percentage.", "description": null, "placeholder": null, "choices": null, "max_files": 1, "answer": { "value": "Test answer" }, "required_if": null, "repeatable_config": null }, { "uuid": "1bf8a2a3-14ee-48a8-bb3d-175481aae4aa", "value": "question_7", "element_type": "SINGLE_CHOICE", "is_required": true, "title": "Will any funds originate from third parties? If yes, please provide details.", "description": null, "placeholder": null, "choices": [ { "label": "Yes", "value": "yes", "requires_text_input": true }, { "label": "No", "value": "no" } ], "max_files": 1, "answer": { "text": "Additional details", "value": "yes" }, "required_if": null, "repeatable_config": null }, { "uuid": "e18d4dd3-b7bf-4883-ba18-d6046adbe313", "value": "question_8", "element_type": "SINGLE_CHOICE", "is_required": true, "title": "Do you hold or plan to use virtual assets (e.g., crypto) to fund this account? If yes, please provide details.", "description": null, "placeholder": null, "choices": [ { "label": "Yes", "value": "yes", "requires_text_input": true }, { "label": "No", "value": "no" } ], "max_files": 1, "answer": { "text": "Additional details", "value": "yes" }, "required_if": null, "repeatable_config": null }, { "uuid": "a90a073d-e098-404c-bbce-5130d8b12a13", "value": "question_9", "element_type": "FILE_UPLOAD", "is_required": true, "title": "Upload a proof of funds document", "description": "You can upload your three (3) most recent bank statements, three (3) most recent payslips, your most recent tax return, proof of company ownership, trading exchange statement, sale of property, or proof of inheritance.", "placeholder": null, "choices": null, "max_files": 3, "answer": { "files": [ "/media/ocr/", "/media/ocr/" ] }, "required_if": null, "repeatable_config": null }, { "uuid": "9503b486-7cb8-4c3b-a97d-4b64926a5a47", "value": "question_10", "element_type": "LONG_TEXT", "is_required": false, "title": "Would you like to add any details to help us expedite our review of the documents you submitted?", "description": null, "placeholder": null, "choices": null, "max_files": 1, "answer": { "value": "Test answer" }, "required_if": null, "repeatable_config": null } ] } ], "status": "Approved" } ], "aml_screenings": [ { "node_id": "feature_aml_1", "status": "In Review", "total_hits": 1, "entity_type": "person", "hits": [ { "id": "hit_7c1e9a40b2d35f86e0a4c912", "url": "https://news.example.org/articles/sample", "match": false, "score": 0.73, "target": null, "caption": "Javier Ejemplo Modelo", "datasets": [ "PEP" ], "features": null, "rca_name": "", "last_seen": "2025-06-13T00:00:00", "risk_view": { "crimes": { "score": 0, "weightage": 20, "risk_level": "Low", "risk_scores": {} }, "countries": { "score": 0, "weightage": 30, "risk_level": "Low", "risk_scores": {} }, "categories": { "score": 100, "weightage": 50, "risk_level": "High", "risk_scores": { "PEP": 100 } }, "custom_list": {} }, "first_seen": "2025-01-18T00:00:00", "properties": { "name": [ "Javier Ejemplo Modelo" ], "alias": [ "Javier Ejemplo Modelo", "David Azagra" ], "notes": [ "Spanish orchestra conductor" ], "title": null, "gender": [ "male" ], "height": null, "topics": null, "weight": null, "address": null, "country": null, "website": null, "eyeColor": null, "keywords": null, "lastName": [ "Ejemplo", "Modelo" ], "position": null, "religion": null, "birthDate": [ "1974" ], "education": [ "Tokyo Arts and Space (2012-2012)", "Saint Petersburg Conservatory (-2010)", "Comillas Pontifical University" ], "ethnicity": null, "firstName": [ "David" ], "hairColor": null, "weakAlias": null, "birthPlace": [ "Madrid" ], "modifiedAt": null, "wikidataId": null, "citizenship": null, "nationality": null }, "match_score": 98, "risk_score": 73, "review_status": "Unreviewed", "score_breakdown": { "name_score": 95, "name_weight": 60, "name_weight_normalized": 70.59, "name_contribution": 67.06, "dob_score": 100, "dob_weight": 25, "dob_weight_normalized": 29.41, "dob_contribution": 29.41, "country_score": 0, "country_weight": 15, "country_weight_normalized": 0, "country_contribution": 0, "document_number_match_type": "NEUTRAL", "document_number_effect": "No document number provided for screening", "total_score": 98 }, "pep_matches": [ { "aliases": [ "Javier Ejemplo Modelo", "David Azagra" ], "education": [ "Tokyo Arts and Space (2012-2012)", "Saint Petersburg Conservatory (-2010)", "Comillas Pontifical University" ], "list_name": "Wikidata", "publisher": "Wikidata", "source_url": "https://news.example.org/articles/sample", "description": "Wikidata is the structured data project of the Wikipedia community, providing fact-based information edited by humans and machines", "matched_name": "Javier Ejemplo Modelo", "pep_position": "", "date_of_birth": "1974", "other_sources": [], "place_of_birth": "Madrid" } ], "linked_entities": [ { "name": [ "Antonio Ejemplo" ], "active": [], "status": [], "details": [], "relation": [] } ], "warning_matches": [], "sanction_matches": [], "adverse_media_details": { "sentiment": "Moderately Negative", "entity_type": "person", "sentiment_score": -2, "adverse_keywords": { "fraud": 3, "juicio": 1, "delitos": 2, "imputado": 1, "impunidad": 1, "corruption": 2, "favoritism": 2, "privilegio": 1, "corrupción": 1, "persecution": 2, "desconfianza": 1, "desprestigio": 1, "fraude de ley": 2, "manipulación": 1, "investigación": 3, "prevaricación": 8, "trato de favor": 1, "irregularidades": 2, "crisis de confianza": 1, "tráfico de influencias": 8 } }, "adverse_media_matches": [ { "country": "spain", "summary": "Javier Ejemplo is implicated in legal violations related to favoritism and influence trafficking, leading to a negative portrayal in the article.", "headline": "La Diputación de Villaejemplo consolida la plaza a medida para el ex asesor de Moncloa amigo del \"hermanito\" de Ejemplo", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "fraud", "prevaricación", "tráfico de influencias", "irregularidades", "imputado" ], "sentiment_score": -2, "publication_date": "2025-06-10T20:46:38" }, { "country": "spain", "summary": "Javier Ejemplo is implicated in legal issues regarding favoritism and corruption, leading to a negative portrayal in the article.", "headline": "La Diputación de Villaejemplo consolida la plaza a medida para el ex asesor de Moncloa amigo del \"hermanito\" de Ejemplo", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "fraud", "prevaricación", "tráfico de influencias", "irregularidades", "trato de favor" ], "sentiment_score": -2, "publication_date": "2025-06-10T20:46:38" }, { "country": "spain", "summary": "Javier Ejemplo Modelo is mentioned in connection with Carlos Ficticio's corruption case, indicating his involvement in alleged influence peddling.", "headline": "España, paraíso del aforado", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "prevaricación", "tráfico de influencias", "corrupción", "impunidad", "privilegio", "desconfianza", "manipulación", "fraude de ley" ], "sentiment_score": -2, "publication_date": "2025-06-10T05:05:34" }, { "country": "spain", "summary": "Javier Ejemplo Modelo is implicated in the same investigation as Ficticio, which raises questions about his conduct and political ethics.", "headline": "Aforamientos: esa figura incómoda", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "prevaricación", "tráfico de influencias", "investigación", "juicio", "fraude de ley", "desprestigio", "crisis de confianza", "delitos" ], "sentiment_score": -2, "publication_date": "2025-06-08T06:01:00" }, { "country": "spain", "summary": "Javier Ejemplo is implicated in a legal investigation regarding irregularities in his hiring, which raises serious concerns about his conduct.", "headline": "La jueza del 'caso Javier Ejemplo' denuncia un «fraude de ley» en el aforamiento de Ficticio (Partido Ejemplo)", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "fraud", "irregularities", "prevaricación", "tráfico de influencias" ], "sentiment_score": -2, "publication_date": "2025-06-09T10:19:10" }, { "country": "spain", "summary": "Javier Ejemplo Modelo is mentioned in connection with legal allegations of corruption, contributing to a negative perception.", "headline": "'Caso aforamiento': la letrada mayor de la Asamblea certifica a la juez que Ficticio es diputado desde antes de prometer su cargo en el Pleno", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "prevaricación", "tráfico de influencias" ], "sentiment_score": -2, "publication_date": "2025-06-09T08:08:30" }, { "country": "spain", "summary": "Javier Ejemplo Modelo is implicated in the same investigation as Ficticio, raising concerns about political corruption and influence.", "headline": "Aforamientos: esa figura incómoda", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "prevaricación", "tráfico de influencias", "investigación" ], "sentiment_score": -2, "publication_date": "2025-06-08T06:01:00" }, { "country": "spain", "summary": "Javier Ejemplo Modelo is implicated in the same investigation as Ficticio, which raises concerns about political misconduct.", "headline": "Aforamientos: esa figura incómoda", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "prevaricación", "tráfico de influencias", "investigación", "delitos" ], "sentiment_score": -2, "publication_date": "2025-06-08T06:00:59" }, { "country": "spain", "summary": "Javier Ejemplo is implicated in a case of favoritism and corruption, which casts a negative light on his character and actions.", "headline": "'Caso Javier Ejemplo': las asociaciones judiciales salen en defensa de la juez Luisa Inventada ante las \"presiones externas\" que sufre", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "favoritism", "corruption", "persecution" ], "sentiment_score": -2, "publication_date": "2025-06-06T10:08:15" }, { "country": "spain", "summary": "Javier Ejemplo is implicated in a case of alleged favoritism and corruption, which casts a negative light on his character and actions.", "headline": "'Caso Javier Ejemplo': las asociaciones judiciales salen en defensa de la juez Luisa Inventada ante las \"presiones externas\" que sufre", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "favoritism", "corruption", "persecution" ], "sentiment_score": -2, "publication_date": "2025-06-06T08:08:15" } ], "additional_information": {} } ], "score": 80, "screened_data": { "full_name": "Javier Ejemplo Modelo", "nationality": "ES", "date_of_birth": "1974-01-01", "document_number": null }, "is_ongoing_monitoring_enabled": true, "next_ongoing_monitoring_bill_date": "2026-07-24", "last_ongoing_screening_at": "2026-09-12T04:03:11Z", "last_ongoing_screening_datasets_updated_at": "2026-09-11T06:00:00Z", "warnings": [ { "feature": "AML", "risk": "POSSIBLE_MATCH_FOUND", "additional_data": null, "log_type": "warning", "short_description": "Possible match found in AML screening", "long_description": "The Anti-Money Laundering (AML) screening process identified potential matches with watchlists or high-risk databases, requiring further review.", "node_id": "feature_aml_1" } ] } ], "ip_analyses": [ { "node_id": "feature_ip_1", "status": "Approved", "device_brand": "Apple", "device_model": "iPhone", "browser_family": "Mobile Safari", "os_family": "iOS", "platform": "mobile", "device_fingerprint": "didit-fp-a1b2c3d4e5f6g7h8", "ip_country": "Spain", "ip_country_code": "ES", "ip_state": "Barcelona", "ip_city": "Barcelona", "latitude": 41.4022, "longitude": 2.1407, "ip_address": "83.50.226.71", "isp": null, "organization": null, "is_vpn_or_tor": false, "is_data_center": false, "time_zone": "Europe/Madrid", "time_zone_offset": "+0100", "ip": { "location": { "latitude": 40.2206327, "longitude": 1.5770097 }, "distance_from_id_document": 23.4, "distance_from_poa_document": 12.3 }, "id_document": { "location": { "latitude": 41.2706327, "longitude": 1.9770097 }, "distance_from_ip": 23.4, "distance_from_poa_document": 18.7 }, "poa_document": { "location": { "latitude": 41.2706327, "longitude": 1.9770097 }, "distance_from_ip": 12.3, "distance_from_id_document": 18.7 }, "warnings": [], "matches": [ { "session_id": "99999999-8888-7777-6666-555555555555", "session_number": 41205, "vendor_data": "22222222-2222-2222-2222-222222222222", "verification_date": "2024-07-20T10:15:30Z", "match_type": "ip_address", "match_source": "ip_address", "matched_value": "83.50.226.71", "status": "Approved", "is_blocklisted": false, "api_service": null, "source": "session", "device_info": { "device_brand": "Apple", "device_model": "iPhone", "browser_family": "Mobile Safari", "os_family": "iOS", "platform": "mobile", "device_fingerprint": "didit-fp-f9e8d7c6b5a40312" }, "location_info": { "ip_address": "83.50.226.71", "ip_country": "Spain", "ip_country_code": "ES", "ip_state": "Barcelona", "ip_city": "Barcelona", "is_vpn_or_tor": false, "is_data_center": false }, "confidence": 0.0, "match_mode": "co_occurrence" }, { "session_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "session_number": 42830, "vendor_data": "33333333-3333-3333-3333-333333333333", "verification_date": "2024-06-30T18:22:05Z", "match_type": "device_fingerprint", "match_source": "recovered_high", "matched_value": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "status": "Declined", "is_blocklisted": false, "api_service": null, "source": "session", "device_info": { "device_brand": "Samsung", "device_model": "SM-G991B", "browser_family": "Chrome Mobile", "os_family": "Android", "platform": "mobile", "device_fingerprint": null }, "location_info": { "ip_address": "83.50.231.18", "ip_country": "Spain", "ip_country_code": "ES", "ip_state": "Madrid", "ip_city": "Madrid", "is_vpn_or_tor": false, "is_data_center": false }, "confidence": 1.0, "match_mode": "deterministic", "recovery_similarity": 0.9874, "tls_ja4_corroborated": true, "recovery_gate_reason": "hardware_root_match" } ] } ], "database_validations": [ { "node_id": "feature_db_validation_1", "issuing_state": "BRA", "validation_type": "one_by_one", "screened_data": { "last_name": "De Lima", "first_name": "Fernando", "tax_number": "01234567890", "date_of_birth": "1980-01-01", "document_type": "ID", "expiration_date": "2030-01-01" }, "validations": [ { "service_id": "bra_cpf", "service_name": "Brazil - CPF status check", "outcome_code": "MATCH", "validation": { "full_name": "full_match", "date_of_birth": "full_match", "identification_number": "full_match" }, "source_data": { "identification_number": "01234567890", "first_name": "FERNANDO", "last_name": "DE LIMA", "date_of_birth": "1980-01-01", "gender": "M", "nationality": "BRA" } } ], "match_type": "full_match", "status": "Approved", "warnings": [] } ], "reviews": [ { "user": "compliance@example.com", "new_status": "Declined", "comment": "Possible match found in AML screening", "created_at": "2024-07-18T13:29:00.366811Z" } ], "created_at": "2024-07-24T08:54:25.443172Z", "expires_at": "2025-07-24T08:54:25.443172Z", "biometric_consent": { "required": false, "trigger": null, "status": "not_required", "given_at": null, "declined_at": null, "text_version": null, "text_hash": null, "locale": null, "policy_url": null, "step": null, "node_id": null, "ip_address": null, "ip_country_code": null, "ip_state": null, "ip_city": null, "user_agent": null, "detected_ip_address": "83.50.226.71", "detected_country_code": "ES", "detected_state": "ES-B", "detected_city": "Barcelona", "declared_state": null, "document_state": null, "jurisdictions": [], "retention_months": null, "reason": null, "decline_reason": null, "face_data_deleted_at": null } } }, "BusinessExample": { "summary": "Пример сессии верификации бизнеса (KYB)", "description": "Решение для `session_kind = \"business\"`: сессии KYB заменяют массивы функций KYC на `registry_checks`, `document_verifications` и `key_people_checks`, при этом общими остаются `aml_screenings`, `phone_verifications`, `email_verifications`, `questionnaire_responses`, `ip_analyses`, `reviews` и оболочка сессии.", "value": { "session_id": "66666666-7777-8888-9999-000000000000", "session_kind": "business", "session_number": 31415, "session_url": "https://verify.didit.me/session/business123", "status": "In Review", "environment": "live", "workflow_id": "abababab-cdcd-efef-0101-232323232323", "features": [ "KYB_REGISTRY", "KYB_DOCUMENTS", "KYB_KEY_PEOPLE" ], "vendor_data": "merchant-001234", "metadata": null, "callback": "https://example.com/verification/callback", "registry_checks": [ { "status": "Approved", "node_id": "feature_kyb_registry_1", "data_resolved": true, "company": { "uuid": "dddd4444-eeee-5555-ffff-666677778888", "node_id": "feature_kyb_registry_1", "status": "Approved", "registry_status": "active", "data_resolved": true, "company_name": "ACME HOLDINGS LTD", "registration_number": "12345678", "country_code": "GB", "region": null, "company_type": "Private Limited Company", "incorporation_date": "2015-03-12", "registered_address": "1 Example Street, London, EC1A 1AA", "tax_number": null, "risk_level": null, "verification_status": "verified", "is_from_registry": true, "fetch_status": "resolved", "alternative_names": null, "nature_of_business": "62012 - Business and domestic software development", "registered_capital": "100 GBP", "registered_capital_amount": "100.00", "registered_capital_currency": "GBP", "website": null, "email": null, "phone": null, "legal_entity_identifier": null, "location_of_registration": "England and Wales", "financial_summary": null, "officers": [ { "uuid": "aaaa1111-bbbb-2222-cccc-333344445555", "name": "Jane Smith", "designation": "Director", "role": "director", "nationality": "British", "is_active": true, "kyc_status": "Approved", "kyc_session_url": "https://verify.didit.me/session/abc123def456" } ], "beneficial_owners": [ { "uuid": "bbbb2222-cccc-3333-dddd-444455556666", "name": "John Doe", "first_name": "John", "last_name": "Doe", "entity_type": "person", "roles": [ "ubo", "shareholder" ], "ownership_min_shares": "50", "ownership_max_shares": "75", "is_active": true, "kyc_status": "Pending", "kyc_session_url": "https://verify.didit.me/session/def456ghi789", "effective_ownership_percent": 75.0 } ], "addresses": [ { "type": "registered", "address": "1 Example Street, London, EC1A 1AA", "country": "GB" } ], "industries": [ { "code": "62012", "description": "Business and domestic software development" } ], "accounts": null, "registry_data": {}, "user_provided_data": { "company_name": "ACME HOLDINGS", "registration_number": "12345678" }, "confirmed_by_user_at": "2026-06-10T12:01:30.000000Z", "last_console_edit_at": null, "is_editable": false }, "ownership_structure": { "shareholders": [ { "name": "John Doe", "first_name": "John", "last_name": "Doe", "date_of_birth": null, "country_of_birth": null, "company_name": null, "registration_number": null, "entity_type": "person", "nationality": null, "designation": null, "roles": [ "shareholder" ], "ownership_min_shares": "75", "ownership_max_shares": "75", "voting_min_shares": null, "voting_max_shares": null, "appointment_date": null, "is_active": true, "shareholding": { "share_class": "ORDINARY", "number_of_shares": 750.0, "currency": "GBP", "nominal_value": 1.0, "total_value": null, "percentage": 75.0 } } ], "beneficial_owners": [] }, "warnings": [] } ], "aml_screenings": null, "document_verifications": [ { "status": "In Review", "node_id": "feature_kyb_documents_1", "items": [ { "uuid": "eeee5555-ffff-6666-0000-777788889999", "document_type": "LEGAL_PRESENCE", "document_subtype": "CERTIFICATE_OF_INCORPORATION", "document_group": "LEGAL_PRESENCE", "file_url": "https:///kyb/certificate-of-incorporation.pdf", "original_filename": "certificate_of_incorporation.pdf", "file_size": 482133, "status": "Approved", "created_at": "2026-06-10T12:03:11.000000Z", "cross_check_result": { "critical": { "company_name": { "document": "ACME HOLDINGS LTD", "registry": "ACME HOLDINGS LTD", "score": 1.0, "match": true }, "registration_number": { "document": "12345678", "registry": "12345678", "match": true } }, "non_critical": {}, "people": {} }, "document_metadata": { "file_size": 482133, "content_type": "application/pdf", "creation_date": "2015-03-12T09:00:00", "modified_date": "2015-03-12T09:00:00", "creator": null, "producer": null, "software": null, "encryption": null, "is_signed": true, "is_tampered": false, "signature_info": null, "exif_original_date": null, "exif_digitized_date": null, "processed_by_known_editor": false, "has_different_creation_mod_date": false, "overlay_manipulation": null }, "description": null, "is_requested": false, "ocr_data": { "company_name": "ACME HOLDINGS LTD", "registration_number": "12345678", "incorporation_date": "2015-03-12" }, "is_console_upload": false, "is_confirmed": true }, { "uuid": "ffff6666-0000-7777-1111-888899990000", "document_type": "OWNERSHIP_STRUCTURE", "document_subtype": null, "document_group": "OWNERSHIP_STRUCTURE", "file_url": null, "original_filename": null, "file_size": null, "status": "Not Finished", "created_at": "2026-06-10T15:40:02.000000Z", "cross_check_result": null, "document_metadata": null, "description": "Please upload an up-to-date shareholder registry", "is_requested": true, "ocr_data": null, "is_console_upload": false, "is_confirmed": true } ], "groups": { "LEGAL_PRESENCE": { "total": 1, "approved": 1, "pending": 0, "declined": 0, "in_review": 0, "other": 0, "missing": 0 }, "OWNERSHIP_STRUCTURE": { "total": 1, "approved": 0, "pending": 0, "declined": 0, "in_review": 0, "other": 0, "missing": 1 } }, "required_groups": [ "LEGAL_PRESENCE", "OWNERSHIP_STRUCTURE" ], "warnings": [] } ], "key_people_checks": [ { "status": "In Review", "node_id": "feature_kyb_key_people_1", "registry": { "officers": [ { "uuid": "aaaa1111-bbbb-2222-cccc-333344445555", "name": "Jane Smith", "designation": "Director", "role": "director", "nationality": "British", "appointment_date": "2015-03-12", "termination_date": null, "is_active": true, "address": "1 Example Street, London, EC1A 1AA", "aml_status": "Approved", "kyc_status": "Approved", "kyc_session_url": "https://verify.didit.me/session/abc123def456", "kyc_session_id": "77777777-8888-9999-aaaa-bbbbbbbbbbbb", "verification_workflow_type": "kyc", "verification_workflow_id": "12121212-3434-5656-7878-909090909090", "verification_workflow_label": "Key People KYC", "verification_workflow_features": [ { "feature": "ID_VERIFICATION", "status": "Approved" }, { "feature": "LIVENESS", "status": "Approved" }, { "feature": "AML", "status": "Approved" } ], "didit_internal_id": "99999999-0000-1111-2222-333333333333", "kyc_document_type": "P", "kyc_nationality": "GBR", "kyc_liveness_passed": true, "kyc_verified_at": "2026-06-10T14:22:31.123456Z", "kyc_aml_categories": { "sanctions": "clear", "pep": "clear", "adverse_media": "clear", "warnings": "clear" }, "kyc_notification_sent_at": "2026-06-09T09:00:00.000000Z" } ], "beneficial_owners": [ { "uuid": "bbbb2222-cccc-3333-dddd-444455556666", "name": "John Doe", "first_name": "John", "last_name": "Doe", "date_of_birth": "1980-05-04", "country_of_birth": null, "email": null, "company_name": null, "registration_number": null, "entity_type": "person", "nationality": "British", "designation": null, "roles": [ "ubo", "shareholder" ], "ownership_min_shares": "50", "ownership_max_shares": "75", "is_active": true, "aml_status": null, "kyc_status": "In Progress", "kyc_session_url": "https://verify.didit.me/session/def456ghi789", "kyc_session_id": "88888888-9999-aaaa-bbbb-cccccccccccc", "verification_workflow_type": "kyc", "verification_workflow_id": "12121212-3434-5656-7878-909090909090", "verification_workflow_label": "Key People KYC", "verification_workflow_features": [ { "feature": "ID_VERIFICATION", "status": "Not Finished" }, { "feature": "LIVENESS", "status": "Not Finished" }, { "feature": "AML", "status": "Not Finished" } ], "didit_internal_id": null, "kyc_document_type": null, "kyc_nationality": null, "kyc_liveness_passed": null, "kyc_verified_at": null, "kyc_aml_categories": null, "kyc_notification_sent_at": null, "child_beneficial_owners": [], "effective_ownership_percent": 75.0 } ] }, "submitted": { "parties": [ { "uuid": "cccc3333-dddd-4444-eeee-555566667777", "entity_type": "person", "source": "USER", "name": "John Doe", "first_name": "John", "last_name": "Doe", "company_name": null, "registration_number": null, "email": "john.doe@example.com", "nationality": "GBR", "phone_number": "+447700900123", "date_of_birth": "1980-05-04", "position": "Chief Executive Officer", "custom_fields": {}, "is_active": true, "is_skipped": false, "requires_verification": true, "roles": [ { "role": "ubo", "ownership_percent": 75.0, "voting_percent": 75.0 }, { "role": "director", "ownership_percent": null, "voting_percent": null } ], "kyc_session_id": "88888888-9999-aaaa-bbbb-cccccccccccc", "kyc_session_status": "In Progress", "kyc_session_url": "https://verify.didit.me/session/def456ghi789", "kyb_sub_session_id": null, "kyb_sub_session_status": null, "kyb_sub_session_url": null, "verification_workflow_type": "kyc", "verification_workflow_id": "12121212-3434-5656-7878-909090909090", "verification_workflow_label": "Key People KYC", "verification_workflow_features": [ { "feature": "ID_VERIFICATION", "status": "Not Finished" }, { "feature": "LIVENESS", "status": "Not Finished" }, { "feature": "AML", "status": "Not Finished" } ], "didit_internal_id": null } ] }, "ubo_kyc_summary": { "total": 1, "approved": 0, "flagged": 0, "pending": 1 }, "warnings": [] } ], "phone_verifications": null, "email_verifications": null, "questionnaire_responses": null, "ip_analyses": null, "reviews": [], "contact_details": null, "expected_details": { "company_name": "Tesco PLC", "registry_country": "GB", "registration_number": "00445790" }, "created_at": "2026-06-10T11:58:04.000000Z", "expires_at": "2026-06-24T11:58:04.000000Z" } } }, "schema": { "$ref": "#/components/schemas/SessionDecision" } } } }, "403": { "description": "Ошибка аутентификации или авторизации. При отсутствии ключа возвращается `403`; неверный, отозванный или истёкший ключ возвращает `401`. Две строки `detail` разграничивают типы ошибок:\n\n- `\"Authentication credentials were not provided or are invalid.\"` — отсутствует заголовок `x-api-key` (и нет токена `Authorization: Bearer`), либо переданные учетные данные не прошли проверку (отозваны, истекли или некорректны).\n- `\"You do not have permission to perform this action.\"` — учетные данные действительны, но не дают права на чтение этой сессии: у Bearer-токена пользователя консоли отсутствует разрешение `read:sessions` или нет доступа к приложению-владельцу, либо API-ключ принадлежит другой организации, отличной от сессии.\n\nОбратите внимание, что для полностью неизвестного `sessionId` endpoint сначала определяет приложение-владельца до валидации учетных данных, поэтому отсутствующая сессия возвращает `404`, даже если учетные данные отсутствуют или недействительны.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "Authentication credentials were not provided or are invalid." } } }, "examples": { "Missing or invalid credentials": { "summary": "Заголовок x-api-key отсутствует, либо ключ не прошёл интроспекцию", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Insufficient permissions": { "summary": "Действительные учетные данные без разрешения read:sessions или доступа к приложению-владельцу", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Сессия не найдена. Возвращается, когда ни одна активная сессия не соответствует переданному `sessionId` как сессия проверки пользователей (KYC) или верификации бизнеса (KYB) — удалённая сессия также попадает сюда. Тело ответа представляет собой стандартную обёртку `{\"detail\": ...}`.\n\n**Две различные строки `detail`.** Если `sessionId` неизвестен ни как KYC-, ни как KYB-сессия, предварительная проверка владельца завершается ошибкой, и вы получаете `{\"detail\": \"Not found.\"}` — это происходит до валидации учетных данных, поэтому возвращается даже для неаутентифицированных вызовов. Если сессия существует, но не может быть получена в рамках аутентифицированного приложения (например, устаревшая или только что удалённая запись), представление возвращает `{\"detail\": \"Session not found.\"}`. Оба варианта указывают на один и тот же результат — сессия недоступна, поэтому проверяйте код состояния `404`, а не саму строку.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "Not found." } } }, "examples": { "Unknown session id": { "summary": "sessionId неизвестен этому приложению", "value": { "detail": "Not found." } }, "Session not retrievable": { "summary": "Сессия существует, но не может быть получена для этого приложения", "value": { "detail": "Session not found." } } } } } }, "429": { "description": "Превышен лимит запросов. Запросы GET ограничены **600 в минуту на учетные данные** (API-ключ, Bearer-токен или IP-адрес источника при неаутентифицированных запросах). Проверьте заголовки `Retry-After` / `X-RateLimit-Reset` и сделайте паузу перед повторной попыткой. Если вы достигли этого лимита при опросе решений, переключитесь на webhook `status.updated` и запрашивайте решение один раз при изменении статуса.", "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой запроса.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Максимальное количество запросов, разрешённое в текущем окне (600 для GET-запросов).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Количество оставшихся запросов в текущем окне.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Unix-время (в секундах), когда сбрасывается текущее окно.", "schema": { "type": "integer", "example": 1750000000 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное объяснение нарушения лимита запросов.", "example": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } }, "examples": { "Throttled": { "summary": "Более 600 GET-запросов за одну минуту с одними и теми же учетными данными", "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID сессии верификации, решение по которой требуется получить. Это `session_id`, возвращённый `POST /v3/session/`. Этот путь работает как для сессий Проверки пользователей (KYC), так и для Верификации бизнеса (KYB) — сервер сопоставляет ID для обоих типов сессий.\n\n**Должен быть корректным UUID.** Маршрут сопоставляется только с корректно сформированными UUID, поэтому некорректное значение отклоняется маршрутизатором URL ещё до выполнения кода приложения, и в ответ возвращается **HTML**-страница `404`, а не конверт JSON `{\"detail\": ...}`, показанный ниже. Проверяйте формат UUID на стороне клиента, чтобы отличать ошибку ввода от действительной ошибки `404` при отсутствии сессии.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "include", "in": "query", "required": false, "description": "Разделённый запятыми список дополнительных секций payload. Поддерживаемые значения: `events` и `resubmissions`, по отдельности или вместе (`events,resubmissions`). Если передан параметр `include=events`, ответ дополнительно содержит хронологию событий сессии (`events`, включая события маршрутизации `WORKFLOW_BRANCH_EVALUATED` / `WORKFLOW_STATUS_NODE_REACHED`, описанные на странице Retrieve Session), полный журнал действий (`activity_reviews`), флаги списка блокировки (`blocklisted`), детализацию `cost_breakdown` за сессию, метаданные сценария (`workflow_type`, `workflow_version`, `workflow_version_id` и `workflow_terminal_node_id` - последний зафиксированный узел статуса сценария, установивший статус сессии, или `null`, если таковой не был зафиксирован; историческое происхождение, которое не сбрасывается ручными одобрениями, отклонениями или повторными отправками и заменяется более поздним узлом статуса сценария) и метаданные сессии (`api_service` — строка или `null`, устанавливается только для сессий автономных API; `session_type` — `API`, `HOSTED` или `MIGRATED`; `has_device_nfc_support` — boolean). Два поля изменяются по сравнению с базовой структурой: дискриминатор верхнего уровня `session_kind` **опускается** (структура с событиями существует только для сессий пользователей), а массив `features` переключается с простых строк на объекты `{feature, node_id}` — где функция электронной почты возвращается как `EMAIL` вместо `EMAIL_VERIFICATION`. Эта расширенная структура в основном используется Didit Console; большинству интеграций через API следует опускать этот параметр. **Ограничение KYB:** `include=events` применяется только к сессиям пользователей (KYC). Сессии компаний (`session_kind = \"business\"`) всегда возвращают стандартную структуру решения для бизнеса — `events`, `activity_reviews`, `blocklisted`, `cost_breakdown` и дополнительные метаданные `workflow_*`/сессии никогда не возвращаются для сессий компаний, а их массив `features` остаётся простым массивом строк. При `include=resubmissions` (как для сессий пользователей, так и для сессий компаний) ответ также содержит `resubmissions`: по одной записи на каждый запрос повторной отправки, начиная с самых старых, каждая с полями `number`, `created_at`, `previous_status`, `nodes`, `reasons`, `requested_by` и `results` (что возвращали повторно отправленные шаги до запроса, под теми же ключами и в той же структуре, что и текущие результаты). Каждый элемент `cost_breakdown` содержит `usage_type`, `price`, `details` и `created_at`: повторно отправленный шаг, выполняемый снова, тарифицируется как новый элемент.", "schema": { "type": "string", "enum": [ "events", "resubmissions", "events,resubmissions" ], "example": "events" } } ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X GET 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/decision/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.retrieve_decision(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.retrieveDecision(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.RetrieveDecision(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsRetrieveDecisionParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().retrieveDecision(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->retrieveDecision('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.retrieve_decision(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.RetrieveDecisionAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/delete/": { "delete": { "summary": "Удалить сессию верификации (KYC или KYB)", "description": "Удаляет отдельную сессию верификации типа «Проверка пользователей (KYC)» или «Верификация бизнеса (KYB)» по её `session_id`. Идентификатор сначала сопоставляется с сессиями KYC, затем с сессиями KYB, поэтому оба типа удаляются через этот единый URL.\n\n**Что удаляется:**\n- Сессия и каждая содержащаяся в ней попытка верификации, включая результаты, заменённые при повторной отправке: решение, извлечённые данные, все связанные записи функций (верификация личности, лицо, проверка живости, сравнение лиц, AML, проверки по реестрам, анализ IP и так далее), её проверки и журнал активности.\n- Все сохранённые файлы, принадлежащие сессии: фотографии лицевой и оборотной сторон документа (полные, обрезанные и варианты с размытием в целях конфиденциальности), видео захвата документа, обрезанные портретные фото, портреты и изображения подписи из NFC-чипа, эталонные изображения лица, видео проверки живости, исходные и целевые изображения сравнения лиц, документы подтверждения адреса и любые дополнительные загруженные файлы (KYC); загруженные документы компании и дополнительные файлы (KYB). Документы электронной подписи, подписанные PDF-файлы, PDF-файлы с подтверждающими материалами и изображения подписи (KYC и KYB): пути для их скачивания перестают действовать. Ранее выданные URL медиафайлов (`https:///...`) перестают открываться.\n- Данные лица сессии. Эмбеддинг лица также удаляется, если вы не решите сохранить шаблон без изображений (см. **Биометрические данные лица**).\n- Доставки webhook, всё ещё находящиеся в очереди для этой сессии, и их повторные попытки. Уже доставленные webhook не затрагиваются.\n- Для сессии Верификации бизнеса (KYB): верификации, созданные для её ключевых лиц (KYC) и её корпоративных владельцев (KYB), рекурсивно, возвращаемые в поле `deleted_child_verifications`. Верификация, на которую она лишь ссылается (например, повторно использованная существующая одобренная верификация KYC), не удаляется.\n\nСессия мгновенно исчезает из всех endpoint для чтения: `GET /v3/session/{sessionId}/decision/` возвращает `404`, а `GET /v3/sessions/` перестаёт отображать её в списке. Постоянный AML-мониторинг и мониторинг реестров KYB, запущенные удалёнными верификациями, прекращаются.\n\n**Что не затрагивается:** записи списка блокировки, созданные на основе этой сессии (по лицу или документу), **не** удаляются; управляйте ими с помощью endpoint списка блокировки. Выпущенные для сессии токены общего доступа не отзываются, однако для них больше нет данных для импорта: импорт с таким token вернёт `400` с `{\"share_token\": [\"Original session does not exist.\"]}`. Уже израсходованные кредиты **не** возвращаются. Родительская сущность пользователя или компании **не** удаляется; для их удаления используйте `POST /v3/users/delete/` или `POST /v3/businesses/delete/`. Если фото профиля пользователя было получено из этой сессии, оно удаляется вместе с ней.\n\n**Биометрические данные лица:** по умолчанию эмбеддинг лица сессии удаляется вместе с сессией (`face_retention_outcome: deleted`). Если приложение согласилось на сохранение биометрического шаблона (`face_retention_policy: retain_until_user_deleted` в `PATCH /v3/webhook/`), или если передан запрос с `retain_face_embeddings: true`, сохраняется один отдельно управляемый биометрический шаблон лица без изображений, привязанный к пользователю, связанному с сессией (`retained_with_user`), чтобы обнаружение дубликатов, Поиск по лицу и биометрическая аутентификация продолжали работать. Шаблон никогда не содержит изображение лица, медиафайлы, поля удостоверения личности, решение или идентификатор удалённой сессии; это биометрические данные, удаляемые в момент `biometric_template_expires_at` или раньше (при удалении пользователя, стирании данных в рамках конфиденциальности или явной очистке через `/v3/biometric-templates/`). Сессия без привязанного пользователя не может сохранить шаблон (`ineligible_no_vendor_user`). Отправляйте `deletion_instruction: privacy_erasure` для запросов субъектов персональных данных: это очищает все сохранённые шаблоны для этого пользователя и гарантирует, что новый шаблон сохранён не будет.\n\n**Необратимо:** удаление является окончательным, и endpoint для восстановления отсутствует. Экспортируйте всё необходимое (например, PDF-файл с решением) до вызова.\n\n**Побочные эффекты:** при удалении webhook не отправляется.\n\n**Ответ:** `200 OK` после завершения удаления с телом JSON, содержащим `face_retention_outcome`, срок действия сохранённого шаблона и, для сессии KYB, `deleted_child_verifications`. Более ранние версии этого endpoint возвращали `204 No Content`; обновите клиенты, ожидающие `204`. Сохраняйте ваш `instruction_id` в собственном журнале удаления данных.\n\n**Идемпотентность:** операция не идемпотентна на уровне HTTP: первый вызов возвращает `200`; повторный вызов возвращает `404`, так как сессия больше не существует. После ошибки `503` сессия остаётся на месте; повторите тот же запрос, чтобы завершить её удаление.\n\n**Аутентификация:** передавайте API-ключ вашего приложения в заголовке `x-api-key`; сессия должна принадлежать этому приложению. Пользовательские токены доступа Консоли (`Authorization: Bearer ...`) также могут вызывать этот endpoint при наличии разрешения `delete:sessions`. Ошибки аутентификации и разрешений возвращают `403`; этот API никогда не возвращает `401`.\n\n**Лимит запросов:** общий лимит на запись 300 запросов/мин на API-ключ для всех endpoint POST/PATCH/DELETE; при его превышении возвращается `429`.\n\nДля массового удаления сессий KYC по их числовому `session_number` используйте вместо этого `POST /v3/sessions/delete/`.\n\n**Поданные регуляторные отчёты:** если выбранные данные входят в окончательно оформленный регуляторный отчёт, весь запрос отклоняется с ошибкой `409` и ничего не удаляется. В теле ответа возвращается `code: in_filed_report` с указанием каждого отчёта через `uuid`, `report_number`, `report_type` и `case_uuid`. Удалите отчёты, затем повторите запрос.", "operationId": "delete_v3_session_by_id", "x-didit-sdk": { "resource": "sessions", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID (`session_id`) удаляемой сессии Проверки пользователей (KYC) или Верификации бизнеса (KYB), возвращённый при создании сессии. Должен быть каноническим UUID с дефисами — значение, не являющееся UUID, не совпадает с маршрутом и возвращает `404`.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } } ], "responses": { "200": { "description": "Сессия удалена. В теле ответа сообщается, что произошло с биометрическими данными лица из сессии, а для сессии KYB, сколько созданных ею верификаций было удалено вместе с ней.", "content": { "application/json": { "schema": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "Удалённая сессия." }, "session_number": { "type": "integer", "nullable": true, "description": "Номер удалённой сессии." }, "face_retention_outcome": { "type": "string", "enum": [ "retained_with_user", "deleted", "none", "ineligible_no_vendor_user" ], "description": "Что произошло с лицевыми биометрическими данными сессии. `deleted`: эмбеддинг лица был удалён вместе с сессией (по умолчанию). `retained_with_user`: сессия удалена, а один биометрический шаблон без изображения остаётся привязанным к пользователю; см. `biometric_template_uuid`. `none`: в сессии не было эмбеддинга лица (например, сессия KYB или сессия KYC без селфи для проверки живости). `ineligible_no_vendor_user`: было запрошено сохранение, но у сессии нет связанного пользователя, поэтому эмбеддинг был удалён вместе с сессией. Сбой биометрического хранилища никогда не возвращается через это поле на данном endpoint: возвращается `503`, и сессия не удаляется." }, "biometric_template_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "Идентификатор сохранённого биометрического шаблона, если `face_retention_outcome` имеет значение `retained_with_user`; в противном случае `null`. Управляется через `/v3/biometric-templates/{template_uuid}/`." }, "biometric_template_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Время удаления сохранённого биометрического шаблона, когда `face_retention_outcome` имеет значение `retained_with_user`; `null`, если шаблон не сохраняется." }, "deleted_child_verifications": { "type": "integer", "description": "Для сессии Верификации бизнеса (KYB): сколько созданных ею верификаций (KYC-сессии её ключевых лиц и KYB-сессии её корпоративных владельцев рекурсивно) было удалено вместе с ней. Всегда `0` для KYC-сессии." } } }, "examples": { "Deleted (default)": { "value": { "session_id": "4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02", "session_number": 1024, "face_retention_outcome": "deleted", "biometric_template_uuid": null, "biometric_template_expires_at": null, "deleted_child_verifications": 0 } }, "Retained with User": { "value": { "session_id": "4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02", "session_number": 1024, "face_retention_outcome": "retained_with_user", "biometric_template_uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "biometric_template_expires_at": "2027-10-09T10:15:00Z", "deleted_child_verifications": 0 } }, "Ineligible: no User": { "summary": "Запрошено хранение для сессии, созданной без vendor_data", "value": { "session_id": "7a1e9c2d-5f4b-4c3a-8e2d-1b0a9f8e7d6c", "session_number": 1031, "face_retention_outcome": "ineligible_no_vendor_user", "biometric_template_uuid": null, "biometric_template_expires_at": null, "deleted_child_verifications": 0 } }, "KYB session": { "value": { "session_id": "0f3c9b7e-2d1a-4e5f-8c6b-7a9d8e1f2c3b", "session_number": 88, "face_retention_outcome": "none", "biometric_template_uuid": null, "biometric_template_expires_at": null, "deleted_child_verifications": 3 }, "summary": "Верификация бизнеса, удалённая вместе с тремя верификациями, созданными для её ключевых лиц" } } } } }, "400": { "description": "Ошибка валидации — ничего не удалено.", "content": { "application/json": { "examples": { "Privacy erasure cannot retain": { "value": { "retain_face_embeddings": [ "Privacy erasure cannot retain biometric templates." ] } }, "No finite retention duration": { "summary": "Запрошено хранение без указания face_retention_days в запросе или приложении", "value": { "detail": "A finite biometric-template retention duration is required." } } } } } }, "403": { "description": "Ошибка аутентификации или разрешения. Отсутствующий ключ также возвращает `403`; неверный, отозванный или истекший ключ возвращает `401`. Исключение: если `sessionId` не соответствует активной сессии, предварительная проверка владельца возвращает `404` раньше, даже при отсутствии или недействительности учетных данных.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid API key": { "summary": "Заголовок x-api-key отсутствует, либо ключ недействителен", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Insufficient permission": { "summary": "token пользователя без разрешения delete:sessions или учётные данные приложения, которому не принадлежит эта сессия", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Активной сессии KYC или KYB с таким `session_id` не существует — id неизвестен или сессия уже была удалена (повторное успешное удаление приводит сюда).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Not Found": { "summary": "Неизвестная или уже удалённая сессия", "value": { "detail": "Not found." } } } } } }, "429": { "description": "Превышен общий лимит запросов на запись (300 запросов POST/PATCH/DELETE в минуту на один API-ключ). Проверьте заголовок `Retry-After` и заголовки ответа `X-RateLimit-*` перед повторной попыткой.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Исчерпан бюджет на запись", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } }, "503": { "description": "Удаление не удалось завершить, так как служба хранения, биометрическое хранилище или поставщик мониторинга были недоступны. Сессия осталась на месте; повторяйте тот же запрос, пока он не вернёт `200`. Некоторые из сохранённых файлов или эмбеддинг лица уже могут быть удалены, поэтому не полагайтесь на них после `503`. Повторные попытки сходятся к единому шаблону.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Session deletion unavailable": { "summary": "Сервис хранения или поставщик мониторинга был недоступен", "value": { "detail": "The session could not be deleted because a storage service or a monitoring provider is unavailable. The session is still in place; repeat the request to finish deleting it." } }, "Biometric store unavailable": { "summary": "Хранилище биометрии было недоступно при сохранении или удалении шаблона", "value": { "detail": "The biometric-template operation could not finish because an external store is unavailable. The operation is retryable." } } } } } }, "409": { "description": "Сессия является частью завершенного регуляторного отчета. Ничего не удалено.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InFiledReportError" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl (default policy)", "source": "curl -X DELETE \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/delete/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "curl", "label": "curl (retain template)", "source": "curl -X DELETE \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/delete/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"retain_face_embeddings\": true, \"face_retention_days\": 365}'" }, { "lang": "curl", "label": "curl (privacy erasure)", "source": "curl -X DELETE \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/delete/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"deletion_instruction\": \"privacy_erasure\", \"instruction_id\": \"dsar-2026-0142\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.delete(\n \"11111111-2222-3333-4444-555555555555\",\n retain_face_embeddings=True,\n face_retention_days=365,\n instruction_id=\"post-approval-cleanup-2026-08\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.delete(\"11111111-2222-3333-4444-555555555555\", {\n retain_face_embeddings: true,\n face_retention_days: 365,\n instruction_id: \"post-approval-cleanup-2026-08\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Delete(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsDeleteParams{\n\tRetainFaceEmbeddings: didit.Bool(true),\n\tFaceRetentionDays: didit.Int(365),\n\tInstructionID: didit.String(\"post-approval-cleanup-2026-08\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsDeleteParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().delete(\"11111111-2222-3333-4444-555555555555\", SessionsDeleteParams.builder()\n .retainFaceEmbeddings(true)\n .faceRetentionDays(365L)\n .instructionId(\"post-approval-cleanup-2026-08\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->delete('11111111-2222-3333-4444-555555555555', [\n 'retain_face_embeddings' => true,\n 'face_retention_days' => 365,\n 'instruction_id' => 'post-approval-cleanup-2026-08',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.delete(\n \"11111111-2222-3333-4444-555555555555\",\n retain_face_embeddings: true,\n face_retention_days: 365,\n instruction_id: \"post-approval-cleanup-2026-08\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.DeleteAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsDeleteParams\n{\n RetainFaceEmbeddings = true,\n FaceRetentionDays = 365,\n InstructionId = \"post-approval-cleanup-2026-08\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": false, "description": "Необязательно. Полностью опустите тело запроса, чтобы следовать политике хранения приложения с выполнением удаления в рамках операционной деятельности.", "content": { "application/json": { "schema": { "type": "object", "properties": { "retain_face_embeddings": { "type": "boolean", "nullable": true, "description": "Переопределить `face_retention_policy` приложения для этого удаления. При значении `true` после удаления сессии сохраняется один биометрический шаблон лица без изображения, привязанный к пользователю сессии; при `false` эмбеддинг лица удаляется вместе с сессией; опустите или укажите `null`, чтобы использовать политику приложения. Игнорируется для KYB-сессий и сессий без эмбеддинга лица.", "example": true }, "face_retention_days": { "type": "integer", "minimum": 1, "maximum": 3650, "description": "Ограниченный срок хранения в днях для сохраняемого шаблона. Обязателен при сохранении шаблона, если в приложении ещё не задан `face_retention_days`. Значение `expires_at` шаблона является наименьшим из этого срока, общего окна хранения данных приложения и `face_retention_deadline`.", "example": 365 }, "face_retention_deadline": { "type": "string", "format": "date-time", "description": "Необязательный точный срок действия сохранённого шаблона. Должен быть в будущем.", "example": "2027-08-28T00:00:00Z" }, "deletion_instruction": { "type": "string", "enum": [ "operational_session_delete", "privacy_erasure" ], "default": "operational_session_delete", "description": "Класс передаваемой инструкции. `operational_session_delete` удаляет сессию и сохраняет шаблон только тогда, когда это предусмотрено политикой или параметром `retain_face_embeddings`. `privacy_erasure` полностью удаляет каждый сохранённый биометрический шаблон, привязанный к пользователю сессии, перед удалением самой сессии, не может быть переопределён политикой приложения и не может сочетаться с `retain_face_embeddings: true` (`400`).", "example": "operational_session_delete" }, "instruction_id": { "type": "string", "maxLength": 255, "description": "Ваш постоянный идентификатор для этой инструкции по удалению (например, id тикета на удаление). Фиксируется в журнале аудита и на любом сохраненном шаблоне. Генерируется Didit, если опущен.", "example": "dsar-2026-0142" } } }, "examples": { "Retain a biometric template": { "summary": "Удалить сессию, сохранив шаблон без изображений на 365 дней", "value": { "retain_face_embeddings": true, "face_retention_days": 365, "instruction_id": "post-approval-cleanup-2026-08" } }, "Force deletion on an opted-in application": { "summary": "Удалить эмбеддинг лица независимо от политики приложения", "value": { "retain_face_embeddings": false } }, "Privacy erasure": { "summary": "Запрос субъекта данных: удалить сессию и стереть все сохранённые шаблоны для этого человека", "value": { "deletion_instruction": "privacy_erasure", "instruction_id": "dsar-2026-0142" } } } } } } } }, "/v3/session/{sessionId}/generate-pdf/": { "get": { "summary": "Скачать PDF-отчёт по сессии верификации", "description": "Сформировать и скачать готовый для комплаенса PDF-отчёт по завершённой сессии верификации. Один и тот же путь обслуживает сессии проверки пользователей (KYC) и верификации бизнеса (KYB) — сервер сопоставляет `sessionId` с обоими типами сессий и выбирает подходящий шаблон отчёта.\n\n**Подходящие статусы.** Сессия уже должна иметь финальный статус или статус, доступный для проверки:\n\n- KYC-сессии: `Approved`, `Declined`, `In Review` или `Kyc Expired`.\n- KYB-сессии: `Approved`, `Declined` или `In Review`.\n\nЛюбой другой статус (`Not Started`, `In Progress`, `Expired`, `Abandoned`, …) возвращает `403` с поясняющей строкой `detail` — см. ответ `403` ниже.\n\n**Что содержит отчёт.** PDF отображает состояние сессии в консоли на момент запроса:\n\n- **KYC** — сводный статус сессии, список предупреждений и по одному разделу для каждой выполненной функции: Верификация личности (изображения документов плюс извлечённые поля), NFC, Проверка живости, Сравнение лиц, Проверка электронной почты, Проверка телефона, Подтверждение адреса, ответы на анкеты, Проверка по базам данных, AML-скрининг и Анализ IP — за которыми следуют теги сессии, действия по проверке в консоли (комментарии и изменения статуса) и хронология событий сессии.\n- **KYB** — проверки по реестрам (данные компании), AML-скрининги, верификации документов компании, проверки ключевых лиц, ответы на анкеты, проверки телефона/электронной почты, анализы IP и хронология событий сессии, за которыми следуют теги и действия по проверке.\n\n**Брендинг.** Если в вашем приложении настроена кастомизация White label, отчёт формируется с вашим логотипом и ссылками на URL вашей политики конфиденциальности; в противном случае он содержит брендинг Didit. Отчёты формируются на английском языке — параметр выбора языка отсутствует.\n\n**Без кэширования.** Каждый вызов заново формирует PDF на основе текущих данных сессии, поэтому отчёт, сгенерированный после ручной проверки, отражает решение проверяющего. Два вызова для одной и той же сессии могут создать побайтово различающиеся файлы — архивируйте скачанный файл, если вам нужна неизменяемая копия.\n\n**Задержка.** При формировании отчёта скачиваются все сохранённые изображения (стороны документов, селфи, дополнительные файлы) перед компоновкой PDF, поэтому сессии с большим объёмом медиафайлов могут обрабатываться несколько секунд. Используйте увеличенный клиентский таймаут чтения (рекомендуется 60 с) и сохраняйте тело ответа потоком на диск.\n\n**Завершающий слеш.** Канонический маршрут заканчивается завершающим слешем (`…/generate-pdf/`). Запрос без него обрабатывается напрямую с тем же ответом — перенаправления `301` нет, поэтому клиенту не нужно переходить по редиректам, а `curl` не требует флага `-L`. Используйте URL со слешем, как показано в примерах.\n\nЕсли вам нужны исходные данные в формате JSON вместо сформированного отчёта, используйте `GET /v3/session/{sessionId}/decision/`. Чтобы получить все сессии одного пользователя, доступные для отчёта, в одном документе, используйте `GET /v3/users/{vendor_data}/generate-pdf/`.", "operationId": "get_v3_session_generate_pdf", "x-didit-sdk": { "resource": "sessions", "method": "generate_pdf", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID сессии Проверки пользователей (KYC) или Верификации бизнеса (KYB) для отображения — `session_id`, возвращаемый методом `POST /v3/session/`. Один и тот же путь подходит для обоих типов сессий; используйте имя файла в заголовке `Content-Disposition` ответа, чтобы определить полученный тип отчёта.\n\n**Должен быть корректно сформированным UUID в нижнем регистре.** Маршрут сопоставляется только с валидными UUID, поэтому некорректное значение отклоняется маршрутизатором URL ещё до выполнения кода приложения, и ответом будет **HTML**-страница `404`, а не оболочка JSON `{\"detail\": ...}`, показанная ниже. Конвертер UUID маршрута поддерживает только каноническую форму в нижнем регистре — UUID с шестнадцатеричными символами в верхнем регистре отклоняются с HTML-ошибкой 404.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } } ], "responses": { "200": { "description": "Сформированный PDF-документ, возвращаемый напрямую как бинарные данные `application/pdf` — без обёртки JSON и без перенаправления по URL для скачивания. Тело ответа начинается с сигнатуры `%PDF` (PDF 1.7). Сохраните его в файл `.pdf` или передайте потоком вызывающей стороне.", "headers": { "Content-Disposition": { "description": "`attachment; filename=session_{sessionId}.pdf` для KYC-сессий, `attachment; filename=business_{sessionId}.pdf` для KYB-сессий — префикс указывает, какой шаблон отчёта был сформирован.", "schema": { "type": "string", "example": "attachment; filename=session_11111111-2222-3333-4444-555555555555.pdf" } }, "Content-Length": { "description": "Общий размер PDF в байтах; тело не разбивается на фрагменты.", "schema": { "type": "integer", "example": 25191 } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Ошибка аутентификации, авторизации или статуса сессии. Отсутствующий ключ возвращает `403`; неверный, отозванный или истекший ключ возвращает `401`. Различайте варианты ошибки по строке `detail`:\n\n- `\"Authentication credentials were not provided or are invalid.\"` — отсутствует заголовок `x-api-key` (и нет токена `Authorization: Bearer`), либо предоставленные учетные данные не прошли проверку (отозваны, истекли или некорректны).\n- `\"You do not have permission to perform this action.\"` — учетные данные действительны, но не позволяют прочитать эту сессию: Bearer-токен пользователя консоли не имеет разрешения `read:sessions` или не имеет доступа к приложению-владельцу, либо API-ключ принадлежит организации, отличной от организации сессии.\n- `\"You can only generate a PDF for sessions in review, declined, approved or kyc expired\"` — сессия KYC существует, но ещё не находится в подходящем статусе (например, `Not Started` или `In Progress`). Дождитесь webhook `status.updated`, прежде чем запрашивать отчёт.\n- `\"You can only generate a PDF for sessions in review, declined or approved\"` — то же условие для сессий KYB.\n\nОбратите внимание: для полностью неизвестного `sessionId` endpoint сначала определяет приложение-владельца до проверки учетных данных, поэтому отсутствующая сессия возвращает `404`, даже если учетные данные отсутствуют или недействительны.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "You can only generate a PDF for sessions in review, declined, approved or kyc expired" } } }, "examples": { "Missing or invalid credentials": { "summary": "Заголовок x-api-key отсутствует, либо ключ не прошёл интроспекцию", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Insufficient permissions": { "summary": "Действительные учетные данные без разрешения read:sessions или доступа к приложению-владельцу", "value": { "detail": "You do not have permission to perform this action." } }, "KYC session not finished": { "summary": "KYC-сессия всё ещё со статусом Not Started / In Progress", "value": { "detail": "You can only generate a PDF for sessions in review, declined, approved or kyc expired" } }, "KYB session not finished": { "summary": "KYB-сессия всё ещё со статусом Not Started / In Progress", "value": { "detail": "You can only generate a PDF for sessions in review, declined or approved" } } } } } }, "404": { "description": "Активной сессии с таким `sessionId` не существует — она никогда не создавалась или была удалена. Определение владельца происходит до проверки учетных данных, поэтому этот `404` возвращается даже для неаутентифицированных запросов. В зависимости от того, какой поиск не дал результатов, строка `detail` содержит `\"Not found.\"` (обычный случай) или `\"Session not found.\"`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "Not found." } } }, "examples": { "Unknown session": { "summary": "sessionId не соответствует ни одной сессии KYC или KYB", "value": { "detail": "Not found." } }, "Recently deleted session": { "summary": "Сессия была удалена между запросами", "value": { "detail": "Session not found." } } } } } }, "429": { "description": "Превышен лимит запросов. Для генерации PDF действует выделенный лимит **50 запросов в минуту на учетные данные** (API-ключ, Bearer-токен или IP-адрес источника при неаутентифицированных запросах) в дополнение к глобальному лимиту GET-запросов в 600/мин. Подождите указанное в `Retry-After` количество секунд (оно также отражено в заголовках `X-RateLimit-*`), затем повторите попытку. Отчёты не кэшируются на стороне сервера, поэтому скачивайте каждый отчёт один раз и сохраняйте файл вместо повторных запросов.", "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой запроса.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Максимальное количество генераций PDF, разрешённое в текущем окне (50).", "schema": { "type": "integer", "example": 50 } }, "X-RateLimit-Remaining": { "description": "Количество оставшихся запросов в текущем окне.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Unix-время (в секундах), когда сбрасывается текущее окно.", "schema": { "type": "integer", "example": 1750000000 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное объяснение нарушения лимита запросов.", "example": "Session PDF generation rate limit exceeded. You can make up to 50 requests per minute." } } }, "examples": { "Throttled": { "summary": "Более 50 генераций PDF за одну минуту с одними и теми же учетными данными", "value": { "detail": "Session PDF generation rate limit exceeded. You can make up to 50 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --fail \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/generate-pdf/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n --output report.pdf" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\ncontent = client.sessions.generate_pdf(\n \"11111111-2222-3333-4444-555555555555\",\n)\nwith open(\"download.pdf\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst content = await didit.sessions.generatePdf(\"11111111-2222-3333-4444-555555555555\");\nawait writeFile(\"download.pdf\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresp, err := client.Sessions.GeneratePDF(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.pdf\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.sessions().generatePdf(\"11111111-2222-3333-4444-555555555555\")\n .writeTo(Path.of(\"download.pdf\"));" }, { "lang": "php", "label": "PHP", "source": "sessions->generatePdf('11111111-2222-3333-4444-555555555555');\n$content->saveTo('download.pdf');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ncontent = didit.sessions.generate_pdf(\"11111111-2222-3333-4444-555555555555\")\nFile.binwrite(\"download.pdf\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar content = await client.Sessions.GeneratePdfAsync(\"11111111-2222-3333-4444-555555555555\");\nawait content.SaveToAsync(\"download.pdf\");" } ] } }, "/v3/session/{sessionId}/sandbox/arm/": { "post": { "summary": "Подготовить сценарий песочницы для сессии", "description": "Сохранить сценарий песочницы для сессии со статусом `Not Started` и применить содержащиеся в нем магические значения (email, телефон или поля `expected_details`) к сессии, чтобы мок-провайдеры воспроизвели результат сценария при запуске процесса. Этот endpoint вызывается селектором сценариев в размещенном интерфейсе верификации Didit перед началом процесса, когда тестировщик выбирает исход перед началом сбора данных. Создайте собственный селектор на его основе или вызывайте его напрямую из тестового стенда песочницы.\n\nВыполняйте аутентификацию с помощью собственного `Session-Token` сессии (возвращается в поле `session_token` методом [Создать сессию](/ru/sessions-api/create-session)), а не `x-api-key` вашего приложения: этот endpoint предназначен для вызова с клиента, а не из вашего бэкенда. Сценарий принимается только в том случае, если `status` равен `Not Started`. Повторный вызов при статусе `Not Started` повторно подготавливает сессию: он подставляет магические значения нового сценария и удаляет только те значения, которые были записаны *предыдущим* сценарием, поэтому любые данные, введенные пользователем вручную (email, имя и т. д.), сохраняются при повторной подготовке. Подготовка сессии, статус которой изменился с `Not Started`, или сессии, принадлежащей продакшн-приложению (не песочнице), отклоняется.\n\nПолный каталог сценариев и два других способа задать результат см. в разделе [Песочница и тестовые данные](/ru/integration/sandbox-testing): параметр `sandbox_scenario` при создании сессии и прямой ввод магических значений.", "operationId": "post_v3_session_sandbox_arm", "x-didit-sdk": { "resource": "sessions", "method": "arm_sandbox", "auth": "device_token", "server": false }, "tags": [ "Sessions" ], "security": [ { "SessionTokenAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID сессии верификации в песочнице для активации. Должен совпадать с сессией, закодированной в Session-Token, используемом для аутентификации.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "scenario" ], "properties": { "scenario": { "type": "string", "description": "Идентификатор сценария для активации. См. каталог по GET /v1/sandbox/scenarios/ или таблицу сценариев в разделе [Песочница и тестовые данные](/ru/integration/sandbox-testing).", "example": "decline_document_expired" } } }, "examples": { "Arm": { "summary": "Подготовить сценарий с совпадением по AML PEP", "value": { "scenario": "decline_aml_hit" } } } } } }, "responses": { "200": { "description": "Сценарий активирован. Его магические значения теперь добавлены в сессию. Поле `status` отражает текущий статус сессии, который этот вызов никогда не меняет: при успешном выполнении он всегда `Not Started`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid" }, "scenario": { "type": "string", "description": "Идентификатор (slug) активированного сценария (повторяет запрос)." }, "status": { "type": "string", "example": "Not Started" } } }, "examples": { "Armed": { "summary": "Сценарий активирован для сессии со статусом Not Started", "value": { "session_id": "11111111-2222-3333-4444-555555555555", "scenario": "decline_aml_hit", "status": "Not Started" } } } } } }, "400": { "description": "Ошибка валидации: неизвестный слаг сценария или сессия уже перешла дальше статуса `Not Started`.", "content": { "application/json": { "examples": { "Unknown Scenario": { "summary": "scenario отсутствует в каталоге", "value": { "scenario": [ "Unknown sandbox scenario: 'not-a-real-scenario'." ] } }, "Already Started": { "summary": "Сессия перешла за пределы статуса Not Started", "value": [ "Scenario can only be armed before the verification starts." ] } } } } }, "404": { "description": "Session-Token не соответствует этому `session_id`, либо сессия принадлежит продакшн-приложению (не песочнице).", "content": { "application/json": { "examples": { "Not Found": { "summary": "Активная сессия или несоответствие session_id / токена", "value": { "detail": "Not found." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/sandbox/arm/ \\\n -H 'Session-Token: YOUR_SESSION_TOKEN' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"scenario\": \"decline_aml_hit\"\n }'" }, { "lang": "python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/sandbox/arm/\",\n headers={\n \"Session-Token\": \"YOUR_SESSION_TOKEN\",\n \"Content-Type\": \"application/json\",\n },\n json={\"scenario\": \"decline_aml_hit\"},\n)\nresponse.raise_for_status()\nprint(response.json()) # {'session_id': '...', 'scenario': 'decline_aml_hit', 'status': 'Not Started'}" }, { "lang": "javascript", "label": "JavaScript", "source": "const response = await fetch(\n 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/sandbox/arm/',\n {\n method: 'POST',\n headers: {\n 'Session-Token': sessionToken,\n 'Content-Type': 'application/json',\n },\n body: JSON.stringify({ scenario: 'decline_aml_hit' }),\n },\n);\nif (!response.ok) throw new Error(`HTTP ${response.status}`);\nconst { session_id, scenario, status } = await response.json();" } ] } }, "/v3/session/{sessionId}/update-status/": { "patch": { "summary": "Одобрить, отклонить или запросить повторную отправку для сессии верификации", "description": "Вручную переопределите итоговое решение по сессии верификации KYC или KYB. Установите для `new_status` значение `Approved` или `Declined`, чтобы зафиксировать ручное решение, либо `Resubmitted`, чтобы очистить определённые шаги верификации и позволить пользователю пройти их заново по тому же URL верификации. Этот endpoint принимает ID сессий как пользователей (KYC), так и компаний (KYB).\n\nВызывайте его, когда сессия перешла в состояние, доступное для проверки: текущий статус должен быть `Approved`, `Declined`, `In Review`, `Kyc Expired`, `Abandoned` или `Resubmitted`. Сессии со статусами `Not Started`, `In Progress` или `Awaiting User`, а также завершённые со статусом `Expired`, возвращают ошибку `400`. Для вашего API-ключа требуется разрешение `write:sessions` (для API-ключа с ограниченной областью действия нужен доступ на запись к решениям). Проверка доступности состояния выполняется до валидации тела запроса, поэтому для сессии в неподходящем статусе возвращается ошибка `Wrong Current Status`, даже если payload также недействителен.\n\nДля `Resubmitted` передайте `nodes_to_resubmit`, чтобы выбрать, какие шаги сценария пользователь должен пройти заново, или опустите этот параметр, чтобы автоматически выбрать существующие попытки выполнения функций в статусе, доступном для повторной отправки (`Declined`, `In Review`, `Not Finished`, `Expired`). Функции, для которых ещё не предпринималась попытка, автоматически не выбираются: укажите их в `nodes_to_resubmit` явно, иначе запрос вернёт ошибку `400`, если ни одна зафиксированная попытка не требует повторной отправки. Предыдущие результаты выбранных шагов переносятся в историю повторной отправки (возвращается методом Get Decision с параметром `include=resubmissions`), порядок шагов перестраивается в соответствии с графом сценария, окно срока действия сессии перезапускается, а исходная ссылка на верификацию снова становится активной. Шаги, выполняемые исключительно на стороне бэкенда (`AML`, `DATABASE_VALIDATION`, `IP_ANALYSIS`) в начале списка, запускаются немедленно без участия пользователя; если все повторно отправленные шаги являются чисто бэкендовыми, сессия повторно финализируется в рамках того же запроса. Шаги `KYB_REGISTRY` и `KYB_KEY_PEOPLE` нельзя отправить на повторное прохождение напрямую: вместо этого отправьте повторно соответствующие дочерние сессии KYC, и родительская сессия компании пересчитается автоматически.\n\nКаждый вызов, изменяющий статус, отправляет [webhook](/ru/integration/webhooks) `status.updated` после фиксации изменения и добавляет запись об активности (с указанием автора действия и вашего `comment`) в список `reviews` сессии, который виден в [Get Decision](#get-/v3/session/-sessionId-/decision/) и в ленте активности в панели управления. Агрегированные данные профиля пользователя, привязанные к `vendor_data` сессии, также обновляются. Отклонение отключает постоянный AML-мониторинг для сессии; повторное одобрение снова включает его (из статусов `Resubmitted`, `Declined` или `Kyc Expired`), если в сценарии активирован мониторинг. Одобрение или отклонение дочерней сессии KYC, относящейся к проверке ключевых лиц KYB, приводит к пересчёту статуса родительской сессии компании. Установите `send_email: true` (вместе с `email_address`), чтобы уведомить пользователя: уведомление о статусе для `Approved`/`Declined` или электронное письмо о повторной отправке со ссылкой на верификацию и причинами по каждому шагу для `Resubmitted`. Чтобы предварительно проверить письмо, используйте предварительный просмотр с помощью [Preview Decision Email](/ru/sessions-api/preview-decision-email) (`Approved`, `Declined`) или [Preview Resubmission Email](/ru/sessions-api/preview-resubmission) (`Resubmitted`) и передайте полученный `preview_token` в качестве `email_preview_token`: в этом случае при обновлении будет отправлено именно просмотренное письмо либо вернётся ошибка `409` до внесения каких-либо изменений, если письмо или сессия изменились с момента предварительного просмотра или если квитанция старше 15 минут.\n\nПовторная установка статуса `Approved` или `Declined` для сессии, у которой уже установлен этот статус, ничего не меняет и возвращает ответ `200`: без отправки webhook, без добавления записи об активности и без отправки электронного письма. Повторная установка статуса `Resubmitted` возвращает ошибку `400` (`The new status is the same as the current status.`). Отсутствие или недействительность учетных данных, а также отсутствие необходимых разрешений возвращают `403`; истёкший API-ключ с ограниченной областью действия возвращает `401`.", "operationId": "patch_v3_session_update_status", "x-didit-sdk": { "resource": "sessions", "method": "update_status", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID сессии верификации для обновления. Принимает ID сессий как пользователей (KYC), так и компаний (KYB) — сервис сопоставляет ID для обоих типов сессий.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "new_status" ], "properties": { "new_status": { "type": "string", "description": "Целевой статус. `Approved` и `Declined` фиксируют окончательное ручное решение (каждое из них также может отменить другое). `Resubmitted` очищает выбранные шаги и возвращает сессию пользователю. Любое другое значение возвращает `400`.", "enum": [ "Approved", "Declined", "Resubmitted" ], "example": "Approved" }, "comment": { "type": "string", "description": "Причина изменения в виде произвольного текста, сохраняемая в журнале проверок сессии и возвращаемая в массиве `reviews` ответа метода [Get Decision](#get-/v3/session/-sessionId-/decision/). Например, `Duplicated user`.", "example": "All checks passed manual review" }, "nodes_to_resubmit": { "type": "array", "description": "Шаги сценария, которые пользователь должен повторить. Обрабатываются только тогда, когда `new_status` имеет значение `Resubmitted`. Для `Approved`/`Declined` записи всё равно проходят валидацию по схеме (недопустимое значение `feature` возвращает `400`), но корректные по схеме записи семантически игнорируются. Если параметр опущен, сервер автоматически выбирает существующие попытки OCR, Проверки живости, Сравнения лиц, POA, Проверки телефона, Проверки электронной почты, AML, Проверки по базам данных и Анкет со статусом `Declined`, `In Review`, `Not Finished` или `Expired` (попытки NFC, анализа IP, оценки возраста, поиска по лицу и документов KYB никогда не выбираются автоматически; попытки проверки лица, не относящиеся к сравнению лиц, выбираются как `LIVENESS`) — функции, которые пользователь ни разу не пытался выполнить (нет записанных попыток), НЕ выбираются, поэтому сессия с нулём попыток возвращает `400` (\"No features found that need resubmission\"), даже если ничего не было одобрено; в этом случае передайте `nodes_to_resubmit` явно. Шаги выполняются в порядке графа сценария независимо от порядка, в котором вы их передали. `KYB_REGISTRY`, `KYB_KEY_PEOPLE` и псевдоним `KYB` отклоняются с кодом `400` — эти родительские проверки пересчитываются из их дочерних KYC-сессий.", "items": { "type": "object", "required": [ "node_id", "feature" ], "properties": { "node_id": { "type": "string", "description": "Идентификатор узла в том виде, в каком он указан в определении сценария сессии (например, `feature_ocr`, `feature_liveness`).", "example": "feature_ocr" }, "feature": { "type": "string", "description": "Тип функции узла. Алиасы `ID_VERIFICATION`, `POA`, `PHONE` и `EMAIL` нормализуются на стороне сервера в `OCR`, `PROOF_OF_ADDRESS`, `PHONE_VERIFICATION` и `EMAIL_VERIFICATION`. `KYB_REGISTRY`, `KYB_KEY_PEOPLE` и `KYB` проходят валидацию схемы, но всегда отклоняются с бизнес-ошибкой `400`, показанной в примерах.", "enum": [ "OCR", "OCR_BACK", "NFC", "AML", "FACE", "LIVENESS", "FACE_MATCH", "IP_ANALYSIS", "AGE_ESTIMATION", "PROOF_OF_ADDRESS", "PHONE_VERIFICATION", "EMAIL_VERIFICATION", "FACE_SEARCH", "DATABASE_VALIDATION", "QUESTIONNAIRE", "DOCUMENT_AI", "KYB_DOCUMENTS", "ID_VERIFICATION", "POA", "PHONE", "EMAIL", "KYB_REGISTRY", "KYB_KEY_PEOPLE", "KYB", "GEOLOCATION" ], "example": "OCR" } } } }, "send_email": { "type": "boolean", "description": "Отправлять ли пользователю электронное письмо об изменении. Требует `email_address`. При `Approved`/`Declined` пользователь получает уведомление о статусе; при `Resubmitted` письмо содержит ссылку на верификацию и причины повторной отправки для каждого шага.", "default": false, "example": false }, "email_address": { "type": "string", "format": "email", "description": "Получатель уведомления по электронной почте. **Обязательно, если `send_email` имеет значение `true`** — если опустить, возвращается `400`.", "example": "user@example.com" }, "email_language": { "type": "string", "description": "Язык для письма с уведомлением. На уровне схемы принимается любая строка; для неподдерживаемых кодов без уведомления используется английский (`en`).", "default": "en", "example": "en" }, "email_preview_token": { "type": "string", "writeOnly": true, "minLength": 1, "maxLength": 512, "description": "Необязательное подтверждение из запроса [Предпросмотр email с решением](/ru/sessions-api/preview-decision-email) (для `Approved` и `Declined`) или [Предпросмотр email для повторной отправки](/ru/sessions-api/preview-resubmission) (для `Resubmitted`): его `preview_token`. Действительно только при `send_email: true`; без этого запрос возвращает `400`. Получатель, язык, статус сессии, отправитель и email (а для повторной отправки также выбранные шаги) должны по-прежнему совпадать с предпросмотром, а срок действия подтверждения истекает через 15 минут. В противном случае запрос возвращает `409` до изменения сессии или отправки email. Существующие интеграции могут опустить это поле." } } }, "examples": { "Approve Session": { "summary": "Одобрить сессию после ручной проверки", "value": { "new_status": "Approved", "comment": "All checks passed manual review" } }, "Decline Session": { "summary": "Отклонить сессию", "value": { "new_status": "Declined", "comment": "Suspected fraud" } }, "Resubmit Specific Steps": { "summary": "Запросить повторную отправку выбранных шагов с отправкой письма", "value": { "new_status": "Resubmitted", "nodes_to_resubmit": [ { "node_id": "feature_ocr", "feature": "OCR" }, { "node_id": "feature_liveness", "feature": "LIVENESS" } ], "send_email": true, "email_address": "user@example.com", "email_language": "en" } }, "Resubmit Auto-select": { "summary": "Запросить повторную отправку (автовыбор неодобренных шагов)", "value": { "new_status": "Resubmitted" } }, "Approve With Previewed Email": { "summary": "Одобрить и отправить электронное письмо, полученное из предварительного просмотра письма с решением", "value": { "new_status": "Approved", "send_email": true, "email_address": "person@example.com", "email_language": "en", "email_preview_token": "eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000" } } } } } }, "responses": { "200": { "description": "Статус обновлен. Ответ содержит только `session_id`; получите обновленную сессию через [Get Decision](#get-/v3/session/-sessionId-/decision/). Webhook `status.updated` срабатывает после фиксации изменения. Повторная отправка `Approved` или `Declined` возвращает то же тело ответа и ничего не меняет.", "content": { "application/json": { "schema": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "UUID обновлённой сессии." } } }, "examples": { "Updated": { "summary": "Возвращается одинаково для Approved, Declined и Resubmitted", "value": { "session_id": "3472fb7c-8f7c-4d1a-9cf4-cf3d74ce1a60" } } } } } }, "400": { "description": "Ошибка валидации. Ошибки полей возвращаются в виде `{\"\": [\"\"]}` (в некоторых случаях отклонения по бизнес-правилам вместо этого используется строковое значение: `{\"nodes_to_resubmit\": \"\"}`), ошибки перехода между состояниями возвращаются в виде `{\"detail\": \"\"}`, а ошибка совпадения статуса в виде простого JSON-массива.", "content": { "application/json": { "examples": { "Wrong Current Status": { "summary": "Сессия не находится в состоянии, доступном для обновления", "value": { "detail": "Only sessions with status Approved, Declined, In Review, Kyc Expired, Abandoned, Resubmitted can be updated. Current status: In Progress" } }, "Invalid Status Value": { "summary": "new_status является допустимым статусом сессии, но не одним из Approved/Declined/Resubmitted", "value": { "new_status": [ "You can only update the status to 'Approved', 'Declined', or 'Resubmitted'." ] } }, "Missing new_status": { "summary": "Обязательное поле не указано", "value": { "new_status": [ "This field is required." ] } }, "Same Status": { "summary": "Повторная отправка запрошена для сессии, которая уже находится в статусе Resubmitted", "value": [ "The new status is the same as the current status." ] }, "Email Address Required": { "summary": "send_email имеет значение true без email_address", "value": { "email_address": [ "Email address is required when send_email is true." ] } }, "Non-resubmittable Feature": { "summary": "Повторная отправка направлена на родительскую проверку KYB", "value": { "nodes_to_resubmit": "The following features cannot be resubmitted directly: KYB_REGISTRY. Resubmit the relevant child KYC sessions instead; the parent will recompute automatically." } }, "Nothing To Resubmit": { "summary": "Автовыбор не нашел неодобренных функций", "value": { "nodes_to_resubmit": "No features found that need resubmission. All features are already approved." } }, "Invalid Feature Choice": { "summary": "Неизвестная функция в nodes_to_resubmit", "value": { "nodes_to_resubmit": [ { "feature": [ "\"BOGUS\" is not a valid choice. Valid choices are: OCR, OCR_BACK, NFC, AML, FACE, LIVENESS, FACE_MATCH, IP_ANALYSIS, AGE_ESTIMATION, PROOF_OF_ADDRESS, PHONE_VERIFICATION, EMAIL_VERIFICATION, FACE_SEARCH, DATABASE_VALIDATION, QUESTIONNAIRE, KYB_REGISTRY, KYB_DOCUMENTS, KYB_KEY_PEOPLE, ID_VERIFICATION, POA, PHONE, EMAIL, KYB" ] } ] } }, "Invalid Status Value (not a status at all)": { "summary": "new_status не является допустимым значением StatusChoices", "value": { "new_status": [ "\"Bogus\" is not a valid choice." ] } }, "Preview Receipt Without Email": { "summary": "email_preview_token отправлен без send_email: true", "value": { "email_preview_token": [ "A preview receipt is only valid when the email is sent." ] } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "API-ключ с ограниченной областью действия с истёкшим сроком действия", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Отсутствуют учетные данные, недостаточно разрешений или передан `session_id`, принадлежащий другому приложению.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Отсутствует или недействителен x-api-key", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "У API-ключа отсутствует разрешение write:sessions", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Сессия KYC или KYB с таким `session_id` не существует (для удалённых сессий также возвращается `404`).", "content": { "application/json": { "examples": { "Not Found": { "summary": "Неизвестный session_id", "value": { "detail": "Not found." } } } } } }, "429": { "description": "Повторная отправка, затрагивающая только бэкенд-функции (AML, DATABASE_VALIDATION, IP_ANALYSIS), была выполнена в течение 30-секундного периода ожидания; немедленный повтор не может изменить результат. Подождите и повторите попытку через интервал, указанный в `Retry-After`.", "content": { "application/json": { "examples": { "Backend-only resubmit throttled": { "value": { "detail": "This session was already resubmitted for backend-only features within the last 30 seconds; repeating it cannot change the outcome. Wait before resubmitting again." } } } } } }, "409": { "description": "Предварительный просмотр письма изменился или истёк. Сформируйте новый предварительный просмотр перед подтверждением; изменения сессии или доставка писем не выполняются.", "content": { "application/json": { "examples": { "Preview Changed": { "summary": "Квитанция больше не совпадает или старше 15 минут", "value": { "detail": "This email preview changed or expired. Preview the message again before confirming." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/update-status/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"new_status\": \"Approved\",\n \"comment\": \"All checks passed manual review\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_status(\n \"11111111-2222-3333-4444-555555555555\",\n new_status=\"Approved\",\n comment=\"All checks passed manual review\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updateStatus(\"11111111-2222-3333-4444-555555555555\", {\n new_status: \"Approved\",\n comment: \"All checks passed manual review\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateStatus(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsUpdateStatusParams{\n\tNewStatus: \"Approved\",\n\tComment: didit.String(\"All checks passed manual review\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsUpdateStatusParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updateStatus(\"11111111-2222-3333-4444-555555555555\", SessionsUpdateStatusParams.builder()\n .newStatus(SessionsUpdateStatusParams.NewStatus.of(\"Approved\"))\n .comment(\"All checks passed manual review\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updateStatus('11111111-2222-3333-4444-555555555555', [\n 'new_status' => 'Approved',\n 'comment' => 'All checks passed manual review',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_status(\n \"11111111-2222-3333-4444-555555555555\",\n new_status: \"Approved\",\n comment: \"All checks passed manual review\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdateStatusAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsUpdateStatusParams\n{\n NewStatus = \"Approved\",\n Comment = \"All checks passed manual review\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/id-verification/": { "post": { "summary": "Верификация личности (OCR документов + проверки на мошенничество)", "description": "OCR документа, удостоверяющего личность, и проверка на мошенничество с документами за один вызов — возвращает извлечённые поля владельца, распознанную MRZ, `status` со значением `Approved`/`Declined`/`In Review` и список `warnings` с описанием каждой обнаруженной проблемы. Поддерживает 14,000+ типов документов из 220+ стран и территорий.\n\n**Как это работает.** Отправьте `front_image` документа (обязательно) и, для двусторонних документов, `back_image`. Загружайте необрезанные фотографии, на которых видны все четыре угла документа: сервис сам определяет границы, выравнивает и обрезает документ, поэтому предварительно обрезать его не нужно. Документ классифицируется автоматически (вам не нужно указывать страну или тип документа), визуальная зона считывается с помощью OCR, а MRZ и любые штрихкоды декодируются. Затем перекрёстные проверки валидируют даты, форматы номеров и контрольные цифры MRZ, а также сравнивают визуальную зону с MRZ. При `perform_document_liveness=true` изображения дополнительно проверяются на пересъёмку с экрана, печатные копии и манипуляции с фотографией владельца.\n\n**Логика принятия решений.** `status` имеет значение `Approved`, если ни одно предупреждение не приводит к отклонению. Риски мошенничества и критические ошибки всегда приводят к отклонению: `DOCUMENT_EXPIRED`, `SCREEN_CAPTURE_DETECTED`, `PRINTED_COPY_DETECTED`, `PORTRAIT_MANIPULATION_DETECTED`, `PUBLIC_DOCUMENT_IMAGE_DETECTED`, а также ошибки извлечения данных (`NAME_NOT_DETECTED`, `DATE_OF_BIRTH_NOT_DETECTED`, `DOCUMENT_NUMBER_NOT_DETECTED`). (`PORTRAIT_IMAGE_NOT_DETECTED`, `INVALID_DATE` и `MRZ_NOT_DETECTED` существуют в сессиях сценариев, но никогда не возвращаются этим отдельным endpoint. `COULD_NOT_DETECT_DOCUMENT_TYPE` возвращается здесь, если лицевая сторона изображения с высокой степенью уверенности не соответствует известному образцу официального документа, и приводит к отклонению запроса.) Три группы рисков можно настроить для каждого запроса с помощью `invalid_mrz_action`, `inconsistent_data_action` и `expiration_date_not_detected_action` (`DECLINE` или `NO_ACTION`). Все остальные предупреждения (например, `POSSIBLE_DUPLICATED_USER`) носят информационный характер и сами по себе никогда не приводят к отклонению. Если `perform_document_liveness=true` (по умолчанию) и проверка на подделку не возвращает пригодную для использования оценку — произошёл сбой у провайдера, получен ответ с кодом, отличным от 200, или HTTP 200 со `status=\"ERR\"` — вызов возвращает `200` со `status: \"In Review\"` и предупреждением `DOCUMENT_LIVENESS_NOT_COMPUTED` (`log_type: \"warning\"`) вместо `Approved`: непроведённая проверка не подтверждает подлинность документа. Такую эскалацию нельзя настроить, и она никогда не переопределяет статус `Declined`; при `perform_document_liveness=false` проверка пропускается, а статус определяется оставшимися предупреждениями, как и ранее. Документ, который вообще не удалось обработать, возвращает `400` с `{\"error\": \"COULD_NOT_RECOGNIZE_DOCUMENT\"}`; читаемый, но проблемный документ возвращает `200` со `status: \"Declined\"` — всегда проверяйте `id_verification.status` и `id_verification.warnings`, а не только HTTP-код.\n\n**Биллинг.** Каждый ответ `200` расходует один кредит API верификации личности (списывается из кредитов вашего тарифа или с баланса пополнения). Если баланс организации недостаточен для оплаты вызова, endpoint возвращает `403` с ошибкой нехватки кредитов до начала обработки изображений.\n\n**Сохранение сессии (`save_api_request`, по умолчанию `true`).** При значении `true` вызов сохраняется как сессия типа API: она отображается в Business Console, возвращаемый `request_id` является реальным идентификатором сессии, который можно передать в `GET /v3/session/{sessionId}/decision/`, обрезанные изображения документа и лица сохраняются и возвращаются в виде временных медиа-URL (`https:///ocr/...`), а webhook `status.updated` отправляется на настроенные адреса назначения webhook. При значении `false` ничего не сохраняется, `request_id` представляет собой одноразовый UUID для корреляции, а `portrait_image`/`front_image`/`back_image` возвращаются прямо в ответе в виде строк JPEG в кодировке base64.\n\n**Песочница.** API-ключи песочницы пропускают всю обработку и биллинг: после валидации запроса (некорректные входные данные по-прежнему возвращают `400`) endpoint возвращает статический тестовый payload со статусом `Approved` (вымышленное удостоверение личности гражданина США «Sandbox User»), сессия не сохраняется, а кредиты не расходуются.\n\n**Аутентификация.** Передавайте API-ключ вашего приложения в заголовке `x-api-key`. При отсутствии или недействительности учетных данных возвращается `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`) — этот API никогда не возвращает `401`.\n\n**Лимит запросов.** Общий лимит на запись составляет 300 запросов в минуту на один API-ключ для всех POST/PATCH/DELETE endpoints; при его превышении возвращается `429`.", "operationId": "post_v3id-verification", "x-didit-sdk": { "resource": "id_verification", "method": "verify", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "parameters": [], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "front_image" ], "properties": { "front_image": { "type": "string", "format": "binary", "description": "Лицевая сторона документа, удостоверяющего личность. Допустимые расширения: `tiff`, `jpg`, `jpeg`, `png`, `webp`, `pdf`. Максимальный размер загружаемого файла: **10 MB** (файлы большего размера отклоняются с ошибкой `400`). PDF-файлы преобразуются в изображение перед OCR; для зашифрованных PDF требуется `front_image_password`. Изображения автоматически сжимаются примерно до 0.5 MB, и применяется ориентация EXIF. Загружайте полный необрезанный снимок, на котором видны все четыре угла документа." }, "front_image_password": { "type": "string", "description": "Пароль для расшифровки `front_image`, если это зашифрованный PDF-файл. Передача зашифрованного PDF без пароля (или с неверным паролем) возвращает `400`.", "writeOnly": true }, "back_image": { "type": "string", "format": "binary", "description": "Обратная сторона документа — отправляйте её всегда, когда она есть у документа (многие ID-карты содержат MRZ или штрихкод на обороте; если её опустить, поля MRZ и обратной стороны в ответе останутся пустыми — этот endpoint не выдаёт предупреждение об отсутствии MRZ). Те же ограничения по формату и размеру, что и для `front_image`. Если поле опущено, `back_image` и поля обратной стороны в ответе будут `null`." }, "back_image_password": { "type": "string", "description": "Пароль для расшифровки `back_image`, если это зашифрованный PDF-файл.", "writeOnly": true }, "perform_document_liveness": { "type": "boolean", "default": true, "description": "Проверяет оба изображения на мошенничество при предъявлении: пересъёмку с экрана (`SCREEN_CAPTURE_DETECTED`), печатные копии (`PRINTED_COPY_DETECTED`) и манипуляции с портретом (`PORTRAIT_MANIPULATION_DETECTED`). Любое из них приводит к автоматическому отклонению. Включено по умолчанию; установите значение `false`, чтобы пропустить проверку на мошенничество и сократить задержку. Если проверка включена, но провайдер не возвращает пригодную для использования оценку, возвращается статус `In Review` с предупреждением `DOCUMENT_LIVENESS_NOT_COMPUTED` вместо `Approved`.", "example": true }, "minimum_age": { "type": "integer", "nullable": true, "default": null, "minimum": 1, "maximum": 120, "description": "Принимается и валидируется (1–120), но **в настоящее время не применяется** этим endpoint — по этому полю никогда не создаётся предупреждение `MINIMUM_AGE_NOT_MET`. Применяйте правила возраста на основе возвращаемых `date_of_birth`/`age` или используйте сценарий сессии верификации с возрастными ограничениями." }, "expiration_date_not_detected_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Действие, если не удаётся прочитать срок действия (`EXPIRATION_DATE_NOT_DETECTED`). По умолчанию `NO_ACTION`, так как во многих документах срок действия не указывается. Примечание: *обнаруженный и истёкший* срок действия всегда приводит к отклонению (`DOCUMENT_EXPIRED`) независимо от этой опции." }, "invalid_mrz_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "DECLINE", "description": "Что делать, если извлеченная MRZ не проходит проверку контрольных цифр (`MRZ_VALIDATION_FAILED`). Отсутствие MRZ на этом endpoint не вызывает предупреждения. Актуально только для документов, содержащих MRZ. Значение `REVIEW` не поддерживается на этом endpoint и возвращает `400`." }, "inconsistent_data_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "DECLINE", "description": "Действие при внутренней несогласованности извлечённых данных: `DATA_INCONSISTENT`, `MRZ_AND_DATA_EXTRACTED_FROM_OCR_NOT_SAME` (визуальная зона расходится с MRZ) или `DOCUMENT_NAME_DIFFERENT_FROM_OTHER_APPROVED_DOCUMENTS`." }, "critical_field_occlusion_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "DECLINE", "description": "Действие при физическом перекрытии важного печатного поля на снимке (`CRITICAL_FIELD_OCCLUSION_DETECTED`) - номера удостоверения личности, имени, даты рождения или срока действия. По умолчанию отклоняет, как и при других рисках целостности документа на этом endpoint: скрытие номеров, с которыми сверяется отчёт, указывает на отредактированный документ. Считанное значение скрытого поля в любом случае удаляется из извлечённых данных, поэтому ему обычно сопутствует предупреждение `*_NOT_DETECTED`. Значение `REVIEW` не поддерживается на этом endpoint и возвращает `400`." }, "document_or_personal_number_format_mismatch_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Действие, если номер не соответствует формату органа выдачи для данного типа документа (`DOCUMENT_NUMBER_FORMAT_MISMATCH`, `PERSONAL_NUMBER_FORMAT_MISMATCH`). По умолчанию `NO_ACTION`, что регистрирует предупреждение без изменения статуса. `REVIEW` не поддерживается на этом endpoint и возвращает `400`." }, "preferred_characters": { "type": "string", "enum": [ "latin", "non_latin" ], "default": "latin", "description": "Предпочтительная система письма для полей имени/адреса в документах, содержащих текст как на латинице, так и не на латинице (арабский, кириллица, CJK, …). `latin` возвращает транслитерированные/латинские значения; `non_latin` отдаёт предпочтение оригинальной системе письма." }, "save_api_request": { "type": "boolean", "default": true, "description": "Если `true` (по умолчанию), сохраняет вызов как сессию типа API — видимую в Business Console, доступную через `GET /v3/session/{sessionId}/decision/` по возвращённому `request_id`, анонсируемую через webhook `status.updated`, с возвратом изображений документов в виде URL-адресов медиа. Если `false`, ничего не сохраняется, `request_id` является временным UUID, а изображения возвращаются встроенными в виде строк base64 JPEG.", "example": true }, "vendor_data": { "type": "string", "description": "Необязательная непрозрачная строка (ваш внутренний идентификатор пользователя, email, UUID…), сохраняемая в сессии и возвращаемая в ответе. Используйте её для сопоставления вызовов API с вашими собственными записями и для последующей фильтрации сессий.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Необязательный объект JSON, сохраняемый вместе с сессией (когда `save_api_request=true`) и возвращаемый обратно в ответе. В multipart-запросах отправляйте его как строковое поле в формате JSON (например, `metadata={\"flow\":\"onboarding\"}`) — он парсится в объект.", "example": { "flow": "onboarding" } } } }, "example": { "front_image": "(binary JPEG/PNG/PDF of the document front)", "back_image": "(binary JPEG/PNG/PDF of the document back)", "perform_document_liveness": true, "save_api_request": true, "vendor_data": "user-123", "metadata": { "flow": "onboarding" } } } } }, "responses": { "200": { "description": "Документ обработан. Значение `id_verification.status`: `Approved`, `Declined` или `In Review`; каждая обнаруженная проблема детализирована в `id_verification.warnings`. Статус `In Review` возвращается, когда запрошенная проверка живости документа не дала пригодного результата (`DOCUMENT_LIVENESS_NOT_COMPUTED`). Для проблемного документа по-прежнему возвращается `200` со статусом `status: \"Declined\"`: проверяйте тело ответа, а не только HTTP-код. Если `save_api_request=true`, `request_id` представляет собой сохранённый id сессии, а поля изображений являются временными URL медиафайлов; при `save_api_request=false` они передаются как встроенные base64-строки JPEG.", "content": { "application/json": { "examples": { "Approved": { "summary": "Двусторонняя ID-карта успешно считана (сохранено — изображения в виде URL-адресов медиа)", "value": { "request_id": "11d219ed-d59c-4b1d-8d65-9b933f12d5b8", "id_verification": { "status": "Approved", "document_type": "Identity Card", "document_subtype": "ID_CARD_GENERIC", "document_number": "CBX164224", "personal_number": "20446581H", "portrait_image": "https:///ocr/11d219ed-d59c-4b1d-8d65-9b933f12d5b8-portrait_image-8c2f.jpg?signature=...", "front_image": "https:///ocr/11d219ed-d59c-4b1d-8d65-9b933f12d5b8-front_image-4a1e.jpg?signature=...", "back_image": "https:///ocr/11d219ed-d59c-4b1d-8d65-9b933f12d5b8-back_image-77b0.jpg?signature=...", "front_image_camera_front": null, "back_image_camera_front": null, "front_image_camera_front_face_match_score": null, "back_image_camera_front_face_match_score": null, "front_image_quality_score": { "focus_score": 78.0, "brightness_score": 83.2, "brightness_issue": "ok", "is_document_fully_visible": true, "resolution_score": 40.7, "overall_score": 70.2 }, "back_image_quality_score": { "focus_score": 100.0, "brightness_score": 95.6, "brightness_issue": "ok", "is_document_fully_visible": true, "resolution_score": 43.0, "overall_score": 84.4 }, "date_of_birth": "1980-01-13", "age": 46, "expiration_date": "2032-03-31", "date_of_issue": "2022-03-31", "issuing_state": "ESP", "issuing_state_name": "Spain", "first_name": "Julio Francisco", "last_name": "Fores Sena", "full_name": "Julio Francisco Fores Sena", "gender": "M", "address": "Brda. Urb. El Cardonal 0052 52 Po3 B,Taco,San Cristobal De La Laguna,Santa Cruz De Tenerife", "formatted_address": "Av. el Cardonal, 52, b, 38108 La Laguna, Santa Cruz de Tenerife, Spain", "place_of_birth": "Valencia, Valencia", "marital_status": "UNKNOWN", "nationality": "ESP", "extra_fields": { "first_surname": "Fores", "second_surname": "Sena" }, "mrz": { "surname": "FORES SENA", "name": "JULIO FRANCISCO", "country": "ESP", "nationality": "ESP", "birth_date": "800113", "expiry_date": "320331", "sex": "M", "document_type": "ID", "document_number": "CBX164224", "optional_data": "20446581H", "optional_data_2": "", "birth_date_hash": "9", "expiry_date_hash": "8", "document_number_hash": "3", "final_hash": "3", "personal_number": "20446581H", "warnings": [], "errors": [], "mrz_type": "TD1", "mrz_string": "IDESPCBX164224320446581H<<<<<<\n8001139M3203318ESP<<<<<<<<<<<3\nFORES/ocr/f61681b8-9422-4378-ac3e-04c6a247fb45-portrait_image-1d9a.jpg?signature=...", "front_image": "https:///ocr/f61681b8-9422-4378-ac3e-04c6a247fb45-front_image-5c2b.jpg?signature=...", "back_image": null, "front_image_camera_front": null, "back_image_camera_front": null, "front_image_camera_front_face_match_score": null, "back_image_camera_front_face_match_score": null, "front_image_quality_score": { "focus_score": 100.0, "brightness_score": 95.7, "brightness_issue": "ok", "is_document_fully_visible": true, "resolution_score": 22.2, "overall_score": 79.3 }, "back_image_quality_score": null, "date_of_birth": "1997-01-30", "age": 29, "expiration_date": "2025-11-26", "date_of_issue": null, "issuing_state": "ESP", "issuing_state_name": "Spain", "first_name": "Lucia", "last_name": "Marin Castro", "full_name": "Lucia Marin Castro", "gender": "F", "address": null, "formatted_address": null, "place_of_birth": null, "marital_status": "UNKNOWN", "nationality": "ESP", "extra_fields": { "first_surname": "Marin", "second_surname": "Castro" }, "mrz": {}, "parsed_address": null, "warnings": [ { "risk": "DOCUMENT_EXPIRED", "feature": "ID_VERIFICATION", "additional_data": null, "log_type": "error", "short_description": "Document expired", "long_description": "The document's expiration date has passed, rendering it no longer valid for use." } ], "barcodes": [] }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T02:25:48.117204+00:00" } } }, "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Идентификатор сохраненной сессии при `save_api_request=true` (доступен для использования с `GET /v3/session/{sessionId}/decision/`); в противном случае это временный корреляционный UUID." }, "id_verification": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review" ], "description": "`Approved`, если ни одно предупреждение не приводит к отклонению и запрошенная проверка живости документа дала пригодный для использования результат; `In Review`, если эта запрошенная проверка не дала пригодного для использования результата (`DOCUMENT_LIVENESS_NOT_COMPUTED`); `Declined`, если предупреждение приводит к отклонению — список `warnings` поясняет причину." }, "document_type": { "type": "string", "nullable": true, "description": "Отображаемое название обнаруженного типа документа: `Identity Card`, `Passport`, `Driver's License`, `Residence Permit`, `Health Insurance Card` или `Tax Card`. `null`, если документ не удалось классифицировать.", "example": "Identity Card" }, "document_subtype": { "type": "string", "nullable": true, "description": "Более точный подтип, если доступен (например, `ID_CARD_GENERIC`, `EPASSPORT`).", "example": "ID_CARD_GENERIC" }, "document_number": { "type": "string", "nullable": true, "example": "CBX164224" }, "personal_number": { "type": "string", "nullable": true, "description": "Вторичный персональный/национальный номер, напечатанный на некоторых документах.", "example": "20446581H" }, "portrait_image": { "type": "string", "nullable": true, "description": "Обрезанная фотография портрета из документа. Временный URL-адрес медиафайла (`https:///ocr/...`), если `save_api_request=true` (по умолчанию); встроенная строка JPEG в кодировке base64, если `save_api_request=false`. `null`, если портрет не был обнаружен." }, "front_image": { "type": "string", "nullable": true, "description": "Выровненная обрезанная область лицевой стороны документа. URL медиафайла, если сохранено, иначе встроенный JPEG в base64." }, "back_image": { "type": "string", "nullable": true, "description": "Выровненная обрезанная область оборотной стороны документа. `null`, если `back_image` не загружался." }, "front_image_camera_front": { "type": "string", "nullable": true, "description": "Всегда `null` на этом endpoint (заполняется только в сессиях верификации с захватом с камеры)." }, "back_image_camera_front": { "type": "string", "nullable": true, "description": "Всегда `null` на этом endpoint." }, "front_image_camera_front_face_match_score": { "type": "number", "nullable": true, "description": "Всегда `null` на этом endpoint." }, "back_image_camera_front_face_match_score": { "type": "number", "nullable": true, "description": "Всегда `null` на этом endpoint." }, "front_image_quality_score": { "type": "object", "nullable": true, "description": "Диагностика качества захвата для загруженного изображения (`null`, если сторона не была предоставлена или оценка не удалась). Все оценки находятся в диапазоне 0–100.", "properties": { "focus_score": { "type": "number", "format": "float", "description": "Чёткость обрезанного изображения документа (чем выше значение, тем чётче)." }, "brightness_score": { "type": "number", "format": "float", "description": "Качество экспозиции (чем выше, тем лучше)." }, "brightness_issue": { "type": "string", "nullable": true, "description": "`ok`, если экспозиция в норме, иначе обнаруженная проблема (например, слишком темно / слишком ярко)." }, "is_document_fully_visible": { "type": "boolean", "nullable": true, "description": "Находятся ли все четыре угла документа внутри рамки." }, "resolution_score": { "type": "number", "format": "float", "description": "Фактическое разрешение области документа." }, "overall_score": { "type": "number", "format": "float", "description": "Агрегированная оценка качества." } } }, "back_image_quality_score": { "type": "object", "nullable": true, "description": "Диагностика качества захвата для загруженного изображения (`null`, если сторона не была предоставлена или оценка не удалась). Все оценки находятся в диапазоне 0–100.", "properties": { "focus_score": { "type": "number", "format": "float", "description": "Чёткость обрезанного изображения документа (чем выше значение, тем чётче)." }, "brightness_score": { "type": "number", "format": "float", "description": "Качество экспозиции (чем выше, тем лучше)." }, "brightness_issue": { "type": "string", "nullable": true, "description": "`ok`, если экспозиция в норме, иначе обнаруженная проблема (например, слишком темно / слишком ярко)." }, "is_document_fully_visible": { "type": "boolean", "nullable": true, "description": "Находятся ли все четыре угла документа внутри рамки." }, "resolution_score": { "type": "number", "format": "float", "description": "Фактическое разрешение области документа." }, "overall_score": { "type": "number", "format": "float", "description": "Агрегированная оценка качества." } } }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "example": "1980-01-13" }, "age": { "type": "integer", "nullable": true, "description": "Возраст владельца в годах, рассчитанный на основе `date_of_birth`.", "example": 46 }, "expiration_date": { "type": "string", "format": "date", "nullable": true, "example": "2032-03-31" }, "date_of_issue": { "type": "string", "format": "date", "nullable": true, "example": "2022-03-31" }, "issuing_state": { "type": "string", "nullable": true, "description": "Страна выдачи (ISO 3166-1 alpha-3).", "example": "ESP" }, "issuing_state_name": { "type": "string", "nullable": true, "example": "Spain" }, "first_name": { "type": "string", "nullable": true, "example": "Julio Francisco" }, "last_name": { "type": "string", "nullable": true, "example": "Fores Sena" }, "full_name": { "type": "string", "nullable": true, "example": "Julio Francisco Fores Sena" }, "gender": { "type": "string", "nullable": true, "description": "`M`, `F` или `null`, если не напечатано или не обнаружено.", "example": "M" }, "address": { "type": "string", "nullable": true, "description": "Адрес в точности так, как напечатан на документе." }, "formatted_address": { "type": "string", "nullable": true, "description": "Геокодированная нормализованная версия `address`." }, "place_of_birth": { "type": "string", "nullable": true, "example": "Valencia, Valencia" }, "marital_status": { "type": "string", "nullable": true, "description": "`UNKNOWN`, если в документе не указано семейное положение.", "example": "UNKNOWN" }, "nationality": { "type": "string", "nullable": true, "description": "Гражданство владельца (ISO 3166-1 alpha-3).", "example": "ESP" }, "extra_fields": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Специфичные для документа дополнительные поля, не имеющие отдельного столбца (например, `first_surname`/`second_surname` в испанских удостоверениях личности, категории в водительских удостоверениях)." }, "mrz": { "type": "object", "description": "Распознанная машиночитаемая зона. **Пустой объект** (`{}`), если в документе нет MRZ или её не удалось прочитать — в этом случае также проверьте список `warnings`. Даты внутри MRZ используют исходный формат `YYMMDD`.", "properties": { "surname": { "type": "string", "example": "FORES SENA" }, "name": { "type": "string", "example": "JULIO FRANCISCO" }, "country": { "type": "string", "description": "Страна выдачи (ISO 3166-1 alpha-3).", "example": "ESP" }, "nationality": { "type": "string", "description": "Гражданство владельца (ISO 3166-1 alpha-3).", "example": "ESP" }, "birth_date": { "type": "string", "description": "Необработанная дата рождения из MRZ (`YYMMDD`).", "example": "800113" }, "expiry_date": { "type": "string", "description": "Необработанный срок действия из MRZ (`YYMMDD`).", "example": "320331" }, "sex": { "type": "string", "example": "M" }, "document_type": { "type": "string", "description": "Код типа документа по MRZ (например, `ID`, `P`).", "example": "ID" }, "document_number": { "type": "string", "example": "CBX164224" }, "optional_data": { "type": "string", "nullable": true, "example": "20446581H" }, "optional_data_2": { "type": "string", "nullable": true, "example": "" }, "birth_date_hash": { "type": "string", "description": "Контрольная цифра MRZ для даты рождения.", "example": "9" }, "expiry_date_hash": { "type": "string", "description": "Контрольная цифра MRZ для срока действия.", "example": "8" }, "document_number_hash": { "type": "string", "description": "Контрольная цифра MRZ для номера документа.", "example": "3" }, "final_hash": { "type": "string", "description": "Составная контрольная цифра MRZ.", "example": "3" }, "personal_number": { "type": "string", "nullable": true, "example": "20446581H" }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "Некритичные предупреждения парсинга MRZ." }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Ошибки контрольной цифры/парсинга MRZ. Наличие ошибок приводит к предупреждению `MRZ_VALIDATION_FAILED`." }, "mrz_type": { "type": "string", "description": "Формат MRZ: `TD1` (удостоверения личности, 3 строки), `TD2` или `TD3` (паспорта, 2 строки).", "example": "TD1" }, "mrz_string": { "type": "string", "description": "Необработанный текст MRZ в исходном виде, строки разделены `\\n`." }, "mrz_key": { "type": "string", "description": "Составной ключ (номер документа + контрольные цифры), используемый для перекрёстных проверок." } } }, "parsed_address": { "type": "object", "nullable": true, "description": "Структурированная геокодированная детализация `address`. `null`, если документ не содержит адреса или его не удалось распознать.", "properties": { "street_1": { "type": "string", "nullable": true, "example": "Avenida el Cardonal 52" }, "street_2": { "type": "string", "nullable": true, "example": "b" }, "city": { "type": "string", "nullable": true, "example": "La Laguna" }, "region": { "type": "string", "nullable": true, "example": "Canarias" }, "country": { "type": "string", "nullable": true, "description": "Двухбуквенный код страны ISO 3166-1 alpha-2.", "example": "ES" }, "postal_code": { "type": "string", "nullable": true, "example": "38108" }, "address_type": { "type": "string", "nullable": true, "example": "Avenida" }, "formatted_address": { "type": "string", "nullable": true, "description": "Каноническая строка геокодированного адреса.", "example": "Av. el Cardonal, 52, b, 38108 La Laguna, Santa Cruz de Tenerife, Spain" }, "raw_results": { "type": "object", "additionalProperties": true, "description": "Необработанный payload геокодирования (`address_components`, `geometry.location`, `place_id`, …) для продвинутых пользователей." }, "document_location": { "type": "object", "nullable": true, "properties": { "latitude": { "type": "number" }, "longitude": { "type": "number" } }, "description": "Геокодированные координаты адреса из документа." }, "label": { "type": "string", "nullable": true, "description": "Из какого поля документа был считан адрес.", "example": "Spain Identity Card Address" }, "is_verified": { "type": "boolean", "description": "Подтвердило ли геокодирование существование адреса." }, "category": { "type": "string", "nullable": true, "description": "Категория адреса (например, `Residential`, `Commercial`).", "example": "Residential" } } }, "warnings": { "type": "array", "description": "Пусто при чистом одобрении. Каждая запись описывает один обнаруженный риск; записи с `log_type: \"error\"` устанавливают для `status` значение `Declined`, а `DOCUMENT_LIVENESS_NOT_COMPUTED` (`log_type: \"warning\"`) устанавливает значение `In Review`.", "items": { "type": "object", "properties": { "risk": { "type": "string", "description": "Машиночитаемый код риска. Риски, всегда приводящие к отклонению: `DOCUMENT_EXPIRED`, `MINIMUM_AGE_NOT_MET`, `PORTRAIT_IMAGE_NOT_DETECTED`, `SCREEN_CAPTURE_DETECTED`, `PRINTED_COPY_DETECTED`, `PORTRAIT_MANIPULATION_DETECTED`, `PUBLIC_DOCUMENT_IMAGE_DETECTED`, `INVALID_DATE`, `COULD_NOT_RECOGNIZE_DOCUMENT` (только для статуса 400, никогда не бывает предупреждением), `DOCUMENT_NUMBER_NOT_DETECTED`, `COULD_NOT_DETECT_DOCUMENT_TYPE`, `NAME_NOT_DETECTED`, `DATE_OF_BIRTH_NOT_DETECTED`. Риски, регулируемые параметрами запроса: `MRZ_NOT_DETECTED` / `MRZ_VALIDATION_FAILED` (`invalid_mrz_action`), `DATA_INCONSISTENT` / `MRZ_AND_DATA_EXTRACTED_FROM_OCR_NOT_SAME` / `DOCUMENT_NAME_DIFFERENT_FROM_OTHER_APPROVED_DOCUMENTS` (`inconsistent_data_action`), `EXPIRATION_DATE_NOT_DETECTED` (`expiration_date_not_detected_action`). Другие риски (например, `POSSIBLE_DUPLICATED_USER`) являются информационными. `DOCUMENT_LIVENESS_NOT_COMPUTED` возникает, когда `perform_document_liveness=true`, но проверка на подделку не вернула пригодной для использования оценки; это устанавливает `status` в значение `In Review` (на проверке). `COULD_NOT_DETECT_DOCUMENT_TYPE` также возвращается, если лицевая сторона документа не совпадает с высокой степенью уверенности с известным официальным дизайном документа, например, при отредактированном или созданном на компьютере документе, либо дизайне, который ещё не поддерживается.", "example": "DOCUMENT_EXPIRED" }, "feature": { "type": "string", "enum": [ "ID_VERIFICATION" ], "description": "Функция, вызвавшая предупреждение. На этом endpoint всегда `ID_VERIFICATION`." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Дополнительный контекст для некоторых рисков (например, `POSSIBLE_DUPLICATED_USER` включает `duplicated_session_id`); `null` для большинства." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Серьёзность. Предупреждения `error` переводят `status` в `Declined`; `warning` (только `DOCUMENT_LIVENESS_NOT_COMPUTED`, когда запрошенная проверка на подделку не дала применимой оценки) переводит `status` в `In Review`; записи `information` носят информационный характер и никогда не меняют статус." }, "short_description": { "type": "string", "description": "Краткая сводка риска в одну строку в понятном человеку формате." }, "long_description": { "type": "string", "description": "Понятное объяснение риска." } } } }, "barcodes": { "type": "array", "description": "Штрихкоды, распознанные на документе (PDF417, QR и т. д.). Пусто, если на документе нет штрихкодов или ни один не удалось прочитать.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Тип штрихкода (например, `PDF417`, `QR_CODE`, `UNKNOWN`)." }, "position": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Местоположение штрихкода на изображении, если доступно." }, "data": { "type": "string", "description": "Декодированный payload." }, "data_raw": { "type": "string", "description": "Необработанный (недекодированный) payload, если отличается." }, "side": { "type": "string", "nullable": true, "description": "`front` или `back`." } } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Эхо-значение переданного вами `vendor_data` или `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Эхо-значение переданного вами объекта `metadata` или `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Временная метка ISO 8601 (UTC) момента генерации ответа." } } } } } }, "400": { "description": "Ошибка валидации или обработки. Проблемы на уровне полей возвращают стандартную структуру DRF (один массив сообщений на каждое проблемное поле). Проблемы с зашифрованными PDF возвращают `{\"detail\": ...}`. Изображение документа, на котором вообще не удаётся распознать документ, возвращает `{\"error\": \"COULD_NOT_RECOGNIZE_DOCUMENT\"}`. Загрузка PDF может дополнительно завершиться ошибкой «Отправленный PDF-файл повреждён или недействителен.» или ошибкой отсутствия страниц.", "content": { "application/json": { "examples": { "Missing front image": { "summary": "`front_image` не включено в данные формы", "value": { "front_image": [ "No file was submitted." ] } }, "Unsupported file extension": { "summary": "Расширение файла отличается от tiff/jpg/jpeg/png/webp/pdf", "value": { "front_image": [ "File extension “txt” is not allowed. Allowed extensions are: tiff, jpg, jpeg, png, webp, pdf." ] } }, "File too large": { "summary": "Размер загружаемого файла превышает лимит в 10 МБ", "value": { "front_image": [ "File size should not exceed 10 MB" ] } }, "Invalid option value": { "summary": "Варианты принимают только DECLINE или NO_ACTION", "value": { "invalid_mrz_action": [ "\"REVIEW\" is not a valid choice." ] } }, "Encrypted PDF": { "summary": "PDF загружен без обязательного пароля", "value": { "detail": "The PDF is encrypted. Please upload a decrypted PDF or a photo instead." } }, "Wrong PDF password": { "summary": "`front_image_password` / `back_image_password` не расшифровывает PDF", "value": { "detail": "The PDF password is incorrect. Please provide the correct password." } }, "Document not recognized": { "summary": "На изображении не удалось обнаружить документ, удостоверяющий личность", "value": { "error": "COULD_NOT_RECOGNIZE_DOCUMENT" } }, "PDF conversion failure": { "summary": "Не удалось преобразовать загруженный PDF-файл в изображение", "value": { "error": "Failed to convert front image PDF." } } } } } }, "403": { "description": "В доступе отказано. Возвращается, если заголовок `x-api-key` отсутствует, а также если баланс вызывающей организации не покрывает вызов; неверный, отозванный или истекший ключ возвращает `401`. Отсутствующий ключ возвращает `403` с `{\"detail\": ...}`; неверный, отозванный или истекший ключ возвращает `401`. При нехватке кредитов возвращается `403` с `{\"error\": ...}` до начала любой обработки изображения.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Отсутствует заголовок `x-api-key`, либо ключ недействителен/отозван", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "Баланс организации недостаточен для совершения вызова", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Превышен лимит запросов. Endpoint'ы POST/PATCH/DELETE делят общий лимит в 300 запросов на запись в минуту на один API-ключ (для создания транзакций и отправки событий действует отдельный лимит в 600). Ответ содержит заголовки `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` и `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Более 300 запросов на запись в текущую минуту", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "503": { "$ref": "#/components/responses/DocumentProcessingBusy" } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X POST 'https://verification.didit.me/v3/id-verification/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'front_image=@./id_front.jpg' \\\n -F 'back_image=@./id_back.jpg' \\\n -F 'perform_document_liveness=true' \\\n -F 'save_api_request=true' \\\n -F 'vendor_data=user-123'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_verification.verify(\n front_image=open(\"front_image.jpg\", \"rb\"),\n back_image=open(\"back_image.jpg\", \"rb\"),\n perform_document_liveness=True,\n save_api_request=True,\n vendor_data=\"user-123\",\n metadata={\"flow\": \"onboarding\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idVerification.verify({\n front_image: await fileFromPath(\"front_image.jpg\"),\n back_image: await fileFromPath(\"back_image.jpg\"),\n perform_document_liveness: true,\n save_api_request: true,\n vendor_data: \"user-123\",\n metadata: { flow: \"onboarding\" },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDVerification.Verify(ctx, didit.IDVerificationVerifyParams{\n\tFrontImage: didit.FileFromPath(\"front_image.jpg\"),\n\tBackImage: didit.Some(didit.FileFromPath(\"back_image.jpg\")),\n\tPerformDocumentLiveness: didit.Bool(true),\n\tSaveAPIRequest: didit.Bool(true),\n\tVendorData: didit.String(\"user-123\"),\n\tMetadata: didit.Some(map[string]any{\"flow\": \"onboarding\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.IdVerificationVerifyParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idVerification().verify(IdVerificationVerifyParams.builder()\n .frontImage(Path.of(\"front_image.jpg\"))\n .backImage(Path.of(\"back_image.jpg\"))\n .performDocumentLiveness(true)\n .saveApiRequest(true)\n .vendorData(\"user-123\")\n .metadata(Map.of(\"flow\", \"onboarding\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idVerification->verify([\n 'front_image' => File::fromPath('front_image.jpg'),\n 'back_image' => File::fromPath('back_image.jpg'),\n 'perform_document_liveness' => true,\n 'save_api_request' => true,\n 'vendor_data' => 'user-123',\n 'metadata' => ['flow' => 'onboarding'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_verification.verify(\n front_image: Pathname(\"front_image.jpg\"),\n back_image: Pathname(\"back_image.jpg\"),\n perform_document_liveness: true,\n save_api_request: true,\n vendor_data: \"user-123\",\n metadata: { flow: \"onboarding\" }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdVerification.VerifyAsync(new IdVerificationVerifyParams\n{\n FrontImage = FileUpload.FromPath(\"front_image.jpg\"),\n BackImage = FileUpload.FromPath(\"back_image.jpg\"),\n PerformDocumentLiveness = true,\n SaveApiRequest = true,\n VendorData = \"user-123\",\n Metadata = new Dictionary { [\"flow\"] = \"onboarding\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/face-match/": { "post": { "summary": "Сравнение лиц", "description": "Сравните два изображения лиц (1:1) и получите оценку сходства `score` (0–100), а также `status` со значением `Approved`/`Declined`.\n\n**Как это работает.** Оба изображения декодируются и анализируются биометрической моделью (установите `rotate_image=true`, если снимки могут быть повёрнуты набок или перевёрнуты), после чего вычисляется оценка сходства между двумя лицами. Оценка **строго выше** `face_match_score_decline_threshold` (по умолчанию `30`) возвращает `status: \"Approved\"`; оценка, равная этому значению или ниже него, возвращает `Declined` с предупреждением `LOW_FACE_MATCH_SIMILARITY`. Если пару лиц вообще невозможно оценить, вызов всё равно возвращает `200` со `status: \"Declined\"` и предупреждением `NO_REFERENCE_IMAGE` — `score` равен `null` при стандартном сохранении или `0` при `save_api_request=false`. Для наилучших результатов передавайте по одному чёткому лицу анфас на каждом изображении.\n\n**Биллинг.** Каждый ответ `200` расходует один API-кредит функции Сравнение лиц (списывается из кредитов вашего тарифа или баланса пополнения). Если на балансе организации недостаточно средств для вызова, endpoint возвращает `403` с ошибкой нехватки кредитов до начала какой-либо обработки изображений.\n\n**Сохранение сессии (`save_api_request`, по умолчанию `true`).** При значении `true` вызов сохраняется как сессия типа API: она отображается в Business Console, возвращённый `request_id` является реальным идентификатором сессии, который можно передать в `GET /v3/session/{sessionId}/decision/`, оба изображения сохраняются как исходное/целевое изображения сравнения лиц сессии, а на настроенные адреса назначения webhook отправляется webhook `status.updated`. При значении `false` ничего не сохраняется, а `request_id` представляет собой разовый корреляционный UUID, который нельзя запросить позже.\n\n**Индекс поиска по лицу.** Этот endpoint никогда не регистрирует лица в вашем индексе поиска по лицу и не выполняет проверку по спискам блокировки или поиск дубликатов — для этого используйте `POST /v3/passive-liveness/` или `POST /v3/face-search/`.\n\n**Песочница.** API-ключи песочницы пропускают всю обработку и биллинг: после валидации запроса (некорректный ввод по-прежнему возвращает `400`) endpoint возвращает статический тестовый payload со статусом `Approved`, сессия не сохраняется и кредиты не расходуются.\n\n**Аутентификация.** Передавайте API-ключ вашего приложения в заголовке `x-api-key`. При отсутствии или недействительности учетных данных возвращается `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`) — этот API никогда не возвращает `401`.\n\n**Лимит запросов.** Общий лимит на запись составляет 300 запросов/мин на API-ключ для всех endpoint POST/PATCH/DELETE; при его превышении возвращается `429`.", "operationId": "post_v3face-match", "x-didit-sdk": { "resource": "face_match", "method": "compare", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "parameters": [], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "user_image", "ref_image" ], "properties": { "user_image": { "type": "string", "format": "binary", "description": "Изображение живого лица или лица-кандидата для верификации (например, селфи). Отправьте одну фотографию анфас, на которой лицо субъекта чётко видно и хорошо освещено. Допустимые расширения: `tiff`, `jpg`, `jpeg`, `png`, `webp`. Максимальный размер загружаемого файла: **5 MB** (файлы большего размера отклоняются с ошибкой `400`). Изображения автоматически сжимаются примерно до 0,5 МБ перед обработкой, поэтому сверхвысокое разрешение не повышает точность." }, "ref_image": { "type": "string", "format": "binary", "description": "Эталонное изображение лица для сравнения (например, фото из удостоверения личности или ранее зарегистрированная фотография). Те же ограничения по формату и размеру, что и для `user_image`." }, "face_match_score_decline_threshold": { "type": "number", "format": "float", "default": 30, "minimum": 0, "maximum": 100, "description": "Порог сходства (0–100), определяющий `status` в ответе. Вычисленная оценка **на уровне или ниже** этого значения устанавливает `status` в `Declined` и добавляет предупреждение `LOW_FACE_MATCH_SIMILARITY`; оценка строго выше него возвращает `Approved`. Значение по умолчанию `30` является мягким — увеличьте его (например, до `50`–`60`) для более строгой верификации. Значения вне диапазона 0–100 возвращают `400`.", "example": 50 }, "rotate_image": { "type": "boolean", "default": false, "description": "Когда `true`, сервис поворачивает входные изображения с шагом 90 градусов (0, 90, 180, 270) и использует ориентацию, обеспечивающую наилучшее обнаружение лица — полезно для мобильных снимков с отсутствующей ориентацией EXIF. Увеличивает задержку, поэтому включайте только в том случае, если вы не можете гарантировать правильную ориентацию изображений.", "example": false }, "save_api_request": { "type": "boolean", "default": true, "description": "Если `true` (по умолчанию), сохраняет вызов как сессию типа API — видимую в Business Console, доступную через `GET /v3/session/{sessionId}/decision/` по возвращенному `request_id` и с уведомлением через webhook `status.updated`. Если `false`, ничего не сохраняется, а `request_id` является временным UUID только для сопоставления ответа.", "example": true }, "vendor_data": { "type": "string", "description": "Необязательная непрозрачная строка (ваш внутренний идентификатор пользователя, email, UUID…), сохраняемая в сессии и возвращаемая в ответе. Используйте её для сопоставления вызовов API с вашими собственными записями и для последующей фильтрации сессий.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Необязательный объект JSON, сохраняемый вместе с сессией (когда `save_api_request=true`) и возвращаемый обратно в ответе. В multipart-запросах отправляйте его как строковое поле в формате JSON (например, `metadata={\"flow\":\"login\"}`) — он парсится в объект.", "example": { "flow": "login", "device_id": "abc123" } } } }, "example": { "user_image": "(binary JPEG/PNG of the live selfie)", "ref_image": "(binary JPEG/PNG of the reference photo)", "face_match_score_decline_threshold": 50, "rotate_image": false, "save_api_request": true, "vendor_data": "user-123", "metadata": { "flow": "login" } } } } }, "responses": { "200": { "description": "Сравнение лиц вычислено. `face_match.score` представляет собой число с плавающей точкой от 0 до 100 (два знака после запятой); `status` имеет значение `Approved`, если оценка строго выше `face_match_score_decline_threshold`, иначе `Declined` с поясняющим предупреждением. При низкой схожести или невозможности оценить пару все равно возвращается `200`: проверяйте `face_match.status` и `face_match.warnings`, а не только HTTP-код. Если `save_api_request=true`, `request_id` является сохраненным id сессии.", "content": { "application/json": { "examples": { "Approved": { "summary": "Тот же человек — оценка выше порога", "value": { "request_id": "f9f5a777-8002-44c6-baaf-128bcfd6e226", "face_match": { "status": "Approved", "score": 99.41, "user_image": { "entities": [ { "bbox": [ 661, 728, 1688, 2188 ], "confidence": 0.732973, "age": 26.91, "gender": "male", "race": null } ], "best_angle": 0 }, "ref_image": { "entities": [ { "bbox": [ 653, 745, 1691, 2185 ], "confidence": 0.722082, "age": 27.0, "gender": "male", "race": null } ], "best_angle": 0 }, "warnings": [] }, "vendor_data": "user-123", "metadata": { "flow": "login" }, "created_at": "2026-06-12T01:04:42.763237+00:00" } }, "Declined - low similarity": { "summary": "Оценка на уровне порога отклонения или ниже его", "value": { "request_id": "7cdda24e-311a-46d3-a3bb-e5d9b564ce73", "face_match": { "status": "Declined", "score": 24.87, "user_image": { "entities": [ { "bbox": [ 661, 728, 1688, 2188 ], "confidence": 0.732973, "age": 26.91, "gender": "male", "race": null } ], "best_angle": 0 }, "ref_image": { "entities": [ { "bbox": [ 156, 234, 679, 898 ], "confidence": 0.717775, "age": 41.2, "gender": "male", "race": null } ], "best_angle": 0 }, "warnings": [ { "risk": "LOW_FACE_MATCH_SIMILARITY", "feature": "FACEMATCH", "additional_data": null, "log_type": "error", "short_description": "Low face match similarity", "long_description": "The facial features of the provided image don't closely match the reference image, suggesting a potential identity mismatch." } ] }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T01:08:19.859116+00:00" } } }, "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Идентификатор сохраненной сессии при `save_api_request=true` (доступен для использования с `GET /v3/session/{sessionId}/decision/`); в противном случае это временный корреляционный UUID." }, "face_match": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined" ], "description": "`Approved`, если оценка сходства строго выше `face_match_score_decline_threshold` и оценку удалось рассчитать; в противном случае `Declined` (причина указана в предупреждении)." }, "score": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Оценка сходства от 0 до 100 — уверенность модели в том, что на обоих изображениях запечатлен один и тот же человек. Округляется до двух знаков после запятой, только если параметр `save_api_request` равен true; при `save_api_request=false` возвращается исходное число с плавающей точкой. `null`, если не удалось оценить пару лиц (при значении по умолчанию `save_api_request=true`); при `save_api_request=false` то же условие может возвращаться как `score: 0`. В любом случае присутствует предупреждение `NO_REFERENCE_IMAGE`, а `status` равен `Declined`.", "example": 99.41 }, "user_image": { "type": "object", "description": "Результаты обнаружения лиц для проанализированных изображений.", "properties": { "entities": { "type": "array", "items": { "type": "object", "properties": { "bbox": { "type": "array", "items": { "type": "integer" }, "minItems": 4, "maxItems": 4, "description": "Ограничивающий прямоугольник обнаруженного лица в координатах пикселей `[x_min, y_min, x_max, y_max]` на обработанном изображении.", "example": [ 661, 728, 1688, 2188 ] }, "confidence": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Уверенность обнаружения лица (0–1).", "example": 0.732973 }, "age": { "type": "number", "format": "float", "description": "Возраст обнаруженного лица в годах, оцененный моделью. Только для справки — не влияет на решение о сравнении лиц.", "example": 26.91 }, "gender": { "type": "string", "description": "Пол обнаруженного лица, спрогнозированный моделью (`male` или `female`). Только для справки.", "example": "male" }, "race": { "type": "string", "nullable": true, "description": "Зарезервированное поле — всегда `null` в ответах от этого endpoint.", "example": null } } }, "description": "Одна запись на каждое обнаруженное лицо." }, "best_angle": { "type": "integer", "description": "Поворот (в градусах: 0, 90, 180 или 270), при котором было достигнуто наилучшее обнаружение лица. Отличен от нуля, только если `rotate_image=true` скорректировал ориентацию.", "example": 0 } } }, "ref_image": { "type": "object", "description": "Результаты обнаружения лица для эталонного изображения, та же структура, что и у `user_image`.", "properties": { "entities": { "type": "array", "items": { "type": "object", "properties": { "bbox": { "type": "array", "items": { "type": "integer" }, "minItems": 4, "maxItems": 4, "description": "Ограничивающий прямоугольник обнаруженного лица в координатах пикселей `[x_min, y_min, x_max, y_max]` на обработанном изображении.", "example": [ 661, 728, 1688, 2188 ] }, "confidence": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Уверенность обнаружения лица (0–1).", "example": 0.732973 }, "age": { "type": "number", "format": "float", "description": "Возраст обнаруженного лица в годах, оцененный моделью. Только для справки — не влияет на решение о сравнении лиц.", "example": 26.91 }, "gender": { "type": "string", "description": "Пол обнаруженного лица, спрогнозированный моделью (`male` или `female`). Только для справки.", "example": "male" }, "race": { "type": "string", "nullable": true, "description": "Зарезервированное поле — всегда `null` в ответах от этого endpoint.", "example": null } } }, "description": "Одна запись на каждое обнаруженное лицо." }, "best_angle": { "type": "integer", "example": 0 } } }, "warnings": { "type": "array", "description": "Пусто при чистом одобрении. `NO_REFERENCE_IMAGE` (`error`) — не удалось оценить пару лиц; `LOW_FACE_MATCH_SIMILARITY` (`error`) — оценка на уровне или ниже порога отклонения. Любое из этих событий устанавливает для `status` значение `Declined`.", "items": { "type": "object", "properties": { "risk": { "type": "string", "enum": [ "NO_REFERENCE_IMAGE", "LOW_FACE_MATCH_SIMILARITY" ], "description": "Машиночитаемый код риска." }, "feature": { "type": "string", "enum": [ "FACEMATCH" ], "description": "Функция, вызвавшая предупреждение. На этом endpoint всегда `FACEMATCH`." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Всегда `null` для предупреждений сравнения лиц." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Серьёзность. Предупреждения `error` переводят `status` в `Declined`; записи `warning` и `information` носят информационный характер и сами по себе никогда не приводят к отклонению." }, "short_description": { "type": "string", "description": "Краткая сводка риска в одну строку в понятном человеку формате." }, "long_description": { "type": "string", "description": "Понятное объяснение риска." } } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Эхо-значение переданного вами `vendor_data` или `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Эхо-значение переданного вами объекта `metadata` или `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Временная метка ISO 8601 (UTC) момента генерации ответа, например `2026-06-12T01:04:42.763237+00:00`." } } } } } }, "400": { "description": "Ошибка валидации. Возвращается, если обязательное изображение отсутствует, превышает 5 МБ, имеет неподдерживаемое расширение или если значение параметра выходит за допустимые пределы. Тело ответа представляет собой стандартную обёртку ошибок полей DRF: один массив сообщений на каждое некорректное поле.", "content": { "application/json": { "examples": { "Missing required image": { "summary": "`ref_image` (или `user_image`) не передан в данных формы", "value": { "ref_image": [ "No file was submitted." ] } }, "Unsupported file extension": { "summary": "Расширение файла отличается от tiff/jpg/jpeg/png/webp", "value": { "user_image": [ "File extension “txt” is not allowed. Allowed extensions are: tiff, jpg, jpeg, png, webp." ] } }, "File too large": { "summary": "Размер загружаемого файла превышает лимит в 5 МБ", "value": { "user_image": [ "File size should not exceed 5 MB" ] } }, "Threshold out of range": { "summary": "`face_match_score_decline_threshold` вне диапазона 0–100", "value": { "face_match_score_decline_threshold": [ "Ensure this value is less than or equal to 100." ] } } } } } }, "403": { "description": "В доступе отказано. Возвращается, если заголовок `x-api-key` отсутствует, а также если баланс вызывающей организации не покрывает вызов; неверный, отозванный или истекший ключ возвращает `401`. Отсутствующий ключ возвращает `403` с `{\"detail\": ...}`; неверный, отозванный или истекший ключ возвращает `401`. При нехватке кредитов возвращается `403` с `{\"error\": ...}` до начала любой обработки изображения.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Отсутствует заголовок `x-api-key`, либо ключ недействителен/отозван", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "Баланс организации недостаточен для совершения вызова", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Превышен лимит запросов. Endpoint'ы POST/PATCH/DELETE делят общий лимит в 300 запросов на запись в минуту на один API-ключ (для создания транзакций и отправки событий действует отдельный лимит в 600). Ответ содержит заголовки `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` и `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Более 300 запросов на запись в текущую минуту", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X POST 'https://verification.didit.me/v3/face-match/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'user_image=@./selfie.jpg' \\\n -F 'ref_image=@./id_portrait.jpg' \\\n -F 'face_match_score_decline_threshold=50' \\\n -F 'save_api_request=true' \\\n -F 'vendor_data=user-123'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.face_match.compare(\n user_image=open(\"user_image.jpg\", \"rb\"),\n ref_image=open(\"ref_image.jpg\", \"rb\"),\n face_match_score_decline_threshold=50.0,\n rotate_image=False,\n save_api_request=True,\n vendor_data=\"user-123\",\n metadata={\"flow\": \"login\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.faceMatch.compare({\n user_image: await fileFromPath(\"user_image.jpg\"),\n ref_image: await fileFromPath(\"ref_image.jpg\"),\n face_match_score_decline_threshold: 50.0,\n rotate_image: false,\n save_api_request: true,\n vendor_data: \"user-123\",\n metadata: { flow: \"login\" },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.FaceMatch.Compare(ctx, didit.FaceMatchCompareParams{\n\tUserImage: didit.FileFromPath(\"user_image.jpg\"),\n\tRefImage: didit.FileFromPath(\"ref_image.jpg\"),\n\tFaceMatchScoreDeclineThreshold: didit.Float(50.0),\n\tRotateImage: didit.Bool(false),\n\tSaveAPIRequest: didit.Bool(true),\n\tVendorData: didit.String(\"user-123\"),\n\tMetadata: didit.Some(map[string]any{\"flow\": \"login\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.FaceMatchCompareParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.faceMatch().compare(FaceMatchCompareParams.builder()\n .userImage(Path.of(\"user_image.jpg\"))\n .refImage(Path.of(\"ref_image.jpg\"))\n .faceMatchScoreDeclineThreshold(50.0)\n .rotateImage(false)\n .saveApiRequest(true)\n .vendorData(\"user-123\")\n .metadata(Map.of(\"flow\", \"login\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "faceMatch->compare([\n 'user_image' => File::fromPath('user_image.jpg'),\n 'ref_image' => File::fromPath('ref_image.jpg'),\n 'face_match_score_decline_threshold' => 50.0,\n 'rotate_image' => false,\n 'save_api_request' => true,\n 'vendor_data' => 'user-123',\n 'metadata' => ['flow' => 'login'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.face_match.compare(\n user_image: Pathname(\"user_image.jpg\"),\n ref_image: Pathname(\"ref_image.jpg\"),\n face_match_score_decline_threshold: 50.0,\n rotate_image: false,\n save_api_request: true,\n vendor_data: \"user-123\",\n metadata: { flow: \"login\" }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.FaceMatch.CompareAsync(new FaceMatchCompareParams\n{\n UserImage = FileUpload.FromPath(\"user_image.jpg\"),\n RefImage = FileUpload.FromPath(\"ref_image.jpg\"),\n FaceMatchScoreDeclineThreshold = 50.0,\n RotateImage = false,\n SaveApiRequest = true,\n VendorData = \"user-123\",\n Metadata = new Dictionary { [\"flow\"] = \"login\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/age-estimation/": { "post": { "summary": "Оценка возраста (возраст по лицу + пассивная проверка живости)", "description": "Оцените возраст человека по одной фотографии лица и запустите пассивную проверку живости в рамках одного вызова — возвращает спрогнозированный моделью `age_estimation` (в годах), `score` проверки живости (0–100) и `status` со значением `Approved`/`Declined`. Возраст **прогнозируется моделью по лицу, а не верифицируется по документу** — используйте его для ограничений по возрасту и проверок с минимальными препятствиями, но не в качестве юридического подтверждения возраста.\n\n**Как это работает.** Изображение анализируется на наличие лиц (установите `rotate_image=true`, если снимки могут быть повернуты набок или перевернуты); для каждого обнаруженного лица оценивается возраст, а `age_estimation` определяется по самому крупному лицу в кадре. Параллельно модель пассивной проверки живости оценивает, изображен ли на фотографии живой человек (без необходимости выполнять действия пользователем), и выявляет атаки предъявления (фотографии фотографий, экраны, маски). Для достижения наилучших результатов отправляйте изображение с одним четким, хорошо освещенным лицом анфас.\n\n**Логика принятия решений.** Любое предупреждение приводит к отклонению: `status` получает значение `Approved` только в том случае, если массив `warnings` пуст. Если `score` проверки живости не превышает значение `face_liveness_score_decline_threshold` (по умолчанию `30`), добавляется `LOW_LIVENESS_SCORE`; при обнаружении атаки добавляется `LIVENESS_FACE_ATTACK`; если модель проверки живости не нашла лицо, добавляется `NO_FACE_DETECTED`; если возраст лица невозможно оценить, добавляется `AGE_NOT_DETECTED` (`age_estimation` равен `null`); если оценочный возраст ниже `age_estimation_decline_threshold` (по умолчанию `18`), добавляется `AGE_BELOW_MINIMUM`. Для пограничных значений возраста вблизи вашего порога рекомендуется предусмотреть резервную верификацию по документам — погрешность модели возрастает для лиц, чей возраст близок к лимиту.\n\n**Биллинг.** Каждый ответ `200` расходует один кредит API «Оценка возраста» (списывается из кредитов вашего тарифа или баланса пополнения). Если баланс организации не может покрыть вызов, endpoint возвращает `403` с ошибкой недостаточного количества кредитов еще до обработки изображения.\n\n**Сохранение сессии (`save_api_request`, по умолчанию `true`).** Если указано `true`, вызов сохраняется как сессия типа API: она отображается в Business Console, возвращаемый `request_id` представляет собой реальный id сессии, который вы можете передать в `GET /v3/session/{sessionId}/decision/` (результат доступен там в `liveness_checks[]` с `features: [\"AGE_ESTIMATION\"]`), кроп лица и эталонное изображение сохраняются, эмбеддинг лица добавляется в индекс лиц вашего приложения (используемый для поиска по лицу и обнаружения дубликатов), а также отправляется webhook `status.updated`. Если указано `false`, ничего не сохраняется, а `request_id` представляет собой одноразовый UUID корреляции, который нельзя запросить позже.\n\n**Песочница.** API-ключи песочницы пропускают всю обработку и биллинг: после валидации запроса (некорректный ввод по-прежнему возвращает `400`) endpoint возвращает статический тестовый payload со статусом `Approved` (`age_estimation: 30`, без предупреждений), сессия не сохраняется, и кредиты не расходуются.\n\n**Аутентификация.** Передавайте API-ключ вашего приложения в заголовке `x-api-key`. При отсутствии или недействительности учетных данных возвращается `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`) — этот API никогда не возвращает `401`.\n\n**Лимит запросов.** Общий лимит на запись составляет 300 запросов/мин на один API-ключ для всех endpoint'ов POST/PATCH/DELETE; при его превышении возвращается `429`.", "operationId": "post_v3age-estimation", "x-didit-sdk": { "resource": "age_estimation", "method": "estimate", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "parameters": [], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "user_image" ], "properties": { "user_image": { "type": "string", "format": "binary", "description": "Фотография лица для анализа (например, селфи). Отправьте одну фотографию анфас с четко различимым и хорошо освещенным лицом субъекта. Допустимые расширения: `tiff`, `jpg`, `jpeg`, `png`, `webp` (кроме PDF). Максимальный размер загрузки: **5 MB** (файлы большего размера отклоняются с кодом `400`). Изображения автоматически сжимаются примерно до ~0.3 MB перед обработкой, поэтому сверхвысокое разрешение не повышает точность." }, "face_liveness_score_decline_threshold": { "type": "number", "format": "float", "default": 30, "minimum": 0, "maximum": 100, "description": "Порог проверки живости (0–100). Оценка `score` проверки живости **на уровне или ниже** этого значения добавляет предупреждение `LOW_LIVENESS_SCORE` и отклоняет сессию. Увеличьте его для более строгой защиты от спуфинга; значения вне диапазона 0–100 возвращают `400`.", "example": 30 }, "age_estimation_decline_threshold": { "type": "integer", "default": 18, "minimum": 0, "maximum": 100, "description": "Минимально допустимый оценочный возраст в годах. Оценочный возраст **ниже** этого значения добавляет предупреждение `AGE_BELOW_MINIMUM` и отклоняет сессию. Укажите `0`, чтобы отключить проверку возраста (в этом случае вызов выполняет только проверку живости + оценку возраста без принятия решения на основе возраста).", "example": 18 }, "rotate_image": { "type": "boolean", "default": false, "description": "Когда `true`, сервис поворачивает входное изображение с шагом 90 градусов (0, 90, 180, 270) и использует ориентацию, обеспечивающую наилучшее обнаружение лица — полезно для мобильных снимков с отсутствующей ориентацией EXIF. Увеличивает задержку, поэтому включайте только в том случае, если вы не можете гарантировать правильную ориентацию изображений.", "example": false }, "save_api_request": { "type": "boolean", "default": true, "description": "Если `true` (по умолчанию), сохраняет вызов как сессию типа API — видимую в Business Console, доступную через `GET /v3/session/{sessionId}/decision/` по возвращенному `request_id`, анонсируемую через webhook `status.updated`, с добавлением обнаруженного лица в индекс лиц вашего приложения. Если `false`, ничего не сохраняется, а `request_id` является временным UUID только для сопоставления ответа.", "example": true }, "vendor_data": { "type": "string", "description": "Необязательная непрозрачная строка (ваш внутренний идентификатор пользователя, email, UUID…), сохраняемая в сессии и возвращаемая в ответе. Используйте её для сопоставления вызовов API с вашими собственными записями и для последующей фильтрации сессий.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Необязательный объект JSON, сохраняемый вместе с сессией (когда `save_api_request=true`) и возвращаемый обратно в ответе. В multipart-запросах отправляйте его как строковое поле в формате JSON (например, `metadata={\"flow\":\"age-gate\"}`) — он парсится в объект.", "example": { "flow": "age-gate" } } } }, "example": { "user_image": "(binary JPEG/PNG of the selfie)", "face_liveness_score_decline_threshold": 30, "age_estimation_decline_threshold": 18, "rotate_image": false, "save_api_request": true, "vendor_data": "user-123", "metadata": { "flow": "age-gate" } } } } }, "responses": { "200": { "description": "Оценка возраста и пассивная проверка живости завершены. Поле `age_estimation.age_estimation` содержит предсказанный моделью возраст в годах для самого крупного обнаруженного лица (`null`, если лиц не обнаружено); `age_estimation.score` является оценкой пассивной проверки живости (0–100); `status` имеет значение `Approved`, только если `warnings` пуст. Снимок несовершеннолетнего пользователя или попытка спуфинга по-прежнему возвращают `200` со статусом `status: \"Declined\"`: проверяйте тело ответа, а не только HTTP-код. При `save_api_request=true` значение `request_id` является сохраненным id сессии.", "content": { "application/json": { "examples": { "Approved": { "summary": "Живое лицо совершеннолетнего — обе проверки пройдены", "value": { "request_id": "0c40ba43-64ab-4e2e-b4b8-7d1f12f81bc1", "age_estimation": { "status": "Approved", "method": "PASSIVE", "score": 97.5, "user_image": { "entities": [ { "age": 27.33, "bbox": [ 40, 40, 100, 100 ], "confidence": 0.7177750468254089, "gender": "male" } ], "best_angle": 0 }, "age_estimation": 27.33, "warnings": [] }, "vendor_data": "user-123", "metadata": { "flow": "age-gate" }, "created_at": "2026-06-12T02:24:11.512941+00:00" } }, "Declined - age below threshold": { "summary": "Оценочный возраст ниже `age_estimation_decline_threshold`", "value": { "request_id": "9be41a6f-2f4e-4f57-92f4-b3a4f6f0a1c2", "age_estimation": { "status": "Declined", "method": "PASSIVE", "score": 95.0, "user_image": { "entities": [ { "age": 16.5, "bbox": [ 40, 40, 100, 100 ], "confidence": 0.7177750468254089, "gender": "female" } ], "best_angle": 0 }, "age_estimation": 16.5, "warnings": [ { "risk": "AGE_BELOW_MINIMUM", "feature": "LIVENESS", "additional_data": null, "log_type": "error", "short_description": "Age below minimum", "long_description": "The age of the face is below the minimum age threshold for the application." } ] }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T02:26:40.118332+00:00" } }, "Declined - liveness too low": { "summary": "Оценка проверки живости на уровне или ниже порога отклонения (возможен спуфинг)", "value": { "request_id": "5f6f2f1f-7c4f-43b9-8d62-0a8f4c2d9e77", "age_estimation": { "status": "Declined", "method": "PASSIVE", "score": 5.0, "user_image": { "entities": [ { "age": 25.0, "bbox": [ 40, 40, 100, 100 ], "confidence": 0.7177750468254089, "gender": "male" } ], "best_angle": 0 }, "age_estimation": 25.0, "warnings": [ { "risk": "LOW_LIVENESS_SCORE", "feature": "LIVENESS", "additional_data": null, "log_type": "error", "short_description": "Low liveness score", "long_description": "The liveness check resulted in a low score, indicating potential use of non-live facial representations or poor-quality biometric data." } ] }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T02:27:02.901547+00:00" } } }, "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Идентификатор сохраненной сессии при `save_api_request=true` (доступен для использования с `GET /v3/session/{sessionId}/decision/`); в противном случае это временный корреляционный UUID." }, "age_estimation": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined" ], "description": "`Approved`, если не возникло никаких предупреждений; в противном случае `Declined` (каждое предупреждение, формируемое этим endpoint, приводит к отклонению)." }, "method": { "type": "string", "enum": [ "PASSIVE" ], "description": "Метод проверки живости. Всегда `PASSIVE` для этого endpoint (одно изображение, без задания пользователю)." }, "score": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Оценка пассивной проверки живости от 0 до 100 — уверенность модели в том, что на фотографии живой человек. Сравнивается с `face_liveness_score_decline_threshold`; при значении на уровне порога или ниже вызов отклоняется с `LOW_LIVENESS_SCORE`. Принимает значение `null`, если модель проверки живости не возвращает оценку уверенности — вызов всё равно отклоняется с `LOW_LIVENESS_SCORE`, поскольку для сравнения с порогом null считается равным 0.", "example": 97.5 }, "user_image": { "type": "object", "description": "Результаты обнаружения лица для проанализированного изображения.", "properties": { "entities": { "type": "array", "description": "Одна запись на каждое обнаруженное лицо. Пусто, если лицо не найдено (в этом случае `age_estimation` имеет значение `null` и добавляется предупреждение `AGE_NOT_DETECTED`).", "items": { "type": "object", "properties": { "age": { "type": "number", "format": "float", "description": "Возраст этого лица в годах, оцененный моделью.", "example": 27.33 }, "bbox": { "type": "array", "items": { "type": "integer" }, "minItems": 4, "maxItems": 4, "description": "Ограничивающий прямоугольник обнаруженного лица в координатах пикселей `[x_min, y_min, x_max, y_max]` на обработанном изображении.", "example": [ 40, 40, 100, 100 ] }, "confidence": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Уверенность обнаружения лица (0–1).", "example": 0.7177750468254089 }, "gender": { "type": "string", "description": "Пол обнаруженного лица, спрогнозированный моделью (`male` или `female`). Только для справки.", "example": "male" } } } }, "best_angle": { "type": "integer", "nullable": true, "description": "Поворот (в градусах: 0, 90, 180 или 270), при котором было достигнуто наилучшее обнаружение лица. Отличен от нуля, только если `rotate_image=true` скорректировал ориентацию.", "example": 0 } } }, "age_estimation": { "type": "number", "format": "float", "nullable": true, "description": "Возраст в годах **самого крупного** обнаруженного лица, спрогнозированный моделью. `null`, если возраст лица не удалось оценить (добавляется предупреждение `AGE_NOT_DETECTED`, и вызов отклоняется).", "example": 27.33 }, "warnings": { "type": "array", "description": "Пусто при чистом одобрении. Любая запись устанавливает для `status` значение `Declined`.", "items": { "type": "object", "properties": { "risk": { "type": "string", "enum": [ "NO_FACE_DETECTED", "LOW_LIVENESS_SCORE", "LIVENESS_FACE_ATTACK", "AGE_NOT_DETECTED", "AGE_BELOW_MINIMUM" ], "description": "Машиночитаемый код риска. `NO_FACE_DETECTED` — модель проверки живости не обнаружила лицо; `LOW_LIVENESS_SCORE` — `score` живости равен или ниже `face_liveness_score_decline_threshold`; `LIVENESS_FACE_ATTACK` — обнаружена атака предъявления (фото/экран/маска); `AGE_NOT_DETECTED` — не удалось оценить возраст лица; `AGE_BELOW_MINIMUM` — оценённый возраст ниже `age_estimation_decline_threshold`. `NO_FACE_DETECTED` и `LOW_LIVENESS_SCORE` взаимоисключают друг друга — если лицо не найдено, возвращается только `NO_FACE_DETECTED`." }, "feature": { "type": "string", "enum": [ "LIVENESS" ], "description": "Функция, вызвавшая предупреждение. На этом endpoint всегда `LIVENESS`." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Всегда `null` для предупреждений оценки возраста." }, "log_type": { "type": "string", "enum": [ "error" ], "description": "Уровень серьёзности. Каждое предупреждение, формируемое этим endpoint, является `error` и устанавливает `status` в `Declined`." }, "short_description": { "type": "string", "description": "Краткая сводка риска в одну строку в понятном человеку формате." }, "long_description": { "type": "string", "description": "Понятное объяснение риска." } } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Эхо-значение переданного вами `vendor_data` или `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Эхо-значение переданного вами объекта `metadata` или `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Временная метка ISO 8601 (UTC) момента генерации ответа." } } } } } }, "400": { "description": "Ошибка валидации. Возвращается, если `user_image` отсутствует, превышает 5 МБ, имеет неподдерживаемое расширение или если порог выходит за допустимые пределы. Тело ответа представляет собой стандартную обёртку ошибок полей DRF: один массив сообщений на каждое некорректное поле.", "content": { "application/json": { "examples": { "Missing user image": { "summary": "`user_image` не включён в данные формы", "value": { "user_image": [ "No file was submitted." ] } }, "Unsupported file extension": { "summary": "Расширение файла отличается от tiff/jpg/jpeg/png/webp", "value": { "user_image": [ "File extension “txt” is not allowed. Allowed extensions are: tiff, jpg, jpeg, png, webp." ] } }, "File too large": { "summary": "Размер загружаемого файла превышает лимит в 5 МБ", "value": { "user_image": [ "File size should not exceed 5 MB" ] } }, "Threshold out of range": { "summary": "`face_liveness_score_decline_threshold` вне диапазона 0–100", "value": { "face_liveness_score_decline_threshold": [ "Ensure this value is less than or equal to 100." ] } } } } } }, "403": { "description": "В доступе отказано. Возвращается, если заголовок `x-api-key` отсутствует, а также если баланс вызывающей организации не покрывает вызов; неверный, отозванный или истекший ключ возвращает `401`. Отсутствующий ключ возвращает `403` с `{\"detail\": ...}`; неверный, отозванный или истекший ключ возвращает `401`. При нехватке кредитов возвращается `403` с `{\"error\": ...}` до начала любой обработки изображения.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Отсутствует заголовок `x-api-key`, либо ключ недействителен/отозван", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "Баланс организации недостаточен для совершения вызова", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Превышен лимит запросов. Endpoint'ы POST/PATCH/DELETE делят общий лимит в 300 запросов на запись в минуту на один API-ключ (для создания транзакций и отправки событий действует отдельный лимит в 600). Ответ содержит заголовки `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` и `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Более 300 запросов на запись в текущую минуту", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X POST 'https://verification.didit.me/v3/age-estimation/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'user_image=@./selfie.jpg' \\\n -F 'age_estimation_decline_threshold=18' \\\n -F 'face_liveness_score_decline_threshold=30' \\\n -F 'save_api_request=true' \\\n -F 'vendor_data=user-123'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.age_estimation.estimate(\n user_image=open(\"user_image.jpg\", \"rb\"),\n face_liveness_score_decline_threshold=30.0,\n age_estimation_decline_threshold=18,\n rotate_image=False,\n save_api_request=True,\n vendor_data=\"user-123\",\n metadata={\"flow\": \"age-gate\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.ageEstimation.estimate({\n user_image: await fileFromPath(\"user_image.jpg\"),\n face_liveness_score_decline_threshold: 30.0,\n age_estimation_decline_threshold: 18,\n rotate_image: false,\n save_api_request: true,\n vendor_data: \"user-123\",\n metadata: { flow: \"age-gate\" },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.AgeEstimation.Estimate(ctx, didit.AgeEstimationEstimateParams{\n\tUserImage: didit.FileFromPath(\"user_image.jpg\"),\n\tFaceLivenessScoreDeclineThreshold: didit.Float(30.0),\n\tAgeEstimationDeclineThreshold: didit.Int(18),\n\tRotateImage: didit.Bool(false),\n\tSaveAPIRequest: didit.Bool(true),\n\tVendorData: didit.String(\"user-123\"),\n\tMetadata: didit.Some(map[string]any{\"flow\": \"age-gate\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.AgeEstimationEstimateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.ageEstimation().estimate(AgeEstimationEstimateParams.builder()\n .userImage(Path.of(\"user_image.jpg\"))\n .faceLivenessScoreDeclineThreshold(30.0)\n .ageEstimationDeclineThreshold(18L)\n .rotateImage(false)\n .saveApiRequest(true)\n .vendorData(\"user-123\")\n .metadata(Map.of(\"flow\", \"age-gate\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "ageEstimation->estimate([\n 'user_image' => File::fromPath('user_image.jpg'),\n 'face_liveness_score_decline_threshold' => 30.0,\n 'age_estimation_decline_threshold' => 18,\n 'rotate_image' => false,\n 'save_api_request' => true,\n 'vendor_data' => 'user-123',\n 'metadata' => ['flow' => 'age-gate'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.age_estimation.estimate(\n user_image: Pathname(\"user_image.jpg\"),\n face_liveness_score_decline_threshold: 30.0,\n age_estimation_decline_threshold: 18,\n rotate_image: false,\n save_api_request: true,\n vendor_data: \"user-123\",\n metadata: { flow: \"age-gate\" }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.AgeEstimation.EstimateAsync(new AgeEstimationEstimateParams\n{\n UserImage = FileUpload.FromPath(\"user_image.jpg\"),\n FaceLivenessScoreDeclineThreshold = 30.0,\n AgeEstimationDeclineThreshold = 18,\n RotateImage = false,\n SaveApiRequest = true,\n VendorData = \"user-123\",\n Metadata = new Dictionary { [\"flow\"] = \"age-gate\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/poa/": { "post": { "summary": "Подтверждение адреса (OCR документа + проверки адреса)", "description": "Извлекайте данные и проверяйте документ Подтверждения адреса — счета за коммунальные услуги, банковские выписки и документы, выданные государственными органами — за один вызов. Возвращает эмитента, даты выдачи и срока действия, имя владельца, исходный и разобранный/геокодированный адрес, `status` (`Approved`/`Declined`) и список `warnings` с пояснением каждой обнаруженной проблемы.\n\n**Задержка.** Извлечение выполняется на базе LLM: стандартные вызовы занимают **5–15 секунд**, многостраничные PDF занимают до **~30 секунд**. Настройте клиентский таймаут **минимум на 45 секунд** и не повторяйте запрос до завершения текущего вызова.\n\n**Как это работает.** Документ (изображение или PDF размером до 15 МБ; для зашифрованных PDF требуется `document_password`) классифицируется по типу и подтипу (например, `UTILITY_BILL` / `WATER_BILL`), а эмитент, даты, имя владельца и адрес извлекаются с помощью LLM. Адрес парсится и геокодируется в `poa_parsed_address`. Криминалистический анализ PDF/EXIF проверяет наличие признаков фальсификации (изменений после цифровой подписи, использования известных PDF-редакторов, манипуляций с наложенным текстом, подозрительного повторного экспорта), фиксируя `SUSPECTED_DOCUMENT_MANIPULATION` или `DOCUMENT_METADATA_MISMATCH`. Текстовое поле, которое было очищено и набрано заново другим шрифтом, если сам файл не содержит подтверждения изменения содержимого, вызывает `POA_DOCUMENT_UNPROVEN_TEXT_REPLACEMENT`. Возраст документа проверяется по параметру `poa_document_age_months`, а язык — по `poa_languages_allowed`. Если вы передаете `expected_address`, `expected_country` или `expected_first_name`/`expected_last_name`, извлеченные значения перекрестно проверяются, а несоответствия отмечаются.\n\n**Логика принятия решений.** `status` имеет значение `Approved`, если ни одно предупреждение не приводит к отклонению. Критические ошибки всегда приводят к отклонению: `MISSING_ADDRESS_INFORMATION`, `POA_DOCUMENT_EXPIRED`, `INVALID_DOCUMENT_TYPE`, `UNABLE_TO_VALIDATE_DOCUMENT_AGE`, а также `UNABLE_TO_EXTRACT_ISSUE_DATE` и `POA_NAME_NOT_DETECTED` (не настраиваются на этом endpoint). Пять групп риска можно настраивать для каждого запроса с помощью параметров `poa_*_action` (`DECLINE` или `NO_ACTION`, по умолчанию везде `DECLINE`). Предупреждения `POA_DOCUMENT_NOT_SUPPORTED_FOR_APPLICATION` и `UNPARSABLE_OR_INVALID_ADDRESS` на этом endpoint носят исключительно информационный характер и никогда не приводят к отклонению. Документ, который вообще невозможно обработать, возвращает `400`; читаемый, но проблемный документ возвращает `200` со значением `status: \"Declined\"` — всегда проверяйте `poa.status` и `poa.warnings`, а не только HTTP-код.\n\n**Биллинг.** Каждый ответ `200` расходует один API-кредит функции «Подтверждение адреса» (списывается из кредитов тарифа или баланса пополнения). Если баланс организации не покрывает стоимость вызова, endpoint возвращает `403` с ошибкой нехватки кредитов до начала обработки документа.\n\n**Сохранение сессии (`save_api_request`, по умолчанию `true`).** При значении `true` вызов сохраняется как сессия с типом API: она отображается в Business Console, загруженный документ сохраняется, возвращенный `request_id` является реальным id сессии, который можно передать в `GET /v3/session/{sessionId}/decision/` (в решении дополнительно возвращаются `document_file` и криминалистические данные `document_metadata`, которые опущены в данном ответе), и отправляется webhook `status.updated`. При значении `false` ничего не сохраняется, а `request_id` представляет собой одноразовый UUID для корреляции, который нельзя запросить позже.\n\n**Песочница.** API-ключи песочницы не запускают обработку и биллинг: после валидации запроса (некорректный ввод по-прежнему возвращает `400`) endpoint возвращает статический тестовый payload со статусом `Approved` (вымышленный счет за электричество от «Sandbox Power Co.»), сессия не сохраняется, а кредиты не списываются.\n\n**Аутентификация.** Передавайте API-ключ вашего приложения в заголовке `x-api-key`. При отсутствии или недействительности учетных данных возвращается `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`) — этот API никогда не возвращает `401`.\n\n**Лимит запросов.** Общий лимит на запись составляет 300 запросов в минуту на один API-ключ для всех endpoint POST/PATCH/DELETE; при его превышении возвращается `429`.\n\nПримечание: `FUTURE_ISSUE_DATE` и `POOR_DOCUMENT_QUALITY` существуют в сессиях сценариев, но никогда не генерируются этим отдельным endpoint; документ с будущей датой здесь не отклоняется автоматически.", "operationId": "post_v3poa", "x-didit-sdk": { "resource": "proof_of_address", "method": "verify", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "parameters": [], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "document" ], "properties": { "document": { "type": "string", "format": "binary", "description": "Документ «Подтверждение адреса». Допустимые расширения: `tiff`, `jpg`, `jpeg`, `png`, `pdf`, `webp`. Максимальный размер загружаемого файла: **15 MB** (файлы большего размера отклоняются с ошибкой `400`). Поддерживаются многостраничные PDF (ожидается более высокая задержка); для зашифрованных PDF требуется `document_password`. Изображения автоматически сжимаются перед обработкой." }, "document_password": { "type": "string", "description": "Пароль для расшифровки `document`, если это зашифрованный PDF-файл. Передача зашифрованного PDF без пароля (или с неверным паролем) возвращает `400`.", "writeOnly": true }, "expected_address": { "type": "string", "description": "Адрес для сверки с документом. Он геокодируется и сравнивается с извлечённым адресом; несоответствие (или ожидаемый адрес, который не удаётся геокодировать/проверить) добавляет `ADDRESS_MISMATCH_WITH_PROVIDED`, управляемое `poa_address_mismatch_action`. Геокодированная форма возвращается в `expected_details_formatted_address` / `expected_details_parsed_address`.", "example": "Av. Monseñor Tavella 1291, Salta, Argentina" }, "expected_country": { "type": "string", "description": "Страна для сверки с документом (код ISO 3166-1, например `ARG` или `AR`). Несовпадение со страной документа добавляет `POA_COUNTRY_MISMATCH_WITH_PROVIDED`, регулируемое `poa_address_mismatch_action`.", "example": "ARG" }, "expected_first_name": { "type": "string", "description": "Имя для сверки с `name_on_document` (нечёткое сравнение с учётом транслитерации). Оценка ниже порога совпадения добавляет `NAME_MISMATCH_WITH_PROVIDED`, регулируемый параметром `poa_address_mismatch_action`.", "example": "Sophia" }, "expected_last_name": { "type": "string", "description": "Фамилия для сверки с `name_on_document`, объединяемая с `expected_first_name` для расчёта оценки совпадения.", "example": "Martinez" }, "poa_languages_allowed": { "type": "string", "description": "Разделённый запятыми список принимаемых языков документов в виде кодов ISO 639-1 (например, `en,es,fr`). Если параметр опущен или пуст, принимаются **все 51 поддерживаемый язык**. Документ на языке вне этого списка добавляет `UNSUPPORTED_DOCUMENT_LANGUAGE` (регулируется параметром `poa_unsupported_language_action`); неизвестный код в списке возвращает `400` с полным набором поддерживаемых кодов.", "example": "en,es" }, "poa_document_age_months": { "type": "string", "description": "Разделённые запятыми пары `key:value`, задающие максимальный возраст документа в месяцах для каждого типа документа — ключи: `utility_bill`, `bank_statement`, `government_issued_document`, `other_poa_document`; значения: `1`–`120` или `-1` для неограниченного срока (без проверки возраста). Значения по умолчанию, если параметр опущен: `utility_bill:3,bank_statement:3,government_issued_document:12,other_poa_document:12`. Документ старше установленного лимита отклоняется с `POA_DOCUMENT_EXPIRED`. **Внимание:** если вы передаёте это поле, укажите *каждый* принимаемый вами тип — пропущенные типы считаются неприемлемыми (информационный статус `POA_DOCUMENT_NOT_SUPPORTED_FOR_APPLICATION`), а проверка их возраста пропускается.", "example": "utility_bill:3,bank_statement:6" }, "poa_name_mismatch_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Принимается, но **в настоящее время не применяется** — предупреждения о несоответствии имени (`NAME_MISMATCH_WITH_PROVIDED`) вместо этого регулируются параметром `poa_address_mismatch_action`. Задайте `poa_address_mismatch_action`, чтобы управлять поведением при несоответствии как имени, так и адреса." }, "poa_document_issues_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Действие при проблемах с целостностью файла — на практике этот endpoint генерирует только `DOCUMENT_METADATA_MISMATCH`." }, "poa_document_authenticity_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Действие при подозрении на манипуляцию с документом (`SUSPECTED_DOCUMENT_MANIPULATION`) — например, PDF был изменён после цифровой подписи, обработан известным PDF-редактором, имеет признаки манипуляций с наложением текста или содержит несогласованные даты EXIF. Также управляет `POA_DOCUMENT_UNPROVEN_TEXT_REPLACEMENT` (повторно набранное текстовое поле, изменение которого невозможно подтвердить или опровергнуть): при `DECLINE` оно также отклоняется, при `NO_ACTION` остаётся предупреждением." }, "poa_unsupported_language_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Что делать, если язык документа не входит в `poa_languages_allowed` (`UNSUPPORTED_DOCUMENT_LANGUAGE`)." }, "poa_address_mismatch_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Что делать, если извлеченные данные не совпадают с полями `expected_*`: предупреждения `ADDRESS_MISMATCH_WITH_PROVIDED`, `NAME_MISMATCH_WITH_PROVIDED` и `POA_COUNTRY_MISMATCH_WITH_PROVIDED` следуют этому действию." }, "poa_issuer_not_identified_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Действие, если в документе не удаётся определить выдавшую компанию/организацию (`ISSUER_NOT_IDENTIFIED`)." }, "save_api_request": { "type": "boolean", "default": true, "description": "Если `true` (по умолчанию), сохраняет вызов как сессию типа API — видимую в Business Console, доступную через `GET /v3/session/{sessionId}/decision/` по возвращенному `request_id`, анонсируемую через webhook `status.updated`, с сохранением загруженного документа. Если `false`, ничего не сохраняется, а `request_id` является временным UUID только для сопоставления ответа.", "example": true }, "vendor_data": { "type": "string", "description": "Необязательная непрозрачная строка (ваш внутренний идентификатор пользователя, email, UUID…), сохраняемая в сессии и возвращаемая в ответе. Используйте её для сопоставления вызовов API с вашими собственными записями и для последующей фильтрации сессий.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Необязательный объект JSON, сохраняемый вместе с сессией (когда `save_api_request=true`) и возвращаемый обратно в ответе. В multipart-запросах отправляйте его как строковое поле в формате JSON (например, `metadata={\"flow\":\"onboarding\"}`) — он парсится в объект.", "example": { "flow": "onboarding" } } } }, "example": { "document": "(binary JPEG/PNG/PDF of the utility bill or bank statement)", "expected_address": "Av. Monseñor Tavella 1291, Salta, Argentina", "expected_country": "ARG", "expected_first_name": "Sophia", "expected_last_name": "Martinez", "poa_languages_allowed": "en,es", "save_api_request": true, "vendor_data": "user-123" } } } }, "responses": { "200": { "description": "Документ обработан. Значение `poa.status`: `Approved` или `Declined`; каждая обнаруженная проблема детализирована в `poa.warnings`. Для истёкшего, несовпадающего или подозрительного документа по-прежнему возвращается `200` со статусом `status: \"Declined\"` — проверяйте тело ответа, а не только HTTP-код. Если `save_api_request=true`, `request_id` представляет собой сохранённый id сессии.", "content": { "application/json": { "examples": { "Approved": { "summary": "Квитанция за коммунальные услуги успешно распознана, без проверок ожидаемых реквизитов", "value": { "request_id": "4b523a8d-ed32-45e4-8aa8-a89eda459d88", "poa": { "issuing_state": "ARG", "document_type": "UTILITY_BILL", "document_subtype": "WATER_BILL", "document_language": "es", "issuer": "Aguas del Norte", "issue_date": "2026-04-10", "expiration_date": null, "poa_address": "AVDA. MONSEÑOR TAVELLA N° 1291, B° VILLA LAVALLE CP: 4400, CAPITAL - SALTA", "poa_formatted_address": "Av. Monseñor Tavella 1291 b, A4400 Salta, Argentina", "poa_parsed_address": { "street_1": "Avenida Monseñor Tavella 1291", "street_2": "b", "city": "Salta", "region": "Salta", "country": "AR", "postal_code": "A4400", "document_location": { "latitude": -24.8208682, "longitude": -65.4130954 } }, "expected_details_address": null, "expected_details_formatted_address": null, "expected_details_parsed_address": null, "name_on_document": "OESTE EMBOTELLADORA S.A.", "extra_fields": { "bank_account_number": null, "bank_iban": null, "bank_sort_code": null, "bank_routing_number": null, "bank_swift_bic": null, "bank_branch_name": null, "bank_branch_address": null, "document_phone_number": null, "additional_names": [ "LA EMBOTELLADORA DEL NORTE SA" ] }, "detected_codes": [ { "type": "QR_CODE", "page_number": 1, "position": [ [ 820, 1120 ], [ 1002, 1120 ], [ 1002, 1302 ], [ 820, 1302 ] ], "x": 820, "y": 1120, "width": 182, "height": 182, "page_width": 1190, "page_height": 1684, "raw_payload": "aHR0cHM6Ly9hZ3Vhc2RlbG5vcnRlLmNvbS9mYWN0dXJhLzk5ODgxMQ==", "parsed_payload": "https://aguasdelnorte.com/factura/998811" }, { "type": "CODE_128", "page_number": 1, "position": [ [ 112, 1480 ], [ 560, 1480 ], [ 560, 1540 ], [ 112, 1540 ] ], "x": 112, "y": 1480, "width": 448, "height": 60, "page_width": 1190, "page_height": 1684, "raw_payload": "MDA5OTg4MTEwMDA0Mg==", "parsed_payload": "0099881100042" } ], "status": "Approved", "warnings": [] }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T02:29:02.439655+00:00" } }, "Declined - document too old": { "summary": "Дата выдачи старше допустимого значения `poa_document_age_months`", "value": { "request_id": "f61681b8-9422-4378-ac3e-04c6a247fb45", "poa": { "issuing_state": "ARG", "document_type": "UTILITY_BILL", "document_subtype": "WATER_BILL", "document_language": "es", "issuer": "Aguas del Norte", "issue_date": "2021-02-10", "expiration_date": null, "poa_address": "AVDA. MONSEÑOR TAVELLA N° 1291, B° VILLA LAVALLE CP: 4400, CAPITAL - SALTA", "poa_formatted_address": "Av. Monseñor Tavella 1291 b, A4400 Salta, Argentina", "poa_parsed_address": { "street_1": "Avenida Monseñor Tavella 1291", "street_2": "b", "city": "Salta", "region": "Salta", "country": "AR", "postal_code": "A4400", "document_location": { "latitude": -24.8208682, "longitude": -65.4130954 } }, "expected_details_address": null, "expected_details_formatted_address": null, "expected_details_parsed_address": null, "name_on_document": "OESTE EMBOTELLADORA S.A.", "extra_fields": { "bank_account_number": null, "bank_iban": null, "bank_sort_code": null, "bank_routing_number": null, "bank_swift_bic": null, "bank_branch_name": null, "bank_branch_address": null, "document_phone_number": null, "additional_names": [ "LA EMBOTELLADORA DEL NORTE SA" ] }, "status": "Declined", "warnings": [ { "risk": "POA_DOCUMENT_EXPIRED", "feature": "PROOF_OF_ADDRESS", "additional_data": { "expiration_reason": "age_window", "max_age_months": 3, "document_subtype": "WATER_BILL", "document_type": "UTILITY_BILL", "issue_date": "2021-02-10" }, "log_type": "error", "short_description": "Document expired", "long_description": "The submitted document is older than the maximum accepted age of 3 months from its issue date, which exceeds the acceptable time period for validity." } ] }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T02:23:02.165493+00:00" } }, "Declined - name mismatch": { "summary": "`expected_first_name`/`expected_last_name` не совпадают с `name_on_document`", "value": { "request_id": "0a7f2f9c-58f1-4b8e-b1e3-2f6f9d4f7a21", "poa": { "issuing_state": "ARG", "document_type": "UTILITY_BILL", "document_subtype": "WATER_BILL", "document_language": "es", "issuer": "Aguas del Norte", "issue_date": "2021-02-10", "expiration_date": null, "poa_address": "AVDA. MONSEÑOR TAVELLA N° 1291, B° VILLA LAVALLE CP: 4400, CAPITAL - SALTA", "poa_formatted_address": "Av. Monseñor Tavella 1291 b, A4400 Salta, Argentina", "poa_parsed_address": { "street_1": "Avenida Monseñor Tavella 1291", "street_2": "b", "city": "Salta", "region": "Salta", "country": "AR", "postal_code": "A4400", "document_location": { "latitude": -24.8208682, "longitude": -65.4130954 } }, "expected_details_address": null, "expected_details_formatted_address": null, "expected_details_parsed_address": null, "name_on_document": "OESTE EMBOTELLADORA S.A.", "extra_fields": { "bank_account_number": null, "bank_iban": null, "bank_sort_code": null, "bank_routing_number": null, "bank_swift_bic": null, "bank_branch_name": null, "bank_branch_address": null, "document_phone_number": null, "additional_names": [ "LA EMBOTELLADORA DEL NORTE SA" ] }, "status": "Declined", "warnings": [ { "risk": "NAME_MISMATCH_WITH_PROVIDED", "feature": "PROOF_OF_ADDRESS", "additional_data": null, "log_type": "error", "short_description": "Name mismatch with provided information", "long_description": "The full name on the document does not match the name from the user's verified identity documents, or the full name sent by API." } ] }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T02:27:21.330172+00:00" } } }, "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Идентификатор сохраненной сессии при `save_api_request=true` (доступен для использования с `GET /v3/session/{sessionId}/decision/`); в противном случае это временный корреляционный UUID." }, "poa": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined" ], "description": "`Approved`, если ни одно предупреждение не приводит к отклонению; в противном случае `Declined` — список `warnings` поясняет причину." }, "issuing_state": { "type": "string", "nullable": true, "description": "Страна выдачи документа, извлечённая из него, — обычно ISO 3166-1 alpha-3 (например, `ARG`).", "example": "ARG" }, "document_type": { "type": "string", "enum": [ "UTILITY_BILL", "BANK_STATEMENT", "GOVERNMENT_ISSUED_DOCUMENT", "OTHER_POA_DOCUMENT", "UNKNOWN" ], "description": "Обнаруженная категория документа. Значение `UNKNOWN` означает, что документ не удалось классифицировать как допустимое Подтверждение адреса, и он автоматически отклоняется со статусом `INVALID_DOCUMENT_TYPE`. Никогда не бывает null — при ошибках классификации возвращается `UNKNOWN`." }, "document_subtype": { "type": "string", "description": "Более детальная классификация внутри `document_type` — например, `ELECTRICITY_BILL`, `WATER_BILL`, `GAS_BILL`, `INTERNET_BILL`, `PHONE_BILL` (коммунальные счета); `ACCOUNT_STATEMENT`, `CREDIT_CARD_STATEMENT` (банковские выписки); `TAX_ASSESSMENT`, `RESIDENCY_CERTIFICATE` (государственные документы). `UNKNOWN`, если подтип определить не удалось. Никогда не бывает null — при ошибках классификации возвращается `UNKNOWN`.", "example": "WATER_BILL" }, "document_language": { "type": "string", "nullable": true, "description": "Обнаруженный язык документа (ISO 639-1).", "example": "es" }, "issuer": { "type": "string", "nullable": true, "description": "Компания или организация, выдавшая документ. `null` добавляет `ISSUER_NOT_IDENTIFIED`.", "example": "Aguas del Norte" }, "issue_date": { "type": "string", "format": "date", "nullable": true, "description": "Дата выдачи документа (`YYYY-MM-DD`). `null`, если её не удалось извлечь — на этом endpoint возвращается отклонение с `UNABLE_TO_EXTRACT_ISSUE_DATE`.", "example": "2021-02-10" }, "expiration_date": { "type": "string", "format": "date", "nullable": true, "description": "Явный срок действия / дата окончания действия, напечатанные на документе, при наличии. Не зависит от проверки давности `poa_document_age_months`." }, "poa_address": { "type": "string", "nullable": true, "description": "Адрес в точности так, как напечатан на документе. При `null` автоматически отклоняется с `MISSING_ADDRESS_INFORMATION`." }, "poa_formatted_address": { "type": "string", "nullable": true, "description": "Геокодированная нормализованная версия `poa_address`.", "example": "Av. Monseñor Tavella 1291 b, A4400 Salta, Argentina" }, "poa_parsed_address": { "type": "object", "nullable": true, "description": "Структурированная геокодированная детализация адреса из документа. `null`, если адрес не удалось распознать.", "properties": { "street_1": { "type": "string", "nullable": true, "example": "Avenida Monseñor Tavella 1291" }, "street_2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true, "example": "Salta" }, "region": { "type": "string", "nullable": true, "example": "Salta" }, "country": { "type": "string", "nullable": true, "description": "Двухбуквенный код страны ISO 3166-1 alpha-2.", "example": "AR" }, "postal_code": { "type": "string", "nullable": true, "example": "A4400" }, "document_location": { "type": "object", "nullable": true, "properties": { "latitude": { "type": "number" }, "longitude": { "type": "number" } }, "description": "Геокодированные координаты адреса из документа." } } }, "expected_details_address": { "type": "string", "nullable": true, "description": "Эхо-значение переданного вами `expected_address` или `null`." }, "expected_details_formatted_address": { "type": "string", "nullable": true, "description": "Геокодированная нормализованная версия `expected_address`; `null`, если не указан или не поддаётся геокодированию." }, "expected_details_parsed_address": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Полный результат геокодирования для `expected_address` (улица/город/регион/страна/почтовый индекс плюс исходные данные геокодера и флаг `is_verified`). `null`, если `expected_address` не был указан." }, "name_on_document": { "type": "string", "nullable": true, "description": "Основное имя владельца, извлечённое из документа; сравнивается с `expected_first_name`/`expected_last_name`, если они указаны. При `null` данный endpoint отклоняет запрос с `POA_NAME_NOT_DETECTED`.", "example": "OESTE EMBOTELLADORA S.A." }, "extra_fields": { "type": "object", "description": "Специфичные для документа дополнительные поля. Поля банков заполняются для банковских выписок, если они напечатаны на документе; в противном случае `null`.", "properties": { "bank_account_number": { "type": "string", "nullable": true }, "bank_iban": { "type": "string", "nullable": true }, "bank_sort_code": { "type": "string", "nullable": true }, "bank_routing_number": { "type": "string", "nullable": true }, "bank_swift_bic": { "type": "string", "nullable": true }, "bank_branch_name": { "type": "string", "nullable": true }, "bank_branch_address": { "type": "string", "nullable": true }, "document_phone_number": { "type": "string", "nullable": true, "description": "Контактный номер телефона, напечатанный на документе." }, "additional_names": { "type": "array", "items": { "type": "string" }, "description": "Другие имена владельцев, найденные в документе (например, совладельцы счета, предыдущие названия счета)." } } }, "warnings": { "type": "array", "description": "Пусто при чистом одобрении. Каждая запись описывает один обнаруженный риск; записи с `log_type: \"error\"` устанавливают для `status` значение `Declined`.", "items": { "type": "object", "properties": { "risk": { "type": "string", "description": "Машиночитаемый код риска. Всегда приводят к отклонению: `MISSING_ADDRESS_INFORMATION`, `POA_DOCUMENT_EXPIRED`, `INVALID_DOCUMENT_TYPE`, `UNABLE_TO_VALIDATE_DOCUMENT_AGE`, а также `UNABLE_TO_EXTRACT_ISSUE_DATE` и `POA_NAME_NOT_DETECTED` (фиксированно отклоняются на этом endpoint). Регулируются параметрами запроса: `NAME_MISMATCH_WITH_PROVIDED` / `ADDRESS_MISMATCH_WITH_PROVIDED` / `POA_COUNTRY_MISMATCH_WITH_PROVIDED` (`poa_address_mismatch_action`), `POOR_DOCUMENT_QUALITY` (никогда не возвращается этим endpoint) / `DOCUMENT_METADATA_MISMATCH` (`poa_document_issues_action`), `SUSPECTED_DOCUMENT_MANIPULATION` и `POA_DOCUMENT_UNPROVEN_TEXT_REPLACEMENT` (`poa_document_authenticity_action`), `UNSUPPORTED_DOCUMENT_LANGUAGE` (`poa_unsupported_language_action`), `ISSUER_NOT_IDENTIFIED` (`poa_issuer_not_identified_action`). Информационные на этом endpoint: `POA_DOCUMENT_NOT_SUPPORTED_FOR_APPLICATION`, `UNPARSABLE_OR_INVALID_ADDRESS`.", "example": "POA_DOCUMENT_EXPIRED" }, "feature": { "type": "string", "enum": [ "PROOF_OF_ADDRESS" ], "description": "Функция, вызвавшая предупреждение. На этом endpoint всегда `PROOF_OF_ADDRESS`." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Дополнительный контекст для некоторых рисков — например, `POA_DOCUMENT_EXPIRED` включает `expiration_reason` (`printed_expiration` или `age_window`), `document_type`, `document_subtype` и `issue_date`, а также `expiration_date` для пути `printed_expiration` или `max_age_months` для пути `age_window`; `SUSPECTED_DOCUMENT_MANIPULATION` включает `reason` и `detection_method`; `POA_DOCUMENT_UNPROVEN_TEXT_REPLACEMENT` включает `reason`, `detection_method` (`unproven_text_replacement`), `replaced_text`, `manipulated_regions` и `manipulated_blocks`. `null` для большинства рисков." }, "log_type": { "type": "string", "enum": [ "error", "information" ], "description": "Серьёзность. Предупреждения `error` переводят `status` в `Declined`; записи `information` носят информационный характер и сами по себе никогда не приводят к отклонению. (`warning` не формируется этим endpoint — его параметры принимают только `DECLINE` или `NO_ACTION`.)" }, "short_description": { "type": "string", "description": "Краткая сводка риска в одну строку в понятном человеку формате." }, "long_description": { "type": "string", "description": "Понятное объяснение риска." } } } }, "detected_codes": { "type": "array", "description": "QR-коды и штрихкоды, обнаруженные на всех обработанных страницах документа. Пусто, если ничего не найдено. Для обнаруженного, но не поддающегося декодированию QR-кода возвращается `parsed_payload: null`.", "items": { "$ref": "#/components/schemas/DocumentAIDetectedCode" } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Эхо-значение переданного вами `vendor_data` или `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Эхо-значение переданного вами объекта `metadata` или `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Временная метка ISO 8601 (UTC) момента генерации ответа." } } } } } }, "400": { "description": "Ошибка валидации или обработки. Проблемы на уровне полей возвращают стандартную структуру DRF (один массив сообщений на каждое проблемное поле). Проблемы с зашифрованными PDF возвращают `{\"detail\": ...}`. Документ, который пайплайн извлечения данных не может обработать, возвращает `{\"error\": [\"Error extracting POA information\"]}`.", "content": { "application/json": { "examples": { "Missing document": { "summary": "`document` не включён в данные формы", "value": { "document": [ "No file was submitted." ] } }, "Unsupported file extension": { "summary": "Расширение файла отличается от tiff/jpg/jpeg/png/pdf/webp", "value": { "document": [ "File extension “txt” is not allowed. Allowed extensions are: tiff, jpg, jpeg, png, pdf, webp." ] } }, "File too large": { "summary": "Размер загружаемого файла превышает лимит в 15 МБ", "value": { "document": [ "File size should not exceed 15 MB" ] } }, "Encrypted PDF": { "summary": "PDF загружен без обязательного пароля", "value": { "detail": "The PDF is encrypted. Please upload a decrypted PDF or a photo instead." } }, "Wrong PDF password": { "summary": "`document_password` не расшифровывает PDF", "value": { "detail": "The PDF password is incorrect. Please provide the correct password." } }, "Invalid language code": { "summary": "`poa_languages_allowed` содержит неподдерживаемый код", "value": { "poa_languages_allowed": [ "Invalid language code: 'xx'. Must be one of the supported languages: ['ar', 'bn', 'hy', 'bg', 'bs', 'ca', 'cnr', 'sq', 'zh', 'hr', 'cs', 'da', 'nl', 'en', 'et', 'fi', 'fr', 'ka', 'kk', 'de', 'el', 'he', 'hi', 'hu', 'id', 'it', 'ja', 'ko', 'ky', 'lv', 'lt', 'mk', 'mn', 'ms', 'no', 'fa', 'pl', 'pt', 'ro', 'ru', 'sr', 'sk', 'sl', 'so', 'es', 'sv', 'th', 'tr', 'uk', 'uz', 'vi']." ] } }, "Invalid document age value": { "summary": "Значение `poa_document_age_months` вне диапазона 1–120 / -1", "value": { "poa_document_age_months": [ "Invalid integer value for 'utility_bill': '999'. Must be -1 (unlimited) or a positive integer between 1 and 120." ] } }, "Extraction failure": { "summary": "Не удалось обработать документ в пайплайне извлечения данных", "value": { "error": [ "Error extracting POA information" ] } } } } } }, "403": { "description": "В доступе отказано. Возвращается, если заголовок `x-api-key` отсутствует, а также если баланс вызывающей организации не покрывает вызов; неверный, отозванный или истекший ключ возвращает `401`. Отсутствующий ключ возвращает `403` с `{\"detail\": ...}`; неверный, отозванный или истекший ключ возвращает `401`. При нехватке кредитов возвращается `403` с `{\"error\": ...}` до начала любой обработки документа.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Отсутствует заголовок `x-api-key`, либо ключ недействителен/отозван", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "Баланс организации недостаточен для совершения вызова", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Превышен лимит запросов. Endpoint'ы POST/PATCH/DELETE делят общий лимит в 300 запросов на запись в минуту на один API-ключ (для создания транзакций и отправки событий действует отдельный лимит в 600). Ответ содержит заголовки `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` и `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Более 300 запросов на запись в текущую минуту", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "503": { "$ref": "#/components/responses/DocumentProcessingBusy" } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X POST 'https://verification.didit.me/v3/poa/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'document=@./utility-bill.pdf' \\\n -F 'expected_address=Av. Monseñor Tavella 1291, Salta, Argentina' \\\n -F 'expected_country=ARG' \\\n -F 'expected_first_name=Sophia' \\\n -F 'expected_last_name=Martinez' \\\n -F 'poa_languages_allowed=en,es' \\\n -F 'vendor_data=user-123' \\\n --max-time 45" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.proof_of_address.verify(\n document=open(\"document.pdf\", \"rb\"),\n expected_address=\"Av. Monseñor Tavella 1291, Salta, Argentina\",\n expected_country=\"ARG\",\n expected_first_name=\"Sophia\",\n expected_last_name=\"Martinez\",\n poa_languages_allowed=\"en,es\",\n save_api_request=True,\n vendor_data=\"user-123\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.proofOfAddress.verify({\n document: await fileFromPath(\"document.pdf\"),\n expected_address: \"Av. Monseñor Tavella 1291, Salta, Argentina\",\n expected_country: \"ARG\",\n expected_first_name: \"Sophia\",\n expected_last_name: \"Martinez\",\n poa_languages_allowed: \"en,es\",\n save_api_request: true,\n vendor_data: \"user-123\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.ProofOfAddress.Verify(ctx, didit.ProofOfAddressVerifyParams{\n\tDocument: didit.FileFromPath(\"document.pdf\"),\n\tExpectedAddress: didit.String(\"Av. Monseñor Tavella 1291, Salta, Argentina\"),\n\tExpectedCountry: didit.String(\"ARG\"),\n\tExpectedFirstName: didit.String(\"Sophia\"),\n\tExpectedLastName: didit.String(\"Martinez\"),\n\tPOALanguagesAllowed: didit.String(\"en,es\"),\n\tSaveAPIRequest: didit.Bool(true),\n\tVendorData: didit.String(\"user-123\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\nimport me.didit.types.ProofOfAddressVerifyParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.proofOfAddress().verify(ProofOfAddressVerifyParams.builder()\n .document(Path.of(\"document.pdf\"))\n .expectedAddress(\"Av. Monseñor Tavella 1291, Salta, Argentina\")\n .expectedCountry(\"ARG\")\n .expectedFirstName(\"Sophia\")\n .expectedLastName(\"Martinez\")\n .poaLanguagesAllowed(\"en,es\")\n .saveApiRequest(true)\n .vendorData(\"user-123\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "proofOfAddress->verify([\n 'document' => File::fromPath('document.pdf'),\n 'expected_address' => 'Av. Monseñor Tavella 1291, Salta, Argentina',\n 'expected_country' => 'ARG',\n 'expected_first_name' => 'Sophia',\n 'expected_last_name' => 'Martinez',\n 'poa_languages_allowed' => 'en,es',\n 'save_api_request' => true,\n 'vendor_data' => 'user-123',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.proof_of_address.verify(\n document: Pathname(\"document.pdf\"),\n expected_address: \"Av. Monseñor Tavella 1291, Salta, Argentina\",\n expected_country: \"ARG\",\n expected_first_name: \"Sophia\",\n expected_last_name: \"Martinez\",\n poa_languages_allowed: \"en,es\",\n save_api_request: true,\n vendor_data: \"user-123\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.ProofOfAddress.VerifyAsync(new ProofOfAddressVerifyParams\n{\n Document = FileUpload.FromPath(\"document.pdf\"),\n ExpectedAddress = \"Av. Monseñor Tavella 1291, Salta, Argentina\",\n ExpectedCountry = \"ARG\",\n ExpectedFirstName = \"Sophia\",\n ExpectedLastName = \"Martinez\",\n PoaLanguagesAllowed = \"en,es\",\n SaveApiRequest = true,\n VendorData = \"user-123\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/document-ai/": { "post": { "summary": "Document AI (извлечение кастомных полей + проверки на подделку)", "description": "Извлекайте поля, которые определяете **вы**, из любых подтверждающих документов (расчетных листков, подтверждений наличия средств, писем об источнике средств, налоговых деклараций, договоров, счетов) за один вызов. Отправьте файл вместе с определением `fields` (ключ, название, инструкция по извлечению, тип) и получите типизированные значения (`text`, `number`, `date` в формате `YYYY-MM-DD`), опциональную оценку совпадения имени с ожидаемым физлицом или компанией, сигналы о модификации PDF/EXIF, `status` со значением `Approved`/`Declined`/`In Review`, а также список `warnings` с описанием каждой обнаруженной проблемы. Это серверный аналог размещенного шага сценария Document AI (см. `/core-technology/document-ai/overview`); он использует стандартную модель извлечения Didit и не поддерживает выбор провайдера.\n\n**Задержка.** Извлечение выполняется на базе LLM: обычные вызовы занимают **5–15 секунд**, а многостраничные PDF - до **~30 секунд**. Настройте таймаут клиента **не менее 45 секунд** и не повторяйте запрос до завершения текущего вызова.\n\n**Формат запроса.** Только `multipart/form-data`. Поле `fields` представляет собой **одну строку с JSON-массивом** (1–30 элементов, не более 16 KB); массивы в стиле форм с квадратными скобками отклоняются с ошибкой `400`. Каждый элемент содержит `{key, name, instruction, type, required, is_full_name}`, где `key` - это возвращаемый JSON-ключ (`^[a-z0-9_]{1,64}$`, уникальный), `instruction` указывает модели, что именно нужно прочитать, `type` принимает значения `text` (по умолчанию) | `number` | `date`, `required` вызывает ошибку `DOCUMENT_AI_MISSING_REQUIRED_FIELDS`, если значение не удалось прочитать, и не более чем в одном поле можно указать `is_full_name: true`, чтобы пометить значение для сравнения с ожидаемым именем.\n\n**Сравнение имен.** Передайте `expected_first_name` + `expected_last_name` (для физического лица) **или** `expected_company_name` (+ опционально `expected_company_country`), но не оба варианта сразу. Значение поля `is_full_name` (или, если оно не задано, первого текстового поля, чей ключ похож на имя) сравнивается методом нечеткого поиска; `name_match_score` (0–100) и `name_on_document` возвращаются всегда, когда присутствуют обе стороны, а оценка ниже порога `document_ai_name_match_score_threshold` (по умолчанию 80) добавляет `DOCUMENT_AI_NAME_MISMATCH`, действие которого определяется параметром `document_ai_name_mismatch_action`.\n\n**Логика принятия решений.** Каждый риск сопоставляется с настраиваемым действием: `DECLINE` → `status: \"Declined\"`, `REVIEW` → `status: \"In Review\"`, `NO_ACTION` → только для информации. Значения по умолчанию соответствуют шагу сценария: нечитаемый документ - `REVIEW`, отсутствуют обязательные поля - `REVIEW`, подозрение на манипуляции - `DECLINE`, несовпадение имени - `NO_ACTION`, неподдерживаемый файл - `REVIEW`. Документ, который вообще не может быть обработан, возвращает `400`; читаемый, но проблемный документ возвращает `200` с `Declined`/`In Review`, поэтому всегда проверяйте `document_ai.status` и `document_ai.warnings`, а не только HTTP-код.\n\n**Биллинг.** Каждый ответ `200` расходует один кредит Document AI API (**$0.20 per document** по тарифной сетке), списание производится из кредитов тарифа или баланса пополнения. Если баланса организации недостаточно для покрытия вызова, endpoint возвращает `403` до начала обработки. API-ключи песочницы возвращают детерминированный тестовый ответ и не тарифицируются.\n\n**Сохранение данных.** При `save_api_request=true` (по умолчанию) вызов сохраняется как сессия типа API: документ, извлеченные значения, определения полей и снимок сравнения имен сохраняются, сессия отображается в Business Console, а `request_id` работает с `GET /v3/session/{sessionId}/decision/`.", "operationId": "post_v3document-ai", "x-didit-sdk": { "resource": "document_ai", "method": "analyze", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "document", "fields" ], "properties": { "document": { "type": "string", "format": "binary", "description": "Документ для чтения. Допустимые расширения: `tiff`, `jpg`, `jpeg`, `png`, `pdf`, `webp`, `zip`. Максимальный размер загрузки: **30 MB** (файлы большего размера отклоняются с ошибкой `400`). Поддерживаются многостраничные PDF (время ожидания может быть выше); зашифрованные PDF отклоняются с ошибкой `400`. Изображения автоматически сжимаются перед обработкой." }, "fields": { "type": "string", "description": "Одна закодированная в JSON строка массива с **1–30** определениями полей (максимум 16 КБ). Каждый элемент: `key` (обязательно, `^[a-z0-9_]{1,64}$`, уникальный — ключ, возвращаемый в `extracted_data`), `name` (≤100 символов, отображается в сообщениях), `instruction` (≤500 символов, что модель должна прочитать), `type` (по умолчанию `text` | `number` | `date`), `required` (булево, по умолчанию `false`), `is_full_name` (булево, по умолчанию `false`, не более одного на запрос). Массивы форм в квадратных скобках, некорректный JSON, повторяющиеся ключи или несколько `is_full_name` возвращают `400` до какой-либо обработки или списания средств.", "example": "[{\"key\": \"employer_name\", \"name\": \"Employer name\", \"instruction\": \"The employer or company issuing the payslip.\", \"type\": \"text\", \"required\": true, \"is_full_name\": false}, {\"key\": \"employee_name\", \"name\": \"Employee name\", \"instruction\": \"The full name of the employee as printed on the payslip.\", \"type\": \"text\", \"required\": true, \"is_full_name\": true}, {\"key\": \"net_pay\", \"name\": \"Net pay\", \"instruction\": \"The net amount paid to the employee for the period.\", \"type\": \"number\", \"required\": true, \"is_full_name\": false}, {\"key\": \"pay_date\", \"name\": \"Pay date\", \"instruction\": \"The payment date shown on the payslip.\", \"type\": \"date\", \"required\": false, \"is_full_name\": false}]" }, "expected_first_name": { "type": "string", "description": "Имя для сверки с полем имени в документе (нечёткое сравнение с учётом транслитерации). Используйте вместе с `expected_last_name`; нельзя комбинировать с `expected_company_name`.", "example": "Sophia" }, "expected_last_name": { "type": "string", "description": "Фамилия для сверки с полем имени в документе, объединяемая с `expected_first_name` для `name_match_score`.", "example": "Martinez" }, "expected_company_name": { "type": "string", "description": "Название компании для сверки с полем имени в документе (для корпоративных документов). Нельзя использовать вместе с `expected_first_name` / `expected_last_name` (значение в примере намеренно отсутствует — сгенерированный пример запроса использует поля физического лица; замените их на это поле при верификации корпоративного документа)." }, "expected_company_country": { "type": "string", "description": "Необязательный двухбуквенный код страны ISO 3166-1 alpha-2 (две буквы ASCII, например `FR`), который настраивает нормализацию названия компании для `expected_company_name`. Используется только вместе с `expected_company_name`." }, "document_ai_name_match_score_threshold": { "type": "integer", "minimum": 0, "maximum": 100, "default": 80, "description": "Минимальное значение `name_match_score` (0–100), при котором имя считается совпавшим. Более низкая оценка добавляет `DOCUMENT_AI_NAME_MISMATCH`, регулируемое параметром `document_ai_name_mismatch_action`.", "example": 80 }, "document_ai_unreadable_document_action": { "type": "string", "enum": [ "DECLINE", "REVIEW", "NO_ACTION" ], "default": "REVIEW", "description": "Действие, если из документа не удалось считать ни одного поля (`DOCUMENT_AI_UNREADABLE_DOCUMENT`)." }, "document_ai_missing_required_fields_action": { "type": "string", "enum": [ "DECLINE", "REVIEW", "NO_ACTION" ], "default": "REVIEW", "description": "Действие, если не удалось прочитать хотя бы одно поле `required` (`DOCUMENT_AI_MISSING_REQUIRED_FIELDS`; список приведён в `additional_data.missing_fields`)." }, "document_ai_document_tampering_action": { "type": "string", "enum": [ "DECLINE", "REVIEW", "NO_ACTION" ], "default": "DECLINE", "description": "Действие при подозрении на манипуляции по результатам криминалистического анализа PDF/EXIF: файл изменён после цифровой подписи, использовался известный PDF-редактор, выявлены манипуляции с наложенным текстом, подозрительный повторный экспорт или аномалии изображения (`DOCUMENT_AI_SUSPECTED_MANIPULATION`)." }, "document_ai_name_mismatch_action": { "type": "string", "enum": [ "DECLINE", "REVIEW", "NO_ACTION" ], "default": "NO_ACTION", "description": "Действие, когда `name_match_score` ниже порогового значения (`DOCUMENT_AI_NAME_MISMATCH`)." }, "document_ai_unsupported_file_action": { "type": "string", "enum": [ "DECLINE", "REVIEW", "NO_ACTION" ], "default": "REVIEW", "description": "Что делать, если загруженный файл пуст или не подлежит обработке (`DOCUMENT_AI_UNSUPPORTED_FILE`)." }, "save_api_request": { "type": "boolean", "default": true, "description": "Если `true` (по умолчанию), сохраняет вызов как сессию типа API — видимую в Business Console, доступную через `GET /v3/session/{sessionId}/decision/` по возвращенному `request_id`, с сохранением загруженного документа, извлеченных значений, определений полей и снимка сопоставления имен. Если `false`, ничего не сохраняется, а `request_id` является временным UUID только для сопоставления ответа; вызов по-прежнему тарифицируется.", "example": true }, "vendor_data": { "type": "string", "description": "Необязательная непрозрачная строка (ваш внутренний идентификатор пользователя, email, UUID…), сохраняемая в сессии и возвращаемая в ответе. Используйте её для сопоставления вызовов API с вашими собственными записями и для последующей фильтрации сессий.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Необязательный объект JSON, сохраняемый вместе с сессией (когда `save_api_request=true`) и возвращаемый обратно в ответе. В multipart-запросах отправляйте его как строковое поле в формате JSON (например, `metadata={\"flow\":\"onboarding\"}`) — он парсится в объект.", "example": { "flow": "onboarding" } } } } } } }, "responses": { "200": { "description": "Документ обработан. Значение `document_ai.status`: `Approved`, `Declined` или `In Review`; каждая обнаруженная проблема детализирована в `document_ai.warnings`. Для проблемного документа по-прежнему возвращается `200` — проверяйте тело ответа, а не только HTTP-код. Если `save_api_request=true`, `request_id` представляет собой сохранённый id сессии.", "content": { "application/json": { "examples": { "Approved": { "summary": "Расчётный листок успешно прочитан, имя совпало", "value": { "request_id": "9d6a3b1e-2f0c-4a8e-9b7d-1c2e3f4a5b6c", "document_ai": { "status": "Approved", "extracted_data": { "employer_name": "Acme Payments Ltd", "employee_name": "Sophia Martinez", "net_pay": 3120.5, "pay_date": "2026-07-31" }, "detected_codes": [ { "type": "CODE_128", "page_number": 1, "position": [ [ 96, 456 ], [ 96, 616 ], [ 1012, 611 ], [ 1015, 456 ] ], "x": 96, "y": 456, "width": 919, "height": 160, "page_width": 1200, "page_height": 1700, "raw_payload": "SU5WLTIwMjYtMDA0Mg==", "parsed_payload": "INV-2026-0042" } ], "fields": [ { "key": "employer_name", "name": "Employer name", "instruction": "The employer or company issuing the payslip.", "type": "text", "required": true, "is_full_name": false }, { "key": "employee_name", "name": "Employee name", "instruction": "The full name of the employee as printed on the payslip.", "type": "text", "required": true, "is_full_name": true }, { "key": "net_pay", "name": "Net pay", "instruction": "The net amount paid to the employee for the period.", "type": "number", "required": true, "is_full_name": false }, { "key": "pay_date", "name": "Pay date", "instruction": "The payment date shown on the payslip.", "type": "date", "required": false, "is_full_name": false } ], "name_match_score": 100.0, "name_on_document": "Sophia Martinez", "warnings": [] }, "vendor_data": "user-123", "metadata": { "flow": "onboarding" }, "created_at": "2026-08-19T16:40:12.318Z" } }, "In Review — missing required field": { "summary": "Не удалось прочитать `net_pay`; действие по умолчанию: REVIEW", "value": { "request_id": "3f2a9c7b-5d4e-4b1a-8c6f-0e9d8c7b6a5f", "document_ai": { "status": "In Review", "extracted_data": { "employer_name": "Acme Payments Ltd", "employee_name": "Sophia Martinez", "net_pay": null, "pay_date": "2026-07-31" }, "detected_codes": [], "fields": [ { "key": "employer_name", "name": "Employer name", "instruction": "The employer or company issuing the payslip.", "type": "text", "required": true, "is_full_name": false }, { "key": "employee_name", "name": "Employee name", "instruction": "The full name of the employee as printed on the payslip.", "type": "text", "required": true, "is_full_name": true }, { "key": "net_pay", "name": "Net pay", "instruction": "The net amount paid to the employee for the period.", "type": "number", "required": true, "is_full_name": false }, { "key": "pay_date", "name": "Pay date", "instruction": "The payment date shown on the payslip.", "type": "date", "required": false, "is_full_name": false } ], "name_match_score": 100.0, "name_on_document": "Sophia Martinez", "warnings": [ { "risk": "DOCUMENT_AI_MISSING_REQUIRED_FIELDS", "feature": "DOCUMENT_AI", "additional_data": { "missing_fields": [ "Net pay" ] }, "log_type": "warning", "short_description": "Required fields could not be extracted", "long_description": "One or more fields configured as required could not be extracted from the uploaded document." } ] }, "vendor_data": null, "metadata": null, "created_at": "2026-08-19T16:41:05.002Z" } }, "Declined — suspected manipulation": { "summary": "Криминалистический анализ PDF выявил известный редактор; действие по умолчанию DECLINE", "value": { "request_id": "7c1d2e3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f", "document_ai": { "status": "Declined", "extracted_data": { "employer_name": "Acme Payments Ltd", "employee_name": "Sophia Martinez", "net_pay": 3120.5, "pay_date": "2026-07-31" }, "detected_codes": [], "fields": [ { "key": "employer_name", "name": "Employer name", "instruction": "The employer or company issuing the payslip.", "type": "text", "required": true, "is_full_name": false }, { "key": "employee_name", "name": "Employee name", "instruction": "The full name of the employee as printed on the payslip.", "type": "text", "required": true, "is_full_name": true }, { "key": "net_pay", "name": "Net pay", "instruction": "The net amount paid to the employee for the period.", "type": "number", "required": true, "is_full_name": false }, { "key": "pay_date", "name": "Pay date", "instruction": "The payment date shown on the payslip.", "type": "date", "required": false, "is_full_name": false } ], "name_match_score": null, "name_on_document": "Sophia Martinez", "warnings": [ { "risk": "DOCUMENT_AI_SUSPECTED_MANIPULATION", "feature": "DOCUMENT_AI", "additional_data": { "detection_method": "known_editor", "processed_by_known_editor": "ilovepdf" }, "log_type": "error", "short_description": "Suspected document manipulation", "long_description": "The system detected signs of potential manipulation or editing in the uploaded document." } ] }, "vendor_data": null, "metadata": null, "created_at": "2026-08-19T16:42:40.771Z" } } }, "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Идентификатор сохраненной сессии при `save_api_request=true` (доступен для использования с `GET /v3/session/{sessionId}/decision/`); в противном случае это временный корреляционный UUID." }, "document_ai": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review" ], "description": "`Approved`, если ни одно предупреждение не приводит к отклонению или рассмотрению; `Declined`, если хотя бы один риск сопоставляется с `DECLINE`; в противном случае `In Review`, если хотя бы один сопоставляется с `REVIEW`. Список `warnings` поясняет причину." }, "extracted_data": { "type": "object", "additionalProperties": true, "description": "Одна запись на каждый запрошенный ключ поля. Значения типизированы в соответствии с `type` поля: строки для `text`, числа для `number`, строки в формате `YYYY-MM-DD` для `date` — или `null`, если значение не удалось прочитать.", "example": { "employer_name": "Acme Payments Ltd", "employee_name": "Sophia Martinez", "net_pay": 3120.5, "pay_date": "2026-07-31" } }, "detected_codes": { "type": "array", "description": "QR-коды и штрихкоды, обнаруженные на всех обработанных страницах. Пусто, если ничего не найдено. Для обнаруженного, но не поддающегося декодированию QR-кода возвращается `parsed_payload: null`.", "items": { "$ref": "#/components/schemas/DocumentAIDetectedCode" } }, "fields": { "type": "array", "description": "Нормализованные определения полей, использованные для этого извлечения, возвращенные в ответе (также сохраняются вместе с сессией при `save_api_request=true`).", "items": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "instruction": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "number", "date" ] }, "required": { "type": "boolean" }, "is_full_name": { "type": "boolean" } } } }, "name_match_score": { "type": "number", "nullable": true, "minimum": 0, "maximum": 100, "description": "Нечёткое сходство (0–100) между `name_on_document` и ожидаемым именем человека или наименованием компании. Возвращается каждый раз, когда присутствуют как значение имени, так и ожидаемое имя — при совпадениях **и** несовпадениях; в противном случае `null`.", "example": 96.0 }, "name_on_document": { "type": "string", "nullable": true, "description": "Значение имени, полученное из документа (поле `is_full_name` или первое текстовое поле, похожее на имя), которое сравнивалось с ожидаемым именем. `null`, если значение имени было недоступно.", "example": "Sophia Martinez" }, "warnings": { "type": "array", "description": "Пусто при чистом одобрении. Каждая запись описывает один обнаруженный риск; записи с `log_type: \"error\"` устанавливают для `status` значение `Declined`, а записи с `log_type: \"warning\"` устанавливают для него значение `In Review`.", "items": { "type": "object", "properties": { "risk": { "type": "string", "enum": [ "DOCUMENT_AI_UNREADABLE_DOCUMENT", "DOCUMENT_AI_MISSING_REQUIRED_FIELDS", "DOCUMENT_AI_SUSPECTED_MANIPULATION", "DOCUMENT_AI_NAME_MISMATCH", "DOCUMENT_AI_UNSUPPORTED_FILE" ], "description": "Машиночитаемый код риска. Каждый регулируется соответствующим параметром запроса `document_ai_*_action`.", "example": "DOCUMENT_AI_MISSING_REQUIRED_FIELDS" }, "feature": { "type": "string", "enum": [ "DOCUMENT_AI" ], "description": "Функция, вызвавшая предупреждение. На этом endpoint всегда `DOCUMENT_AI`." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Дополнительный контекст риска: `{\"missing_fields\": [\"Net pay\"]}` для отсутствующих обязательных полей, `{\"name_on_document\", \"score\", \"threshold\"}` для несовпадения имени и результат криминалистического анализа (`detection_method`, сведения о создателе/редакторе) при подозрении на манипуляции. `null`, если добавить нечего.", "example": { "missing_fields": [ "Net pay" ] } }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Уровень серьёзности, определяемый настроенным действием: `error` (DECLINE), `warning` (REVIEW), `information` (NO_ACTION)." }, "short_description": { "type": "string", "description": "Краткое описание риска в одну строку в понятном человеку формате.", "example": "Required fields could not be extracted" }, "long_description": { "type": "string", "description": "Понятное объяснение, при необходимости дополненное значениями из `additional_data`." } } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Эхо-значение переданного вами `vendor_data` или `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Эхо-значение переданного вами объекта `metadata` или `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Время обработки запроса (UTC, ISO 8601)." } } } } } }, "400": { "description": "Ошибка валидации или обработки. Проблемы на уровне полей возвращают стандартную структуру DRF (один массив сообщений на каждое проблемное поле). Зашифрованные или нечитаемые документы, а также сбои извлечения данных возвращают `{\"error\": ...}`.", "content": { "application/json": { "examples": { "Missing document": { "summary": "`document` не включён в данные формы", "value": { "document": [ "No file was submitted." ] } }, "Invalid fields payload": { "summary": "`fields` не является единой JSON-строкой массива", "value": { "fields": [ "fields must be a valid JSON array string." ] } }, "Duplicate field keys": { "summary": "Два элемента имеют одинаковый `key`", "value": { "fields": [ "Every fields item must have a unique key." ] } }, "Conflicting expectations": { "summary": "Ожидаемые данные физического лица и компании, переданные вместе", "value": { "non_field_errors": [ "Provide either person expected-name fields or expected_company_name, not both." ] } }, "Invalid metadata": { "summary": "`metadata` не является JSON-объектом (или содержит символ NUL)", "value": { "metadata": [ "Metadata must be a JSON object." ] } }, "Oversized vendor_data": { "summary": "`vendor_data` превышает лимит в 2 000 байт", "value": { "vendor_data": [ "vendor_data is too long (maximum 2000 bytes)." ] } }, "Encrypted PDF": { "summary": "Защищенный паролем PDF", "value": { "error": "The PDF is encrypted. Please upload a decrypted PDF or a photo instead." } }, "Extraction failed": { "summary": "Конвейер извлечения данных не смог обработать документ", "value": { "error": [ "Error extracting Document AI information" ] } } }, "schema": { "type": "object", "additionalProperties": true } } } }, "403": { "description": "В доступе отказано. Возвращается, если заголовок `x-api-key` отсутствует, а также если баланс вызывающей организации не покрывает вызов; неверный, отозванный или истекший ключ возвращает `401`. Отсутствующий ключ возвращает `403` с `{\"detail\": ...}`; неверный, отозванный или истекший ключ возвращает `401`. При нехватке кредитов — а также для организаций с оплатой по договору, в тарифной таблице которых нет позиции Document AI API — возвращается `403` с `{\"error\": ...}` до начала любой обработки документа.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Отсутствует заголовок `x-api-key`, либо ключ недействителен/отозван", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "Баланс организации недостаточен для совершения вызова", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } }, "Contract rate missing": { "summary": "Организация с контрактным биллингом, в тарифной таблице которой нет записи для Document AI API", "value": { "error": "Document AI API is not included in your contract rate card. Contact support@didit.me to enable it." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "error": { "type": "string" } } } } } }, "429": { "description": "Превышен лимит запросов. Endpoint'ы POST/PATCH/DELETE делят общий лимит в 300 запросов на запись в минуту на один API-ключ (для создания транзакций и отправки событий действует отдельный лимит в 600). Ответ содержит заголовки `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` и `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Более 300 запросов на запись в текущую минуту", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "503": { "$ref": "#/components/responses/DocumentProcessingBusy" } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.document_ai.analyze(\n document=open(\"document.pdf\", \"rb\"),\n fields=\"[{\\\"key\\\": \\\"employer_name\\\", \\\"name\\\": \\\"Employer name\\\", \\\"instruction\\\": \\\"The employer or company issuing the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"employee_name\\\", \\\"name\\\": \\\"Employee name\\\", \\\"instruction\\\": \\\"The full name of the employee as printed on the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": true}, {\\\"key\\\": \\\"net_pay\\\", \\\"name\\\": \\\"Net pay\\\", \\\"instruction\\\": \\\"The net amount paid to the employee for the period.\\\", \\\"type\\\": \\\"number\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"pay_date\\\", \\\"name\\\": \\\"Pay date\\\", \\\"instruction\\\": \\\"The payment date shown on the payslip.\\\", \\\"type\\\": \\\"date\\\", \\\"required\\\": false, \\\"is_full_name\\\": false}]\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.documentAi.analyze({\n document: await fileFromPath(\"document.pdf\"),\n fields: \"[{\\\"key\\\": \\\"employer_name\\\", \\\"name\\\": \\\"Employer name\\\", \\\"instruction\\\": \\\"The employer or company issuing the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"employee_name\\\", \\\"name\\\": \\\"Employee name\\\", \\\"instruction\\\": \\\"The full name of the employee as printed on the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": true}, {\\\"key\\\": \\\"net_pay\\\", \\\"name\\\": \\\"Net pay\\\", \\\"instruction\\\": \\\"The net amount paid to the employee for the period.\\\", \\\"type\\\": \\\"number\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"pay_date\\\", \\\"name\\\": \\\"Pay date\\\", \\\"instruction\\\": \\\"The payment date shown on the payslip.\\\", \\\"type\\\": \\\"date\\\", \\\"required\\\": false, \\\"is_full_name\\\": false}]\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.DocumentAi.Analyze(ctx, didit.DocumentAiAnalyzeParams{\n\tDocument: didit.FileFromPath(\"document.pdf\"),\n\tFields: \"[{\\\"key\\\": \\\"employer_name\\\", \\\"name\\\": \\\"Employer name\\\", \\\"instruction\\\": \\\"The employer or company issuing the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"employee_name\\\", \\\"name\\\": \\\"Employee name\\\", \\\"instruction\\\": \\\"The full name of the employee as printed on the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": true}, {\\\"key\\\": \\\"net_pay\\\", \\\"name\\\": \\\"Net pay\\\", \\\"instruction\\\": \\\"The net amount paid to the employee for the period.\\\", \\\"type\\\": \\\"number\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"pay_date\\\", \\\"name\\\": \\\"Pay date\\\", \\\"instruction\\\": \\\"The payment date shown on the payslip.\\\", \\\"type\\\": \\\"date\\\", \\\"required\\\": false, \\\"is_full_name\\\": false}]\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\nimport me.didit.types.DocumentAiAnalyzeParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.documentAi().analyze(DocumentAiAnalyzeParams.builder()\n .document(Path.of(\"document.pdf\"))\n .fields(\"[{\\\"key\\\": \\\"employer_name\\\", \\\"name\\\": \\\"Employer name\\\", \\\"instruction\\\": \\\"The employer or company issuing the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"employee_name\\\", \\\"name\\\": \\\"Employee name\\\", \\\"instruction\\\": \\\"The full name of the employee as printed on the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": true}, {\\\"key\\\": \\\"net_pay\\\", \\\"name\\\": \\\"Net pay\\\", \\\"instruction\\\": \\\"The net amount paid to the employee for the period.\\\", \\\"type\\\": \\\"number\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"pay_date\\\", \\\"name\\\": \\\"Pay date\\\", \\\"instruction\\\": \\\"The payment date shown on the payslip.\\\", \\\"type\\\": \\\"date\\\", \\\"required\\\": false, \\\"is_full_name\\\": false}]\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "documentAi->analyze([\n 'document' => File::fromPath('document.pdf'),\n 'fields' => '[{\"key\": \"employer_name\", \"name\": \"Employer name\", \"instruction\": \"The employer or company issuing the payslip.\", \"type\": \"text\", \"required\": true, \"is_full_name\": false}, {\"key\": \"employee_name\", \"name\": \"Employee name\", \"instruction\": \"The full name of the employee as printed on the payslip.\", \"type\": \"text\", \"required\": true, \"is_full_name\": true}, {\"key\": \"net_pay\", \"name\": \"Net pay\", \"instruction\": \"The net amount paid to the employee for the period.\", \"type\": \"number\", \"required\": true, \"is_full_name\": false}, {\"key\": \"pay_date\", \"name\": \"Pay date\", \"instruction\": \"The payment date shown on the payslip.\", \"type\": \"date\", \"required\": false, \"is_full_name\": false}]',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.document_ai.analyze(\n document: Pathname(\"document.pdf\"),\n fields: \"[{\\\"key\\\": \\\"employer_name\\\", \\\"name\\\": \\\"Employer name\\\", \\\"instruction\\\": \\\"The employer or company issuing the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"employee_name\\\", \\\"name\\\": \\\"Employee name\\\", \\\"instruction\\\": \\\"The full name of the employee as printed on the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": true}, {\\\"key\\\": \\\"net_pay\\\", \\\"name\\\": \\\"Net pay\\\", \\\"instruction\\\": \\\"The net amount paid to the employee for the period.\\\", \\\"type\\\": \\\"number\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"pay_date\\\", \\\"name\\\": \\\"Pay date\\\", \\\"instruction\\\": \\\"The payment date shown on the payslip.\\\", \\\"type\\\": \\\"date\\\", \\\"required\\\": false, \\\"is_full_name\\\": false}]\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.DocumentAi.AnalyzeAsync(new DocumentAiAnalyzeParams\n{\n Document = FileUpload.FromPath(\"document.pdf\"),\n Fields = \"[{\\\"key\\\": \\\"employer_name\\\", \\\"name\\\": \\\"Employer name\\\", \\\"instruction\\\": \\\"The employer or company issuing the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"employee_name\\\", \\\"name\\\": \\\"Employee name\\\", \\\"instruction\\\": \\\"The full name of the employee as printed on the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": true}, {\\\"key\\\": \\\"net_pay\\\", \\\"name\\\": \\\"Net pay\\\", \\\"instruction\\\": \\\"The net amount paid to the employee for the period.\\\", \\\"type\\\": \\\"number\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"pay_date\\\", \\\"name\\\": \\\"Pay date\\\", \\\"instruction\\\": \\\"The payment date shown on the payslip.\\\", \\\"type\\\": \\\"date\\\", \\\"required\\\": false, \\\"is_full_name\\\": false}]\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/aml/": { "post": { "summary": "AML-скрининг (автономный)", "operationId": "post_v3aml", "x-didit-sdk": { "resource": "aml", "method": "screen", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Необязательный ключ защиты от повторных попыток длиной до 255 символов. Повторное использование того же ключа с тем же телом запроса возвращает исходный ответ без запуска и тарификации второго скрининга. Повторное использование ключа с другим телом возвращает `409`.", "schema": { "type": "string", "maxLength": 255 } } ], "description": "Выполняйте скрининг физического лица или компании по базам данных политически значимых лиц (PEP), санкций, списков предупреждений и наблюдения, а также негативных публикаций в СМИ за один вызов.\n\n**Модель двух оценок.** Каждое совпадение содержит `match_score` (0–100, уверенность совпадения личности) и `risk_score` (0–100, риск сущности). Совпадения, у которых `match_score` ниже `aml_match_score_threshold` (по умолчанию **93**), получают метку `review_status: \"False Positive\"` и игнорируются при расчёте риска; максимальный `risk_score` среди оставшихся совпадений становится значением `aml.score`. Итоговый `aml.status` рассчитывается по вашим порогам: `score` > `aml_score_review_threshold` (по умолчанию **100**) → `Declined`; `score` > `aml_score_approve_threshold` (по умолчанию **80**) → `In Review`; в остальных случаях: `Approved`. Если `score` не равен нулю и ≥ порога одобрения, добавляется предупреждение `POSSIBLE_MATCH_FOUND` (при оценке, в точности равной 0, предупреждение не добавляется).\n\n**Веса оценки совпадения.** Сумма `aml_name_weight` + `aml_dob_weight` + `aml_country_weight` должна составлять ровно 100 (по умолчанию 60/25/15). Отсутствующие в запросе компоненты перенормируются; совпадающий `document_number` действует как «золотой ключ», переопределяющий `match_score` на 100.\n\n**Задержка.** Обычный скрининг обычно выполняется за несколько секунд. При `include_adverse_media=true` API ожидает обогащения данными о негативных публикациях в СМИ (начальная пауза ~5 с плюс до ~25 с опроса), поэтому настройте клиентский таймаут **не менее 60 секунд**.\n\n**Сохранение данных.** Параметр `save_api_request` по умолчанию равен **true**: скрининг сохраняется как сессия (`request_id` работает с `GET /v3/session/{sessionId}/decision/`), отображается в консоли, отправляется webhook `status.updated`, а статусы проверки совпадений можно обновить позже. При `save_api_request=false` ничего не сохраняется, и `request_id` является временным идентификатором корреляции. При `include_ongoing_monitoring=true` продолжается постоянный повторный скрининг профиля, что требует `save_api_request=true` (иначе возвращается ошибка `400`).\n\n**Идемпотентность.** Передавайте заголовок `Idempotency-Key` при повторных попытках после таймаута или временной ошибки. Ключ привязан к вашему приложению и точному телу запроса. Первый успешно завершённый запрос сохраняет свой ответ; последующие идентичные повторные попытки возвращают тот же ответ без запуска и тарификации нового AML-скрининга. Если исходный запрос всё ещё выполняется, повторите попытку позже с тем же ключом. Если тот же ключ используется с другим телом запроса, API возвращает `409`.\n\n**Биллинг.** Один кредит AML API списывается после первого успешного скрининга. За повторно воспроизведённые идемпотентные ответы средства повторно не взимаются; при недостаточном балансе возвращается `403` до запуска нового скрининга.\n\n**Песочница.** Ключи от приложений в песочнице полностью пропускают скрининг и биллинг, возвращая тестовый результат: `Approved` без совпадений, если не передан параметр `sandbox_scenario`. Параметр `save_api_request` работает так же, как и для продакшн-ключей, поэтому сохранённый скрининг из песочницы можно получить через `GET /v3/session/{sessionId}/decision/` и `GET /v3/session/{sessionId}/generate-pdf/`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "full_name" ], "properties": { "full_name": { "type": "string", "minLength": 2, "description": "Полное имя человека или наименование компании для скрининга. Минимум **2 символа** - минимальный порог самого провайдера скрининга. Более короткое или пустое имя вернёт `400` по этому полю до запуска скрининга, поэтому списания средств не произойдёт.", "example": "Antonio Ejemplo Modelo" }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "default": "person", "description": "Тип субъекта для скрининга. По умолчанию `person`." }, "date_of_birth": { "type": "string", "format": "date", "description": "Дата рождения (физические лица) или дата регистрации (компании), `YYYY-MM-DD`. Повышает точность совпадения за счёт веса даты рождения.", "example": "1972-02-29" }, "nationality": { "type": "string", "description": "Двухбуквенный код страны ISO 3166-1 **alpha-2** (например, `ES`). Недопустимые коды возвращают `400`. Повышает точность совпадения за счет веса страны.", "example": "ES" }, "document_number": { "type": "string", "description": "Номер документа, удостоверяющего личность. Не имеет весового коэффициента и выступает в качестве «золотого ключа»: точное совпадение заменяет `match_score` совпадения на 100, а явное несовпадение снижает его. Отправляется провайдеру скрининга в качестве поискового фильтра, только если содержит **2-50 символов**; значение вне этого диапазона принимается и сохраняется, а скрининг всё равно выполняется и тарифицируется, просто без фильтрации по номеру документа." }, "aml_score_approve_threshold": { "type": "number", "minimum": 0, "maximum": 100, "default": 80, "description": "Порог оценки риска, на уровне которого или ниже результат переходит в `Approved`. Должен быть ≤ `aml_score_review_threshold` (иначе `400`)." }, "aml_score_review_threshold": { "type": "number", "minimum": 0, "maximum": 100, "default": 100, "description": "Порог оценки риска, выше которого результат переходит в `Declined`. Оценки между двумя порогами приводят к `In Review`." }, "aml_name_weight": { "type": "integer", "minimum": 0, "maximum": 100, "default": 60, "description": "Вес схожести имени в оценке совпадения для каждого совпадения. Сумма трёх весов должна составлять ровно 100 (иначе `400`)." }, "aml_dob_weight": { "type": "integer", "minimum": 0, "maximum": 100, "default": 25, "description": "Вес даты рождения в оценке совпадения для каждого совпадения." }, "aml_country_weight": { "type": "integer", "minimum": 0, "maximum": 100, "default": 15, "description": "Вес страны/гражданства в оценке совпадения для каждого совпадения." }, "aml_match_score_threshold": { "type": "integer", "minimum": 0, "maximum": 100, "default": 93, "description": "Порог отсечения для совпадений: совпадения с `match_score` ниже этого значения считаются `False Positive` (исключаются из оценки риска); со значением равным или выше считаются возможными совпадениями со статусом `Unreviewed`." }, "include_adverse_media": { "type": "boolean", "default": false, "description": "Также искать негативные публикации в СМИ. Добавляет до ~30 с задержки во время сбора результатов — используйте таймаут клиента ≥60 с." }, "include_ongoing_monitoring": { "type": "boolean", "default": false, "description": "Продолжать повторный скрининг этого профиля и отправлять изменения через webhook. Требует `save_api_request=true` (иначе `400`)." }, "save_api_request": { "type": "boolean", "default": true, "description": "Сохранять скрининг как сессию (отображение в консоли, endpoint решений, webhook, проверка срабатываний). Укажите `false` для проверки без сохранения состояния." }, "vendor_data": { "type": "string", "description": "Ваш идентификатор пользователя, прошедшего скрининг; возвращается в ответе и сохраняется вместе с сессией." }, "metadata": { "type": "object", "nullable": true, "description": "JSON в свободной форме, сохраняемый с запросом и возвращаемый в ответе." }, "sandbox_scenario": { "type": "string", "description": "Слаг сценария только для песочницы. Принимается, только если API-ключ принадлежит приложению в режиме песочницы; отклоняется для приложений в продакшн-среде. У отдельного скрининга нет сессии для инициализации, поэтому слаг указывается непосредственно в запросе на скрининг: `decline_aml_hit` возвращает одно совпадение формата продакшна и переводит скрининг в статус `Declined`, `review_aml_possible_match` переводит его в статус `In Review`, а сценарий, не задающий результат AML, оставляет скрининг чистым. См. каталог сценариев в GET /v1/sandbox/scenarios/ или [Песочница и тестовые данные](/ru/integration/sandbox-testing).", "example": "decline_aml_hit" } } }, "example": { "full_name": "Antonio Ejemplo Modelo", "entity_type": "person", "date_of_birth": "1972-02-29", "nationality": "ES", "include_adverse_media": false, "vendor_data": "user-1234" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/aml/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -H 'Idempotency-Key: aml-user-1234-2026-08-20' \\\n -d '{\n \"full_name\": \"Antonio Ejemplo Modelo\",\n \"entity_type\": \"person\",\n \"date_of_birth\": \"1972-02-29\",\n \"nationality\": \"ES\",\n \"include_adverse_media\": false,\n \"vendor_data\": \"user-1234\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.aml.screen(\n full_name=\"Antonio Ejemplo Modelo\",\n entity_type=\"person\",\n date_of_birth=\"1972-02-29\",\n nationality=\"ES\",\n include_adverse_media=False,\n vendor_data=\"user-1234\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.aml.screen({\n full_name: \"Antonio Ejemplo Modelo\",\n entity_type: \"person\",\n date_of_birth: \"1972-02-29\",\n nationality: \"ES\",\n include_adverse_media: false,\n vendor_data: \"user-1234\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.AML.Screen(ctx, didit.AMLScreenParams{\n\tFullName: \"Antonio Ejemplo Modelo\",\n\tEntityType: didit.Some(didit.AMLScreenParamsEntityType(\"person\")),\n\tDateOfBirth: didit.String(\"1972-02-29\"),\n\tNationality: didit.String(\"ES\"),\n\tIncludeAdverseMedia: didit.Bool(false),\n\tVendorData: didit.String(\"user-1234\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.LocalDate;\nimport me.didit.Didit;\nimport me.didit.types.AmlScreenParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.aml().screen(AmlScreenParams.builder()\n .fullName(\"Antonio Ejemplo Modelo\")\n .entityType(AmlScreenParams.EntityType.of(\"person\"))\n .dateOfBirth(LocalDate.parse(\"1972-02-29\"))\n .nationality(\"ES\")\n .includeAdverseMedia(false)\n .vendorData(\"user-1234\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "aml->screen([\n 'full_name' => 'Antonio Ejemplo Modelo',\n 'entity_type' => 'person',\n 'date_of_birth' => '1972-02-29',\n 'nationality' => 'ES',\n 'include_adverse_media' => false,\n 'vendor_data' => 'user-1234',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.aml.screen(\n full_name: \"Antonio Ejemplo Modelo\",\n entity_type: \"person\",\n date_of_birth: \"1972-02-29\",\n nationality: \"ES\",\n include_adverse_media: false,\n vendor_data: \"user-1234\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Aml.ScreenAsync(new AmlScreenParams\n{\n FullName = \"Antonio Ejemplo Modelo\",\n EntityType = new AmlScreenParamsEntityType(\"person\"),\n DateOfBirth = \"1972-02-29\",\n Nationality = \"ES\",\n IncludeAdverseMedia = false,\n VendorData = \"user-1234\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Скрининг завершён. `aml.status` отражает ваши пороги; каждое совпадение на уровне или выше внутреннего порога включения перечислено в `aml.hits` вместе с оценкой совпадения личности `match_score`, оценкой риска сущности `risk_score` и объектом `score_breakdown`, поясняющим совпадение.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Идентификатор сохраненной сессии при `save_api_request=true` (доступен для использования с `GET /v3/session/{sessionId}/decision/`); в противном случае это временный корреляционный UUID." }, "aml": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "`Declined`, если `score` > `aml_score_review_threshold`; `In Review`, если `score` > `aml_score_approve_threshold`; в противном случае `Approved` (в том числе когда оценка недоступна)." }, "total_hits": { "type": "integer", "description": "Количество записей в `hits`." }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Эхо типа проверенной сущности." }, "hits": { "type": "array", "items": { "type": "object", "description": "Одно совпадение скрининга. `match_score` (0–100) измеряет уверенность в совпадении личности — совпадения ниже `aml_match_score_threshold` помечаются как `review_status: \"False Positive\"` и исключаются из оценки риска; совпадения на уровне порога или выше считаются возможными совпадениями со статусом `\"Unreviewed\"`. `risk_score` (0–100) измеряет степень риска найденной сущности и определяет итоговый `aml.score` верхнего уровня.", "properties": { "id": { "type": "string", "nullable": true, "description": "Стабильный идентификатор Didit для совпадения: `hit_`, за которым следуют 24 шестнадцатеричных символа. Та же найденная сущность сохраняет тот же `id` при повторном скрининге субъекта. Передавайте его как `hit_id` в endpoint проверки совпадений AML." }, "url": { "type": "string", "nullable": true, "description": "Исходный URL сущности с совпадением, если доступен." }, "match": { "type": "boolean", "nullable": true, "description": "Устаревший флаг точного совпадения. Рекомендуется использовать `match_score` + `review_status`." }, "score": { "type": "number", "nullable": true, "description": "УСТАРЕЛО: взвешенная оценка совпадения в диапазоне 0–1. Используйте вместо этого `match_score`." }, "match_score": { "type": "number", "nullable": true, "description": "Оценка уверенности идентификации (0–100). Сравнивается с `aml_match_score_threshold` для разделения ложных срабатываний и возможных совпадений." }, "risk_score": { "type": "number", "nullable": true, "description": "Оценка риска сущности (0–100). Наибольший `risk_score` среди совпадений, не являющихся ложными срабатываниями, становится `aml.score` верхнего уровня." }, "target": { "type": "boolean", "nullable": true }, "caption": { "type": "string", "nullable": true, "description": "Отображаемое имя найденной сущности." }, "datasets": { "type": "array", "nullable": true, "items": { "type": "string", "enum": [ "PEP", "PEP Level 1", "PEP Level 2", "PEP Level 3", "PEP Level 4", "Sanctions", "Adverse Media", "Warnings and Regulatory Enforcement", "Fitness and Probity", "SIP", "SIE", "Insolvency", "Other Lists" ] }, "description": "Категории риска, в которых числится сущность: `PEP` (с указанием уровня, от `PEP Level 1` до `PEP Level 4`), `Sanctions`, `Adverse Media`, `Warnings and Regulatory Enforcement`, `Fitness and Probity`, `SIP`, `SIE` или `Insolvency`. Значение `Other Lists` используется, когда источник сущности не указывает ни одну из этих категорий." }, "features": { "type": "object", "nullable": true }, "properties": { "type": "object", "nullable": true, "description": "Профиль сущности: `name`, `alias`, `notes`, `gender`, `birthDate`, `birthPlace`, `nationality`, `position` и другие биографические массивы (каждый может принимать значение null)." }, "rca_name": { "type": "string", "nullable": true, "description": "Имя связанного близкого лица, через которое было найдено совпадение сущности, если совпадение относится к RCA." }, "pep_matches": { "type": "array", "description": "Записи списка политически значимых лиц (PEP), соответствующие этому совпадению.", "items": { "type": "object", "properties": { "list_name": { "type": "string" }, "publisher": { "type": "string" }, "source_url": { "type": "string" }, "description": { "type": "string" }, "matched_name": { "type": "string" }, "pep_position": { "type": "string" }, "date_of_birth": { "type": "string" }, "place_of_birth": { "type": "string" }, "aliases": { "type": "array", "items": { "type": "string" } }, "education": { "type": "array", "items": { "type": "string" } }, "other_sources": { "type": "array", "items": { "type": "string" } } } } }, "sanction_matches": { "type": "array", "items": { "type": "object" }, "description": "Записи санкционных списков, подтверждающие это совпадение (та же структура записей подтверждающего списка, что и в `pep_matches`, плюс специфичные для санкций поля)." }, "warning_matches": { "type": "array", "items": { "type": "object" }, "description": "Записи предупреждений и списка наблюдения, послужившие основанием для этого совпадения." }, "adverse_media_matches": { "type": "array", "description": "Статьи о негативных публикациях в СМИ. Заполняется только при `include_adverse_media=true`.", "items": { "type": "object", "properties": { "headline": { "type": "string" }, "summary": { "type": "string" }, "sentiment": { "type": "string" }, "sentiment_score": { "type": "number" }, "source_url": { "type": "string" }, "thumbnail": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "author_name": { "type": "string", "nullable": true }, "publication_date": { "type": "string", "nullable": true }, "adverse_keywords": { "type": "array", "items": { "type": "string" } }, "other_sources": { "type": "array", "items": { "type": "string" } } } } }, "adverse_media_details": { "type": "object", "nullable": true, "description": "Агрегированная тональность негативных публикаций в СМИ для сущности (`sentiment`, `sentiment_score`, частотная карта `adverse_keywords`). Заполняется только при `include_adverse_media=true`." }, "first_seen": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда сущность впервые появилась в наборах данных." }, "last_seen": { "type": "string", "format": "date-time", "nullable": true, "description": "Самое последнее обновление набора данных, включившее данную сущность." }, "linked_entities": { "type": "array", "description": "Известные связи сопоставленной сущности (семья, связанные лица, компании).", "items": { "type": "object", "properties": { "name": { "type": "array", "items": { "type": "string" } }, "relation": { "type": "array", "items": { "type": "string" } }, "status": { "type": "array", "items": { "type": "string" } }, "details": { "type": "array", "items": { "type": "string" } }, "active": { "type": "array", "items": { "type": "string" } } } } }, "risk_view": { "type": "object", "nullable": true, "description": "Разбивка риска по измерениям (`crimes`, `countries`, `categories`, `custom_list`), каждое из которых содержит `score`, `weightage`, `risk_level` и карту `risk_scores`." }, "additional_information": { "type": "object", "nullable": true, "description": "Дополнительный контекст в свободной форме, например массив `flag_summary`, объясняющий, почему сущность помечена флагом." }, "review_status": { "type": "string", "nullable": true, "enum": [ "False Positive", "Unreviewed", "Confirmed Match", "Inconclusive" ], "description": "`False Positive` — `match_score` ниже `aml_match_score_threshold`, исключено из оценки рисков. `Unreviewed` — возможное совпадение, ожидающее проверки. `Confirmed Match` / `Inconclusive` — устанавливается проверяющим вручную (через Business Console) для сохранённых сессий; эта возможность проверки не входит в данную спецификацию." }, "score_breakdown": { "type": "object", "nullable": true, "description": "Как рассчитывалась `match_score`. Имя, дата рождения и страна вносят по `_score` × `_weight_normalized` баллов; веса пересчитываются (нормализуются заново), если компонент отсутствует в проверяемых данных. Номер документа не взвешивается — он выступает в качестве «золотого ключа»: `MATCH` заменяет оценку на 100, `NEUTRAL` оставляет её без изменений, `HARD_MISMATCH` применяет штраф.", "properties": { "name_score": { "type": "integer", "nullable": true, "description": "Необработанное сходство имён (0–100)." }, "name_weight": { "type": "integer", "nullable": true, "description": "Настроенный вес имени (`aml_name_weight`)." }, "name_weight_normalized": { "type": "number", "nullable": true, "description": "Вес имени после перенормализации (0–100)." }, "name_contribution": { "type": "number", "nullable": true, "description": "Баллы за имя, вошедшие в `total_score`." }, "dob_score": { "type": "integer", "nullable": true, "description": "Оценка даты рождения в процентах от её веса (от −100 до 100)." }, "dob_weight": { "type": "integer", "nullable": true, "description": "Настроенный вес даты рождения (`aml_dob_weight`)." }, "dob_weight_normalized": { "type": "number", "nullable": true, "description": "Вес даты рождения после перенормировки (0–100)." }, "dob_contribution": { "type": "number", "nullable": true, "description": "Баллы за дату рождения, вошедшие в `total_score`." }, "country_score": { "type": "integer", "nullable": true, "description": "Оценка страны в процентах от её веса (от −100 до 100)." }, "country_weight": { "type": "integer", "nullable": true, "description": "Настроенный вес страны (`aml_country_weight`)." }, "country_weight_normalized": { "type": "number", "nullable": true, "description": "Вес страны после перенормировки (0–100)." }, "country_contribution": { "type": "number", "nullable": true, "description": "Баллы за страну, вошедшие в `total_score`." }, "document_number_match_type": { "type": "string", "nullable": true, "enum": [ "MATCH", "NEUTRAL", "HARD_MISMATCH" ], "description": "Результат сравнения номеров документов по эталонному ключу (golden-key)." }, "document_number_effect": { "type": "string", "nullable": true, "description": "Понятное описание влияния номера документа." }, "total_score": { "type": "integer", "nullable": true, "description": "Финальная взвешенная оценка совпадения (0–100) — дублирует `match_score`." } } } } } }, "score": { "type": "number", "nullable": true, "description": "Общая оценка риска AML (0–100): наибольший `risk_score` среди совпадений, не являющихся ложными срабатываниями. Определяет `status` с помощью двух порогов." }, "screened_data": { "type": "object", "description": "Эхо проверенных данных: `full_name`, `date_of_birth`, `nationality`, `document_number` (отсутствующие поля содержат `null`).", "properties": { "full_name": { "type": "string" }, "date_of_birth": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "document_number": { "type": "string", "nullable": true } } }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Функция, вызвавшая предупреждение." }, "risk": { "type": "string", "description": "Машиночитаемый идентификатор риска." }, "additional_data": { "type": "object", "nullable": true, "description": "Дополнительный контекст предупреждения, если он доступен." }, "log_type": { "type": "string", "description": "`warning`, `information` или `error` — как этот риск повлиял на результат." }, "short_description": { "type": "string", "description": "Однострочная понятная человеку сводка." }, "long_description": { "type": "string", "description": "Полное понятное человеку объяснение." } } }, "description": "Содержит предупреждение `POSSIBLE_MATCH_FOUND`, когда `score` не равен нулю и ≥ `aml_score_approve_threshold` (оценка ровно 0 никогда не вызывает предупреждение); в остальных случаях пустой." } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Эхо отправленных вами `vendor_data`." }, "metadata": { "type": "object", "nullable": true, "description": "Эхо-значение переданного вами `metadata`." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "No hits (Approved)": { "summary": "Чистый скрининг — ноль совпадений", "value": { "request_id": "d27c5509-7a66-45a9-b05e-d69d9f4c336a", "aml": { "status": "Approved", "total_hits": 0, "entity_type": "person", "hits": [], "score": 0, "screened_data": { "full_name": "Maximilian Mustermann-Doe", "date_of_birth": "1992-03-14", "nationality": "DE", "document_number": null }, "warnings": [] }, "vendor_data": "user-1234", "metadata": { "internal_ref": "abc-123" }, "created_at": "2026-06-11T10:21:07.013938+00:00" } }, "PEP hit (Approved — risk below approve threshold)": { "summary": "Одно возможное совпадение с политически значимым лицом (PEP); оценка риска 73 остаётся ниже стандартного порога одобрения 80", "value": { "request_id": "0b7e7a3e-65a1-4f3d-9c7a-1de2f9a40111", "aml": { "status": "Approved", "total_hits": 1, "entity_type": "person", "hits": [ { "id": "hit_7c1e9a40b2d35f86e0a4c912", "url": "https://news.example.org/articles/sample", "match": false, "score": 0.93, "match_score": 93.0, "risk_score": 73.0, "target": null, "caption": "Antonio Ejemplo Modelo", "datasets": [ "PEP Level 1", "PEP" ], "features": null, "rca_name": "", "first_seen": "2026-01-07T00:00:00", "last_seen": "2026-01-07T00:00:00", "review_status": "Unreviewed", "properties": { "name": [ "Antonio Ejemplo Modelo", "Antonio Ejemplo" ], "alias": [ "Antonio Ejemplo Modelo", "Ejemplo Modelo, Pedro" ], "notes": [ "Prime Minister of Spain" ], "gender": [ "male" ], "birthDate": [ "1972-02-29" ], "birthPlace": [ "Madrid, Spain" ], "nationality": null, "position": null }, "risk_view": { "crimes": { "score": 0.0, "weightage": 20, "risk_level": "Low", "risk_scores": {} }, "countries": { "score": 9.64, "weightage": 30, "risk_level": "Low", "risk_scores": { "Spain": 25.71 } }, "categories": { "score": 62.5, "weightage": 50, "risk_level": "High", "risk_scores": { "PEP": 100.0, "PEP Level 1": 100.0 } }, "custom_list": {} }, "score_breakdown": { "name_score": 89, "name_weight": 60, "name_weight_normalized": 60.0, "name_contribution": 53.4, "dob_score": 100, "dob_weight": 25, "dob_weight_normalized": 25.0, "dob_contribution": 25.0, "country_score": 100, "country_weight": 15, "country_weight_normalized": 15.0, "country_contribution": 15.0, "document_number_match_type": "NEUTRAL", "document_number_effect": "No document number provided for screening", "total_score": 93 }, "pep_matches": [ { "aliases": [], "education": [], "list_name": "Presidency of the Government of Spain", "publisher": "Presidency of the Government of Spain", "source_url": "https://news.example.org/articles/sample", "description": "The Presidency of the Government is the central institutional body in Spain that supports the Prime Minister and coordinates the general action of the central government.", "matched_name": "Antonio Ejemplo Modelo", "pep_position": "", "date_of_birth": "1972-02-29", "other_sources": [], "place_of_birth": "Madrid, Spain" } ], "sanction_matches": [], "warning_matches": [], "adverse_media_matches": [], "adverse_media_details": null, "linked_entities": [ { "name": [ "Maria Begona Gomez Fernandez" ], "active": [], "status": [], "details": [], "relation": [ "spouse" ] } ], "additional_information": { "flag_summary": [ "Antonio Ejemplo Modelo has been flagged as a Level 1 Politically Exposed Person (PEP) from Spain, serving as the President of the Government of Spain." ] } } ], "score": 73.0, "screened_data": { "full_name": "Pedro Sanchez Perez-Castejon", "date_of_birth": "1972-02-29", "nationality": "ES", "document_number": null }, "warnings": [] }, "vendor_data": null, "metadata": null, "created_at": "2026-06-11T10:23:44.812000+00:00" } } } } } }, "400": { "description": "Ошибка валидации. Проблемы на уровне полей возвращают стандартную структуру DRF (один массив сообщений на каждое некорректное поле); межполевые правила (сумма весов, порядок порогов, мониторинг без сохранения) возвращают `{\"error\": [...]}`.", "content": { "application/json": { "examples": { "Missing full_name": { "summary": "`full_name` является единственным обязательным полем", "value": { "full_name": [ "This field is required." ] } }, "Short full_name": { "summary": "`full_name` должно содержать не менее 2 символов", "value": { "full_name": [ "Ensure this field has at least 2 characters." ] } }, "Invalid nationality": { "summary": "`nationality` должно соответствовать ISO 3166-1 alpha-2", "value": { "nationality": [ "Invalid ISO 3166-1 alpha-2 country code." ] } }, "Weights do not sum to 100": { "summary": "`aml_name_weight` + `aml_dob_weight` + `aml_country_weight` ≠ 100", "value": { "error": [ "AML weights must sum to 100. Current sum: 90 (name: 50, dob: 25, country: 15)" ] } }, "Thresholds out of order": { "summary": "Порог одобрения выше порога проверки", "value": { "error": [ "Approve threshold (90.0) cannot be greater than review threshold (80.0)" ] } }, "Monitoring without saving": { "summary": "`include_ongoing_monitoring=true` при `save_api_request=false`", "value": { "error": [ "Ongoing monitoring can only be enabled when the API request is saved." ] } } } } } }, "403": { "description": "В доступе отказано. Возвращается, если заголовок `x-api-key` отсутствует, а также если баланс вызывающей организации не покрывает вызов; неверный, отозванный или истекший ключ возвращает `401`. Отсутствующий ключ возвращает `403` с `{\"detail\": ...}`; неверный, отозванный или истекший ключ возвращает `401`. При нехватке кредитов возвращается `403` с `{\"error\": ...}` до начала любого скрининга или вызова провайдера.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Отсутствует заголовок `x-api-key`, либо ключ недействителен/отозван", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "Баланс организации недостаточен для совершения вызова", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Превышен лимит запросов. Endpoint'ы POST/PATCH/DELETE делят общий лимит в 300 запросов на запись в минуту на один API-ключ (для создания транзакций и отправки событий действует отдельный лимит в 600). Ответ содержит заголовки `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` и `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Более 300 запросов на запись в текущую минуту", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } } } }, "/v3/face-search/": { "post": { "summary": "Поиск по лицу", "description": "Выполните поиск изображения лица (1:N) по индексу поиска по лицу вашего приложения — лицам, зарегистрированным из сессий верификации, сохранённых отдельных вызовов API, прямых загрузок лиц в профили пользователей, а также ваших списков блокировки и разрешений — и получите ранжированные совпадения по сходству, а также предупреждения о списках блокировки и дубликатах.\n\n**Как это работает.** Для самого крупного обнаруженного лица на `user_image` формируется эмбеддинг, по которому выполняется поиск по индексу в рамках вашего приложения. В `matches` возвращается до **5 совпадений** выше минимального порога сходства, каждое из которых содержит `similarity_percentage`, исходную сессию (`session_id`, `session_number`, `status`, `vendor_data`), данные `user_details`, извлечённые в ходе верификации документа этой сессии, флаги `is_blocklisted` / `is_allowlisted` и дискриминатор `source` (`session`, `imported` или `list_entry`).\n\n- `search_type=most_similar` (по умолчанию) ранжирует все зарегистрированные лица по сходству — используйте этот тип для дедупликации и расследования мошеннических схем.\n- `search_type=blocklisted_or_approved` ограничивает кандидатов лицами из списка блокировки, разрешёнными лицами, лицами из одобренных сессий и импортированными лицами из профилей пользователей, при этом записи из списка блокировки ранжируются первыми — используйте этот тип, когда основной целью является скрининг по списку блокировки.\n\nПараметр `status` принимает значение `Declined` только в том случае, если срабатывает предупреждение `FACE_IN_BLOCKLIST` или `POSSIBLE_FACE_IN_BLOCKLIST`; предупреждения `DUPLICATED_FACE` / `POSSIBLE_DUPLICATED_FACE` (`information`) и `MULTIPLE_FACES_DETECTED` (`warning`) никогда не приводят к отклонению. В отличие от пассивной проверки живости, этот endpoint **не** исключает из сопоставления предыдущие сессии с тем же `vendor_data`. Внутренний анализ пассивной проверки живости также запускается и сохраняется вместе с сохранённой сессией, но его результат не включается в данный ответ.\n\n**Биллинг.** Каждый ответ `200` расходует один кредит API Поиска по лицу (списывается с кредитов вашего тарифа или баланса пополнения). При недостаточном балансе возвращается `403` до начала какой-либо обработки изображения.\n\n**Сохранение сессии и регистрация лица (`save_api_request`, по умолчанию `true`).** Если установлено значение `true`, вызов сохраняется как сессия типа API (Business Console, `GET /v3/session/{sessionId}/decision/` по возвращённому `request_id`, webhook `status.updated`), а лицо, по которому выполнялся поиск, регистрируется в вашем индексе поиска по лицу. Лица, зарегистрированные при вызовах Поиска по лицу, исключаются из будущих результатов Поиска по лицу, поэтому повторные поиски никогда не совпадут друг с другом. Если установлено значение `false`, вызов является однократным: ничего не сохраняется, лицо не регистрируется, а значения `match_image_url` представляют собой внутренние пути хранилища, а не доступные для скачивания URL.\n\n**Песочница.** API-ключи песочницы пропускают всю обработку и биллинг: после валидации запроса (некорректный ввод по-прежнему возвращает `400`) endpoint возвращает статический payload-заглушку со статусом `Approved`, сессия не сохраняется, и кредиты не расходуются.\n\n**Аутентификация.** Передавайте API-ключ вашего приложения в заголовке `x-api-key`. При отсутствии или недействительности учётных данных возвращается `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`) — этот API никогда не возвращает `401`.\n\n**Лимит запросов.** Общий лимит на запись составляет 300 запросов/мин на один API-ключ для всех endpoints POST/PATCH/DELETE; при его превышении возвращается `429`.", "operationId": "post_v3face-search", "x-didit-sdk": { "resource": "face_search", "method": "search", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "parameters": [], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "user_image" ], "properties": { "user_image": { "type": "string", "format": "binary", "description": "Фронтальное изображение лица для поиска. Допустимые расширения: `tiff`, `jpg`, `jpeg`, `png`, `webp`. Максимальный размер загружаемого файла: **5 MB** (файлы большего размера отклоняются с ошибкой `400`). Перед обработкой изображения автоматически сжимаются примерно до 0.5 MB, поэтому сверхвысокое разрешение не повышает точность. На изображении должно быть хотя бы одно распознаваемое лицо — иначе endpoint возвращает `400`. Если лиц несколько, поиск выполняется по самому крупному и добавляется предупреждение `MULTIPLE_FACES_DETECTED`." }, "search_type": { "type": "string", "default": "most_similar", "enum": [ "most_similar", "blocklisted_or_approved" ], "description": "Политика поиска. `most_similar` (по умолчанию) ранжирует все зарегистрированные лица в вашем приложении по сходству. `blocklisted_or_approved` ограничивает кандидатов лицами из списка блокировки, белого списка, лицами из одобренных сессий и импортированными лицами из профилей пользователей, при этом записи из списка блокировки располагаются первыми.", "example": "most_similar" }, "rotate_image": { "type": "boolean", "default": false, "description": "Когда `true`, сервис пробует поворачивать входное изображение с шагом 90 градусов и использует ориентацию, обеспечивающую наилучшее обнаружение лица. Полезно, когда отсутствуют данные ориентации EXIF. Увеличивает задержку ответа.", "example": false }, "save_api_request": { "type": "boolean", "default": true, "description": "Когда `true` (по умолчанию), сохраняет вызов как сессию типа API, отправляет webhook `status.updated`, генерирует предварительно подписанные URL для значений `match_image_url` и регистрирует найденное лицо в вашем индексе Поиска по лицу (зарегистрированные лица исключаются из будущих поисков). Когда `false`, поиск является однократным — сессия не сохраняется, а лицо не регистрируется.", "example": true }, "vendor_data": { "type": "string", "description": "Необязательный непрозрачный идентификатор (ваш user id, email, UUID…), сохраняемый в сессии и возвращаемый обратно. Он не исключает лица того же пользователя из результатов поиска.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Необязательный объект JSON, сохраняемый вместе с сессией (когда `save_api_request=true`) и возвращаемый обратно. В multipart-запросах отправляйте его как строковое поле в формате JSON — он парсится в объект.", "example": { "flow": "dedup_check" } } } }, "example": { "user_image": "(binary JPEG/PNG selfie)", "search_type": "most_similar", "rotate_image": false, "save_api_request": true, "vendor_data": "user-123", "metadata": { "flow": "dedup_check" } } } } }, "responses": { "200": { "description": "Поиск по лицу завершен. `face_search.matches` содержит до 5 похожих лиц, отсортированных по схожести; пустой массив означает, что ни одно зарегистрированное лицо не превысило минимальный порог схожести. `status` принимает значение `Declined` только при совпадениях со списком блокировки — совпадения-дубликаты возвращают `Approved`, поэтому проверяйте `matches` и `warnings`, а не только `status`. Если `save_api_request=true`, `request_id` является сохраненным id сессии. Каждое совпадение содержит `source` (`session`, `imported`, `list_entry` или `retained_template`), `vendor_user_id` и `biometric_template_id`; совпадение `retained_template` поступает из биометрического шаблона без изображений, сохраненного после удаления исходной сессии, и содержит `null` в полях сессии, `match_image_url` и `user_details`.", "content": { "application/json": { "examples": { "Blocklist hit (Declined)": { "summary": "Лицо совпадает с лицом из списка блокировки", "value": { "request_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef", "face_search": { "status": "Declined", "total_matches": 1, "matches": [ { "session_id": "882c42d5-8a4d-4d20-8080-a22f57822c86", "session_number": 323442, "similarity_percentage": 99.99, "source": "session", "vendor_data": "user-1", "verification_date": "2025-01-01T00:00:00Z", "user_details": { "full_name": "Jane Marie Doe", "document_type": "ID", "document_number": "X1234567" }, "match_image_url": "https:///face/3f6a1c2e/reference.jpg", "status": "Approved", "is_blocklisted": true, "is_allowlisted": false, "api_service": null, "vendor_user_id": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f", "biometric_template_id": null } ], "user_image": { "entities": [ { "bbox": [ 40, 40, 120, 120 ], "confidence": 0.732973 } ], "best_angle": 0 }, "warnings": [ { "risk": "FACE_IN_BLOCKLIST", "feature": "LIVENESS", "additional_data": { "blocklisted_session_id": "882c42d5-8a4d-4d20-8080-a22f57822c86", "blocklisted_session_number": 323442, "api_service": null }, "log_type": "error", "short_description": "Face in blocklist", "long_description": "The system identified a face in the blocklist, which means the face is not allowed to be verified." } ] }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T01:04:42.763237+00:00" } }, "Duplicate found (Approved)": { "summary": "Лицо уже фигурировало в другой одобренной сессии — информационное сообщение, не приводит к отклонению", "value": { "request_id": "5e0c3a1f-7b2d-4c8e-9f10-2a3b4c5d6e7f", "face_search": { "status": "Approved", "total_matches": 1, "matches": [ { "session_id": "1f2e3d4c-5b6a-7980-1122-334455667788", "session_number": 1024, "similarity_percentage": 87.42, "source": "session", "vendor_data": "user-9", "verification_date": "2025-11-20T09:15:00Z", "user_details": null, "match_image_url": "https:///face/9c8b7a6d/reference.jpg", "status": "Approved", "is_blocklisted": false, "is_allowlisted": false, "api_service": "PASSIVE_LIVENESS", "vendor_user_id": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f", "biometric_template_id": null } ], "user_image": { "entities": [ { "bbox": [ 40, 40, 120, 120 ], "confidence": 0.732973 } ], "best_angle": 0 }, "warnings": [ { "risk": "DUPLICATED_FACE", "feature": "LIVENESS", "additional_data": { "duplicated_session_id": "1f2e3d4c-5b6a-7980-1122-334455667788", "duplicated_session_number": 1024, "api_service": "PASSIVE_LIVENESS" }, "log_type": "information", "short_description": "Duplicated face from other approved session", "long_description": "The system identified a duplicated face from another approved session, requiring further investigation." } ] }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T01:04:42.763237+00:00" } }, "No matches (Approved)": { "summary": "Ни одно зарегистрированное лицо не превысило минимальный порог сходства", "value": { "request_id": "9d8c7b6a-5f4e-3d2c-1b0a-998877665544", "face_search": { "status": "Approved", "total_matches": 0, "matches": [], "user_image": { "entities": [ { "bbox": [ 40, 40, 120, 120 ], "confidence": 0.732973 } ], "best_angle": 0 }, "warnings": [] }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T01:04:42.763237+00:00" } } }, "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Идентификатор сохраненной сессии при `save_api_request=true` (доступен для использования с `GET /v3/session/{sessionId}/decision/`); в противном случае это временный корреляционный UUID." }, "face_search": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined" ], "description": "`Declined`, только если сработало предупреждение `FACE_IN_BLOCKLIST` или `POSSIBLE_FACE_IN_BLOCKLIST`. Предупреждения о дубликатах совпадений и нескольких лицах никогда не приводят к отклонению." }, "total_matches": { "type": "integer", "description": "Количество записей в `matches` (0–5).", "example": 1 }, "matches": { "type": "array", "maxItems": 5, "description": "До 5 лиц из вашего индекса поиска по лицу, превышающих порог схожести, отсортированных по схожести (записи из списка блокировки идут первыми при `search_type=blocklisted_or_approved`). Пусто, если ни одно зарегистрированное лицо не является достаточно похожим.", "items": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Идентификатор сессии верификации, к которой относится совпавшее лицо. Имеет значение `null`, если `source` равен `imported`, `list_entry` или `retained_template`.", "example": "882c42d5-8a4d-4d20-8080-a22f57822c86" }, "session_number": { "type": "integer", "nullable": true, "description": "Понятный номер сессии, отображаемый в Business Console. `null` для совпадений, не связанных с сессиями.", "example": 323442 }, "similarity_percentage": { "type": "number", "format": "float", "minimum": 0, "maximum": 100, "description": "Степень сходства между переданным лицом и найденным лицом (0–100).", "example": 99.99 }, "source": { "type": "string", "enum": [ "session", "imported", "list_entry", "retained_template" ], "description": "Откуда было зарегистрировано совпавшее лицо: `session` — сессия верификации или сохраненный отдельный вызов API; `imported` — лицо, загруженное напрямую в профиль пользователя; `list_entry` — лицо, прикрепленное к одному из ваших списков; `retained_template` — биометрический шаблон без изображения, сохраненный у пользователя и доступный в списке `/v3/biometric-templates/`." }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` совпавшей сессии или связанного пользователя для импортированных лиц и лиц с сохранённым шаблоном.", "example": "user-1" }, "vendor_user_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Идентификатор связанного пользователя. `null` для записей списка и совпадений сессий без пользователя.", "example": "2f7c1a9e-4b28-4a6d-97f1-83576f80e1b4" }, "biometric_template_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Идентификатор сохранённого биометрического шаблона. Задаётся, только если `source` равен `retained_template`; в противном случае `null`.", "example": null }, "verification_date": { "type": "string", "format": "date-time", "nullable": true, "description": "Время первоначального захвата совпавшего лица или время создания сохранённого шаблона (`YYYY-MM-DDThh:mm:ssZ`). `null` для совпадений типа `list_entry`.", "example": "2025-01-01T00:00:00Z" }, "user_details": { "type": "object", "nullable": true, "description": "Данные личности, извлечённые во время проверки документов в совпавшей сессии. `null`, если в совпавшей сессии нет данных документов (например, в сессиях только с проверкой живости), и всегда `null` для совпадений с `retained_template`. Для совпадений с `source: imported` заполняется из профиля пользователя: `full_name` задано, `document_type`/`document_number` null.", "properties": { "full_name": { "type": "string", "nullable": true, "example": "Jane Marie Doe" }, "document_type": { "type": "string", "nullable": true, "example": "ID" }, "document_number": { "type": "string", "nullable": true, "example": "X1234567" } } }, "match_image_url": { "type": "string", "nullable": true, "description": "URL с ограниченным сроком действия (`https:///...`) эталонного изображения совпавшего лица, если `save_api_request=true`. При `save_api_request=false` это внутренний путь хранилища, недоступный для прямого скачивания. Всегда `null` для совпадений `retained_template`, поскольку сохранённые шаблоны не содержат изображения.", "example": "https:///face/3f6a1c2e/reference.jpg" }, "status": { "type": "string", "nullable": true, "description": "Статус сопоставленной сессии (`Approved`, `Declined`, `In Review`, …). `null` для совпадений `imported`/`list_entry`.", "example": "Approved" }, "is_blocklisted": { "type": "boolean", "description": "`true`, если совпавшее лицо находится в вашем списке блокировки лиц. Любое достаточно близкое совпадение из списка блокировки отклоняет поиск." }, "is_allowlisted": { "type": "boolean", "description": "`true`, если совпавшее лицо находится в одном из ваших белых списков. Совпадения из белого списка подавляют предупреждения о дубликатах." }, "api_service": { "type": "string", "nullable": true, "description": "Задаётся, если сопоставленное лицо было зарегистрировано с помощью автономного вызова API (например, `PASSIVE_LIVENESS`); `null` для обычных сессий верификации и импортированных лиц.", "example": null } } } }, "user_image": { "type": "object", "description": "Результаты обнаружения лица для переданного изображения. Элементы здесь содержат только `bbox` и `confidence`.", "properties": { "entities": { "type": "array", "description": "Одна запись на каждое обнаруженное лицо. Поиск выполняется по самому крупному лицу.", "items": { "type": "object", "properties": { "bbox": { "type": "array", "items": { "type": "integer" }, "minItems": 4, "maxItems": 4, "description": "Ограничивающий прямоугольник `[x_min, y_min, x_max, y_max]` в пикселях.", "example": [ 40, 40, 120, 120 ] }, "confidence": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Уверенность обнаружения лица (0–1).", "example": 0.732973 } } } }, "best_angle": { "type": "integer", "description": "Поворот (в градусах), при котором было достигнуто наилучшее обнаружение лица; отличен от нуля, только если `rotate_image=true` скорректировал ориентацию. На этом endpoint никогда не бывает null (по умолчанию 0, если модель его опускает).", "example": 0 } } }, "warnings": { "type": "array", "description": "Сигналы риска. `FACE_IN_BLOCKLIST` / `POSSIBLE_FACE_IN_BLOCKLIST` (`error`) отклоняют поиск; `MULTIPLE_FACES_DETECTED` (`warning`) и `DUPLICATED_FACE` / `POSSIBLE_DUPLICATED_FACE` (`information`) носят рекомендательный характер.", "items": { "type": "object", "properties": { "risk": { "type": "string", "enum": [ "MULTIPLE_FACES_DETECTED", "FACE_IN_BLOCKLIST", "POSSIBLE_FACE_IN_BLOCKLIST", "DUPLICATED_FACE", "POSSIBLE_DUPLICATED_FACE" ], "description": "Машиночитаемый код риска." }, "feature": { "type": "string", "enum": [ "LIVENESS" ], "description": "Функция, вызвавшая предупреждение. На этом endpoint всегда `LIVENESS`." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "`null` для `MULTIPLE_FACES_DETECTED`. Совпадения со списком блокировки содержат `{blocklisted_session_id, blocklisted_session_number, api_service}`; дубликаты содержат `{duplicated_session_id, duplicated_session_number, api_service}`, указывающие на первую совпавшую сессию." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Серьёзность. Предупреждения `error` переводят `status` в `Declined`; записи `warning` и `information` носят информационный характер и сами по себе никогда не приводят к отклонению." }, "short_description": { "type": "string", "description": "Краткая сводка риска в одну строку в понятном человеку формате." }, "long_description": { "type": "string", "description": "Понятное объяснение риска." } } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Эхо-значение переданного вами `vendor_data` или `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Эхо-значение переданного вами объекта `metadata` или `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Временная метка ISO 8601 (UTC) момента генерации ответа, например `2026-06-12T01:04:42.763237+00:00`." } } } } } }, "400": { "description": "Ошибка валидации. Возвращается, если `user_image` отсутствует, превышает 5 МБ, имеет неподдерживаемое расширение или если в отправленном изображении **лицо не обнаружено**. Ошибки полей используют обёртку DRF `{field: [messages]}`; сбои обнаружения лица используют `{\"error\": ...}`.", "content": { "application/json": { "examples": { "No face detected": { "summary": "Изображение успешно декодируется, но не содержит обнаруживаемого лица", "value": { "error": "No face detected in the image" } }, "Missing image": { "summary": "`user_image` не включён в данные формы", "value": { "user_image": [ "No file was submitted." ] } }, "Unsupported file extension": { "summary": "Расширение файла отличается от tiff/jpg/jpeg/png/webp", "value": { "user_image": [ "File extension “txt” is not allowed. Allowed extensions are: tiff, jpg, jpeg, png, webp." ] } }, "File too large": { "summary": "Размер загружаемого файла превышает лимит в 5 МБ", "value": { "user_image": [ "File size should not exceed 5 MB" ] } } } } } }, "403": { "description": "В доступе отказано. Возвращается, если заголовок `x-api-key` отсутствует, а также если баланс вызывающей организации не покрывает вызов; неверный, отозванный или истекший ключ возвращает `401`. Отсутствующий ключ возвращает `403` с `{\"detail\": ...}`; неверный, отозванный или истекший ключ возвращает `401`. При нехватке кредитов возвращается `403` с `{\"error\": ...}` до начала любой обработки изображения.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Отсутствует заголовок `x-api-key`, либо ключ недействителен/отозван", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "Баланс организации недостаточен для совершения вызова", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Превышен лимит запросов. Endpoint'ы POST/PATCH/DELETE делят общий лимит в 300 запросов на запись в минуту на один API-ключ (для создания транзакций и отправки событий действует отдельный лимит в 600). Ответ содержит заголовки `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` и `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Более 300 запросов на запись в текущую минуту", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X POST 'https://verification.didit.me/v3/face-search/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'user_image=@./selfie.jpg' \\\n -F 'search_type=most_similar' \\\n -F 'save_api_request=true' \\\n -F 'vendor_data=user-123'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.face_search.search(\n user_image=open(\"user_image.jpg\", \"rb\"),\n search_type=\"most_similar\",\n rotate_image=False,\n save_api_request=True,\n vendor_data=\"user-123\",\n metadata={\"flow\": \"dedup_check\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.faceSearch.search({\n user_image: await fileFromPath(\"user_image.jpg\"),\n search_type: \"most_similar\",\n rotate_image: false,\n save_api_request: true,\n vendor_data: \"user-123\",\n metadata: { flow: \"dedup_check\" },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.FaceSearch.Search(ctx, didit.FaceSearchSearchParams{\n\tUserImage: didit.FileFromPath(\"user_image.jpg\"),\n\tSearchType: didit.Some(didit.FaceSearchSearchParamsSearchType(\"most_similar\")),\n\tRotateImage: didit.Bool(false),\n\tSaveAPIRequest: didit.Bool(true),\n\tVendorData: didit.String(\"user-123\"),\n\tMetadata: didit.Some(map[string]any{\"flow\": \"dedup_check\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.FaceSearchSearchParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.faceSearch().search(FaceSearchSearchParams.builder()\n .userImage(Path.of(\"user_image.jpg\"))\n .searchType(FaceSearchSearchParams.SearchType.of(\"most_similar\"))\n .rotateImage(false)\n .saveApiRequest(true)\n .vendorData(\"user-123\")\n .metadata(Map.of(\"flow\", \"dedup_check\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "faceSearch->search([\n 'user_image' => File::fromPath('user_image.jpg'),\n 'search_type' => 'most_similar',\n 'rotate_image' => false,\n 'save_api_request' => true,\n 'vendor_data' => 'user-123',\n 'metadata' => ['flow' => 'dedup_check'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.face_search.search(\n user_image: Pathname(\"user_image.jpg\"),\n search_type: \"most_similar\",\n rotate_image: false,\n save_api_request: true,\n vendor_data: \"user-123\",\n metadata: { flow: \"dedup_check\" }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.FaceSearch.SearchAsync(new FaceSearchSearchParams\n{\n UserImage = FileUpload.FromPath(\"user_image.jpg\"),\n SearchType = new FaceSearchSearchParamsSearchType(\"most_similar\"),\n RotateImage = false,\n SaveApiRequest = true,\n VendorData = \"user-123\",\n Metadata = new Dictionary { [\"flow\"] = \"dedup_check\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/sessions/": { "get": { "summary": "Получить список сессий верификации (KYC и/или KYB) с фильтрацией и пагинацией", "description": "Возвращает разбитый на страницы список сессий верификации для приложения, определяемого вашим API-ключом, сначала новые (по убыванию `session_number`).\n\n**Канонический URL:** маршрут: `/v3/sessions/` (со слэшем на конце). Запросы к `/v3/sessions` без слэша получают перенаправление `301` на URL со слэшем с сохранением строки запроса; большинство HTTP-клиентов прозрачно следуют ему при вызовах GET.\n\n**Когда использовать этот endpoint, а когда webhook.** Используйте этот endpoint для панелей управления, поиска в бэк-офисе, сверки данных и пакетного экспорта. Не опрашивайте его для отслеживания прогресса отдельных верификаций - настройте вместо этого [webhook](/ru/integration/webhooks), которые отправляют события `status.updated` в момент изменения сессии. Чтобы получить полный результат по одной сессии, вызывайте `GET /v3/session/{sessionId}/decision/`.\n\n**Сессии KYC и KYB.** `session_kind` определяет, какие типы сессий выводятся в списке:\n- `user` (по умолчанию) - только сессии Проверки пользователей (KYC). Поведение для обратной совместимости.\n- `business` - только сессии Верификации бизнеса (KYB). Строки имеют другую, более компактную структуру (см. схему ответа).\n- `all` - оба типа в одном ответе: страница KYC и страница KYB для одних и тех же `limit`/`offset` объединяются в `results` (сначала строки KYC), поэтому страница может содержать до `2 x limit` строк. `count` представляет собой сумму обоих типов, а `next`/`previous` отражают пагинацию со стороны KYC. Для строгой пагинации смешанных данных вызывайте `user` и `business` отдельно.\n\nКаждая строка содержит дискриминатор `session_kind` (`\"user\"` или `\"business\"`).\n\n**Пагинация.** Стандартная схема limit/offset: `limit` (по умолчанию 50) и `offset` (по умолчанию 0), с готовыми URL страниц в `next`/`previous`. Для строк KYC значение `count` является точным. Для строк KYB значение `count` вычисляется с помощью ограниченного сканирования и ограничено 100 - если совпадений больше 100, оно остаётся равным 100, поэтому выполняйте итерацию с помощью `next` (или проверяя, была ли возвращена полная страница), а не вычисляя общее количество страниц из `count`.\n\n**Семантика фильтров.** Все фильтры объединяются по условию И (AND) и применяются к строкам KYC. Когда `session_kind` имеет значение `business` или `all`, на стороне KYB учитываются общие параметры `vendor_data`, `status`, `workflow_id`, `country` (код страны регистрации компании), `date_from`, `date_to`, `search` (название компании, регистрационный номер — вводите регистрационные номера без разделителей, например `DPC001`, а не `DPC-001` — vendor_data, номер сессии или UUID сессии), `warning` и `organization_name`; остальные фильтры, предназначенные только для KYC, игнорируются для строк KYB. Параметры, разделённые запятыми (`status`, `country`, `document_type`, `region`, `workflow_id`, `document_name`, `warning`, `organization_name`, `session_type`), сопоставляются с любым из указанных значений (ИЛИ внутри параметра). Поле `vendor_data` сопоставляется точно - используйте `search` для частичного совпадения. Неизвестные значения в фильтрах-списках просто не возвращают строк (без ошибки); некорректно сформированные типизированные значения (`date_from`, `date_to`, `didit_internal_id`, `api_service`, `session_kind`) возвращают `400` с объектом ошибки для каждого поля.\n\n**Поиск.** Параметр `search` адаптируется к входным данным: полный UUID ищет по `session_id`; цифры (с необязательными `+ - . space`) сопоставляются с префиксом номера сессии, номерами документов/персональными номерами, префиксом номера телефона или `vendor_data`; значения, содержащие `@`, сопоставляются с префиксами адресов электронной почты; любой другой текст сопоставляется с именами (без учёта диакритических знаков) и `vendor_data`.\n\nФиксированный лимит запросов на endpoint не установлен, однако опрашивайте список нечасто и полагайтесь на webhook для получения обновлений в реальном времени.", "operationId": "get_v3_sessions", "x-didit-sdk": { "resource": "sessions", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "session_kind", "in": "query", "required": false, "description": "Какой тип сессий возвращать в списке: `user` (только KYC, по умолчанию), `business` (только KYB) или `all` (оба типа, объединённые - семантику объединённой пагинации см. в описании). Сопоставление нечувствительно к регистру (работает `BUSINESS`); любое значение, отличное от вариантов регистра `user`/`business`/`all`, возвращает `400`.", "schema": { "type": "string", "enum": [ "user", "business", "all" ], "default": "user" }, "example": "all" }, { "name": "limit", "in": "query", "required": false, "description": "Максимальное количество строк на странице (для каждого типа при `session_kind=all`). По умолчанию 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "example": 20 }, { "name": "offset", "in": "query", "required": false, "description": "Количество строк, пропускаемых перед первой возвращаемой строкой. По умолчанию 0. Рекомендуется переходить по URL `next`/`previous` из ответа.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "example": 20 }, { "name": "status", "in": "query", "required": false, "description": "Разделённый запятыми список статусов сессий для включения, например `Approved,In Review`. Значения чувствительны к регистру; см. [Статусы верификации](/ru/integration/verification-statuses). Неизвестные значения не дают совпадений.", "schema": { "type": "string" }, "example": "Approved,In Review" }, { "name": "vendor_data", "in": "query", "required": false, "description": "Фильтр по точному совпадению с `vendor_data`, переданным при создании сессии (ваш собственный идентификатор пользователя/компании). Для частичных совпадений используйте `search`.", "schema": { "type": "string" }, "example": "your-user-id-123" }, { "name": "search", "in": "query", "required": false, "description": "Полная отображаемая ссылка, например `S-0001` (пользователь) или `B-0001` (компания), соответствует только сессии с этим номером и типом; ведущие нули и регистр букв не влияют на сопоставление. Интеллектуальный поиск по свободному тексту. Полный UUID сопоставляется с `session_id`; числовой ввод сопоставляется с префиксом номера сессии, номерами документов/персональными номерами, префиксом телефона или `vendor_data`; ввод, содержащий `@`, сопоставляется с префиксами email; прочий текст сопоставляется с именами (без учёта диакритики) и `vendor_data`. Свободный текст, содержащий цифры, дополнительно сопоставляется с полями поиска документов/персональных номеров и префиксами номеров сессий.", "schema": { "type": "string" }, "example": "jane doe" }, { "name": "workflow_id", "in": "query", "required": false, "description": "Разделённые запятыми UUID сценариев (их можно найти на странице Workflows в Console). Некорректные UUID в списке игнорируются; если валидных нет, результат будет пустым.", "schema": { "type": "string" }, "example": "9f9b1234-aaaa-bbbb-cccc-1234567890ab" }, { "name": "date_from", "in": "query", "required": false, "description": "Только сессии, созданные в эту дату (UTC) или позже, формат `YYYY-MM-DD`. Некорректный формат даты возвращает ошибку `400`.", "schema": { "type": "string", "format": "date" }, "example": "2026-06-01" }, { "name": "date_to", "in": "query", "required": false, "description": "Только сессии, созданные до этой даты (UTC) включительно, формат `YYYY-MM-DD`. Для строк KYC включается весь день; для строк KYB сравнение выполняется как `created_at <= date_to` (полночь), поэтому используйте дату следующего дня, чтобы включить полный день сессий KYB.", "schema": { "type": "string", "format": "date" }, "example": "2026-06-30" }, { "name": "tags", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Разделённый запятыми список идентификаторов тегов (`tags` вашего приложения). Возвращает сессии, содержащие любой из них. Идентификаторы, не являющиеся корректными UUID, игнорируются, и если ни один из них не валиден, список будет пустым." }, { "name": "decided_from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Дата и время в формате ISO 8601. Возвращает сессии, статус которых в последний раз изменился в этот момент или позже. Фильтрация выполняется по времени последнего изменения статуса, а не по времени создания." }, { "name": "decided_to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Дата и время в формате ISO 8601. Возвращает сессии, статус которых в последний раз изменился до этого момента. Объедините с `decided_from` для задания полуинтервала." }, { "name": "country", "in": "query", "required": false, "description": "Разделённый запятыми фильтр по странам. Для строк KYC: трёхбуквенные коды ISO 3166-1 alpha-3 страны выдачи документа, удостоверяющего личность (например, `ESP,USA`), которая может отличаться от гражданства. Для строк KYB: код страны компании из реестра.", "schema": { "type": "string" }, "example": "ESP,USA" }, { "name": "document_type", "in": "query", "required": false, "description": "Разделённые запятыми коды типов документов, удостоверяющих личность, проверенных в сессии (только строки KYC): `P` (Паспорт), `ID` (Удостоверение личности), `DL` (Водительское удостоверение), `RP` (Вид на жительство), `SSC` (Карта социального страхования), `HIC` (Медицинская страховая карта), `WP` (Разрешение на работу), `TC` (Налоговая карта), `VISA`, `PSC` (Карта государственного обслуживания), `BC` (Свидетельство о рождении), `OTHER`. Обратите внимание, что поле ответа `document_type` содержит отображаемое имя, а не код.", "schema": { "type": "string" }, "example": "P,ID" }, { "name": "document_name", "in": "query", "required": false, "description": "Точные названия документов; несколько названий можно передать через запятую, однако разделение по запятым выполняется только при наличии более одного разделителя ` - ` (отдельное название со встроенной запятой сопоставляется целиком). Названия указываются так, как они распознаются при верификации документов (лицевая или оборотная сторона), например `Spain - Id Card (2021)`. Только для строк KYC.", "schema": { "type": "string" }, "example": "Spain - Id Card (2021)" }, { "name": "region", "in": "query", "required": false, "description": "Разделённые запятыми значения региона/штата документа (для документов, выдаваемых по регионам, таких как водительские удостоверения в США). Только для строк KYC.", "schema": { "type": "string" }, "example": "CA,TX" }, { "name": "didit_internal_id", "in": "query", "required": false, "description": "Фильтр по внутреннему идентификатору пользователя в Didit (поле ответа `didit_internal_id`) для вывода всех сессий одного верифицированного пользователя. Должен быть корректным UUID; некорректные значения возвращают `400`. Только для записей KYC.", "schema": { "type": "string", "format": "uuid" }, "example": "d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147" }, { "name": "session_type", "in": "query", "required": false, "description": "Разделённый запятыми список каналов создания сессий: `API`, `HOSTED`, `MIGRATED`. Специальное значение `ALL` (или отсутствие параметра) отключает фильтр. Только строки KYC.", "schema": { "type": "string" }, "example": "HOSTED" }, { "name": "api_service", "in": "query", "required": false, "description": "Фильтр автономных сессий API по сервису. Недопустимые значения возвращают `400`. Только строки KYC.", "schema": { "type": "string", "enum": [ "ID_VERIFICATION", "FACE_MATCH", "AGE_ESTIMATION", "FACE_SEARCH", "POA", "AML", "KYB_REGISTRY", "PASSIVE_LIVENESS", "DATABASE_VALIDATION", "PHONE_VERIFICATION", "EMAIL_VERIFICATION" ] }, "example": "AML" }, { "name": "screened_full_name", "in": "query", "required": false, "description": "Поиск по имени без учёта диакритических знаков среди данных, проверенных в рамках AML и проверки по базам данных. В сочетании с `api_service=AML` или `api_service=DATABASE_VALIDATION` поиск ограничивается проверенными данными соответствующей функции. Только строки KYC.", "schema": { "type": "string" }, "example": "Jane Doe" }, { "name": "warning", "in": "query", "required": false, "description": "Разделённые запятыми коды риска предупреждений; возвращает сессии, для которых сработал любой из них (например, `POSSIBLE_FRAUD`). Коды риска перечислены для каждой функции в [документации по предупреждениям](/ru/integration/webhooks). Применяется к строкам KYC и, с кодами предупреждений для бизнеса, к строкам KYB.", "schema": { "type": "string" }, "example": "POSSIBLE_FRAUD" }, { "name": "status_initialized_as_in_review", "in": "query", "required": false, "description": "Когда `true`, возвращает только сессии, решение по которым изначально перешло в статус `In Review` (полезно для аудита объема ручных проверок). Только строки KYC.", "schema": { "type": "boolean" }, "example": true }, { "name": "is_kyc_to_be_reviewed", "in": "query", "required": false, "description": "`true` возвращает сессии, верификация документов которых помечена для ручной проверки; `false` возвращает сессии, где верификация документов явно не помечена. Опустите, чтобы отключить фильтр. Только для строк KYC.", "schema": { "type": "boolean" }, "example": true }, { "name": "euuid", "in": "query", "required": false, "description": "Фильтр по euuid конечного пользователя (UUID, назначенный верифицируемому пользователю; используется диплинками Console). Должен быть валидным UUID; некорректные значения возвращают ошибку поля с кодом 400. Только строки KYC.", "schema": { "type": "string", "format": "uuid" }, "example": "0f8fad5b-d9cb-469f-a165-70867728950e" }, { "name": "organization_name", "in": "query", "required": false, "description": "Разделённый запятыми список названий организаций. Предназначен для Console; при использовании API-ключа (уже привязанного к одному приложению) соответствует только названию вашей собственной организации.", "schema": { "type": "string" }, "example": "Acme Inc" } ], "responses": { "200": { "description": "Список сессий с пагинацией. Элементы `results` представляют собой строки KYC, строки KYB или и то, и другое в зависимости от `session_kind`; различайте их с помощью поля `session_kind` каждой строки.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "description": "Количество сессий, соответствующих фильтрам: точное значение до 100 и с ограничением 100 сверх этого порога, поэтому не используйте его в качестве общего итога. Используйте `next`, чтобы узнать, есть ли ещё страницы. Для `session_kind=all` это сумма обоих типов, каждый с ограничением 100.", "example": 2 }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "Абсолютный URL следующей страницы или `null` на последней странице.", "example": "https://verification.didit.me/v3/sessions/?limit=20&offset=20" }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "Абсолютный URL предыдущей страницы или `null` на первой странице.", "example": null }, "results": { "type": "array", "description": "Строки сессий, сначала новые. При `session_kind=all` сначала идут строки KYC, затем строки KYB.", "items": { "oneOf": [ { "$ref": "#/components/schemas/UserSessionListItem" }, { "$ref": "#/components/schemas/BusinessSessionListItem" } ], "discriminator": { "propertyName": "session_kind", "mapping": { "user": "#/components/schemas/UserSessionListItem", "business": "#/components/schemas/BusinessSessionListItem" } } } } } }, "examples": { "KYC sessions (default)": { "summary": "session_kind=user - одна завершённая и одна неначатая сессия", "value": { "count": 2, "next": null, "previous": null, "results": [ { "session_id": "5b3720ed-d429-42ef-b67f-37ea805f48ee", "session_kind": "user", "session_number": 720, "session_url": "https://verify.didit.me/session/CuXoBYCYVO5Y", "portrait_image": "https:///portraits/5b3720ed.jpg?X-Amz-Expires=3600&X-Amz-Signature=...", "document_type": "Passport", "full_name": "Jane Marie Doe", "country": "ESP", "status": "Approved", "vendor_data": "your-user-id-123", "didit_internal_id": "d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147", "created_at": "2026-06-09T12:26:54.328364Z", "features": [ { "feature": "ID_VERIFICATION", "status": "Approved" }, { "feature": "LIVENESS", "status": "Approved" }, { "feature": "FACE_MATCH", "status": "Approved" }, { "feature": "AML", "status": "Approved" }, { "feature": "IP_ANALYSIS", "status": "Approved" } ], "phone_number": { "number": "+14155552671", "is_verified": true }, "email_address": { "email": "jane@example.com", "is_verified": true }, "additional_details": { "aml": { "total_hits": 0, "entity_type": "person", "is_adverse_media_fetched": false }, "liveness": { "method": "PASSIVE", "score": 0.98 }, "face_match": { "score": 0.95 } } }, { "session_id": "038ad62f-5ebd-46c2-afe9-4b2956bf687f", "session_kind": "user", "session_number": 719, "session_url": "https://verify.didit.me/session/7RGKiO6ioGH6", "portrait_image": null, "document_type": null, "full_name": null, "country": null, "status": "Not Started", "vendor_data": "your-user-id-124", "didit_internal_id": "eb4e679d-ca4b-461f-9685-687bac29ebdb", "created_at": "2026-06-09T08:02:23.343053Z", "features": [ { "feature": "ID_VERIFICATION", "status": "Not Finished" }, { "feature": "LIVENESS", "status": "Not Finished" }, { "feature": "FACE_MATCH", "status": "Not Finished" }, { "feature": "AML", "status": "Not Finished" }, { "feature": "IP_ANALYSIS", "status": "Not Finished" } ], "phone_number": null, "email_address": null, "additional_details": null } ] } }, "Mixed KYC + KYB (session_kind=all)": { "summary": "session_kind=all - строка KYC, за которой следует строка KYB", "value": { "count": 2, "next": null, "previous": null, "results": [ { "session_id": "5b3720ed-d429-42ef-b67f-37ea805f48ee", "session_kind": "user", "session_number": 720, "session_url": "https://verify.didit.me/session/CuXoBYCYVO5Y", "portrait_image": null, "document_type": "Identity Card", "full_name": "Jane Marie Doe", "country": "ESP", "status": "In Review", "vendor_data": "your-user-id-123", "didit_internal_id": "d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147", "created_at": "2026-06-09T12:26:54.328364Z", "features": [ { "feature": "ID_VERIFICATION", "status": "In Review" }, { "feature": "LIVENESS", "status": "Approved" } ], "phone_number": null, "email_address": null, "additional_details": { "liveness": { "method": "PASSIVE", "score": 0.98 } } }, { "session_id": "8a1f63c2-1b9e-4f3a-9c41-2f6a1f0b7d52", "session_kind": "business", "session_number": 42, "status": "Approved", "vendor_data": "your-company-id-77", "created_at": "2026-06-08T09:14:02.118450Z", "workflow_id": "9f9b1234-aaaa-bbbb-cccc-1234567890ab", "workflow_type": "kyb", "workflow_label": "Standard KYB", "company_name": "Acme Holdings S.L.", "registration_number": "B12345678", "country": "ES" } ] } } } } } }, "301": { "description": "Перенаправление на канонический URL с завершающим слешем. Возвращается, когда путь запроса равен `/v3/sessions` (без завершающего слеша); заголовок `Location` указывает на `/v3/sessions/` с сохранением строки запроса. Клиенты GET обычно следуют ему автоматически." }, "400": { "description": "Недопустимый параметр запроса. Тело ответа представляет собой объект с ключом проблемного параметра.", "content": { "application/json": { "examples": { "Invalid session_kind": { "summary": "session_kind не входит в список user/business/all", "value": { "session_kind": "Must be \"user\", \"business\", or \"all\"." } }, "Invalid date": { "summary": "Некорректный формат date_from/date_to", "value": { "date_from": [ "Enter a valid date." ] } }, "Invalid didit_internal_id": { "summary": "didit_internal_id не является UUID", "value": { "didit_internal_id": [ "Enter a valid UUID." ] } }, "Invalid api_service": { "summary": "api_service отсутствует среди допустимых вариантов", "value": { "api_service": [ "Select a valid choice. FOO is not one of the available choices." ] } } } } } }, "403": { "description": "Отсутствующий, некорректный или отозванный API-ключ. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.\n\n**Удаленное приложение:** в течение нескольких минут после удаления приложения запрос, выполненный с одним из его API-ключей, может вернуть ответ `{\"detail\": \"This application was deleted.\", \"code\": \"application_deleted\"}`. Не повторяйте попытку: приложение и его API-ключи больше не существуют. По истечении нескольких минут ключ отклоняется, как и любой другой недействительный ключ.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "You do not have permission to perform this action." }, "code": { "type": "string", "description": "Машиночитаемая причина, присутствует только при некоторых ошибках. `application_deleted`: API-ключ принадлежит приложению, которое было удалено.", "example": "application_deleted" } }, "required": [ "detail" ] }, "examples": { "Forbidden": { "summary": "Отсутствует или недействителен x-api-key", "value": { "detail": "You do not have permission to perform this action." } }, "ApplicationDeleted": { "summary": "API-ключ удалённого приложения", "value": { "detail": "This application was deleted.", "code": "application_deleted" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -s 'https://verification.didit.me/v3/sessions/?status=Approved,In%20Review&date_from=2026-06-01&limit=20' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.sessions.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.sessions.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Sessions.ListAutoPaging(ctx, didit.SessionsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.sessions().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "sessions->list() as $item) {\n print_r($item);\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.sessions.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Sessions.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] } }, "/v3/session/{sessionId}/share/": { "post": { "summary": "Сгенерировать токен общего доступа для завершённой сессии верификации", "description": "Сгенерировать короткоживущий JWT, позволяющий конкретному приложению Didit импортировать эту завершённую сессию. Используется в паре с `POST /v3/session/import-shared/`.", "operationId": "post_v3_session_share", "x-didit-sdk": { "resource": "sessions", "method": "share", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "responses": { "200": { "description": "Выпущен токен доступа.", "content": { "application/json": { "schema": { "type": "object", "properties": { "share_token": { "type": "string", "description": "JWT с подписью HS256. Передайте это значение без изменений в качестве `share_token` в [`POST /v3/session/import-shared/`](/sessions-api/import-shared-session) в целевом приложении.", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." }, "for_application_id": { "type": "string", "format": "uuid", "description": "Возвращает эхо UUID целевого приложения, к которому привязан token.", "example": "a5f3bca2-46e2-411e-90ef-a580900a57ee" }, "session_kind": { "type": "string", "enum": [ "user", "business" ], "description": "Является ли исходная сессия сессией Проверки пользователей (KYC) или Верификации бизнеса (KYB)." } } }, "examples": { "User session": { "summary": "Поделиться сессией KYC", "value": { "share_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZXNzaW9uX2lkIjoiMjBiYjNjM2ItNjE0Ni00MzlmLTg0YTQtYmQzMGQwMGFjNmEyIiwiZnJvbV9hcHBsaWNhdGlvbl9pZCI6ImRiZDIwZTM0LTQyZTktNGYyYy1iYTkxLWNmMDc2MjAxNmY2NCIsImZvcl9hcHBsaWNhdGlvbl9pZCI6ImE1ZjNiY2EyLTQ2ZTItNDExZS05MGVmLWE1ODA5MDBhNTdlZSIsImlhdCI6MTc1MzYzMDY2NiwiZXhwIjoxNzUzNjM0MjY2fQ.JJ9pNE_hqZsOtbR0XYZIWw4JzidjdEl279iUrsIkhGE", "for_application_id": "a5f3bca2-46e2-411e-90ef-a580900a57ee", "session_kind": "user" } }, "Business session": { "summary": "Поделиться сессией KYB", "value": { "share_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "for_application_id": "a5f3bca2-46e2-411e-90ef-a580900a57ee", "session_kind": "business" } } } } } }, "401": { "description": "Отсутствуют или недействительны учетные данные. В отличие от большинства endpoint v3, этот endpoint выполняет аутентификацию через декоратор разрешений и возвращает `401`, если не предоставлен действительный token/ключ.", "content": { "application/json": { "examples": { "Unauthorized": { "summary": "Не авторизован", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "404": { "description": "Сессия с указанным `session_id` не существует в вашем приложении.", "content": { "application/json": { "examples": { "Not Found": { "summary": "Сессия не найдена", "value": { "detail": "Not found." } } } } } }, "400": { "description": "Ошибка валидации. Ошибки полей сгруппированы по именам полей; ошибка о незавершенности возвращается под ключом `detail` (в виде массива).", "content": { "application/json": { "examples": { "Wrong status": { "summary": "Исходная сессия не завершена", "value": { "detail": [ "Only finished sessions (\"Approved\", \"Declined\", \"In Review\") can be shared." ] } }, "Target missing": { "summary": "Целевое приложение не существует", "value": { "for_application_id": [ "Target application does not exist." ] } }, "Self-share": { "summary": "Целевым объектом является вызывающее приложение", "value": { "for_application_id": [ "Cannot share a session with the same application." ] } }, "TTL bounds": { "summary": "ttl_in_seconds выходит за допустимые пределы", "value": { "ttl_in_seconds": [ "Ensure this value is greater than or equal to 60." ] } } } } } }, "403": { "description": "Учетные данные действительны, но не имеют разрешения `write:sessions` для этого приложения.", "content": { "application/json": { "examples": { "No Permission": { "value": { "detail": "You do not have permission to perform this action." }, "summary": "Нет разрешения" } } } } } }, "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID исходной сессии верификации, для которой выпускается token.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } } ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "for_application_id" ], "properties": { "for_application_id": { "type": "string", "format": "uuid", "description": "UUID приложения Didit, которое погасит token. Оно должно существовать, не быть удалено и отличаться от вызывающего приложения. Его можно найти в Business Console в разделе **Settings → Application**.", "example": "a5f3bca2-46e2-411e-90ef-a580900a57ee" }, "ttl_in_seconds": { "type": "integer", "description": "Срок действия token в секундах. Минимум `60`, максимум `86400` (24 ч). По умолчанию `3600` (1 ч).", "minimum": 60, "maximum": 86400, "default": 3600, "example": 3600 } } }, "example": { "for_application_id": "a5f3bca2-46e2-411e-90ef-a580900a57ee", "ttl_in_seconds": 7200 } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/share/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"for_application_id\": \"a5f3bca2-46e2-411e-90ef-a580900a57ee\",\n \"ttl_in_seconds\": 7200\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.share(\n \"11111111-2222-3333-4444-555555555555\",\n for_application_id=\"a5f3bca2-46e2-411e-90ef-a580900a57ee\",\n ttl_in_seconds=7200,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.share(\"11111111-2222-3333-4444-555555555555\", {\n for_application_id: \"a5f3bca2-46e2-411e-90ef-a580900a57ee\",\n ttl_in_seconds: 7200,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Share(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsShareParams{\n\tForApplicationID: \"a5f3bca2-46e2-411e-90ef-a580900a57ee\",\n\tTTLInSeconds: didit.Int(7200),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsShareParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().share(\"11111111-2222-3333-4444-555555555555\", SessionsShareParams.builder()\n .forApplicationId(\"a5f3bca2-46e2-411e-90ef-a580900a57ee\")\n .ttlInSeconds(7200L)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->share('11111111-2222-3333-4444-555555555555', [\n 'for_application_id' => 'a5f3bca2-46e2-411e-90ef-a580900a57ee',\n 'ttl_in_seconds' => 7200,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.share(\n \"11111111-2222-3333-4444-555555555555\",\n for_application_id: \"a5f3bca2-46e2-411e-90ef-a580900a57ee\",\n ttl_in_seconds: 7200\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.ShareAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsShareParams\n{\n ForApplicationId = \"a5f3bca2-46e2-411e-90ef-a580900a57ee\",\n TtlInSeconds = 7200,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/import-shared/": { "post": { "summary": "Использовать токен общего доступа для клонирования сессии верификации в ваше приложение", "description": "Использовать токен общего доступа для клонирования сессии KYC или KYB в вызывающее приложение с новым `session_id`. Не идемпотентно — токен можно погасить только один раз для каждого получателя.", "operationId": "post_v3_session_import_shared", "x-didit-sdk": { "resource": "sessions", "method": "import_shared", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "responses": { "201": { "description": "Сессия клонирована. Тело ответа представляет собой payload решения V3 для обоих типов, разделяемых по `session_kind`: `\"user\"` (KYC) со списочными блоками функций, такими как `id_verifications`, `liveness_checks`, `aml_screenings`; `\"business\"` (KYB) с такими блоками, как `registry_checks` и `key_people_checks`. Оба содержат `shared_from_session` — `session_id` исходной сессии в исходном приложении. При `trust_review: false` параметру `status` клонированной сессии принудительно задаётся значение `In Review`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionDecision" }, "examples": { "User session imported": { "summary": "Клонированная сессия KYC (сокращено — в реальности полный payload решения V3)", "value": { "session_id": "11111111-2222-3333-4444-555555555555", "session_kind": "user", "shared_from_session": "99999999-8888-7777-6666-555555555555", "session_number": 43762, "session_url": null, "status": "In Review", "workflow_id": "9f9b1234-aaaa-bbbb-cccc-1234567890ab", "vendor_data": "user-1", "created_at": "2026-05-17T08:42:11Z", "expires_at": "2026-05-24T08:42:11Z" } }, "Business session imported": { "summary": "Клонированная сессия KYB (сокращено — в реальности полный payload решения V3 KYB)", "value": { "session_id": "22222222-3333-4444-5555-666666666666", "session_kind": "business", "shared_from_session": "88888888-7777-6666-5555-444444444444", "session_number": 982, "session_url": null, "status": "Approved", "workflow_id": "9f9b1234-aaaa-bbbb-cccc-1234567890ab", "vendor_data": "company-1" } } } } } }, "400": { "description": "Ошибка валидации (token недействителен, истёк срок действия, указан неверный целевой объект или сессия больше не существует).", "content": { "application/json": { "examples": { "Invalid Share Token": { "summary": "Недействительный JWT", "value": { "share_token": [ "Invalid share token." ] } }, "Expired Share Token": { "summary": "Срок действия token истёк по `exp`", "value": { "share_token": [ "Share token has expired." ] } }, "Wrong audience": { "summary": "Token не привязан к этому приложению", "value": { "share_token": [ "This token is not valid for this application." ] } }, "Original missing": { "summary": "Исходная сессия была удалена", "value": { "share_token": [ "Original session does not exist." ] } } } } } }, "403": { "description": "Отсутствует API-ключ (при неверном, отозванном или истекшем ключе возвращается `401`), либо эта исходная сессия уже была импортирована в вызывающее приложение (одно погашение на каждого получателя).", "content": { "application/json": { "examples": { "Forbidden": { "summary": "Запрещено", "value": { "detail": "You do not have permission to perform this action." } }, "Already imported": { "summary": "Источник уже был импортирован", "value": { "detail": "This session has already been shared with your application." } } } } } }, "404": { "description": "`workflow_id` не принадлежит вызывающему приложению.", "content": { "application/json": { "examples": { "Workflow not found": { "summary": "Неизвестный сценарий", "value": { "detail": "Workflow does not exist for this application." } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "share_token", "trust_review", "workflow_id" ], "properties": { "share_token": { "type": "string", "description": "JWT-токен общего доступа, выпущенный [`POST /v3/session/{sessionId}/share/`](/sessions-api/share-session).", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." }, "trust_review": { "type": "boolean", "description": "Если `true`, клонированная сессия сохраняет окончательный `status` исходной сессии. Если `false`, она принудительно переводится в `In Review`.", "example": false }, "workflow_id": { "type": "string", "format": "uuid", "description": "UUID сценария в вызывающем приложении. Идентификаторы из других приложений отклоняются с кодом `404`.", "example": "9f9b1234-aaaa-bbbb-cccc-1234567890ab" }, "vendor_data": { "type": "string", "nullable": true, "description": "Необязательное переопределение для `vendor_data` клонированной сессии.", "example": "user-1" } } }, "example": { "share_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "trust_review": false, "workflow_id": "9f9b1234-aaaa-bbbb-cccc-1234567890ab", "vendor_data": "user-1" } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST \\\n https://verification.didit.me/v3/session/import-shared/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"share_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"trust_review\": false,\n \"workflow_id\": \"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n \"vendor_data\": \"user-1\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.import_shared(\n share_token=\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n trust_review=False,\n workflow_id=\"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n vendor_data=\"user-1\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.importShared({\n share_token: \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n trust_review: false,\n workflow_id: \"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n vendor_data: \"user-1\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.ImportShared(ctx, didit.SessionsImportSharedParams{\n\tShareToken: \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n\tTrustReview: false,\n\tWorkflowID: \"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n\tVendorData: didit.String(\"user-1\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsImportSharedParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().importShared(SessionsImportSharedParams.builder()\n .shareToken(\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\")\n .trustReview(false)\n .workflowId(\"9f9b1234-aaaa-bbbb-cccc-1234567890ab\")\n .vendorData(\"user-1\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->importShared([\n 'share_token' => 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...',\n 'trust_review' => false,\n 'workflow_id' => '9f9b1234-aaaa-bbbb-cccc-1234567890ab',\n 'vendor_data' => 'user-1',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.import_shared(\n share_token: \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n trust_review: false,\n workflow_id: \"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n vendor_data: \"user-1\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.ImportSharedAsync(new SessionsImportSharedParams\n{\n ShareToken = \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n TrustReview = false,\n WorkflowId = \"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n VendorData = \"user-1\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/kyb/search/": { "post": { "summary": "Поиск компании в реестре KYB (отдельный)", "operationId": "post_v3_kyb_search", "x-didit-sdk": { "resource": "kyb", "method": "search", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [], "description": "Поиск компаний-кандидатов в официальных реестрах компаний по названию и/или регистрационному номеру. Это шаг 1 двухэтапного процесса работы с реестром: **поиск** возвращает краткие сведения о кандидатах, а затем `POST /v3/kyb/select/` получает полный профиль одного кандидата.\n\n**Биллинг поиска.** Успешные поисковые запросы с использованием платного источника данных о компаниях стоят USD 0.50 за запрос независимо от количества кандидатов. Пустые результаты, сбои и результаты, полученные только из других источников, не тарифицируются. Применимая цена резервируется до выполнения поиска; при недостаточном балансе возвращается 403 с кодом `insufficient_credits`. При наличии договорённостей применяются контрактные тарифы, а ненастроенный контрактный тариф на поиск возвращает 403. Поисковые запросы в песочнице бесплатны. Повторный успешный поиск может повлечь за собой дополнительное списание; доставка callback не тарифицируется. Получение профиля оплачивается отдельно. Эта плата за поиск также применяется к v2. Кандидаты всегда возвращаются со статусом `fetch_status: \"pending\"`: полные данные о компании запрашиваются (и тарифицируются) только при выборе (select).\n\n**`kyb_response_id` является временным.** Это дескриптор отдельного поиска, а не постоянный идентификатор компании. Выбирайте кандидата сразу после поиска и выполняйте повторный поиск для получения свежего дескриптора вместо его сохранения.\n\n**`tier` определяет цепочку провайдеров.** `tier` указывает уровень реестра, по которому выполняется поиск: `basic` (по умолчанию, цепочка Lite), `shareholders` или `ubo`. Поиск использует цепочку провайдеров, обслуживающую этот уровень, и это не всегда та же цепочка, к которой обращается поиск Lite. Поэтому пустой результат поиска Lite не является доказательством отсутствия компании в реестре — выполните повторный поиск на необходимом уровне. В стране, где запрашиваемый уровень недоступен, поиск выполняется на максимальном доступном уровне вплоть до указанного. Получайте данные кандидата через endpoint, соответствующий этому уровню: `POST /v3/kyb/select/` (Lite), `POST /v3/kyb/shareholders/` или `POST /v3/kyb/ubo/`.\n\n**Аутентификация.** `POST /v3/kyb/search/` (и `/v2/`) принимает API-ключ вашего приложения в заголовке `x-api-key`. Размещённый маршрут `POST /v1/kyb/search/` аутентифицируется по сессии и вызывается размещённым процессом верификации: он возвращает `403` при использовании API-ключа и не принимает `tier` — цепочку определяет конфигурация реестра KYB в сценарии.\n\n**Два режима.**\n- *Синхронный (по умолчанию):* API опрашивает реестр до завершения поиска и возвращает итоговый список кандидатов (`search_resolved: true`).\n- *Асинхронный:* передайте `webhook_url`, и API ответит немедленно — обычно со статусом `search_status: \"pending\"` и пустым списком кандидатов — а затем отправит POST-запрос с callback `kyb.registry_search.resolved` на ваш URL после завершения работы реестра. Тело callback содержит `{\"event_id\", \"event_type\": \"kyb.registry_search.resolved\", \"request_id\", \"vendor_data\", \"metadata\", \"search_status\", \"search_resolved\", \"kyb_registry\", \"timestamp\", \"created_at\"}` — обратите внимание, что `timestamp` и `created_at` в callback представляют собой целые числа в формате epoch, в отличие от формата ISO в `created_at` этого endpoint — и отправляется **без подписи** (заголовок `X-Didit-Unsigned-Callback: true`, без `X-Signature`).\n\n**Коды стран.** ISO 3166-1 alpha-2 (`GB`, `DE`), а также коды подразделений `XX-YY`, если реестры региональные — например, `US-CA` для Калифорнии.\n\n**Песочница.** Ключи приложений из песочницы возвращают одного статического кандидата без обращения к реестрам.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "country_code" ], "properties": { "country_code": { "type": "string", "maxLength": 10, "description": "Двухбуквенный код страны ISO 3166-1 alpha-2, в реестре компаний которой выполняется поиск. Например, `GB`. Если реестры компаний действуют на уровне штата или провинции, добавьте код подразделения ISO 3166-2 в формате `XX-YY`: `US-CA` выполняет поиск по реестру Калифорнии. Для поиска по США всегда требуется код подразделения — одиночный код `US` отклоняется. Нечувствителен к регистру; нормализуется к верхнему регистру.", "example": "GB" }, "name": { "type": "string", "maxLength": 255, "description": "Название компании для поиска. Требуется либо `name`, либо `registration_number`.", "example": "Tesco" }, "registration_number": { "type": "string", "maxLength": 100, "description": "Регистрационный номер в реестре для поиска. Требуется указать либо `name`, либо `registration_number`." }, "tier": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "default": "basic", "description": "Уровень реестра, по цепочке провайдеров которого выполняется этот поиск. `basic` (по умолчанию) выполняет поиск по цепочке Lite для страны; `shareholders` и `ubo` выполняют поиск по цепочке структуры владения соответствующего уровня, которая может использовать другой источник, поэтому пустой результат поиска Lite не доказывает отсутствие компании в реестре. Если для страны указанный уровень недоступен, поиск выполняется на наивысшем доступном уровне вплоть до запрошенного. Получите кандидата с endpoint, предоставляющего запрошенный уровень: `POST /v3/kyb/select/` (Lite), `POST /v3/kyb/shareholders/` или `POST /v3/kyb/ubo/`.", "example": "basic" }, "search_type": { "type": "string", "enum": [ "contains" ], "default": "contains", "description": "Стратегия сопоставления имён, применяемая при поиске по реестрам. Единственным допустимым значением является `contains`: ни один источник реестров, используемый при поиске, не поддерживает режим префикса или нечёткого поиска, поэтому `start_with` и `fuzzy` отклоняются с кодом `400` (`not a valid choice`)." }, "vendor_data": { "type": "string", "description": "Ваш идентификатор этого поиска; возвращается в ответе и включается в обратный вызов webhook." }, "metadata": { "type": "object", "nullable": true, "description": "JSON в свободной форме; возвращается в ответе и включается в обратный вызов webhook." }, "webhook_url": { "type": "string", "format": "uri", "maxLength": 500, "description": "Переключает поиск в асинхронный режим: API немедленно возвращает ответ и отправляет неподписанный callback `kyb.registry_search.resolved` методом POST на этот URL, когда список кандидатов готов." } } }, "example": { "country_code": "GB", "name": "Tesco", "search_type": "contains", "vendor_data": "company-1234" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/kyb/search/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"country_code\": \"GB\",\n \"name\": \"Tesco\",\n \"search_type\": \"contains\",\n \"vendor_data\": \"company-1234\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.kyb.search(\n country_code=\"GB\",\n name=\"Tesco\",\n search_type=\"contains\",\n vendor_data=\"company-1234\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.kyb.search({\n country_code: \"GB\",\n name: \"Tesco\",\n search_type: \"contains\",\n vendor_data: \"company-1234\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.KYB.Search(ctx, didit.KYBSearchParams{\n\tCountryCode: \"GB\",\n\tName: didit.String(\"Tesco\"),\n\tSearchType: didit.Some(didit.KYBSearchParamsSearchType(\"contains\")),\n\tVendorData: didit.String(\"company-1234\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.KybSearchParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.kyb().search(KybSearchParams.builder()\n .countryCode(\"GB\")\n .name(\"Tesco\")\n .searchType(KybSearchParams.SearchType.of(\"contains\"))\n .vendorData(\"company-1234\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "kyb->search([\n 'country_code' => 'GB',\n 'name' => 'Tesco',\n 'search_type' => 'contains',\n 'vendor_data' => 'company-1234',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.kyb.search(\n country_code: \"GB\",\n name: \"Tesco\",\n search_type: \"contains\",\n vendor_data: \"company-1234\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Kyb.SearchAsync(new KybSearchParams\n{\n CountryCode = \"GB\",\n Name = \"Tesco\",\n SearchType = new KybSearchParamsSearchType(\"contains\"),\n VendorData = \"company-1234\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Поиск принят. Синхронный режим возвращает сформированный список кандидатов; режим webhook возвращает ответ немедленно (часто со статусом `search_status: \"pending\"`) и доставляет финальный список через обратный вызов `kyb.registry_search.resolved`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "С `webhook_url`: сохранённый id запроса на поиск, возвращаемый как `request_id` в обратном вызове `kyb.registry_search.resolved`. Без `webhook_url`: временный UUID корреляции (поиск не сохраняется)." }, "kyb_registry": { "$ref": "#/components/schemas/KYBRegistrySearchResults" }, "vendor_data": { "type": "string", "nullable": true, "description": "Эхо отправленных вами `vendor_data`." }, "metadata": { "type": "object", "nullable": true, "description": "Эхо-значение переданного вами `metadata`." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "Resolved search": { "summary": "Синхронный режим — итоговый список кандидатов", "value": { "request_id": "0c7e9a40-3a13-4f7e-8a44-9d2e2f1c5b6a", "kyb_registry": { "companies": [ { "kyb_response_id": "69aeeb95febb0f1704042259", "name": "Tesco PLC", "registration_number": "00445790", "status": "active", "type": "Public Limited Company", "risk_level": null, "fetch_status": "pending" }, { "kyb_response_id": "69aeeb95febb0f170404225a", "name": "E-TESCO LTD", "registration_number": "15168476", "status": "active", "type": "Private Limited Company", "risk_level": null, "fetch_status": "pending" } ], "pagination": { "total": 2, "page": 1, "per_page": 25 }, "search_status": "resolved", "search_resolved": true }, "vendor_data": "company-1234", "metadata": null, "created_at": "2026-06-11T10:40:00.000000+00:00" } }, "Pending search (webhook mode)": { "summary": "`webhook_url` передан — кандидаты поступают через обратный вызов kyb.registry_search.resolved", "value": { "request_id": "5f2d8c1b-7e4a-4b9c-9f0d-3a6e8c2b1d4f", "kyb_registry": { "companies": [], "pagination": { "total": 0, "page": 1, "per_page": 25 }, "search_status": "pending", "search_resolved": false }, "vendor_data": "company-1234", "metadata": { "source": "onboarding" }, "created_at": "2026-06-11T10:41:00.000000+00:00" } } } } } }, "400": { "description": "Ошибка валидации. Проблемы на уровне полей используют стандартную структуру DRF; правило проверки имени/регистрационного номера возвращает ошибку в `non_field_errors`. Если страна не поддерживается реестрами, возвращается `400` с `code: kyb_registry_country_unsupported`.", "content": { "application/json": { "examples": { "Missing search criteria": { "summary": "Не указаны ни `name`, ни `registration_number`", "value": { "non_field_errors": [ "Either 'name' or 'registration_number' is required." ] } }, "Invalid country_code": { "summary": "Должен быть `XX` (alpha-2) или подразделением в формате `XX-YY`", "value": { "country_code": [ "country_code must be a 2-letter ISO code." ] } }, "Invalid search_type": { "summary": "Принимается только `contains`", "value": { "search_type": [ "\"start_with\" is not a valid choice." ] } }, "Invalid webhook_url": { "summary": "`webhook_url` должен быть корректным URL", "value": { "webhook_url": [ "Enter a valid URL." ] } }, "Country not covered": { "summary": "Ни один реестр компаний не охватывает эту страну", "value": { "detail": "Company registry search is not available for this country. Enter the company details manually to continue.", "code": "kyb_registry_country_unsupported" } } } } } }, "403": { "description": "В доступе отказано. Возвращается, если заголовок `x-api-key` отсутствует; неверный, отозванный или истекший ключ возвращает `401`. Отсутствующий ключ возвращает `403` с `{\"detail\": ...}`; неверный, отозванный или истекший ключ возвращает `401`. Также возвращается перед поиском, если не удаётся покрыть применимую комиссию за поиск (`code: \"insufficient_credits\"`), или если отсутствует договорной тариф на поиск.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Отсутствует заголовок `x-api-key`, либо ключ недействителен/отозван", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Превышен лимит запросов или исчерпан лимит поисковых запросов. Endpoint'ы POST/PATCH/DELETE делят общий лимит в 300 запросов на запись в минуту на один API-ключ (для создания транзакций и отправки событий действует отдельный лимит в 600) с заголовками `X-RateLimit-*` и `Retry-After`. Отдельно платные поисковые запросы по реестрам ограничены 600 запросами на приложение в час: сверх этого лимита возвращается ответ `429` с `code: kyb_registry_search_limit_reached`, при этом поиск только по бесплатным источникам продолжает работать. Подождите и повторите поиск позже.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Более 300 запросов на запись в текущую минуту", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } }, "Search allowance spent": { "summary": "Более 600 платных поисков за последний час", "value": { "detail": "The maximum number of company registry searches for this session has been reached. Enter the company details manually to continue.", "code": "kyb_registry_search_limit_reached" } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string" } } } } } }, "502": { "description": "Провайдер реестра KYB временно недоступен: ответ 5xx, таймаут или сбой подключения со стороны вышестоящего реестра. Поиск не тарифицируется. Повторите попытку позже, либо, в размещённом сценарии верификации Didit, пользователю автоматически предлагается ручной ввод данных компании вместо ошибки, требующей только повтора.", "content": { "application/json": { "examples": { "Registry provider outage": { "summary": "Провайдер реестра не ответил на поисковый запрос", "value": { "detail": "The KYB registry provider is temporarily unavailable. Please try again shortly.", "code": "kyb_registry_provider_unavailable" } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string" } } } } } } } } }, "/v3/kyb/select/": { "post": { "summary": "Выбор компании в реестре KYB — уровень Lite (отдельный)", "operationId": "post_v3_kyb_select", "x-didit-sdk": { "resource": "kyb", "method": "select", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [], "description": "Получить профиль реестра **Lite** для одного кандидата, возвращенного `POST /v3/kyb/search/` — сведения о компании, зарегистрированный адрес, идентификаторы, статус, деятельность и руководство, а также необработанный payload из реестра. Сведения об акционерах и конечных бенефициарных владельцах приобретаются через `POST /v3/kyb/shareholders/` и `POST /v3/kyb/ubo/`.\n\n**Связка с поиском.** Передайте `kyb_response_id` кандидата в точности так, как он был возвращен поиском того же приложения. Идентификатор является временным и действует только в рамках этого поиска — делайте выбор без задержки и выполняйте повторный поиск для получения свежего дескриптора вместо его сохранения.\n\n**Биллинг.** Каждый выбор тарифицируется по цене тарифа Lite для соответствующей страны (любая плата за поиск взимается отдельно); см. [Цены на запросы к реестрам KYB](/ru/getting-started/kyb-registry-pricing). Баланс проверяется перед каждым вызовом реестра (`403` при нехватке средств), и списание фиксируется в созданной сессии компании.\n\n**Сохранение обязательно.** Каждый выбор создает сессию компании (идентификатором которой является `request_id`), что позволяет отслеживать биллинг и получение данных; она отображается в консоли. `save_api_request` принимается для симметрии, но должен иметь значение `true` (по умолчанию) — отправка `false` возвращает `400`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KYBRegistryCandidateRequest" }, "example": { "kyb_response_id": "69aeeb95febb0f1704042259", "vendor_data": "company-1234" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/kyb/select/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"kyb_response_id\": \"69aeeb95febb0f1704042259\",\n \"vendor_data\": \"company-1234\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.kyb.select(\n kyb_response_id=\"69aeeb95febb0f1704042259\",\n vendor_data=\"company-1234\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.kyb.select({\n kyb_response_id: \"69aeeb95febb0f1704042259\",\n vendor_data: \"company-1234\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.KYB.Select(ctx, didit.KYBRegistryCandidateRequest{\n\tKYBResponseID: \"69aeeb95febb0f1704042259\",\n\tVendorData: didit.String(\"company-1234\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.KYBRegistryCandidateRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.kyb().select(KYBRegistryCandidateRequest.builder()\n .kybResponseId(\"69aeeb95febb0f1704042259\")\n .vendorData(\"company-1234\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "kyb->select([\n 'kyb_response_id' => '69aeeb95febb0f1704042259',\n 'vendor_data' => 'company-1234',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.kyb.select(\n kyb_response_id: \"69aeeb95febb0f1704042259\",\n vendor_data: \"company-1234\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Kyb.SelectAsync(new KYBRegistryCandidateRequest\n{\n KybResponseId = \"69aeeb95febb0f1704042259\",\n VendorData = \"company-1234\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Компания получена, плата начислена. `kyb_registry` содержит полный профиль; проверьте `data_resolved` — при значении `false` реестр всё ещё выполнял обработку, и сохранённая запись будет автоматически дополнена после завершения обработки.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Идентификатор бизнес-сессии, созданной для этого запроса данных. Сохранённая запись (видимая в консоли) продолжает обновляться, если реестр завершит обработку после отправки ответа." }, "registry_tier_requested": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "description": "Уровень, который продает этот endpoint: `basic` (Lite) для select, `shareholders`, `ubo`." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "description": "Уровень, фактически предоставленный и включенный в счёт. Ниже запрошенного, если реестры страны не содержат данных о структуре владения или в реестре нет записей о структуре владения для этой компании." }, "kyb_registry": { "type": "object", "description": "Полный профиль компании из реестра.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Идентификатор Didit для этой записи компании." }, "node_id": { "type": "string", "example": "feature_kyb_registry" }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review" ], "description": "Оценка Didit по проверке в реестре (например, `In Review`, если компания не активна в реестре или данные о структуре владения не удалось определить)." }, "registry_status": { "type": "string", "nullable": true, "enum": [ "active", "dissolved", "deregistered", "see full details", "authorised", "appointed representative", "unauthorised", "inactive", "no longer authorised", "closed", "struck off" ], "description": "Нормализованный статус компании согласно данным реестра." }, "data_resolved": { "type": "boolean", "description": "`true`, когда реестр вернул полный профиль. `false`, если реестр всё ещё обрабатывал запрос после опроса — сохранённая запись будет автоматически дополнена, как только реестр завершит обработку." }, "company_name": { "type": "string", "example": "Tesco PLC" }, "registration_number": { "type": "string", "nullable": true, "example": "00445790" }, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2.", "example": "GB" }, "region": { "type": "string", "nullable": true, "description": "Код подразделения, если реестр региональный (например, `CA` для `US-CA`); в противном случае пусто." }, "company_type": { "type": "string", "nullable": true, "example": "Public Limited Company" }, "incorporation_date": { "type": "string", "format": "date", "nullable": true, "example": "1947-11-27" }, "registered_address": { "type": "string", "nullable": true, "example": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA" }, "tax_number": { "type": "string", "nullable": true, "example": "GB412 8925 93" }, "risk_level": { "type": "string", "nullable": true, "description": "Уровень риска по данным реестра, если доступен." }, "verification_status": { "type": "string", "enum": [ "verified", "failed", "unknown" ], "nullable": true, "description": "Статус верификации между юрисдикциями: `verified`, когда статус в реестре подтверждает правовой статус (`active`), `failed`, когда реестр указывает, что компания ликвидирована или не действует (например, `dissolved`), в противном случае `unknown`. `null` для компании, полученной не из реестра, а также пока выбор остаётся в статусе `pending`." }, "is_from_registry": { "type": "boolean", "description": "Всегда `true` для этого endpoint — профиль был получен из официального реестра." }, "fetch_status": { "type": "string", "enum": [ "pending", "resolved" ], "description": "Жизненный цикл получения данных из реестра. Дублируется полем `data_resolved`." }, "alternative_names": { "type": "string", "nullable": true, "description": "Альтернативные, торговые, прежние или наименования компании на языке оригинала в виде текста, если они указаны." }, "nature_of_business": { "type": "string", "nullable": true, "description": "Описание деятельности или код классификации, если они указаны." }, "registered_capital": { "type": "string", "nullable": true }, "registered_capital_amount": { "type": "string", "nullable": true, "description": "Десятичная сумма в виде строки, если передана." }, "registered_capital_currency": { "type": "string", "nullable": true, "description": "Код ISO 4217, если указан." }, "website": { "type": "string", "nullable": true, "example": "https://www.tesco.com/" }, "email": { "type": "string", "nullable": true, "example": "customer.service@tesco.co.uk" }, "phone": { "type": "string", "nullable": true, "example": "03301231688" }, "legal_entity_identifier": { "type": "string", "nullable": true, "description": "LEI, если указан." }, "location_of_registration": { "type": "string", "nullable": true, "description": "Реестр или юрисдикция регистрации компании, если указаны." }, "vat_number": { "type": "string", "nullable": true, "description": "Номер плательщика НДС в ЕС, если он был собран на размещённом шаге реестра или изменён впоследствии. При выборе он обычно ещё не задан — проверка НДС и налогового номера выполняется, когда конечный пользователь отправляет шаг реестра в размещённом процессе." }, "vat_validation_status": { "type": "string", "enum": [ "valid", "invalid", "format_valid", "invalid_format", "could_not_validate", "not_applicable" ], "description": "Результат валидации номера плательщика НДС (VAT) или, при его отсутствии, `tax_number` при отправке в реестр. `valid` / `invalid`: определяется официальным реестром страны (EU VIES, Норвегия, Швейцария, Бразилия, Колумбия, Коста-Рика, Эквадор, Парагвай; Польша также по внутреннему реестру НДС). `format_valid` / `invalid_format`: определяется правилами формата и контрольных цифр страны, если реестр недоступен для запроса. `could_not_validate`: реестр был недоступен. `not_applicable`: номер отсутствует, в стране нет реестра или правил либо это сессия в песочнице." }, "vat_validated_number": { "type": "string", "nullable": true, "description": "Номер, который был проверен, в том виде, в каком он известен источнику (например, номер VAT, полученный из французского SIREN или нидерландского RSIN). `null`, если проверка не выполнялась." }, "vat_validation_source": { "type": "string", "nullable": true, "enum": [ "eu_vies", "pl_vat_white_list", "no_brreg", "ch_uid_register", "br_receita_federal", "co_rues", "cr_hacienda", "ec_sri", "py_dnit", "format_rules", null ], "description": "Источник, определивший `vat_validation_status`: официальный реестр или `format_rules`. `null`, если проверка не проводилась." }, "vat_validated_name": { "type": "string", "nullable": true, "description": "Имя, зарегистрированное в источнике, подтвердившем номер, если источник его раскрывает. Указывается только со статусом `valid`." }, "vat_validated_address": { "type": "string", "nullable": true, "description": "Адрес, зарегистрированный в источнике, выполнившем проверку номера, если он раскрывает его. Заполняется, только когда статус равен `valid`." }, "vat_checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Временная метка проверки. `null`, если проверка не запускалась." }, "financial_summary": { "type": "object", "nullable": true, "description": "Сведения об акциях и капитале по данным реестра (валюта, общее количество акций, классы акций), если доступны." }, "officers": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "example": "MELISSA BETHELL" }, "designation": { "type": "string", "nullable": true, "description": "Необработанное наименование должности из реестра (например, `Director`, `Secretary`)." }, "role": { "type": "string", "description": "Нормализованная роль, полученная из должности. Полный набор модели из 17 значений; парсинг реестра на этом endpoint обычно возвращает director, non_executive_director, secretary, chairman или company_officer.", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "company_officer", "settlor", "protector", "investor", "other" ] }, "nationality": { "type": "string", "nullable": true }, "is_active": { "type": "boolean", "description": "`false`, когда реестр отмечает назначение как завершённое из-за отставки." }, "kyc_status": { "type": "string", "nullable": true, "enum": [ "Approved", "Declined", "Pending" ], "description": "Статус связанной KYC-сессии, если она была запущена для этого должностного лица. В противном случае `null`." }, "kyc_session_url": { "type": "string", "nullable": true, "description": "URL верификации связанной сессии KYC, если таковая существует." }, "first_name": { "type": "string", "nullable": true, "description": "Имя, если оно явно указано в реестре; не выводится из полного имени." }, "last_name": { "type": "string", "nullable": true, "description": "Фамилия, если она явно указана в реестре." }, "address": { "type": "string", "nullable": true, "description": "Адрес должностного лица, указанный в реестре." }, "appointment_date": { "type": "string", "nullable": true, "description": "Дата назначения должностного лица.", "format": "date" }, "termination_date": { "type": "string", "nullable": true, "description": "Дата окончания полномочий, если указана.", "format": "date" }, "date_of_birth": { "type": "string", "nullable": true, "description": "Полная дата рождения по данным реестра. Null, если известны только год или месяц рождения.", "format": "date" }, "date_of_birth_year": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 9999, "description": "Год рождения по данным реестра, в том числе когда полная дата недоступна." }, "date_of_birth_month": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 12, "description": "Месяц рождения по данным реестра. Null, если известен только год." } } }, "description": "Директора, секретари и другие должностные лица, извлечённые из реестра." }, "beneficial_owners": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Является ли владелец физическим или юридическим лицом." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Нормализованные роли (например, `ubo`, `shareholder`)." }, "ownership_min_shares": { "type": "string", "nullable": true, "description": "Нижняя граница диапазона владения, указанная в реестре (например, `25%`)." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Верхняя граница диапазона доли владения согласно реестру." }, "is_active": { "type": "boolean" }, "kyc_status": { "type": "string", "nullable": true, "enum": [ "Approved", "Declined", "Pending" ] }, "kyc_session_url": { "type": "string", "nullable": true }, "effective_ownership_percent": { "type": "number", "nullable": true, "description": "Распознанный процент владения (верхняя граница, с переходом на нижнюю границу при отсутствии)." }, "company_name": { "type": "string", "nullable": true }, "registration_number": { "type": "string", "nullable": true }, "country_of_birth": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "designation": { "type": "string", "nullable": true }, "voting_min_shares": { "type": "string", "nullable": true }, "voting_max_shares": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "nullable": true, "description": "Полная дата рождения, если указана.", "format": "date" }, "appointment_date": { "type": "string", "nullable": true, "description": "Дата назначения, если указана.", "format": "date" }, "shareholding": { "$ref": "#/components/schemas/KYBRegistryShareholding" } } }, "description": "Бенефициарные владельцы / лица, осуществляющие значительный контроль, извлечённые из реестра. Может быть пустым, если реестр не раскрывает структуру владения." }, "addresses": { "type": "array", "nullable": true, "description": "Каждый адрес, указанный в реестре, в едином каноническом формате. Null, если реестр не указывает ни одного.", "items": { "$ref": "#/components/schemas/KYBRegistryAddress" } }, "industries": { "type": "array", "nullable": true, "description": "Виды деятельности, к которым реестр относит компанию, в единой канонической форме. Null, если ни один вид не указан.", "items": { "$ref": "#/components/schemas/KYBRegistryIndustry" } }, "accounts": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Даты подачи документов в реестр, если доступны. Для годовой отчётности и общих собраний используются last_annual_return_date и last_agm_date; они отличаются от финансовой отчётности." }, "registry_data": { "$ref": "#/components/schemas/KYBRegistryData" }, "user_provided_data": { "type": "object", "nullable": true, "description": "Всегда `null` на этом endpoint (используется в размещённом сценарии KYB, когда конечные пользователи редактируют данные из реестра)." }, "confirmed_by_user_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Всегда `null` на этом endpoint." }, "last_console_edit_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Задаётся, когда проверяющий из консоли позже редактирует запись." }, "is_editable": { "type": "boolean", "description": "Можно ли по-прежнему редактировать данные из реестра компаний в размещённом сценарии или консоли." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "description": "То же, что и `registry_tier_delivered` верхнего уровня." }, "registry_ownership_status": { "type": "string", "nullable": true, "enum": [ "not_requested", "delivered", "not_held", "unavailable" ], "description": "`delivered`, когда данные о структуре владения получены; `not_held`, когда реестр структуры владения ответил и в нём нет этой компании (см. `registry_data.ownership_error`); `unavailable`, когда был запрошен уровень со структурой владения, но в реестре не было данных по этой компании или к нему не удалось обратиться (см. `registry_data.ownership_error`); `not_requested` для уровня Lite." }, "ownership": { "$ref": "#/components/schemas/KYBRegistryOwnership" }, "registry_tier": { "type": "string", "nullable": true, "description": "Уровень реестра, запрошенный сценарием: `basic`, `shareholders` или `ubo`. Также указан в `ownership.tier_requested`." }, "registry_monitoring": { "type": "object", "nullable": true, "description": "Последний мониторинг реестра для компании или `null`, если он отсутствует.", "properties": { "uuid": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "unavailable_reason": { "type": "string", "nullable": true }, "enrolled_at": { "type": "string", "format": "date-time", "nullable": true }, "cancelled_at": { "type": "string", "format": "date-time", "nullable": true }, "last_bill_date": { "type": "string", "format": "date", "nullable": true }, "next_bill_date": { "type": "string", "format": "date", "nullable": true }, "last_event_at": { "type": "string", "format": "date-time", "nullable": true }, "events_count": { "type": "integer" }, "watched_fields": { "description": "Поля компании, отслеживаемые мониторингом." } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Эхо отправленных вами `vendor_data`." }, "metadata": { "type": "object", "nullable": true, "description": "Эхо-значение переданного вами `metadata`." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "Resolved company": { "summary": "Полный профиль из реестра (список должностных лиц сокращён для краткости)", "value": { "request_id": "9d4f2c7a-1b3e-4a5c-8d6f-0e9a8b7c6d5e", "kyb_registry": { "uuid": "f1e2d3c4-b5a6-4789-9c0d-1e2f3a4b5c6d", "node_id": "feature_kyb_registry", "status": "In Review", "registry_status": "active", "data_resolved": true, "company_name": "Tesco PLC", "registration_number": "00445790", "country_code": "GB", "region": "", "company_type": "Public Limited Company", "incorporation_date": "1947-11-27", "registered_address": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA", "tax_number": "GB412 8925 93", "risk_level": "low risk", "verification_status": "verified", "is_from_registry": true, "fetch_status": "resolved", "alternative_names": "TESCO STORES (HOLDINGS) PUBLIC LIMITED COMPANY", "nature_of_business": null, "registered_capital": null, "registered_capital_amount": null, "registered_capital_currency": null, "website": "https://www.tesco.com/", "email": "customer.service@tesco.co.uk", "phone": "03301231688", "legal_entity_identifier": null, "location_of_registration": null, "financial_summary": { "currency": "Pound (£)", "total_number_of_shares": "8174378721", "meta_detail": { "Class_Of_Share": "Ordinary" } }, "officers": [ { "uuid": "a1b2c3d4-e5f6-4789-9a0b-1c2d3e4f5a6b", "name": "CHRISTOPHER JON TAYLOR", "designation": "Secretary", "role": "secretary", "nationality": null, "is_active": true, "kyc_status": null, "kyc_session_url": null }, { "uuid": "b2c3d4e5-f6a7-4890-8b1c-2d3e4f5a6b7c", "name": "MELISSA BETHELL", "designation": "Director", "role": "director", "nationality": "British", "is_active": true, "kyc_status": null, "kyc_session_url": null } ], "beneficial_owners": [], "addresses": [ { "address": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA", "type": "legal_entity_registry_address", "description": "registered office address" } ], "industries": null, "accounts": { "last_account": "26 February 2025", "next_account": "26 February 2026", "due_by_date": "26 August 2026" }, "registry_data": {}, "user_provided_data": null, "confirmed_by_user_at": null, "last_console_edit_at": null, "is_editable": true }, "vendor_data": "company-1234", "metadata": null, "created_at": "2026-06-11T10:45:00.000000+00:00" } }, "Pending (registry still resolving)": { "summary": "Выбор остался в состоянии ожидания после опроса — разреженные поля, автозаполнение на стороне сервера", "value": { "request_id": "9d4f2c7a-1b3e-4a5c-8d6f-0e9a8b7c6d5e", "kyb_registry": { "uuid": "7c0a4f7e-2b1d-4f6a-9c3e-8d5b2a1f0e9d", "node_id": "feature_kyb_registry", "status": "Not Finished", "registry_status": null, "data_resolved": false, "company_name": "Tesco PLC", "registration_number": "00445790", "country_code": "GB", "region": null, "company_type": null, "incorporation_date": null, "registered_address": null, "tax_number": null, "risk_level": null, "verification_status": null, "is_from_registry": true, "fetch_status": "pending", "alternative_names": null, "nature_of_business": null, "registered_capital": null, "registered_capital_amount": null, "registered_capital_currency": null, "website": null, "email": null, "phone": null, "legal_entity_identifier": null, "location_of_registration": null, "financial_summary": {}, "officers": [], "beneficial_owners": [], "addresses": null, "industries": null, "accounts": null, "registry_data": {}, "user_provided_data": null, "confirmed_by_user_at": null, "last_console_edit_at": null, "is_editable": true }, "vendor_data": "company-1234", "metadata": null, "created_at": "2026-06-11T10:45:00.000000+00:00" } } } } } }, "400": { "description": "Ошибка валидации. Проблемы на уровне полей используют стандартную структуру DRF. Если страна не поддерживается реестрами, возвращается `400` с `code: kyb_registry_country_unsupported`.", "content": { "application/json": { "examples": { "Missing kyb_response_id": { "summary": "Поле `kyb_response_id` обязательно", "value": { "kyb_response_id": [ "This field is required." ] } }, "save_api_request=false rejected": { "summary": "Выбранные значения всегда сохраняются", "value": { "save_api_request": [ "KYB registry select must be saved so billing and retrieval can be tracked." ] } }, "Country not covered": { "summary": "Ни один реестр компаний не охватывает эту страну", "value": { "detail": "Company registry search is not available for this country. Enter the company details manually to continue.", "code": "kyb_registry_country_unsupported" } } } } } }, "403": { "description": "В доступе отказано. Возвращается, если заголовок `x-api-key` отсутствует, а также если баланс вызывающей организации не покрывает вызов; неверный, отозванный или истекший ключ возвращает `401`. Отсутствующий ключ возвращает `403` с `{\"detail\": ...}`; неверный, отозванный или истекший ключ возвращает `401`. При нехватке кредитов возвращается `403` с `{\"error\": ...}` до начала любого скрининга или вызова провайдера.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Отсутствует заголовок `x-api-key`, либо ключ недействителен/отозван", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "Баланс организации недостаточен для совершения вызова", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Превышен лимит запросов. Endpoint'ы POST/PATCH/DELETE делят общий лимит в 300 запросов на запись в минуту на один API-ключ (для создания транзакций и отправки событий действует отдельный лимит в 600). Ответ содержит заголовки `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` и `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Более 300 запросов на запись в текущую минуту", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } } } }, "/v3/passive-liveness/": { "post": { "summary": "Пассивная проверка живости", "description": "Обнаружение атак предъявления (распечатанных фотографий, воспроизведения с экранов, масок, дипфейков) по одной фотографии лица. Не требует видео, движений или действий со стороны пользователя.\n\n**Как это работает.** Модель биометрии анализирует изображение; оценивается самое крупное обнаруженное лицо и вычисляется `score` живости (0–100). `status` принимает значение `Declined`, если срабатывает любое предупреждение с уровнем важности `error`:\n- `NO_FACE_DETECTED`: модель живости не обнаружила лицо,\n- `LOW_LIVENESS_SCORE`: оценка равна или ниже порога `face_liveness_score_decline_threshold` (по умолчанию `30`),\n- `LIVENESS_FACE_ATTACK`: модель обнаружила атаку предъявления,\n- `FACE_IN_BLOCKLIST` / `POSSIBLE_FACE_IN_BLOCKLIST`: лицо совпадает с записью в вашем списке блокировки лиц.\n\n`MULTIPLE_FACES_DETECTED` является сигналом с уровнем важности `warning` (не приводит к отклонению), а `DUPLICATED_FACE` / `POSSIBLE_DUPLICATED_FACE` являются сигналами с уровнем важности `information`, указывающими на то, что это же лицо уже встречалось в другой одобренной сессии (они никогда не приводят к отклонению). Параметры `face_quality` и `face_luminance` (0–100, допускают значение null) описывают качество захваченного изображения.\n\n**Проверка по списку блокировки и на дубликаты.** Выполняется при **каждом** вызове (с `save_api_request` или без него) путем сопоставления обнаруженного лица с поисковым индексом лиц вашего приложения. Предыдущие лица с тем же `vendor_data` исключаются из всего поиска по индексу, поэтому повторный запуск проверки живости для того же пользователя не вызывает срабатывание `DUPLICATED_FACE`, а лицо из списка блокировки, полученное из сессии с собственным `vendor_data` вызывающей стороны, также НЕ помечается (проверка `FACE_IN_BLOCKLIST` пропускается для лиц с одинаковым `vendor_data`).\n\n**Биллинг.** Каждый ответ `200` расходует один кредит Passive Liveness API (списывается с кредита вашего тарифа или с баланса пополнения). При недостаточном балансе возвращается `403` до начала обработки изображения.\n\n**Сохранение сессии и регистрация лица (`save_api_request`, по умолчанию `true`).** При значении `true` вызов сохраняется как сессия типа API (Business Console, `GET /v3/session/{sessionId}/decision/` по возвращённому `request_id`, webhook `status.updated`), сохраняются эталонное изображение и кадрированное изображение лица, а обнаруженное лицо **вносится в ваш поисковый индекс лиц**, чтобы последующие вызовы «Поиск по лицу» и проверки на дубликаты могли найти с ним совпадение. При значении `false` вызов является разовым: ничего не сохраняется и лицо не вносится в индекс (проверка по списку блокировки и на дубликаты при этом выполняется).\n\n**Песочница.** API-ключи песочницы пропускают всю обработку и биллинг: после валидации запроса (некорректный ввод по-прежнему возвращает `400`) endpoint возвращает статический тестовый payload со статусом `Approved`, сессия не сохраняется, а кредиты не расходуются.\n\n**Аутентификация.** Передавайте API-ключ вашего приложения в заголовке `x-api-key`. При отсутствии или недействительности учетных данных возвращается `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`); этот API никогда не возвращает `401`.\n\n**Лимит запросов.** Общий бюджет на запись составляет 300 запросов/мин на API-ключ для всех endpoints POST/PATCH/DELETE; при его превышении возвращается `429`.", "operationId": "post_v3passive-liveness", "x-didit-sdk": { "resource": "passive_liveness", "method": "check", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "parameters": [], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "user_image" ], "properties": { "user_image": { "type": "string", "format": "binary", "description": "Фронтальное изображение лица (например, селфи). Допустимые расширения: `tiff`, `jpg`, `jpeg`, `png`, `webp`. Максимальный размер загружаемого файла: **5 MB** (файлы большего размера отклоняются с ошибкой `400`). Перед обработкой изображения автоматически сжимаются примерно до 0.5 MB, поэтому сверхвысокое разрешение не повышает точность. На изображении должен быть только один человек — если лиц несколько, оценивается самое крупное и добавляется предупреждение `MULTIPLE_FACES_DETECTED`." }, "face_liveness_score_decline_threshold": { "type": "number", "format": "float", "default": 30, "minimum": 0, "maximum": 100, "description": "Порог оценки проверки живости (0–100). Вычисленная оценка **на уровне или ниже** этого значения генерирует предупреждение `LOW_LIVENESS_SCORE` и устанавливает `status` в `Declined`. По умолчанию `30`; увеличьте его для более строгой защиты от спуфинга. Значения вне диапазона 0–100 возвращают `400`.", "example": 30 }, "rotate_image": { "type": "boolean", "default": false, "description": "Когда `true`, сервис пробует поворачивать входное изображение с шагом 90 градусов и использует ориентацию, обеспечивающую наилучшее обнаружение лица. Полезно, когда отсутствуют данные ориентации EXIF. Увеличивает задержку ответа.", "example": false }, "save_api_request": { "type": "boolean", "default": true, "description": "Когда `true` (по умолчанию), сохраняет вызов как сессию типа API, сохраняет изображения лица, отправляет webhook `status.updated` и регистрирует обнаруженное лицо в вашем индексе Поиска по лицу. Когда `false`, вызов является однократным — ничего не сохраняется, а лицо не регистрируется. Проверки по списку блокировки и на дубликаты выполняются в обоих случаях.", "example": true }, "vendor_data": { "type": "string", "description": "Необязательный непрозрачный идентификатор (ваш идентификатор пользователя, email, UUID…), сохраняемый в сессии и возвращаемый обратно. Также используется для исключения предыдущих сессий с тем же `vendor_data` из проверки на дубликаты лиц, благодаря чему повторная верификация того же пользователя не вызывает ошибку `DUPLICATED_FACE`.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Необязательный объект JSON, сохраняемый вместе с сессией (когда `save_api_request=true`) и возвращаемый обратно. В multipart-запросах отправляйте его как строковое поле в формате JSON — он парсится в объект.", "example": { "flow": "withdrawal" } } } }, "example": { "user_image": "(binary JPEG/PNG selfie)", "face_liveness_score_decline_threshold": 30, "rotate_image": false, "save_api_request": true, "vendor_data": "user-123", "metadata": { "flow": "withdrawal" } } } } }, "responses": { "200": { "description": "Пассивная проверка живости завершена. `liveness.score` представляет собой оценку уверенности модели от 0 до 100 в том, что на изображении живой человек; `status` имеет значение `Approved`, если не сработало предупреждение уровня `error`. Лицо с признаками спуфинга или из списка блокировки всё равно возвращает `200`: проверяйте `liveness.status` и `liveness.warnings`, а не только HTTP-код. Если `save_api_request=true`, `request_id` является сохранённым идентификатором сессии.", "content": { "application/json": { "examples": { "Approved": { "summary": "Живое лицо — предупреждений нет", "value": { "request_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef", "liveness": { "status": "Approved", "method": "PASSIVE", "score": 95.0, "user_image": { "entities": [ { "bbox": [ 661, 728, 1688, 2188 ], "confidence": 0.732973, "age": 26.91, "gender": "male", "race": null } ], "best_angle": 0 }, "warnings": [], "face_quality": 84.21, "face_luminance": 50.33 }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T01:04:42.763237+00:00" } }, "Declined - presentation attack": { "summary": "Модель зафиксировала спуфинг (печать, воспроизведение видео, маска…)", "value": { "request_id": "f1c8c9b2-d3e4-4f5a-9b8c-7d6e5f4a3b2c", "liveness": { "status": "Declined", "method": "PASSIVE", "score": 12.5, "user_image": { "entities": [ { "bbox": [ 100, 120, 420, 540 ], "confidence": 0.81, "age": 30.1, "gender": "female", "race": null } ], "best_angle": 0 }, "warnings": [ { "risk": "LOW_LIVENESS_SCORE", "feature": "LIVENESS", "additional_data": null, "log_type": "error", "short_description": "Low liveness score", "long_description": "The liveness check resulted in a low score, indicating potential use of non-live facial representations or poor-quality biometric data." }, { "risk": "LIVENESS_FACE_ATTACK", "feature": "LIVENESS", "additional_data": null, "log_type": "error", "short_description": "Liveness Face Attack", "long_description": "The system detected a potential attempt to bypass the liveness check." } ], "face_quality": 72.4, "face_luminance": 48.2 }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T01:04:42.763237+00:00" } }, "Declined - face on blocklist": { "summary": "Живое лицо, но совпадает с записью в списке блокировки", "value": { "request_id": "0b54a1de-22aa-4e0f-9c84-5a2b1f3c4d5e", "liveness": { "status": "Declined", "method": "PASSIVE", "score": 93.75, "user_image": { "entities": [ { "bbox": [ 40, 40, 100, 100 ], "confidence": 0.722082, "age": 27.0, "gender": "male", "race": null } ], "best_angle": 0 }, "warnings": [ { "risk": "FACE_IN_BLOCKLIST", "feature": "LIVENESS", "additional_data": { "blocklisted_session_id": "882c42d5-8a4d-4d20-8080-a22f57822c86", "blocklisted_session_number": 3242, "api_service": null }, "log_type": "error", "short_description": "Face in blocklist", "long_description": "The system identified a face in the blocklist, which means the face is not allowed to be verified." } ], "face_quality": null, "face_luminance": null }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T01:04:42.763237+00:00" } } }, "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Идентификатор сохраненной сессии при `save_api_request=true` (доступен для использования с `GET /v3/session/{sessionId}/decision/`); в противном случае это временный корреляционный UUID." }, "liveness": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined" ], "description": "`Declined`, если сработало хотя бы одно предупреждение с уровнем важности `error` (лицо не обнаружено, низкая оценка, атака предъявления или совпадение со списком блокировки); в противном случае `Approved`. Записи `warning`/`information` (несколько лиц, дубликаты) сами по себе никогда не приводят к отклонению." }, "method": { "type": "string", "enum": [ "PASSIVE" ], "description": "Всегда `PASSIVE` для этого endpoint." }, "score": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Уверенность проверки живости (0–100, два знака после запятой) в том, что на изображении запечатлён живой человек, а не спуфинг. `null`, если модель не вернула уверенность.", "example": 95.0 }, "user_image": { "type": "object", "description": "Результаты обнаружения лица для переданного изображения.", "properties": { "entities": { "type": "array", "items": { "type": "object", "properties": { "bbox": { "type": "array", "items": { "type": "integer" }, "minItems": 4, "maxItems": 4, "description": "Ограничивающий прямоугольник обнаруженного лица в координатах пикселей `[x_min, y_min, x_max, y_max]` на обработанном изображении.", "example": [ 661, 728, 1688, 2188 ] }, "confidence": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Уверенность обнаружения лица (0–1).", "example": 0.732973 }, "age": { "type": "number", "format": "float", "description": "Возраст обнаруженного лица в годах, оцененный моделью. Только для справки — не влияет на решение о проверке живости.", "example": 26.91 }, "gender": { "type": "string", "description": "Пол обнаруженного лица, спрогнозированный моделью (`male` или `female`). Только для справки.", "example": "male" }, "race": { "type": "string", "nullable": true, "description": "Зарезервированное поле — всегда `null` в ответах от этого endpoint.", "example": null } } }, "description": "Одна запись на каждое обнаруженное лицо. Оценивается самое крупное лицо." }, "best_angle": { "type": "integer", "nullable": true, "description": "Поворот (в градусах), при котором было достигнуто наилучшее обнаружение лица; отличен от нуля, только если `rotate_image=true` скорректировал ориентацию.", "example": 0 } } }, "warnings": { "type": "array", "description": "Сигналы риска. Серьёзность `error` (отклонения): `NO_FACE_DETECTED`, `LOW_LIVENESS_SCORE` (оценка на уровне порога или ниже), `LIVENESS_FACE_ATTACK`, `FACE_IN_BLOCKLIST`, `POSSIBLE_FACE_IN_BLOCKLIST`. Серьёзность `warning` (проверка, без отклонения): `MULTIPLE_FACES_DETECTED`. Серьёзность `information` (без отклонения): `DUPLICATED_FACE`, `POSSIBLE_DUPLICATED_FACE` — то же самое лицо уже появлялось в другой одобренной сессии.", "items": { "type": "object", "properties": { "risk": { "type": "string", "enum": [ "NO_FACE_DETECTED", "LOW_LIVENESS_SCORE", "LIVENESS_FACE_ATTACK", "MULTIPLE_FACES_DETECTED", "FACE_IN_BLOCKLIST", "POSSIBLE_FACE_IN_BLOCKLIST", "DUPLICATED_FACE", "POSSIBLE_DUPLICATED_FACE" ], "description": "Машиночитаемый код риска." }, "feature": { "type": "string", "enum": [ "LIVENESS" ], "description": "Функция, вызвавшая предупреждение. На этом endpoint всегда `LIVENESS`." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "`null` для большинства предупреждений. Срабатывания по списку блокировки содержат `{blocklisted_session_id, blocklisted_session_number, api_service}`; срабатывания по дубликатам содержат `{duplicated_session_id, duplicated_session_number, api_service}`, указывающие на совпадающую сессию." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Серьёзность. Предупреждения `error` переводят `status` в `Declined`; записи `warning` и `information` носят информационный характер и сами по себе никогда не приводят к отклонению." }, "short_description": { "type": "string", "description": "Краткая сводка риска в одну строку в понятном человеку формате." }, "long_description": { "type": "string", "description": "Понятное объяснение риска." } } } }, "face_quality": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Оценка качества захвата обнаруженного лица, нормализованная до 0–100. `null`, если модель не смогла сформировать надёжное значение.", "example": 84.21 }, "face_luminance": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Яркость обнаруженного лица, нормализованная в диапазоне 0–100. `null`, если значение недоступно.", "example": 50.33 } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Эхо-значение переданного вами `vendor_data` или `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Эхо-значение переданного вами объекта `metadata` или `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Временная метка ISO 8601 (UTC) момента генерации ответа, например `2026-06-12T01:04:42.763237+00:00`." } } } } } }, "400": { "description": "Ошибка валидации. Возвращается, если `user_image` отсутствует, превышает 5 МБ, имеет неподдерживаемое расширение, не проходит декодирование изображения на стороне сервера или если значение параметра выходит за допустимые пределы. Ошибки полей используют обёртку DRF `{field: [messages]}`; сбои декодирования изображения используют `{\"error\": ...}`.", "content": { "application/json": { "examples": { "Missing image": { "summary": "`user_image` не включён в данные формы", "value": { "user_image": [ "No file was submitted." ] } }, "Invalid image format": { "summary": "Разрешённое расширение, но не поддающееся декодированию содержимое изображения", "value": { "error": "Invalid user image format.", "code": "invalid_image" } }, "Unsupported file extension": { "summary": "Расширение файла отличается от tiff/jpg/jpeg/png/webp", "value": { "user_image": [ "File extension “txt” is not allowed. Allowed extensions are: tiff, jpg, jpeg, png, webp." ] } }, "File too large": { "summary": "Размер загружаемого файла превышает лимит в 5 МБ", "value": { "user_image": [ "File size should not exceed 5 MB" ] } } } } } }, "403": { "description": "В доступе отказано. Возвращается, если заголовок `x-api-key` отсутствует, а также если баланс вызывающей организации не покрывает вызов; неверный, отозванный или истекший ключ возвращает `401`. Отсутствующий ключ возвращает `403` с `{\"detail\": ...}`; неверный, отозванный или истекший ключ возвращает `401`. При нехватке кредитов возвращается `403` с `{\"error\": ...}` до начала любой обработки изображения.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Отсутствует заголовок `x-api-key`, либо ключ недействителен/отозван", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "Баланс организации недостаточен для совершения вызова", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Превышен лимит запросов. Endpoint'ы POST/PATCH/DELETE делят общий лимит в 300 запросов на запись в минуту на один API-ключ (для создания транзакций и отправки событий действует отдельный лимит в 600). Ответ содержит заголовки `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` и `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Более 300 запросов на запись в текущую минуту", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X POST 'https://verification.didit.me/v3/passive-liveness/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'user_image=@./selfie.jpg' \\\n -F 'face_liveness_score_decline_threshold=30' \\\n -F 'save_api_request=true' \\\n -F 'vendor_data=user-123'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.passive_liveness.check(\n user_image=open(\"user_image.jpg\", \"rb\"),\n face_liveness_score_decline_threshold=30.0,\n rotate_image=False,\n save_api_request=True,\n vendor_data=\"user-123\",\n metadata={\"flow\": \"withdrawal\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.passiveLiveness.check({\n user_image: await fileFromPath(\"user_image.jpg\"),\n face_liveness_score_decline_threshold: 30.0,\n rotate_image: false,\n save_api_request: true,\n vendor_data: \"user-123\",\n metadata: { flow: \"withdrawal\" },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.PassiveLiveness.Check(ctx, didit.PassiveLivenessCheckParams{\n\tUserImage: didit.FileFromPath(\"user_image.jpg\"),\n\tFaceLivenessScoreDeclineThreshold: didit.Float(30.0),\n\tRotateImage: didit.Bool(false),\n\tSaveAPIRequest: didit.Bool(true),\n\tVendorData: didit.String(\"user-123\"),\n\tMetadata: didit.Some(map[string]any{\"flow\": \"withdrawal\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.PassiveLivenessCheckParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.passiveLiveness().check(PassiveLivenessCheckParams.builder()\n .userImage(Path.of(\"user_image.jpg\"))\n .faceLivenessScoreDeclineThreshold(30.0)\n .rotateImage(false)\n .saveApiRequest(true)\n .vendorData(\"user-123\")\n .metadata(Map.of(\"flow\", \"withdrawal\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "passiveLiveness->check([\n 'user_image' => File::fromPath('user_image.jpg'),\n 'face_liveness_score_decline_threshold' => 30.0,\n 'rotate_image' => false,\n 'save_api_request' => true,\n 'vendor_data' => 'user-123',\n 'metadata' => ['flow' => 'withdrawal'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.passive_liveness.check(\n user_image: Pathname(\"user_image.jpg\"),\n face_liveness_score_decline_threshold: 30.0,\n rotate_image: false,\n save_api_request: true,\n vendor_data: \"user-123\",\n metadata: { flow: \"withdrawal\" }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.PassiveLiveness.CheckAsync(new PassiveLivenessCheckParams\n{\n UserImage = FileUpload.FromPath(\"user_image.jpg\"),\n FaceLivenessScoreDeclineThreshold = 30.0,\n RotateImage = false,\n SaveApiRequest = true,\n VendorData = \"user-123\",\n Metadata = new Dictionary { [\"flow\"] = \"withdrawal\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/database-validation/": { "post": { "summary": "Проверка по базам данных (автономная)", "operationId": "post_v3database-validation", "x-didit-sdk": { "resource": "database_validation", "method": "validate", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [], "description": "Проверяйте данные личности человека по официальным государственным источникам и реестрам: CPF в Бразилии, RENAPER в Аргентине, реестры DNI в Испании и Перу, INE в Мексике и ещё 100+ сервисов в 60+ странах.\n\n**Выбор сервиса.** Для каждой страны доступен один или несколько каталожных сервисов, идентифицируемых по `service_id` (например, `bra_cpf`, `arg_renaper`, `pan_cedula_sib`). Задайте нужные сервисы с помощью массива `services` — если его опустить, выполняется ровно **один** сервис по умолчанию (самый давно действующий продакшн-сервис для этой страны). Передача `services` также переключает ответ на расширенный формат с полями `services_used` и `match_score`. Узнать доступные сервисы, их обязательные поля и цены можно через `GET /v1/organization/database-validation-countries/` (каталожный endpoint, не описанный в данной спецификации) или в редакторе сценариев в Business Console. Некоторые сервисы в каталоге помечены флагом `requires_consent=true` и требуют передачи `consent=true`; для вызова других требуется предварительный онбординг вашей организации.\n\n**Входные поля.** Поле `identification_number` является универсальным и автоматически сопоставляется с соответствующим полем конкретной страны (см. его описание). Правила формата для страны проверяются до обращения к какому-либо провайдеру (например, бразильский CPF должен содержать ровно 11 цифр), а ошибки формата никогда не тарифицируются. Биометрическим сервисам требуется загрузка `selfie` (только multipart); сервис RENAPER в Аргентине дополнительно требует `gender`.\n\n**Результаты.** Каждый сервис возвращает карту полей `validation`, а также независимый от вендора код `outcome_code` (`MATCH`, `PARTIAL_MATCH`, `NO_MATCH`, `DOCUMENT_NOT_FOUND`, `INVALID_DOCUMENT_FORMAT`, `INVALID_INPUT`, `MINOR_BLOCKED`, `DECEASED`, `BIOMETRIC_NO_MATCH`, `BIOMETRIC_IMAGE_UNUSABLE`, `INCONCLUSIVE`, `DOCUMENT_SUPERSEDED`, `REGISTRY_UNAVAILABLE`, `REGISTRY_ERROR`). Обратите внимание на различия: `NO_MATCH` — это окончательное несовпадение, `INCONCLUSIVE` означает, что реестр не смог дать однозначного подтверждения (требуется проверка, а не отклонение), а `BIOMETRIC_IMAGE_UNUSABLE` указывает на техническую проблему с селфи (повторная съёмка), в отличие от окончательного `BIOMETRIC_NO_MATCH`. Общий `match_type` агрегируется по всем сервисам (любое полное совпадение → `full_match`, иначе любое частичное → `partial_match`, иначе `no_match`), а `no_match_action`/`partial_match_action` преобразуют его в итоговый `status`. Значение `validation_type` вычисляется: `two_by_two`, если два или более различных сервиса дали полное совпадение (по идентификационному номеру, по полному имени вместе с датой рождения или по адресу без противоречий), иначе `one_by_one`.\n\n**Сохранение данных.** Параметр `save_api_request` по умолчанию имеет значение **true**: результат сохраняется как сессия (`request_id` можно использовать в `GET /v3/session/{sessionId}/decision/`), отображается в консоли и инициирует webhook `status.updated`. Он также управляет структурой `validations` — раздельные объекты по сервисам при сохранении, либо объединённая карта `{field: match}`, если сохранение отключено.\n\n**Биллинг.** Посервисно: с каждого сервиса, вернувшего тарифицируемый результат, взимается стоимость по каталогу. Неудачные или пропущенные сервисы не тарифицируются, а запросы, отклонённые со статусом `400`, ничего не стоят. Предварительная проверка баланса охватывает сумму цен всех выбранных сервисов (`403` при нехватке средств).\n\n**Ошибки.** Если ни один из выбранных сервисов не вернул пригодный результат, API возвращает `400` с массивом `validation_errors`, когда каждая неотвеченная попытка явно отклонила входные данные (`provider_rejected_input`, `retryable: false`). Исправьте входные данные перед повторной попыткой. В противном случае возвращается `502` с `validation_errors` (`empty_provider_response`, `retryable: true`), включая случаи сочетания отклонённых входных данных и недоступных резервных попыток; средства не списываются (сессия всё равно сохраняется со статусом `Not Finished`, если `save_api_request=true`). Если сбой произошёл только у части сервисов, ответ `200` содержит информацию об их ошибках в `database_validation.errors`.\n\n**Песочница.** Ключи приложений из песочницы не выполняют вызовы к реестрам, не тарифицируются и возвращают статичный ответ `full_match` — payload песочницы всегда содержит `services_used` и `match_score: 100` независимо от того, как был передан параметр `services`, поэтому не проверяйте логику расширенного формата продакшна или дробные значения `match_score` от 0.0 до 1.0 на ответах песочницы.\n\nОтправляйте запрос как `application/json` или как `multipart/form-data` при загрузке `selfie`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "issuing_state" ], "properties": { "issuing_state": { "type": "string", "description": "Трехбуквенный код страны ISO 3166-1 **alpha-3** реестра для проверки (например, `BRA`, `ESP`, `COL`). Определяет доступные сервисы. Неподдерживаемые коды возвращают `400` с полным списком допустимых вариантов.", "example": "BRA" }, "services": { "type": "array", "items": { "type": "string" }, "description": "Идентификаторы `service_id` из каталога для запуска по этой стране (например, `[\"bra_cpf\"]`). Также принимается одна строка или строка с разделением запятыми/JSON-кодированная строка. **Если параметр опущен или пуст, запускается ровно один сервис по умолчанию** — наиболее устоявшийся продакшн-сервис для данной страны; более новые, биометрические и тарифицируемые по факту использования сервисы должны быть указаны явно. Отправка `services` переключает ответ на расширенный формат (добавляет `services_used` и `match_score`). Каждый идентификатор должен существовать и быть активен в продакшне для `issuing_state`; сервисы, требующие онбординга, возвращают `400` до момента их активации для вашей организации. Узнать доступные сервисы по странам можно через `GET /v1/organization/database-validation-countries/` (каталожный endpoint, не описанный в данной спецификации) или в редакторе сценариев Business Console.", "example": [ "bra_cpf" ] }, "validation_type": { "type": "string", "deprecated": true, "description": "УСТАРЕЛО. Принимается для обратной совместимости, но игнорируется — `validation_type` в ответе теперь определяется тем, сколько сервисов дали полное совпадение. Используйте `services`, чтобы зафиксировать конкретные сервисы." }, "consent": { "type": "boolean", "default": false, "description": "Установите значение `true`, если конечный пользователь дал явное согласие на использование выбранных сервисов валидации. Обязательно для сервисов с флагом `requires_consent=true` в каталоге — без него эти сервисы возвращают `400` с `services_requiring_consent`." }, "identification_number": { "type": "string", "description": "Универсальный идентификационный номер — автоматически сопоставляется с нужным полем для конкретной страны, поэтому вы можете использовать его вместо `personal_number`/`tax_number`/`document_number`: ARG→document_number (DNI), BOL→document_number (CI), BRA→tax_number (CPF, 11 цифр), CHL→personal_number (RUT), COL→personal_number (Cédula), CRI→personal_number (Cédula), DOM→personal_number (Cédula, 11 цифр), ECU→personal_number (Cédula, 10 цифр), ESP→personal_number (DNI/NIE), GTM→document_number (DPI), HND→document_number (DNI), MEX→personal_number (CURP, 18 символов), PAN→personal_number (Cédula), PER→personal_number (DNI, 8 цифр), PRY→document_number (CI), SLV→document_number (DUI), URY→personal_number (CI), VEN→document_number (Cédula). Он никогда не перезаписывает явно переданное поле для конкретной страны." }, "first_name": { "type": "string", "description": "Имя физического лица. Требуется для некоторых сервисов/стран.", "example": "John" }, "last_name": { "type": "string", "description": "Фамилия физического лица. Требуется для некоторых сервисов/стран.", "example": "Doe" }, "middle_name": { "type": "string", "description": "Второе имя, используемое сервисами некоторых стран (AUS, NZL, …)." }, "full_name": { "type": "string", "description": "Полное имя — некоторые сервисы принимают его вместо имени и фамилии (например, китайские сервисы CHN, которые сверяют имя в оригинальной системе письма)." }, "date_of_birth": { "type": "string", "format": "date", "description": "Дата рождения, `YYYY-MM-DD`. Требуется многими сервисами.", "example": "1980-01-01" }, "personal_number": { "type": "string", "description": "Уникальный государственный идентификатор личности. Используется в: CHL (RUT), COL (Cédula), CRI, DOM, ECU, ESP (DNI/NIE), MEX (CURP), PAN (Cédula), PER (DNI), URY. Рассмотрите `identification_number` вместо этого." }, "tax_number": { "type": "string", "description": "Налоговый номер. Используется: BRA (CPF, 11 цифр). Рекомендуется использовать `identification_number`." }, "document_number": { "type": "string", "description": "Номер документа. Используется для: ARG (DNI), BOL (CI), GTM (DPI), HND (DNI), PRY (CI), SLV (DUI), VEN (Cédula). Рекомендуется использовать `identification_number`." }, "document_type": { "type": "string", "enum": [ "P", "DL", "ID", "RP", "SSC", "HIC", "WP", "TC", "VISA", "PSC", "BC", "OTHER" ], "description": "Тип проверяемого документа: `P` паспорт, `DL` водительское удостоверение, `ID` национальное удостоверение личности, `RP` вид на жительство (а также `SSC`, `HIC`, `WP`, `TC`, `VISA`, `PSC`, `BC`, `OTHER`). Требуется для некоторых сервисов (например, ESP)." }, "expiration_date": { "type": "string", "format": "date", "description": "Срок действия документа, `YYYY-MM-DD`. Обязательно для валидации в ESP (Испания).", "example": "2030-01-15" }, "date_of_issue": { "type": "string", "format": "date", "description": "Дата выдачи документа, `YYYY-MM-DD` (fecha de expedición). Обязательно для валидации cédula в COL (Колумбия).", "example": "2015-06-20" }, "nationality": { "type": "string", "description": "Гражданство в формате ISO 3166-1 alpha-3. Требуется для некоторых сервисов." }, "gender": { "type": "string", "enum": [ "M", "F", "X" ], "description": "Пол: `M`, `F` или `X` (другой/неизвестно). Обязательно для валидации RENAPER в Аргентине (`arg_renaper`)." }, "address": { "description": "Адрес проживания. Предпочтительнее структурированный объект `{\"street_1\":\"123 Main St\",\"street_2\":\"Apt 4B\",\"city\":\"Springfield\",\"region\":\"IL\",\"postal_code\":\"62701\",\"country\":\"US\"}`; полная однострочная строка также принимается. Требуется сервисами подтверждения адреса; если сервис определяет требования к адресу, при отсутствии обязательных данных возвращается `400` с `address_fields_required_by`.", "oneOf": [ { "type": "object", "properties": { "street_1": { "type": "string" }, "street_2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" } } }, { "type": "string", "description": "Полный однострочный адрес (устаревший)." } ] }, "address_element_1": { "type": "string", "description": "Адрес улицы, включая номер дома и тип улицы. Если не указано, определяется на основе `address`." }, "address_element_2": { "type": "string", "description": "Квартира, блок/помещение, здание, этаж или дополнительная строка адреса. Отправляйте только при явном наличии этих данных." }, "address_element_3": { "type": "string", "description": "Город, пригород, район, населённый пункт или квартал. Если не указано, определяется из `address`." }, "address_element_4": { "type": "string", "description": "Штат, провинция, регион или населённый пункт. Если не указано, определяется из `address`." }, "address_element_5": { "type": "string", "description": "Почтовый индекс. `postal_code` принимается в качестве псевдонима." }, "postal_code": { "type": "string", "description": "Почтовый индекс для сервисов на основе адреса (псевдоним `address_element_5`)." }, "driver_license_number": { "type": "string", "description": "Номер водительского удостоверения для государственных служб проверки документов (AUS, NZL, IND)." }, "driver_license_card_number": { "type": "string", "description": "Номер физической карты водительского удостоверения, если он требуется отдельно от номера удостоверения (AUS)." }, "driver_license_state": { "type": "string", "description": "Штат или территория выдачи водительского удостоверения (AUS)." }, "driver_license_version": { "type": "string", "description": "Код версии водительского удостоверения (NZL)." }, "passport_number": { "type": "string", "description": "Номер паспорта для государственных сервисов верификации паспортов (AUS, NZL, IND, CHN)." }, "passport_expiration_date": { "type": "string", "format": "date", "description": "Срок действия паспорта, `YYYY-MM-DD`, для сервисов верификации паспортов." }, "passport_file_number": { "type": "string", "description": "Номер файла паспорта (IND)." }, "passport_issue_country": { "type": "string", "description": "Страна выдачи паспорта (ISO 3166-1 alpha-3) для сервисов верификации паспортов." }, "medicare_card_number": { "type": "string", "description": "Номер карты Medicare (Австралия)." }, "immi_card_number": { "type": "string", "description": "Номер австралийской карты ImmiCard." }, "immi_card_expiry_date": { "type": "string", "format": "date", "description": "Срок действия австралийской карты ImmiCard." }, "citizenship_certificate_number": { "type": "string", "description": "Номер свидетельства о гражданстве (AUS)." }, "birth_registration_number": { "type": "string", "description": "Номер регистрации свидетельства о рождении (AUS)." }, "birth_registration_date": { "type": "string", "format": "date", "description": "Дата регистрации свидетельства о рождении (AUS)." }, "birth_registration_state": { "type": "string", "description": "Штат регистрации свидетельства о рождении (AUS)." }, "marriage_certificate_number": { "type": "string", "description": "Номер свидетельства о браке (AUS)." }, "change_of_name_certificate_number": { "type": "string", "description": "Номер свидетельства о смене имени (AUS)." }, "first_partner_name": { "type": "string", "description": "Имя партнёра в свидетельстве о браке (AUS)." }, "last_partner_name": { "type": "string", "description": "Фамилия партнёра в свидетельстве о браке (AUS)." }, "voter_id": { "type": "string", "description": "Номер регистрации избирателя (IND EPIC, IRL)." }, "epic_card": { "type": "string", "description": "Номер карты избирателя Индии (EPIC)." }, "pan": { "type": "string", "description": "PAN (Permanent Account Number) Индии." }, "national_id": { "type": "string", "description": "Номер национального удостоверения личности (CHN, MYS, KEN, KHM, NGA, ZAF, …)." }, "cic": { "type": "string", "description": "Мексиканский Código de Identificación de Credencial (CIC) INE/IFE, 9 цифр. Используется сервисом проверки действительности учетных данных MEX INE (`mex_ine_vigencia`)." }, "identificador_ciudadano": { "type": "string", "description": "Мексиканский Identificador del Ciudadano INE (9 цифр). Используется вместе с `cic` для современных моделей INE (E/F/G/H) в `mex_ine_vigencia`." }, "ocr": { "type": "string", "description": "Мексиканский номер OCR INE (13 цифр, на обратной стороне карты). Используется вместе с `cic` для модели D в `mex_ine_vigencia`." }, "voter_number": { "type": "string", "description": "Мексиканский Clave de Elector INE (18 символов). Используется вместе с `emission_number` для устаревших моделей IFE (A/B/C) в `mex_ine_vigencia`." }, "emission_number": { "type": "string", "description": "Мексиканский Número de Emisión INE. Используется вместе с `voter_number` для устаревших моделей IFE (A/B/C) в `mex_ine_vigencia`." }, "bvn": { "type": "string", "description": "Банковский верификационный номер Нигерии (BVN)." }, "bank_card_number": { "type": "string", "description": "Номер банковской карты (верификация банковских карт CHN)." }, "company_registration_number": { "type": "string", "description": "Регистрационный номер компании, выданный реестром компаний: CNPJ в Бразилии (например, `11222333000181`), регистрационный номер в Южной Африке (например, `1936/007721/06`). Требуется сервисами реестра компаний и директоров компаний (`bra_company_registry`, `bra_company_directors`, `zaf_company_registry`, `zaf_company_directors`)." }, "company_name": { "type": "string", "description": "Зарегистрированное название компании, сверенное с записью в реестре. Необязательно для `zaf_company_registry`." }, "initials": { "type": "string", "description": "Инициалы человека в том виде, в каком они напечатаны на документе. Обязательно для `zaf_drivers_license`; принимается для `zaf_bank_account_holder`." }, "licence_number": { "type": "string", "description": "Номер водительского удостоверения, как он напечатан на карте, для `zaf_drivers_license`. Если не указан, используется `document_number`." }, "refugee_file_number": { "type": "string", "description": "Номер дела беженца, выданный Министерством внутренних дел ЮАР. Обязателен для `zaf_refugee`." }, "bank_name": { "type": "string", "description": "Название банка, в котором открыт счёт. Обязательно для `zaf_bank_account_holder`." }, "bank_account_number": { "type": "string", "description": "Номер банковского счёта. Обязателен для `zaf_bank_account_holder`; принимается в `zaf_fraud_prevention`." }, "account_type": { "type": "string", "description": "Тип банковского счёта для `zaf_bank_account_holder`: `current`, `savings`, `transmission`, `subscriptionShare` или `notKnown` (без учёта регистра). Любое другое значение возвращает `400`. Опустите его, если тип вам неизвестен: в этом случае результат сверки типа счёта будет отмечен как неподтверждённый." }, "phone_number": { "type": "string", "description": "Контактный номер мобильного телефона для сервисов, перепроверяющих доступность для связи (`zaf_bank_account_holder`, `zaf_fraud_prevention`, `zaf_refugee`)." }, "right_thumb": { "type": "string", "description": "Отпечаток большого пальца правой руки в кодировке Base64 для `zaf_dha_fingerprint_match`, вместе с `left_thumb` или отдельно." }, "left_thumb": { "type": "string", "description": "Отпечаток большого пальца левой руки в кодировке Base64 для `zaf_dha_fingerprint_match`, вместе с `right_thumb` или отдельно." }, "score_level": { "type": "integer", "description": "Минимальный уровень биометрической оценки для `zaf_criminal_face_screening`. По умолчанию `3`." }, "max_matches": { "type": "integer", "description": "Максимальное количество кандидатов на совпадение, возвращаемых `zaf_criminal_face_screening`. По умолчанию `1`." }, "vehicle_register_number": { "type": "string", "description": "Регистрационный номер транспортного средства. Обязателен вместе с `vehicle_licence_plate` и `vin` для `zaf_vehicle_ownership`." }, "vehicle_licence_plate": { "type": "string", "description": "Регистрационный номерной знак транспортного средства. Обязателен вместе с `vehicle_register_number` и `vin` для `zaf_vehicle_ownership`." }, "vin": { "type": "string", "description": "Идентификационный номер транспортного средства (VIN или номер шасси). Обязателен вместе с `vehicle_register_number` и `vehicle_licence_plate` для `zaf_vehicle_ownership`." }, "ssn": { "type": "string", "description": "Номер социального страхования (США)." }, "phone": { "type": "string", "description": "Номер телефона для сервисов проверки телефона." }, "landline": { "type": "string", "description": "Номер стационарного телефона для сервисов проверки телефона." }, "email": { "type": "string", "format": "email", "description": "Адрес электронной почты для сервисов верификации личности." }, "country_of_residence": { "type": "string", "description": "Двухбуквенный код страны проживания по стандарту ISO 3166-1 alpha-2. Используется глобальными сервисами обогащения идентификационных данных (например, `glb_identity_enrichment`) для сужения области поиска.", "example": "US" }, "partial_match_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "NO_ACTION", "description": "Действие при `partial_match` в отношении `database_validation.status`. По умолчанию `NO_ACTION` (статус остаётся `Approved` с предупреждением)." }, "no_match_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Действие при `no_match` в отношении `database_validation.status`. По умолчанию `DECLINE`." }, "save_api_request": { "type": "boolean", "default": true, "description": "Сохранять валидацию как сессию (отображение в консоли, endpoint решений, webhook `status.updated`). Также изменяет структуру ответа `validations`: отдельные объекты по каждому сервису при значении `true` (по умолчанию), объединенная карта полей при `false`." }, "vendor_data": { "type": "string", "description": "Ваш идентификатор валидированного пользователя; возвращается в ответе и сохраняется вместе с сессией." }, "metadata": { "type": "object", "nullable": true, "description": "JSON в свободной форме, сохраняемый с запросом и возвращаемый в ответе." } } }, "example": { "issuing_state": "BRA", "services": [ "bra_cpf" ], "identification_number": "12345678900", "first_name": "John", "last_name": "Doe", "date_of_birth": "1980-01-01", "vendor_data": "user-1234" } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "issuing_state" ], "properties": { "issuing_state": { "type": "string", "description": "Трехбуквенный код страны ISO 3166-1 **alpha-3** реестра для проверки (например, `BRA`, `ESP`, `COL`). Определяет доступные сервисы. Неподдерживаемые коды возвращают `400` с полным списком допустимых вариантов.", "example": "BRA" }, "services": { "type": "array", "items": { "type": "string" }, "description": "Идентификаторы `service_id` из каталога для запуска по этой стране (например, `[\"bra_cpf\"]`). Также принимается одна строка или строка с разделением запятыми/JSON-кодированная строка. **Если параметр опущен или пуст, запускается ровно один сервис по умолчанию** — наиболее устоявшийся продакшн-сервис для данной страны; более новые, биометрические и тарифицируемые по факту использования сервисы должны быть указаны явно. Отправка `services` переключает ответ на расширенный формат (добавляет `services_used` и `match_score`). Каждый идентификатор должен существовать и быть активен в продакшне для `issuing_state`; сервисы, требующие онбординга, возвращают `400` до момента их активации для вашей организации. Узнать доступные сервисы по странам можно через `GET /v1/organization/database-validation-countries/` (каталожный endpoint, не описанный в данной спецификации) или в редакторе сценариев Business Console.", "example": [ "bra_cpf" ] }, "validation_type": { "type": "string", "deprecated": true, "description": "УСТАРЕЛО. Принимается для обратной совместимости, но игнорируется — `validation_type` в ответе теперь определяется тем, сколько сервисов дали полное совпадение. Используйте `services`, чтобы зафиксировать конкретные сервисы." }, "consent": { "type": "boolean", "default": false, "description": "Установите значение `true`, если конечный пользователь дал явное согласие на использование выбранных сервисов валидации. Обязательно для сервисов с флагом `requires_consent=true` в каталоге — без него эти сервисы возвращают `400` с `services_requiring_consent`." }, "identification_number": { "type": "string", "description": "Универсальный идентификационный номер — автоматически сопоставляется с нужным полем для конкретной страны, поэтому вы можете использовать его вместо `personal_number`/`tax_number`/`document_number`: ARG→document_number (DNI), BOL→document_number (CI), BRA→tax_number (CPF, 11 цифр), CHL→personal_number (RUT), COL→personal_number (Cédula), CRI→personal_number (Cédula), DOM→personal_number (Cédula, 11 цифр), ECU→personal_number (Cédula, 10 цифр), ESP→personal_number (DNI/NIE), GTM→document_number (DPI), HND→document_number (DNI), MEX→personal_number (CURP, 18 символов), PAN→personal_number (Cédula), PER→personal_number (DNI, 8 цифр), PRY→document_number (CI), SLV→document_number (DUI), URY→personal_number (CI), VEN→document_number (Cédula). Он никогда не перезаписывает явно переданное поле для конкретной страны." }, "first_name": { "type": "string", "description": "Имя физического лица. Требуется для некоторых сервисов/стран.", "example": "John" }, "last_name": { "type": "string", "description": "Фамилия физического лица. Требуется для некоторых сервисов/стран.", "example": "Doe" }, "middle_name": { "type": "string", "description": "Второе имя, используемое сервисами некоторых стран (AUS, NZL, …)." }, "full_name": { "type": "string", "description": "Полное имя — некоторые сервисы принимают его вместо имени и фамилии (например, китайские сервисы CHN, которые сверяют имя в оригинальной системе письма)." }, "date_of_birth": { "type": "string", "format": "date", "description": "Дата рождения, `YYYY-MM-DD`. Требуется многими сервисами.", "example": "1980-01-01" }, "personal_number": { "type": "string", "description": "Уникальный государственный идентификатор личности. Используется в: CHL (RUT), COL (Cédula), CRI, DOM, ECU, ESP (DNI/NIE), MEX (CURP), PAN (Cédula), PER (DNI), URY. Рассмотрите `identification_number` вместо этого." }, "tax_number": { "type": "string", "description": "Налоговый номер. Используется: BRA (CPF, 11 цифр). Рекомендуется использовать `identification_number`." }, "document_number": { "type": "string", "description": "Номер документа. Используется для: ARG (DNI), BOL (CI), GTM (DPI), HND (DNI), PRY (CI), SLV (DUI), VEN (Cédula). Рекомендуется использовать `identification_number`." }, "document_type": { "type": "string", "enum": [ "P", "DL", "ID", "RP", "SSC", "HIC", "WP", "TC", "VISA", "PSC", "BC", "OTHER" ], "description": "Тип проверяемого документа: `P` паспорт, `DL` водительское удостоверение, `ID` национальное удостоверение личности, `RP` вид на жительство (а также `SSC`, `HIC`, `WP`, `TC`, `VISA`, `PSC`, `BC`, `OTHER`). Требуется для некоторых сервисов (например, ESP)." }, "expiration_date": { "type": "string", "format": "date", "description": "Срок действия документа, `YYYY-MM-DD`. Обязательно для валидации в ESP (Испания).", "example": "2030-01-15" }, "date_of_issue": { "type": "string", "format": "date", "description": "Дата выдачи документа, `YYYY-MM-DD` (fecha de expedición). Обязательно для валидации cédula в COL (Колумбия).", "example": "2015-06-20" }, "nationality": { "type": "string", "description": "Гражданство в формате ISO 3166-1 alpha-3. Требуется для некоторых сервисов." }, "gender": { "type": "string", "enum": [ "M", "F", "X" ], "description": "Пол: `M`, `F` или `X` (другой/неизвестно). Обязательно для валидации RENAPER в Аргентине (`arg_renaper`)." }, "address": { "description": "Адрес проживания. Предпочтительнее структурированный объект `{\"street_1\":\"123 Main St\",\"street_2\":\"Apt 4B\",\"city\":\"Springfield\",\"region\":\"IL\",\"postal_code\":\"62701\",\"country\":\"US\"}`; полная однострочная строка также принимается. Требуется сервисами подтверждения адреса; если сервис определяет требования к адресу, при отсутствии обязательных данных возвращается `400` с `address_fields_required_by`.", "oneOf": [ { "type": "object", "properties": { "street_1": { "type": "string" }, "street_2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" } } }, { "type": "string", "description": "Полный однострочный адрес (устаревший)." } ] }, "address_element_1": { "type": "string", "description": "Адрес улицы, включая номер дома и тип улицы. Если не указано, определяется на основе `address`." }, "address_element_2": { "type": "string", "description": "Квартира, блок/помещение, здание, этаж или дополнительная строка адреса. Отправляйте только при явном наличии этих данных." }, "address_element_3": { "type": "string", "description": "Город, пригород, район, населённый пункт или квартал. Если не указано, определяется из `address`." }, "address_element_4": { "type": "string", "description": "Штат, провинция, регион или населённый пункт. Если не указано, определяется из `address`." }, "address_element_5": { "type": "string", "description": "Почтовый индекс. `postal_code` принимается в качестве псевдонима." }, "postal_code": { "type": "string", "description": "Почтовый индекс для сервисов на основе адреса (псевдоним `address_element_5`)." }, "driver_license_number": { "type": "string", "description": "Номер водительского удостоверения для государственных служб проверки документов (AUS, NZL, IND)." }, "driver_license_card_number": { "type": "string", "description": "Номер физической карты водительского удостоверения, если он требуется отдельно от номера удостоверения (AUS)." }, "driver_license_state": { "type": "string", "description": "Штат или территория выдачи водительского удостоверения (AUS)." }, "driver_license_version": { "type": "string", "description": "Код версии водительского удостоверения (NZL)." }, "passport_number": { "type": "string", "description": "Номер паспорта для государственных сервисов верификации паспортов (AUS, NZL, IND, CHN)." }, "passport_expiration_date": { "type": "string", "format": "date", "description": "Срок действия паспорта, `YYYY-MM-DD`, для сервисов верификации паспортов." }, "passport_file_number": { "type": "string", "description": "Номер файла паспорта (IND)." }, "passport_issue_country": { "type": "string", "description": "Страна выдачи паспорта (ISO 3166-1 alpha-3) для сервисов верификации паспортов." }, "medicare_card_number": { "type": "string", "description": "Номер карты Medicare (Австралия)." }, "immi_card_number": { "type": "string", "description": "Номер австралийской карты ImmiCard." }, "immi_card_expiry_date": { "type": "string", "format": "date", "description": "Срок действия австралийской карты ImmiCard." }, "citizenship_certificate_number": { "type": "string", "description": "Номер свидетельства о гражданстве (AUS)." }, "birth_registration_number": { "type": "string", "description": "Номер регистрации свидетельства о рождении (AUS)." }, "birth_registration_date": { "type": "string", "format": "date", "description": "Дата регистрации свидетельства о рождении (AUS)." }, "birth_registration_state": { "type": "string", "description": "Штат регистрации свидетельства о рождении (AUS)." }, "marriage_certificate_number": { "type": "string", "description": "Номер свидетельства о браке (AUS)." }, "change_of_name_certificate_number": { "type": "string", "description": "Номер свидетельства о смене имени (AUS)." }, "first_partner_name": { "type": "string", "description": "Имя партнёра в свидетельстве о браке (AUS)." }, "last_partner_name": { "type": "string", "description": "Фамилия партнёра в свидетельстве о браке (AUS)." }, "voter_id": { "type": "string", "description": "Номер регистрации избирателя (IND EPIC, IRL)." }, "epic_card": { "type": "string", "description": "Номер карты избирателя Индии (EPIC)." }, "pan": { "type": "string", "description": "PAN (Permanent Account Number) Индии." }, "national_id": { "type": "string", "description": "Номер национального удостоверения личности (CHN, MYS, KEN, KHM, NGA, ZAF, …)." }, "cic": { "type": "string", "description": "Мексиканский Código de Identificación de Credencial (CIC) INE/IFE, 9 цифр. Используется сервисом проверки действительности учетных данных MEX INE (`mex_ine_vigencia`)." }, "identificador_ciudadano": { "type": "string", "description": "Мексиканский Identificador del Ciudadano INE (9 цифр). Используется вместе с `cic` для современных моделей INE (E/F/G/H) в `mex_ine_vigencia`." }, "ocr": { "type": "string", "description": "Мексиканский номер OCR INE (13 цифр, на обратной стороне карты). Используется вместе с `cic` для модели D в `mex_ine_vigencia`." }, "voter_number": { "type": "string", "description": "Мексиканский Clave de Elector INE (18 символов). Используется вместе с `emission_number` для устаревших моделей IFE (A/B/C) в `mex_ine_vigencia`." }, "emission_number": { "type": "string", "description": "Мексиканский Número de Emisión INE. Используется вместе с `voter_number` для устаревших моделей IFE (A/B/C) в `mex_ine_vigencia`." }, "bvn": { "type": "string", "description": "Банковский верификационный номер Нигерии (BVN)." }, "bank_card_number": { "type": "string", "description": "Номер банковской карты (верификация банковских карт CHN)." }, "company_registration_number": { "type": "string", "description": "Регистрационный номер компании, выданный реестром компаний: CNPJ в Бразилии (например, `11222333000181`), регистрационный номер в Южной Африке (например, `1936/007721/06`). Требуется сервисами реестра компаний и директоров компаний (`bra_company_registry`, `bra_company_directors`, `zaf_company_registry`, `zaf_company_directors`)." }, "company_name": { "type": "string", "description": "Зарегистрированное название компании, сверенное с записью в реестре. Необязательно для `zaf_company_registry`." }, "initials": { "type": "string", "description": "Инициалы человека в том виде, в каком они напечатаны на документе. Обязательно для `zaf_drivers_license`; принимается для `zaf_bank_account_holder`." }, "licence_number": { "type": "string", "description": "Номер водительского удостоверения, как он напечатан на карте, для `zaf_drivers_license`. Если не указан, используется `document_number`." }, "refugee_file_number": { "type": "string", "description": "Номер дела беженца, выданный Министерством внутренних дел ЮАР. Обязателен для `zaf_refugee`." }, "bank_name": { "type": "string", "description": "Название банка, в котором открыт счёт. Обязательно для `zaf_bank_account_holder`." }, "bank_account_number": { "type": "string", "description": "Номер банковского счёта. Обязателен для `zaf_bank_account_holder`; принимается в `zaf_fraud_prevention`." }, "account_type": { "type": "string", "description": "Тип банковского счёта для `zaf_bank_account_holder`: `current`, `savings`, `transmission`, `subscriptionShare` или `notKnown` (без учёта регистра). Любое другое значение возвращает `400`. Опустите его, если тип вам неизвестен: в этом случае результат сверки типа счёта будет отмечен как неподтверждённый." }, "phone_number": { "type": "string", "description": "Контактный номер мобильного телефона для сервисов, перепроверяющих доступность для связи (`zaf_bank_account_holder`, `zaf_fraud_prevention`, `zaf_refugee`)." }, "right_thumb": { "type": "string", "description": "Отпечаток большого пальца правой руки в кодировке Base64 для `zaf_dha_fingerprint_match`, вместе с `left_thumb` или отдельно." }, "left_thumb": { "type": "string", "description": "Отпечаток большого пальца левой руки в кодировке Base64 для `zaf_dha_fingerprint_match`, вместе с `right_thumb` или отдельно." }, "score_level": { "type": "integer", "description": "Минимальный уровень биометрической оценки для `zaf_criminal_face_screening`. По умолчанию `3`." }, "max_matches": { "type": "integer", "description": "Максимальное количество кандидатов на совпадение, возвращаемых `zaf_criminal_face_screening`. По умолчанию `1`." }, "vehicle_register_number": { "type": "string", "description": "Регистрационный номер транспортного средства. Обязателен вместе с `vehicle_licence_plate` и `vin` для `zaf_vehicle_ownership`." }, "vehicle_licence_plate": { "type": "string", "description": "Регистрационный номерной знак транспортного средства. Обязателен вместе с `vehicle_register_number` и `vin` для `zaf_vehicle_ownership`." }, "vin": { "type": "string", "description": "Идентификационный номер транспортного средства (VIN или номер шасси). Обязателен вместе с `vehicle_register_number` и `vehicle_licence_plate` для `zaf_vehicle_ownership`." }, "ssn": { "type": "string", "description": "Номер социального страхования (США)." }, "phone": { "type": "string", "description": "Номер телефона для сервисов проверки телефона." }, "landline": { "type": "string", "description": "Номер стационарного телефона для сервисов проверки телефона." }, "email": { "type": "string", "format": "email", "description": "Адрес электронной почты для сервисов верификации личности." }, "country_of_residence": { "type": "string", "description": "Двухбуквенный код страны проживания по стандарту ISO 3166-1 alpha-2. Используется глобальными сервисами обогащения идентификационных данных (например, `glb_identity_enrichment`) для сужения области поиска.", "example": "US" }, "partial_match_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "NO_ACTION", "description": "Действие при `partial_match` в отношении `database_validation.status`. По умолчанию `NO_ACTION` (статус остаётся `Approved` с предупреждением)." }, "no_match_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Действие при `no_match` в отношении `database_validation.status`. По умолчанию `DECLINE`." }, "save_api_request": { "type": "boolean", "default": true, "description": "Сохранять валидацию как сессию (отображение в консоли, endpoint решений, webhook `status.updated`). Также изменяет структуру ответа `validations`: отдельные объекты по каждому сервису при значении `true` (по умолчанию), объединенная карта полей при `false`." }, "vendor_data": { "type": "string", "description": "Ваш идентификатор валидированного пользователя; возвращается в ответе и сохраняется вместе с сессией." }, "metadata": { "type": "object", "nullable": true, "description": "JSON в свободной форме, сохраняемый с запросом и возвращаемый в ответе." }, "selfie": { "type": "string", "format": "binary", "description": "Изображение селфи (`jpg`, `jpeg`, `png`, `webp`; макс. 2 МБ — изображения сжимаются до ~1.5 МБ перед загрузкой в реестр) для сервисов биометрической валидации, например Argentina RENAPER (`arg_renaper`) и Panama SIB (`pan_cedula_sib`, `pan_cedula_sib_plus`). Обязательно, если выбранный сервис указывает его как обязательное поле. Доступно только через `multipart/form-data`." } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/database-validation/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"issuing_state\": \"BRA\",\n \"services\": [\"bra_cpf\"],\n \"identification_number\": \"12345678900\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": \"1980-01-01\",\n \"vendor_data\": \"user-1234\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.database_validation.validate(\n issuing_state=\"BRA\",\n services=[\"bra_cpf\"],\n identification_number=\"12345678900\",\n first_name=\"John\",\n last_name=\"Doe\",\n date_of_birth=\"1980-01-01\",\n vendor_data=\"user-1234\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.databaseValidation.validate({\n issuing_state: \"BRA\",\n services: [\"bra_cpf\"],\n identification_number: \"12345678900\",\n first_name: \"John\",\n last_name: \"Doe\",\n date_of_birth: \"1980-01-01\",\n vendor_data: \"user-1234\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.DatabaseValidation.Validate(ctx, didit.DatabaseValidationValidateParams{\n\tIssuingState: \"BRA\",\n\tServices: didit.Some([]string{\"bra_cpf\"}),\n\tIdentificationNumber: didit.String(\"12345678900\"),\n\tFirstName: didit.String(\"John\"),\n\tLastName: didit.String(\"Doe\"),\n\tDateOfBirth: didit.String(\"1980-01-01\"),\n\tVendorData: didit.String(\"user-1234\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.LocalDate;\nimport java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.DatabaseValidationValidateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.databaseValidation().validate(DatabaseValidationValidateParams.builder()\n .issuingState(\"BRA\")\n .services(List.of(\"bra_cpf\"))\n .identificationNumber(\"12345678900\")\n .firstName(\"John\")\n .lastName(\"Doe\")\n .dateOfBirth(LocalDate.parse(\"1980-01-01\"))\n .vendorData(\"user-1234\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "databaseValidation->validate([\n 'issuing_state' => 'BRA',\n 'services' => ['bra_cpf'],\n 'identification_number' => '12345678900',\n 'first_name' => 'John',\n 'last_name' => 'Doe',\n 'date_of_birth' => '1980-01-01',\n 'vendor_data' => 'user-1234',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.database_validation.validate(\n issuing_state: \"BRA\",\n services: [\"bra_cpf\"],\n identification_number: \"12345678900\",\n first_name: \"John\",\n last_name: \"Doe\",\n date_of_birth: \"1980-01-01\",\n vendor_data: \"user-1234\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.DatabaseValidation.ValidateAsync(new DatabaseValidationValidateParams\n{\n IssuingState = \"BRA\",\n Services = new string[] { \"bra_cpf\" },\n IdentificationNumber = \"12345678900\",\n FirstName = \"John\",\n LastName = \"Doe\",\n DateOfBirth = \"1980-01-01\",\n VendorData = \"user-1234\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Проверка завершена — как минимум один выбранный сервис вернул применимый результат. Проверьте `database_validation.match_type` для сводного результата, `validations` для сравнения полей по каждому сервису и кодов `outcome_code`, а также `errors` (при наличии) для сервисов, завершившихся ошибкой.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Идентификатор сохраненной сессии при `save_api_request=true` (доступен для использования с `GET /v3/session/{sessionId}/decision/`); в противном случае это временный корреляционный UUID." }, "database_validation": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review" ], "description": "`Declined`, если общий `match_type` запускает действие `DECLINE` (`no_match_action` по умолчанию имеет значение `DECLINE`, а `partial_match_action` имеет значение `NO_ACTION`); `In Review`, если ни один сервис не предоставил пригодного для использования результата сравнения, например когда единственный выбранный сервис вернул `REGISTRY_UNAVAILABLE` или `INCONCLUSIVE`; в противном случае `Approved`. Запрос, в котором выбрано несколько сервисов, может получить `Approved` по совпадению в одном сервисе, даже если другой был недоступен, поэтому также проверяйте `errors` и значения `outcome_code` по каждому сервису." }, "issuing_state": { "type": "string", "description": "Эхо-значение страны по стандарту ISO 3166-1 alpha-3, по которой проводилась проверка.", "example": "BRA" }, "validation_type": { "type": "string", "enum": [ "one_by_one", "two_by_two" ], "description": "Определяется на основе результатов: `two_by_two`, когда ≥2 различных сервисов вернули полное совпадение (по идентификационному номеру, по полному имени + дате рождения вместе либо по адресу без противоречий); `one_by_one` в противном случае. (Поле запроса с таким же именем устарело и игнорируется.)" }, "screened_data": { "type": "object", "description": "Эхо входных полей, отправленных в выбранные сервисы (даты нормализованы к формату `YYYY-MM-DD`; `selfie`, если отправлено, возвращается в виде предварительно подписанного URL; `consent_obtained: true` добавляется при предоставлении согласия)." }, "match_type": { "type": "string", "nullable": true, "enum": [ "full_match", "partial_match", "no_match" ], "description": "Общий результат, агрегированный по сервисам со сравнением на уровне полей: любое `full_match` → `full_match`; иначе любое `partial_match` → `partial_match`; иначе `no_match`. Сервисы, возвращающие только итог (например, биометрический криминальный скрининг), могут возвращать `null`; проверяйте `outcome_code` для каждого элемента в `validations`." }, "validations": { "description": "Формат зависит от `save_api_request`. **`true` (по умолчанию):** массив объектов по каждому сервису (`service_id`, `service_name`, `validation`, `outcome_code`, `outcome_detail`, `source_data`). **`false`:** единый плоский объект, объединяющий результаты всех сервисов на уровне полей (`{\"full_name\": \"full_match\", ...}`).", "oneOf": [ { "type": "array", "items": { "type": "object", "description": "Результат валидации по сервисам (возвращается, когда `save_api_request=true`, по умолчанию).", "properties": { "service_id": { "type": "string", "description": "Каталожный идентификатор сервиса, сформировавшего этот результат (например, `bra_cpf`).", "example": "bra_cpf" }, "service_name": { "type": "string", "description": "Понятное название сервиса в каталоге.", "example": "Brazil - CPF status check" }, "validation": { "type": "object", "description": "Сравнение по каждому полю ваших входных данных с записью в реестре. Ключи: канонические имена полей (`full_name`, `date_of_birth`, `identification_number`, `address`, …); значения: `full_match`, `partial_match` или `no_match`.", "additionalProperties": { "type": "string", "enum": [ "full_match", "partial_match", "no_match" ] } }, "outcome_code": { "type": "string", "enum": [ "MATCH", "PARTIAL_MATCH", "NO_MATCH", "DOCUMENT_NOT_FOUND", "INVALID_DOCUMENT_FORMAT", "INVALID_INPUT", "MINOR_BLOCKED", "DECEASED", "BIOMETRIC_NO_MATCH", "BIOMETRIC_IMAGE_UNUSABLE", "INCONCLUSIVE", "DOCUMENT_SUPERSEDED", "REGISTRY_UNAVAILABLE", "REGISTRY_ERROR" ], "description": "Нейтральный к вендору результат проверки по реестру. `MATCH`/`PARTIAL_MATCH`/`NO_MATCH` описывают результат сравнения; `DOCUMENT_NOT_FOUND` означает, что идентификатор отсутствует в реестре; `INCONCLUSIVE` означает, что реестр не смог подтвердить ни один из вариантов (направлено на проверку, это НЕ несовпадение); `BIOMETRIC_NO_MATCH` означает окончательное несовпадение лица, тогда как `BIOMETRIC_IMAGE_UNUSABLE` указывает на техническую проблему с изображением (переснимите селфи); `DECEASED`/`MINOR_BLOCKED` являются результатами, определяемыми политикой реестра; `DOCUMENT_SUPERSEDED` означает, что личность совпала, но версия предъявленного документа не соответствует зарегистрированной (была выпущена более новая версия); `INVALID_DOCUMENT_FORMAT`/`INVALID_INPUT` означают, что сам реестр отклонил переданные ему данные; `REGISTRY_UNAVAILABLE`/`REGISTRY_ERROR` указывают на сбои вышестоящего сервиса." }, "outcome_detail": { "type": "string", "nullable": true, "description": "Необработанные детали статуса от вышестоящей системы, лежащие в основе кода результата (например, HTTP-код статуса или статус реестра)." }, "source_data": { "type": "object", "nullable": true, "description": "Очищенное и нормализованное представление записи реестра с каноническими именами полей (`identification_number`, `first_name`, `last_name`, `date_of_birth`, а также специфичные для реестра флаги). Поля изображений, если они присутствуют, возвращаются в виде предварительно подписанных URL." } } } }, { "type": "object", "additionalProperties": { "type": "string", "enum": [ "full_match", "partial_match", "no_match" ] }, "description": "Объединённые результаты на уровне полей (формат stateless `save_api_request=false`)." } ] }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Функция, вызвавшая предупреждение." }, "risk": { "type": "string", "description": "Машиночитаемый идентификатор риска." }, "additional_data": { "type": "object", "nullable": true, "description": "Дополнительный контекст предупреждения, если он доступен." }, "log_type": { "type": "string", "description": "`warning`, `information` или `error` — как этот риск повлиял на результат." }, "short_description": { "type": "string", "description": "Однострочная понятная человеку сводка." }, "long_description": { "type": "string", "description": "Полное понятное человеку объяснение." } } }, "description": "`DATABASE_VALIDATION_NO_MATCH` или `DATABASE_VALIDATION_PARTIAL_MATCH`, если применимо; пусто при полном совпадении." }, "errors": { "type": "array", "description": "Присутствует только тогда, когда завершились сбоем некоторые (но не все) выбранные сервисы. Каждая запись содержит `service_id`, `code`, `message` и `retryable`. Сервис, указанный здесь, отсутствует в `validations` и `services_used` и не тарифицируется. Этот массив является единственным местом, где он появляется, поэтому проверяйте его, даже если `status` равен `Approved`.", "items": { "type": "object", "properties": { "service_id": { "type": "string" }, "code": { "type": "string", "example": "empty_provider_response" }, "message": { "type": "string" }, "retryable": { "type": "boolean", "description": "`true`, если сервис не дал ответа и повторная попытка позже может быть успешной; `false`, если источник отклонил переданные данные и сначала необходимо исправить входные данные.", "example": true } } } }, "services_used": { "type": "array", "items": { "type": "string" }, "description": "Каталожные идентификаторы сервисов, вернувших тарифицируемый результат. **Присутствует только в том случае, если запрос явно содержал `services`.**" }, "match_score": { "type": "number", "description": "Доля (0.0–1.0) сервисов, для которых была предпринята попытка проверки, выдавших полное совпадение (по идентификационному номеру, по полному имени вместе с датой рождения или по адресу без противоречий). **Присутствует только тогда, когда в запросе были явно переданы `services`.**" } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Эхо отправленных вами `vendor_data`." }, "metadata": { "type": "object", "nullable": true, "description": "Эхо-значение переданного вами `metadata`." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "Full match (Approved)": { "summary": "По умолчанию save_api_request=true — объекты `validations` для каждого сервиса", "value": { "request_id": "7f9a1c0e-1f2b-4f6e-9d3a-2b1c0e7f9a1c", "database_validation": { "status": "Approved", "issuing_state": "BRA", "validation_type": "one_by_one", "screened_data": { "tax_number": "12345678900", "first_name": "John", "last_name": "Doe", "date_of_birth": "1980-01-01" }, "match_type": "full_match", "validations": [ { "validation": { "full_name": "full_match", "date_of_birth": "full_match", "identification_number": "full_match" }, "outcome_code": "MATCH", "outcome_detail": "200", "service_id": "bra_cpf", "service_name": "Brazil - CPF status check", "source_data": { "identification_number": "12345678900", "first_name": "JOHN", "last_name": "DOE", "date_of_birth": "1980-01-01", "lgpd_minor": false, "minor_under_16": false, "minor_under_18": false } } ], "warnings": [] }, "vendor_data": "user-1234", "metadata": null, "created_at": "2026-06-11T10:30:00.000000+00:00" } }, "Explicit services (extended shape)": { "summary": "В запросе отправлено `services` — в ответе добавлены `services_used` и `match_score`", "value": { "request_id": "b3e7c1a2-9d4f-4f0b-8a6c-5e2d1f0a9b3e", "database_validation": { "status": "Approved", "issuing_state": "BRA", "validation_type": "one_by_one", "screened_data": { "tax_number": "12345678900", "first_name": "John", "last_name": "Doe", "date_of_birth": "1980-01-01" }, "match_type": "full_match", "validations": [ { "validation": { "full_name": "full_match", "date_of_birth": "full_match", "identification_number": "full_match" }, "outcome_code": "MATCH", "outcome_detail": "200", "service_id": "bra_cpf", "service_name": "Brazil - CPF status check", "source_data": { "identification_number": "12345678900", "first_name": "JOHN", "last_name": "DOE", "date_of_birth": "1980-01-01", "lgpd_minor": false, "minor_under_16": false, "minor_under_18": false } } ], "warnings": [], "services_used": [ "bra_cpf" ], "match_score": 1.0 }, "vendor_data": "user-1234", "metadata": null, "created_at": "2026-06-11T10:30:00.000000+00:00" } }, "No match (Declined)": { "summary": "Запись в реестре не совпадает — по умолчанию `no_match_action=DECLINE`", "value": { "request_id": "0a1b2c3d-4e5f-6789-abcd-ef0123456789", "database_validation": { "status": "Declined", "issuing_state": "BRA", "validation_type": "one_by_one", "screened_data": { "tax_number": "12345678900", "first_name": "John", "last_name": "Doe", "date_of_birth": "1980-01-01" }, "match_type": "no_match", "validations": [ { "validation": { "full_name": "no_match", "date_of_birth": "no_match", "identification_number": "no_match" }, "outcome_code": "NO_MATCH", "outcome_detail": "200", "service_id": "bra_cpf", "service_name": "Brazil - CPF status check", "source_data": { "identification_number": "00987654321", "first_name": "TOTALLY", "last_name": "DIFFERENT NAME", "date_of_birth": "1999-01-01", "lgpd_minor": false, "minor_under_16": false, "minor_under_18": false } } ], "warnings": [ { "feature": "DATABASE_VALIDATION", "risk": "DATABASE_VALIDATION_NO_MATCH", "additional_data": null, "log_type": "error", "short_description": "Database validation no match", "long_description": "The system identified a no match in the database validation, requiring further investigation." } ] }, "vendor_data": null, "metadata": null, "created_at": "2026-06-11T10:31:00.000000+00:00" } }, "Stateless (save_api_request=false)": { "summary": "`validations` сворачивается в объединённую карту полей; ничего не сохраняется", "value": { "request_id": "c4d5e6f7-8901-2345-6789-abcdef012345", "database_validation": { "status": "Approved", "issuing_state": "BRA", "validation_type": "one_by_one", "screened_data": { "tax_number": "12345678900", "first_name": "John", "last_name": "Doe", "date_of_birth": "1980-01-01" }, "match_type": "full_match", "validations": { "full_name": "full_match", "date_of_birth": "full_match", "identification_number": "full_match" }, "warnings": [] }, "vendor_data": null, "metadata": null, "created_at": "2026-06-11T10:32:00.000000+00:00" } } } } } }, "400": { "description": "Ошибка валидации: биллинг не выполняется. Предварительные ошибки полей возникают до любого внешнего вызова. Если каждая попытка без ответа явно отклоняет входные данные, ответ вместо этого содержит `validation_errors` с `code: provider_rejected_input` и `retryable: false`; исправьте входные данные перед повторной попыткой. Ошибки на уровне полей используют стандартную обёртку DRF; ошибки каталога возвращают массив `services` (плюс `requires_onboarding` или `services_requiring_consent`, когда это применимо); ошибки отсутствующих полей включают `fields_required_by`, сопоставляющий каждое отсутствующее поле с сервисами, которые его требуют; сервисы, которым требуется как минимум один дополнительный идентификатор (например, `usa_states_credit_bureau`, который не может проверить только имя), возвращают `any_field_required_by`, сопоставляющий каждый сервис с полями, хотя бы одно из которых должно присутствовать; ошибки формата, проверяемые для каждого сервиса, возвращают `invalid_fields_by_service`.", "content": { "application/json": { "examples": { "Invalid issuing_state": { "summary": "Страна не поддерживается — в сообщении перечислены все допустимые коды alpha-3", "value": { "error": [ "Invalid issuing state. Valid options are: ARE, ARG, AUS, AUT, BEL, BGD, BOL, BRA, CAN, CHE, CHL, CHN, CIV, COL, CRI, CZE, DEU, DNK, DOM, ECU, ESP, FIN, FRA, GBR, GHA, GLB, GRC, GTM, HKG, HND, IDN, IND, IRL, ITA, KEN, KHM, MAR, MEX, MYS, NGA, NLD, NOR, NZL, OMN, PAN, PER, PHL, POL, PRT, PRY, QAT, SGP, SLV, SVK, SWE, THA, UGA, URY, USA, VEN, ZAF, ZMB, ZWE" ] } }, "Missing required fields": { "summary": "Объединение обязательных полей для выбранных сервисов с подсказкой об универсальном поле", "value": { "error": [ "Missing required fields: tax_number (or use 'identification_number' which maps to 'tax_number' for BRA)" ], "fields_required_by": { "tax_number": [ "bra_cpf" ] } } }, "Unknown service id": { "summary": "`services` содержит идентификатор, отсутствующий в каталоге", "value": { "services": [ "Unknown service_id(s): ['bogus_service']" ] } }, "Service not live for country": { "summary": "`services` указывает сервис из другой страны (или фиктивную запись)", "value": { "services": [ "Services not currently live for PER: ['bra_cpf']. Available services: ['per_dni', 'per_residential', 'per_tax_registration']" ] } }, "Service requires onboarding": { "summary": "Сервис существует, но ещё не активирован для вашей организации", "value": { "services": [ "Services require onboarding before they can be enabled for AUS: ['aus_australia_driver_licence']. Contact Didit support to activate them." ], "requires_onboarding": [ "aus_australia_driver_licence" ] } }, "Consent missing": { "summary": "Выбранный сервис помечен requires_consent=true, а `consent` не равен `true`", "value": { "consent": [ "Explicit end-user consent is required for these database validation services: ['chn_national_id']. Send `consent=true`." ], "services_requiring_consent": [ "chn_national_id" ] } }, "Country format rule violation": { "summary": "Идентификатор не соответствует правилу формата для страны (длина/цифры/регулярное выражение)", "value": { "tax_number": [ "Invalid tax number for BRA: Brazilian CPF (exactly 11 digits). Must be exactly 11 characters long (got 10)." ] } }, "Service-specific format violation": { "summary": "Поле не соответствует требованиям к формату выбранного сервиса", "value": { "error": [ "One or more fields do not match the format required by the selected service." ], "invalid_fields_by_service": { "chn_national_id": [ "national_id_format" ] } } }, "Input refused by every attempt": { "summary": "Исправьте входные данные перед повторной попыткой", "value": { "error": "The source refused to run this query with the supplied input.", "validation_errors": [ { "service_id": "bra_cpf", "code": "provider_rejected_input", "message": "The source refused to run this query with the supplied input.", "retryable": false } ] } } }, "schema": { "type": "object", "additionalProperties": true, "properties": { "error": { "description": "Пояснение на уровне запроса или ошибки полей предварительной проверки.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "validation_errors": { "type": "array", "description": "Присутствует, если каждая попытка без ответа отклоняла входные данные после предварительной проверки.", "items": { "type": "object", "properties": { "service_id": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean", "description": "Может ли повторная попытка позже устранить этот сбой сервиса. Значение false означает, что сначала необходимо исправить переданные входные данные." } } } } } } } } }, "403": { "description": "В доступе отказано. Возвращается, если заголовок `x-api-key` отсутствует, а также если баланс вызывающей организации не покрывает вызов; неверный, отозванный или истекший ключ возвращает `401`. Отсутствующий ключ возвращает `403` с `{\"detail\": ...}`; неверный, отозванный или истекший ключ возвращает `401`. При нехватке кредитов возвращается `403` с `{\"error\": ...}` до начала любого скрининга или вызова провайдера.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Отсутствует заголовок `x-api-key`, либо ключ недействителен/отозван", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "Баланс организации недостаточен для совершения вызова", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Превышен лимит запросов. Endpoint'ы POST/PATCH/DELETE делят общий лимит в 300 запросов на запись в минуту на один API-ключ (для создания транзакций и отправки событий действует отдельный лимит в 600). Ответ содержит заголовки `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` и `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Более 300 запросов на запись в текущую минуту", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "502": { "description": "Ни один выбранный сервис не вернул пригодный результат. Проверьте каждую запись в validation_errors перед повторной попыткой; один лишь HTTP 502 не означает временный сбой. Запись empty_provider_response с retryable: true указывает на недоступные или необъяснимые результаты, включая отказ основного сервиса с последующей недоступностью резервного. Устаревшие записи provider_invalid_input и provider_validation_error вместо этого требуют исправления входных данных и могут опускать retryable. Списания средств не происходит. Если save_api_request=true, неудавшаяся попытка записывается как сессия со статусом Not Finished. Частичные сбои возвращают 200 с database_validation.errors.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "validation_errors": { "type": "array", "items": { "type": "object", "properties": { "service_id": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean", "description": "Может ли повторная попытка позже устранить этот сбой сервиса. Значение false означает, что сначала необходимо исправить переданные входные данные." } } } } } }, "examples": { "Provider returned no result": { "summary": "Каждый выбранный сервис завершился сбоем", "value": { "error": "Database validation could not be performed. The external validation service did not return a result. Please try again later.", "validation_errors": [ { "service_id": "bra_cpf", "code": "empty_provider_response", "message": "The provider did not return a database validation result.", "retryable": true } ] } } } } } } } } }, "/v3/phone/send/": { "post": { "summary": "Отправить код на телефон", "description": "Отправьте одноразовый код (OTP) на номер телефона через WhatsApp, SMS или другой поддерживаемый канал, а затем проверьте его с помощью [`POST /v3/phone/check/`](/ru/standalone-apis/phone-check).\n\n**Как связываются отправка и проверка.** Состояние верификации привязано к вашему приложению и `phone_number` в формате E.164 — вызов проверки не принимает `request_id`. Каждая новая отправка создает верификацию в состоянии ожидания, которая действует в течение **5 минут**: вызовите проверку с тем же номером и кодом, полученным пользователем, до закрытия этого окна. Повторный вызов отправки на тот же номер, пока верификация находится в ожидании, повторно отправляет код для этой же верификации (`status: \"Retry\"`, тот же `request_id`). Таким образом привязывается не более одной повторной попытки (всего две отправки); последующая отправка начинает новую верификацию с новым `request_id`. Окно в 5 минут отсчитывается от первой отправки и не продлевается повторными попытками.\n\n**Каналы доставки.** `options.preferred_channel` выбирает канал (по умолчанию `whatsapp`; также поддерживаются `sms`, `telegram`, `voice`, `rcs`, `viber` и `zalo`). Когда предпочтительный канал недоступен для страны назначения или номера, доставка автоматически переключается на SMS — отправка по-прежнему возвращает `Success`, а фактически использованный канал сообщается в ответе проверки (`phone.verification_method` и события `lifecycle`).\n\n**Брендинг.** SMS-коды содержат имя отправителя SMS вашего приложения, настроенное в Business Console, без дополнительной платы. Передайте `options.sms_sender_name`, чтобы подписать конкретный код другим именем, или `options.use_white_label_customization: true`, чтобы использовать ваше публичное White label имя, когда имя отправителя не настроено. Коды WhatsApp используют фиксированное сообщение; подключите собственный номер WhatsApp Business в Business Console, чтобы отправлять их от имени и с номера вашей компании с оплатой только комиссии Didit.\n\n**Статусы отправки.** `Success` — OTP отправлен для новой верификации; `Retry` — OTP отправлен повторно для верификации в состоянии ожидания; `Blocked` — слой защиты от мошенничества отклонил отправку (см. `reason`, например `repeated_attempts`, `suspicious`, `spam`). Отправка со статусом `Blocked` немедленно завершает верификацию со статусом `Declined` с предупреждением о высоком уровне риска, поэтому последующая проверка возвращает `Expired or Not Found`.\n\n**Биллинг.** Цена зависит от страны назначения и канала, который фактически доставляет сообщение — см. [Цены на проверку телефона](/ru/getting-started/phone-verification-pricing). Бесплатными гарантированно являются только отправки со статусом `Blocked`: любая другая неоплаченная попытка отправки списывается при завершении или истечении срока действия верификации, даже если доставка так и не была подтверждена или провайдер доставки сообщил о невозможности доставки сообщения. Проверки всегда бесплатны. В качестве меры защиты от злоупотреблений проверка телефона отключена до первого пополнения баланса вашей организации (`403`).\n\n**Сохранение сессии.** Каждая новая верификация сохраняется как сессия типа API: `request_id` является реальным идентификатором сессии, который можно передать в `GET /v3/session/{sessionId}/decision/`, верификация отображается в Business Console, и по мере её выполнения отправляются события webhook `status.updated`.\n\n**Песочница.** API-ключи песочницы пропускают доставку и биллинг: после валидации запроса (некорректные данные по-прежнему возвращают `400`) endpoint возвращает статический payload `Success` со случайным `request_id`; сообщение не отправляется и данные не сохраняются. Для проверки в песочнице используйте код `123456`.\n\n**Аутентификация.** Передайте API-ключ вашего приложения в заголовке `x-api-key`. Отсутствие или недействительность учетных данных возвращает `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`) — этот API никогда не возвращает `401`.\n\n**Лимиты запросов.** Общий лимит на запись составляет 300 запросов/мин на API-ключ для всех POST/PATCH/DELETE endpoints, плюс ограничение для защиты от злоупотреблений в 4 попытки отправки на один номер телефона в час; превышение любого из них возвращает `429`.", "operationId": "post_v3phone_send", "x-didit-sdk": { "resource": "phone", "method": "send_code", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/phone/send/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"phone_number\": \"+14155552671\",\n \"options\": {\n \"code_size\": 6,\n \"preferred_channel\": \"whatsapp\",\n \"locale\": \"en-US\"\n },\n \"vendor_data\": \"user-1234\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.phone.send_code(\n phone_number=\"+14155552671\",\n options={\n \"locale\": \"en-US\",\n \"preferred_channel\": \"whatsapp\",\n },\n vendor_data=\"user-1234\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.phone.sendCode({\n phone_number: \"+14155552671\",\n options: {\n locale: \"en-US\",\n preferred_channel: \"whatsapp\",\n },\n vendor_data: \"user-1234\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Phone.SendCode(ctx, didit.PhoneSendCodeParams{\n\tPhoneNumber: \"+14155552671\",\n\tOptions: didit.Some(didit.PhoneSendCodeParamsOptions{\n\t\tLocale: didit.String(\"en-US\"),\n\t\tPreferredChannel: didit.Some(didit.PhoneSendCodeParamsOptionsPreferredChannel(\"whatsapp\")),\n\t}),\n\tVendorData: didit.String(\"user-1234\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.PhoneSendCodeParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.phone().sendCode(PhoneSendCodeParams.builder()\n .phoneNumber(\"+14155552671\")\n .options(PhoneSendCodeParams.Options.builder()\n .locale(\"en-US\")\n .preferredChannel(PhoneSendCodeParams.Options.PreferredChannel.of(\"whatsapp\"))\n .build())\n .vendorData(\"user-1234\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "phone->sendCode([\n 'phone_number' => '+14155552671',\n 'options' => [\n 'locale' => 'en-US',\n 'preferred_channel' => 'whatsapp',\n ],\n 'vendor_data' => 'user-1234',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.phone.send_code(\n phone_number: \"+14155552671\",\n options: {\n locale: \"en-US\",\n preferred_channel: \"whatsapp\",\n },\n vendor_data: \"user-1234\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Phone.SendCodeAsync(new PhoneSendCodeParams\n{\n PhoneNumber = \"+14155552671\",\n Options = new PhoneSendCodeParamsOptions\n {\n Locale = \"en-US\",\n PreferredChannel = new PhoneSendCodeParamsOptionsPreferredChannel(\"whatsapp\"),\n },\n VendorData = \"user-1234\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "phone_number": { "type": "string", "maxLength": 20, "description": "Номер телефона получателя в формате E.164 — с начальным `+` и кодом страны (например, `+14155552671`). Номера проверяются и нормализуются до формата E.164; нераспознаваемые или недействительные номера возвращают `400` с ошибкой поля `phone_number`.", "example": "+14155552671" }, "options": { "type": "object", "description": "Параметры доставки одноразового кода. Все поля необязательны.", "properties": { "code_size": { "type": "integer", "minimum": 4, "maximum": 8, "default": 6, "description": "Количество цифр в OTP." }, "locale": { "type": "string", "maxLength": 5, "pattern": "^[a-z]{2,3}(-[A-Z]{2,3})?$", "description": "Локаль BCP-47, используемая для локализации сообщения верификации (например, `en-US`, `fr`, `es`). Недопустимые форматы возвращают `400`.", "example": "en-US" }, "preferred_channel": { "type": "string", "enum": [ "whatsapp", "sms", "telegram", "voice", "rcs", "viber", "zalo" ], "default": "whatsapp", "description": "Предпочтительный канал доставки. Если канал недоступен для страны назначения или номера, сообщение автоматически переключается на SMS — отправка всё равно возвращает `Success`." }, "use_white_label_customization": { "type": "boolean", "default": false, "description": "Когда `true`, отправка выполняется с использованием White label: если у вашего приложения не задано имя отправителя SMS, в SMS вместо него указывается ваше публичное имя White label («123456 - ваш код верификации для Acme Bank»). Если имя отправителя SMS настроено, оно используется независимо от этого флага. Применяется к SMS-сообщениям, включая резервную отправку SMS из другого канала; коды WhatsApp отправляются с фиксированным сообщением и не брендируются. По умолчанию `false`." }, "sms_sender_name": { "type": "string", "nullable": true, "maxLength": 30, "example": "Acme Bank", "description": "Имя, которое отображается в SMS с этим кодом («123456 is your verification code for Acme Bank»), вместо имени отправителя SMS вашего приложения. Бесплатно. От 1 до 30 символов: только буквы, цифры, пробелы и ' & - !, не только цифры, с одиночными пробелами между словами; при любом другом значении возвращается `400`, и код не отправляется. Если опущено, имеет значение `null` или пустое, используется имя отправителя SMS вашего приложения. Каждое приложение может начать использовать до двух новых имен в день (UTC); сверх этого код отправляется с именем вашего приложения. Применяется к SMS-сообщениям, включая резервную отправку по SMS из другого канала; коды WhatsApp не брендируются.", "pattern": "^$|^(?![\\d ]+$)[\\p{L}\\p{N}'&!-]+( [\\p{L}\\p{N}'&!-]+)*$" } } }, "signals": { "type": "object", "description": "Необязательные сигналы об устройстве и сети конечного пользователя, передаваемые на уровень защиты от фрода для улучшения обнаружения злоупотреблений или автоматизированного трафика. Все поля необязательны.", "properties": { "ip": { "type": "string", "description": "IP-адрес устройства конечного пользователя. IPv4 или IPv6.", "example": "192.0.2.1" }, "device_id": { "type": "string", "maxLength": 255, "description": "Уникальный идентификатор устройства конечного пользователя. Android: `ANDROID_ID`; iOS: `identifierForVendor`.", "example": "8F0B8FDD-C2CB-4387-B20A-56E9B2E5A0D2" }, "device_platform": { "type": "string", "enum": [ "android", "ios", "ipados", "tvos", "web" ], "description": "Платформа устройства конечного пользователя." }, "device_model": { "type": "string", "maxLength": 255, "description": "Модель устройства конечного пользователя.", "example": "iPhone17,2" }, "os_version": { "type": "string", "maxLength": 64, "description": "Версия операционной системы устройства конечного пользователя.", "example": "18.0.1" }, "app_version": { "type": "string", "maxLength": 64, "description": "Версия вашего приложения.", "example": "1.2.34" }, "user_agent": { "type": "string", "maxLength": 512, "description": "User-Agent браузера или приложения конечного пользователя.", "example": "Mozilla/5.0 (iPhone; CPU iPhone OS 14_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Mobile/15E148 Safari/604.1" } } }, "vendor_data": { "type": "string", "description": "Необязательный идентификатор, контролируемый вызывающей стороной (ваш внутренний идентификатор пользователя, email, UUID и т. д.), сохраняемый в сессии и возвращаемый в ответе на отправку, ответе проверки соответствия, webhook и Business Console. Используйте его для сопоставления `request_id` от Didit с вашей записью пользователя." }, "metadata": { "type": "object", "nullable": true, "description": "Необязательный JSON-объект в свободной форме, сохраняемый в сессии и возвращаемый в ответе на отправку, в ответе проверки соответствия, в webhook и в Business Console." } }, "required": [ "phone_number" ] }, "examples": { "WhatsApp (default)": { "summary": "6-значный OTP через WhatsApp с автоматическим переключением на SMS при сбое", "value": { "phone_number": "+14155552671", "options": { "preferred_channel": "whatsapp", "locale": "en-US" }, "vendor_data": "user-1234" } }, "SMS with custom code length": { "summary": "Принудительная доставка по SMS с 4-значным кодом", "value": { "phone_number": "+34699999999", "options": { "preferred_channel": "sms", "code_size": 4, "locale": "es" } } }, "With fraud signals": { "summary": "Передавать сигналы устройства для усиления антифрод-скрининга", "value": { "phone_number": "+14155552671", "signals": { "ip": "192.0.2.1", "device_id": "8F0B8FDD-C2CB-4387-B20A-56E9B2E5A0D2", "device_platform": "ios", "device_model": "iPhone17,2", "os_version": "18.0.1", "app_version": "1.2.34" }, "vendor_data": "user-1234" } } } } } }, "responses": { "200": { "description": "Отправка подтверждена. Проверьте `status`: `Success` и `Retry` означают, что код в пути; `Blocked` означает, что антифрод-система отклонила операцию и верификация уже завершена со статусом `Declined`. Поле `request_id` содержит сохранённый идентификатор сессии (тот же id при `Retry`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneVerificationSendResponse" }, "examples": { "Success": { "summary": "Одноразовый код отправлен для новой верификации", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Success", "reason": null, "vendor_data": "user-1234", "metadata": null } }, "Retry": { "summary": "Повторная отправка на тот же номер в течение 5-минутного окна — тот же request_id", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Retry", "reason": null, "vendor_data": "user-1234", "metadata": null } }, "Blocked": { "summary": "Антифрод-отказ — верификация завершена со статусом Отклонена, списаний нет", "value": { "request_id": "0d8af1f4-0c43-46d7-b75c-6e4e22c0a7b3", "status": "Blocked", "reason": "repeated_attempts", "vendor_data": "user-1234", "metadata": null } } } } } }, "400": { "description": "Ошибка валидации. Некорректные входные данные возвращают обёртку ошибок полей DRF (по одному массиву сообщений для каждого некорректного поля, вложенному в `options` для ошибок параметров). Номер, который успешно разбирается, но отклоняется в момент отправки (недоступен или имеет неподдерживаемый тип линии, например короткий номер), возвращает вместо этого обёртку `{\"detail\": ...}`.", "content": { "application/json": { "examples": { "Invalid phone number (field error)": { "summary": "Номер не соответствует формату E.164", "value": { "phone_number": [ "Invalid phone number provided." ] } }, "Missing phone number": { "summary": "`phone_number` не передан в теле запроса", "value": { "phone_number": [ "This field is required." ] } }, "Invalid options": { "summary": "Параметр `code_size` вне допустимого диапазона, некорректная `locale`, неизвестный `preferred_channel`", "value": { "options": { "code_size": [ "Ensure this value is less than or equal to 8." ], "locale": [ "Ensure this field has no more than 5 characters." ], "preferred_channel": [ "\"carrier_pigeon\" is not a valid choice." ] } } }, "Number rejected at send time": { "summary": "Корректный формат E.164, но номер не может получить одноразовый код", "value": { "detail": "Invalid phone number provided." } }, "Ineligible line type": { "summary": "Тип линии не может получать одноразовый код (например, короткий номер)", "value": { "detail": "Invalid phone line type provided." } } } } } }, "403": { "description": "В доступе отказано. Возвращается, если заголовок `x-api-key` отсутствует (`{\"detail\": ...}`); неверный, отозванный или истекший ключ возвращает `401`. Также возвращается перед любой отправкой, если организация ни разу не пополняла баланс (защита от злоупотреблений) или если её баланс не покрывает стоимость отправки для данного адреса назначения (`{\"error\": ...}`).", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Отсутствует заголовок `x-api-key`, либо ключ недействителен/отозван", "value": { "detail": "You do not have permission to perform this action." } }, "Top-up required": { "summary": "Проверка телефона остается отключенной до первого пополнения баланса организации", "value": { "detail": "To protect against abuse, phone verification is disabled until your first top-up." } }, "Not enough credits": { "summary": "Баланс организации недостаточен для оплаты цены отправки", "value": { "error": "You don't have enough credits to perform this request." } } } } } }, "429": { "description": "Превышен лимит запросов. Endpoint'ы POST/PATCH/DELETE делят общий лимит в 300 запросов на запись в минуту на один API-ключ (для создания транзакций и отправки событий действует отдельный лимит в 600). Кроме того, выше по цепочке действует лимит для предотвращения злоупотреблений в 4 попытки верификации на один номер телефона в час. Ответ содержит заголовки `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` и `Retry-After`. Примечание: заголовки `X-RateLimit-*`/`Retry-After` сопровождают только ошибку 429 при превышении лимита записи 300/мин; ошибка 429 при превышении лимита на номер телефона не содержит заголовков лимитирования.", "content": { "application/json": { "examples": { "Per-number cap": { "summary": "Более 4 попыток верификации для одного и того же номера за последний час", "value": { "detail": "Maximum verification attempts reached for this phone number. Only 4 authentication attempts are allowed per hour. Try again later or use a different number." } }, "Write rate limit exceeded": { "summary": "Более 300 запросов на запись в текущую минуту", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "502": { "description": "Провайдер проверки телефона временно недоступен: ответ с ошибкой 5xx, таймаут или сбой подключения после встроенных повторных попыток. Повторить попытку безопасно: плата не взимается и попытка не расходуется.", "content": { "application/json": { "examples": { "Provider outage": { "summary": "Провайдер не ответил на запрос отправки", "value": { "detail": "Phone verification is temporarily unavailable. Please try again shortly.", "code": "phone_provider_unavailable" } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string" } } } } } }, "500": { "description": "Непредвиденная ошибка при создании верификации, не связанная с известным сбоем провайдера. Повторная попытка безопасна.", "content": { "application/json": { "examples": { "Provider error": { "summary": "Не удалось инициировать доставку одноразового кода", "value": { "detail": "Error creating phone verification" } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/phone/check/": { "post": { "summary": "Проверить телефонный код", "description": "Проверьте OTP, отправленный с помощью [`POST /v3/phone/send/`](/ru/standalone-apis/phone-send), и получите окончательный результат верификации вместе с аналитическими данными о номере: название оператора и тип линии, признаки виртуального (VoIP) и одноразового номера, а также информацию о повторном использовании номера в ваших сессиях.\n\n**Как проверка находит верификацию.** Поиск выполняется по вашему приложению и номеру в формате E.164 `phone_number` (`request_id` не передаётся во входных данных). Проверяется последняя ожидающая верификация, созданная за последние **5 минут**. Если такой нет (код не отправлялся, уже завершён или прошло более 5 минут), endpoint возвращает `200` со статусом `status: \"Expired or Not Found\"`.\n\n**Лимит попыток.** На каждую верификацию даётся **3 попытки ввода кода**. Первые два неверных кода возвращают `status: \"Failed\"` с количеством оставшихся попыток и `phone: null`; третий неверный код переводит верификацию в статус `Declined` с предупреждением `VERIFICATION_CODE_ATTEMPTS_EXCEEDED` и возвращает полный отчёт по номеру телефона.\n\n**Результаты.** `Approved`: код введён правильно, блокирующие риски отсутствуют. `Declined`: финальный статус: код был правильным, но сработал блокирующий риск (действие `DECLINE` ниже, номер из списка блокировки или номер высокого риска), либо был исчерпан лимит попыток. `Failed`: неверный код, попытки ещё остались. `Expired or Not Found`: нет данных для проверки. При статусах `Approved`/`Declined` параметр `request_id` совпадает с `request_id` отправки (идентификатором сессии), а объект `phone` содержит полный отчёт (`carrier`, `is_virtual`, `is_disposable`, `warnings`, `lifecycle`, `matches`); при статусах `Failed` и `Expired or Not Found` параметр `request_id` представляет собой одноразовый случайный UUID.\n\n**Действия при рисках.** Параметры `duplicated_phone_number_action`, `disposable_number_action` и `voip_number_action` определяют, что происходит при обнаружении соответствующего риска при правильном коде: `DECLINE` меняет итоговый статус на `Declined`; `NO_ACTION` (по умолчанию) фиксирует риск в `phone.warnings`, не влияя на статус.\n\n**Биллинг.** Сами проверки бесплатны: доставка тарифицируется на этапе отправки (см. [Цены на проверку телефона](/ru/getting-started/phone-verification-pricing)).\n\n**Сохранение сессии.** Завершённая проверка обновляет сессию, созданную при отправке (отображается в Business Console, доступна для запроса через `GET /v3/session/{sessionId}/decision/`), и отправляет событие webhook `status.updated`.\n\n**Песочница.** API-ключи песочницы не выполняют обработку: любой корректный код (от 4 до 8 цифр, включая `123456`) возвращает статический payload со статусом `Approved` и упрощённым плоским объектом `phone` (`status`, `phone_number`, `country_code`, `carrier_name`, `line_type`, `flags`); некорректный ввод по-прежнему возвращает `400`. Никакие данные не сохраняются.\n\n**Аутентификация.** Передавайте API-ключ вашего приложения в заголовке `x-api-key`. Отсутствующие или недействительные учётные данные возвращают `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`); этот API никогда не возвращает `401`.\n\n**Лимиты запросов.** Общий лимит на запись составляет 300 запросов/мин на API-ключ, плюс вышестоящее ограничение против злоупотреблений: 4 попытки на один номер в час; превышение любого из них возвращает `429`.\n\n**Цифровой след в соцсетях.** Установите `enable_social` в `true`, чтобы добавить блок `phone_social`: платформы, на которых зарегистрирован этот номер, с количеством по категориям и доступными деталями профилей. Значение `profiles_registered: 0` означает, что платформы были проверены и номер ни на одной из них не найден - это корректный, оплачиваемый ответ. Блок отсутствует, если дополнение не запрашивалось или проверку не удалось выполнить; в этом случае плата не взимается. Биллинг добавляет одну единицу `phone_social` за запрос сверх стоимости самого endpoint.", "operationId": "post_v3phone_check", "x-didit-sdk": { "resource": "phone", "method": "check_code", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/phone/check/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"phone_number\": \"+14155552671\",\n \"code\": \"123456\",\n \"voip_number_action\": \"DECLINE\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.phone.check_code(\n phone_number=\"+14155552671\",\n code=\"123456\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.phone.checkCode({\n phone_number: \"+14155552671\",\n code: \"123456\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Phone.CheckCode(ctx, didit.PhoneCheckCodeParams{\n\tPhoneNumber: \"+14155552671\",\n\tCode: \"123456\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.PhoneCheckCodeParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.phone().checkCode(PhoneCheckCodeParams.builder()\n .phoneNumber(\"+14155552671\")\n .code(\"123456\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "phone->checkCode([\n 'phone_number' => '+14155552671',\n 'code' => '123456',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.phone.check_code(\n phone_number: \"+14155552671\",\n code: \"123456\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Phone.CheckCodeAsync(new PhoneCheckCodeParams\n{\n PhoneNumber = \"+14155552671\",\n Code = \"123456\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "phone_number": { "type": "string", "maxLength": 20, "description": "Тот же номер телефона, что использовался в соответствующем вызове [`POST /v3/phone/send/`](/ru/standalone-apis/phone-send), в формате E.164. Именно он связывает проверку с отправкой.", "example": "+14155552671" }, "code": { "type": "string", "minLength": 4, "maxLength": 8, "pattern": "^[0-9]{4,8}$", "description": "Одноразовый код (OTP), полученный конечным пользователем. Должен содержать от 4 до 8 цифр — любое другое значение возвращает `400` без списания попытки. Корректно сформированный, но неверный код возвращает `200` со статусом `status: \"Failed\"` и списывает одну из 3 попыток.", "example": "123456" }, "duplicated_phone_number_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Что делать, если тот же номер уже использовался другим пользователем (другой `vendor_data`) вашего приложения. `DECLINE` меняет итоговый `status` на `Declined`; `NO_ACTION` фиксирует риск в `phone.warnings` и заполняет `phone.matches`." }, "disposable_number_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Действие, если проверка оператора связи помечает номер как временный/одноразовый (`phone.is_disposable`). `DECLINE` меняет итоговый `status` на `Declined`; `NO_ACTION` фиксирует риск в `phone.warnings`." }, "voip_number_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Действие, если проверка оператора сообщает о виртуальном типе линии — `voip`, `isp` или `vpn` (`phone.is_virtual`). `DECLINE` переводит финальный `status` в `Declined`; `NO_ACTION` фиксирует риск в `phone.warnings`." }, "enable_enrichment": { "type": "boolean", "default": false, "description": "Когда `true`, также выполняет проверку номера телефона (phone intelligence): оценку риска, тип линии, факт недавнего переноса номера и индекс доверия. Тарифицируется как одна единица `phone_intelligence_api` за запрос ($0.05 по прайс-листу) в дополнение к собственной цене этого endpoint. Запрос возвращает `403`, если ваш баланс не может покрыть списание.", "example": false }, "phone_intelligence_score_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Действие, когда оценка риска при анализе телефона превышает порог. `DECLINE` меняет итоговый `status` на `Declined`; `NO_ACTION` фиксирует сигнал без отклонения. Действует только тогда, когда `enable_enrichment` имеет значение `true`." }, "phone_type_risk_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Действие, когда номер относится к типу линии с высоким уровнем риска. `DECLINE` меняет итоговый `status` на `Declined`; `NO_ACTION` фиксирует сигнал без отклонения. Действует только тогда, когда `enable_enrichment` имеет значение `true`." }, "recent_port_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Действие, когда номер был недавно перенесён к другому оператору связи. `DECLINE` меняет итоговый `status` на `Declined`; `NO_ACTION` фиксирует сигнал без отклонения. Действует только тогда, когда `enable_enrichment` имеет значение `true`." }, "low_phone_trust_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Действие, когда индекс доверия при анализе телефона находится на уровне порога или ниже. `DECLINE` меняет итоговый `status` на `Declined`; `NO_ACTION` фиксирует сигнал без отклонения. Действует только тогда, когда `enable_enrichment` имеет значение `true`." }, "enable_social": { "type": "boolean", "default": false, "description": "Если true, также запрашивает цифровой след номера: мессенджеры, социальные сети, площадки электронной коммерции и профессиональные платформы, где он зарегистрирован. Тарифицируется как одна единица `phone_social` за запрос дополнительно к цене самого endpoint.", "example": true }, "phone_no_social_presence_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Действие, когда проверка цифрового следа в соцсетях не находит номер ни на одной из поддерживаемых платформ. В этом endpoint принимаются только NO_ACTION и DECLINE; REVIEW доступно в одноимённом ключе конфигурации сценария." } }, "required": [ "phone_number", "code" ] }, "examples": { "Default": { "summary": "Фиксировать любые риски, но никогда не отклонять автоматически", "value": { "phone_number": "+14155552671", "code": "123456" } }, "Strict risk policy": { "summary": "Автоматически отклонять VoIP и одноразовые номера", "value": { "phone_number": "+14155552671", "code": "123456", "voip_number_action": "DECLINE", "disposable_number_action": "DECLINE" } } } } } }, "responses": { "200": { "description": "Проверка завершена — неверные коды и отсутствующие верификации также возвращают `200`; проверяйте `status`, а не HTTP-код. Поле `phone` заполняется только при финальных результатах (`Approved`/`Declined`), равно `null` при `Failed` и отсутствует при `Expired or Not Found`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneVerificationCheckResponse" }, "examples": { "Approved": { "summary": "Правильный код — полный отчёт по телефону с оператором связи, жизненным циклом и совпадениями", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Approved", "message": "The verification code is correct.", "phone": { "status": "Approved", "phone_number_prefix": "+1", "phone_number": "4155552671", "full_number": "+14155552671", "country_code": "US", "country_name": "United States", "carrier": { "name": "AT&T", "type": "mobile" }, "is_disposable": false, "is_virtual": false, "verification_method": "whatsapp", "verification_attempts": 1, "verified_at": "2026-06-12T01:24:47.311323Z", "warnings": [], "lifecycle": [ { "type": "PHONE_VERIFICATION_MESSAGE_SENT", "timestamp": "2026-06-12T01:23:39.580554+00:00", "details": { "status": "Success", "reason": null, "channel": "whatsapp", "actual_channel": "whatsapp" }, "fee": 0.0509 }, { "type": "PHONE_DELIVERY_DELIVERED", "timestamp": "2026-06-12T01:23:43.118220+00:00", "details": { "channel": "whatsapp", "status": "delivered" }, "fee": 0 }, { "type": "VALID_CODE_ENTERED", "timestamp": "2026-06-12T01:24:47.311201+00:00", "details": { "code_tried": "123456", "status": "Approved" }, "fee": 0 }, { "type": "PHONE_VERIFICATION_APPROVED", "timestamp": "2026-06-12T01:24:47.384292+00:00", "details": null, "fee": 0 } ], "matches": [] }, "vendor_data": "user-1234", "metadata": null, "created_at": "2026-06-12T01:24:47.401719+00:00" } }, "Failed (attempts remaining)": { "summary": "Неверный код — пользователь может повторить попытку; request_id здесь представляет собой одноразовый UUID", "value": { "request_id": "11111111-2222-3333-4444-555555555555", "status": "Failed", "message": "The verification code is incorrect. Attempts remaining: 2", "phone": null, "vendor_data": "user-1234", "metadata": null, "created_at": "2026-06-12T01:24:21.512340+00:00" } }, "Declined (max attempts)": { "summary": "Третий неверный код — верификация завершена со статусом «отклонена»", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Declined", "message": "The verification code is incorrect. Maximum attempts reached.", "phone": { "status": "Declined", "phone_number_prefix": "+1", "phone_number": "4155552671", "full_number": "+14155552671", "country_code": "US", "country_name": "United States", "carrier": { "name": "AT&T", "type": "mobile" }, "is_disposable": false, "is_virtual": false, "verification_method": "whatsapp", "verification_attempts": 1, "verified_at": null, "warnings": [ { "feature": "PHONE", "risk": "VERIFICATION_CODE_ATTEMPTS_EXCEEDED", "additional_data": null, "log_type": "error", "short_description": "Verification code attempts exceeded", "long_description": "The system detected that the phone number has exceeded the maximum number of verification code attempts." } ], "lifecycle": [ { "type": "PHONE_VERIFICATION_MESSAGE_SENT", "timestamp": "2026-06-12T01:23:39.580554+00:00", "details": { "status": "Success", "reason": null, "channel": "whatsapp", "actual_channel": "whatsapp" }, "fee": 0.0509 }, { "type": "INVALID_CODE_ENTERED", "timestamp": "2026-06-12T01:24:01.118220+00:00", "details": { "code_tried": "111111", "status": "Failed" }, "fee": 0 }, { "type": "INVALID_CODE_ENTERED", "timestamp": "2026-06-12T01:24:21.512340+00:00", "details": { "code_tried": "222222", "status": "Failed" }, "fee": 0 }, { "type": "INVALID_CODE_ENTERED", "timestamp": "2026-06-12T01:24:47.311201+00:00", "details": { "code_tried": "333333", "status": "Failed" }, "fee": 0 }, { "type": "PHONE_VERIFICATION_DECLINED", "timestamp": "2026-06-12T01:24:47.384292+00:00", "details": { "reason": "VERIFICATION_CODE_ATTEMPTS_EXCEEDED" }, "fee": 0 } ], "matches": [] }, "vendor_data": "user-1234", "metadata": null, "created_at": "2026-06-12T01:24:47.401719+00:00" } }, "Declined (risk policy)": { "summary": "Правильный код, но линия является VoIP и voip_number_action=DECLINE", "value": { "request_id": "7f1c9d2e-44a1-4b6e-9a3e-5b8e6f1c2d3a", "status": "Declined", "message": "The verification code is correct.", "phone": { "status": "Declined", "phone_number_prefix": "+1", "phone_number": "5005550006", "full_number": "+15005550006", "country_code": "US", "country_name": "United States", "carrier": { "name": "CLEC LLC", "type": "voip" }, "is_disposable": false, "is_virtual": true, "verification_method": "sms", "verification_attempts": 1, "verified_at": "2026-06-12T01:24:47.311323Z", "warnings": [ { "feature": "PHONE", "risk": "VOIP_NUMBER_DETECTED", "additional_data": null, "log_type": "error", "short_description": "VoIP number detected", "long_description": "The system detected that the phone number is a VoIP number, which is not allowed." } ], "lifecycle": [ { "type": "PHONE_VERIFICATION_MESSAGE_SENT", "timestamp": "2026-06-12T01:23:39.580554+00:00", "details": { "status": "Success", "reason": null, "channel": "whatsapp", "actual_channel": "sms" }, "fee": 0.0509 }, { "type": "VALID_CODE_ENTERED", "timestamp": "2026-06-12T01:24:47.311201+00:00", "details": { "code_tried": "123456", "status": "Approved" }, "fee": 0 }, { "type": "PHONE_VERIFICATION_DECLINED", "timestamp": "2026-06-12T01:24:47.384292+00:00", "details": { "reason": "VOIP_NUMBER_DETECTED" }, "fee": 0 } ], "matches": [] }, "vendor_data": "user-1234", "metadata": null, "created_at": "2026-06-12T01:24:47.401719+00:00" } }, "Expired or Not Found": { "summary": "Нет незавершённой верификации для этого номера за последние 5 минут", "value": { "request_id": "69cc35c6-280a-47a6-ab8c-4f32abc02ed0", "status": "Expired or Not Found", "message": "No pending phone verification found in the last 5 minutes.", "vendor_data": null, "metadata": null, "created_at": "2026-06-12T01:24:47.311323+00:00" } } } } } }, "400": { "description": "Ошибка валидации — обёртка ошибок полей DRF: один массив сообщений на каждое некорректное поле.", "content": { "application/json": { "examples": { "Invalid code format": { "summary": "`code` не состоит из 4–8 цифр", "value": { "code": [ "Invalid code format. Enter 4 to 8 numeric digits." ] } }, "Invalid phone number": { "summary": "`phone_number` не является валидным номером в формате E.164", "value": { "phone_number": [ "Invalid phone number provided." ] } }, "Invalid action": { "summary": "Действия по рискам принимают только NO_ACTION или DECLINE", "value": { "voip_number_action": [ "\"REVIEW\" is not a valid choice." ] } } } } } }, "403": { "description": "В доступе отказано. Возвращается, если заголовок `x-api-key` отсутствует; неверный, отозванный или истекший ключ возвращает `401`. Проверки бесплатны, поэтому проверка наличия кредитов здесь не выполняется.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Отсутствует заголовок `x-api-key`, либо ключ недействителен/отозван", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Превышен лимит запросов. Endpoint'ы POST/PATCH/DELETE делят общий лимит в 300 запросов на запись в минуту на один API-ключ (для создания транзакций и отправки событий действует отдельный лимит в 600). Кроме того, выше по цепочке действует лимит для предотвращения злоупотреблений в 4 попытки верификации на один номер телефона в час. Ответ содержит заголовки `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` и `Retry-After`. Примечание: заголовки `X-RateLimit-*`/`Retry-After` сопровождают только ошибку 429 при превышении лимита записи 300/мин; ошибка 429 при превышении лимита на номер телефона не содержит заголовков лимитирования.", "content": { "application/json": { "examples": { "Per-number cap": { "summary": "Более 4 попыток верификации для одного и того же номера за последний час", "value": { "detail": "Maximum verification attempts reached for this phone number. Only 4 authentication attempts are allowed per hour. Try again later or use a different number." } }, "Write rate limit exceeded": { "summary": "Более 300 запросов на запись в текущую минуту", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "502": { "description": "Провайдер проверки телефона временно недоступен: ответ с ошибкой 5xx, таймаут или сбой подключения после встроенных повторных попыток. Повторить попытку безопасно: лимит попыток не расходуется.", "content": { "application/json": { "examples": { "Provider outage": { "summary": "Провайдер не ответил на запрос проверки", "value": { "detail": "Phone verification is temporarily unavailable. Please try again shortly.", "code": "phone_provider_unavailable" } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string" } } } } } }, "500": { "description": "Непредвиденная ошибка при проверке кода вышестоящим сервисом, не связанная с известным сбоем провайдера. Повторная попытка безопасна; лимит попыток расходуется только завершёнными проверками.", "content": { "application/json": { "examples": { "Provider error": { "summary": "Не удалось завершить проверку кода", "value": { "detail": "Error checking phone verification" } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/bank/account-check/": { "post": { "summary": "Проверить банковский счёт", "description": "Проверьте, принадлежит ли банковский счёт указанному вами физическому лицу или компании, прежде чем отправлять на него средства. Без сессий и без авторизации: отправьте имя и счёт, получите результат. Это [проверка счёта](/ru/core-technology/bank-verification/account-check) в рамках шага верификации банка, выполняемая из вашего бэкенда.\n\n**Что вы отправляете.** Страну счёта `country` (ISO 3166-1 alpha-3), номер `account` в формате этой страны и имя владельца `holder`: `full_name` для физического лица или `business_name` для компании. Название компании проверяет корпоративный счёт.\n\n**Что вы получаете в ответ.** Поле `result` принимает значения `match`, `close_match`, `no_match` или `cannot_verify`. При `close_match` в поле `holder_name` возвращается имя, на которое счёт открыт в банке, если банк его предоставил. Поле `account` возвращается маскированным до последних 4 символов.\n\n**Биллинг.** Каждая проверка, на которую банк ответил, тарифицируется один раз по цене проверки счёта для страны этого счёта, независимо от результата: `no_match`, несуществующий счёт и `cannot_verify` также оплачиваются. Запрос, завершившийся ошибкой, никогда не тарифицируется.\n\n**Каждый запрос является новой проверкой.** Ключ идемпотентности и endpoint для повторного чтения проверки отсутствуют, поэтому повторный запрос выполняется и тарифицируется снова. Сохраняйте ответ.\n\n**Песочница.** Используйте API-ключ песочницы с тестовыми реквизитами счёта. Ключ песочницы не обращается к банку и не расходует средства. Последние 4 символа IBAN (или номера счёта) определяют ответ: `0001`: `close_match` с `holder_name`, `0002`: `close_match` без него, `0003` и `0006`: `no_match`, `0004`: `cannot_verify`, `0005`: `503`, а `0009`: `400`. Любое другое окончание возвращает `match`.\n\n**API-ключи.** API-ключу с ограниченными правами требуется доступ на запись к сессиям.", "operationId": "post_v3_bank_account_check", "tags": [ "Standalone APIs" ], "x-didit-sdk": { "resource": "bank", "method": "account_check", "auth": "api_key", "server": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckRequest" }, "examples": { "Person, Nigeria": { "summary": "Банковский код и номер счёта, сверенные с именем физического лица", "value": { "country": "NGA", "account": { "bank_code": "000014", "account_number": "0123450001" }, "holder": { "full_name": "Maria Oliveira" }, "vendor_data": "payout_20481" } }, "Company, Nigeria": { "summary": "Банковский код и номер счёта, сверенные с наименованием компании", "value": { "country": "NGA", "account": { "bank_code": "000014", "account_number": "0123456789" }, "holder": { "business_name": "Northwind Trading Ltd" } } } } } } }, "responses": { "200": { "description": "Банк ответил. Проверка тарифицируется независимо от результата.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckResponse" }, "examples": { "Close match": { "summary": "Банк ведёт счёт на похожее имя", "value": { "request_id": "c2f4a9e0-7b1d-4c3a-9e55-1d0a6b8f2a47", "result": "close_match", "holder_name": "MARIA R OLIVEIRA", "account": "****0001", "vendor_data": "payout_20481", "created_at": "2026-10-21T14:32:08Z" } }, "Match": { "summary": "Банк ведёт счёт на указанное имя", "value": { "request_id": "5b0e2d7c-41a8-4f6e-9c3b-8e7d1a2f6c90", "result": "match", "holder_name": null, "account": "****6789", "vendor_data": null, "created_at": "2026-10-21T14:35:41Z" } } } } } }, "400": { "description": "Отклонено в переданном виде, плата не взимается. `field` указывает поле тела запроса для исправления, а `reason` указывает причину: те же причины отображаются в размещённой форме аккаунта. Сообщается только о первом отклонённом поле.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Missing field": { "summary": "Для проверки в этой стране требуется банковский код", "value": { "detail": "The bank code is not valid (required).", "code": "invalid_account_input", "field": "account.bank_code", "reason": "required" } }, "Invalid IBAN": { "summary": "Длина IBAN не соответствует его стране", "value": { "detail": "The iban is not valid (length).", "code": "invalid_account_input", "field": "account.iban", "reason": "length" } }, "Refused by the bank": { "summary": "Банк отклонил счёт в отправленном виде", "value": { "detail": "The account was refused as typed (rejected).", "code": "invalid_account_input", "field": "account.account_number", "reason": "rejected" } }, "No name": { "summary": "`holder` не содержит ни `full_name`, ни `business_name`", "value": { "detail": "Send full_name for a person or business_name for a company.", "code": "invalid_account_input", "field": "holder", "reason": "required" } }, "Consent required": { "summary": "Для проверки счета в этой стране требуется согласие владельца счета", "value": { "detail": "Account checks in this country need the account holder's explicit consent. Ask for it, then send `consent=true`.", "code": "invalid_account_input", "field": "consent", "reason": "required" } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Expired key": { "summary": "Срок действия ключа истёк", "value": { "detail": "This API key has expired." } } } } } }, "402": { "description": "Проверку невозможно оплатить, поэтому она не была выполнена. Пополните баланс и отправьте запрос снова.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Out of credit": { "summary": "Ваш баланс не покрывает одну проверку", "value": { "detail": "You don't have enough credits to perform this request. Please top up at https://business.didit.me", "code": "insufficient_credits" } }, "Not in your contract": { "summary": "В вашем договоре не указана цена для Account check API", "value": { "detail": "Your contract does not price the Account check API. Contact your account manager.", "code": "contract_rate_missing" } } } } } }, "403": { "description": "Заголовок `x-api-key` или bearer-token отсутствует либо недействителен, запрос поступил с адреса вне IP-списка ключа, либо ключ с ограниченной областью действия не имеет доступа на запись к сессиям.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Missing or invalid credentials": { "summary": "Нет валидного API-ключа или токена", "value": { "detail": "You do not have permission to perform this action." } }, "No sessions write": { "summary": "Ключ с ограниченной областью действия без доступа на запись к сессиям", "value": { "detail": "This API key has no write access to sessions." } } } } } }, "404": { "description": "Ни одна проверка счёта пока не обслуживает этот счёт, поэтому проверка и списание средств не проводились. `country_not_covered`: ни одна проверка не обслуживает страну счёта или соответствующий тип счёта (физическое лицо или компания) в ней. `bank_not_covered`: ни одна проверка не обслуживает банк счёта.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Country not covered": { "summary": "Ни одна проверка счёта не обслуживает эту страну", "value": { "detail": "No account check serves this country yet.", "code": "country_not_covered" } }, "Bank not covered": { "summary": "Ни одна проверка счёта не обслуживает банк этого счёта", "value": { "detail": "No account check serves this account's bank yet.", "code": "bank_not_covered" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" }, "503": { "description": "Банк не смог ответить. Проверка и списание средств не производились; отправьте запрос на проверку позже.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Unavailable": { "summary": "Банк не ответил", "value": { "detail": "The account check is temporarily unavailable and this request was not charged. Please try again.", "code": "account_check_unavailable" } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/bank/account-check/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"country\": \"NGA\",\n \"account\": {\"bank_code\": \"000014\", \"account_number\": \"0123450001\"},\n \"holder\": {\"full_name\": \"Maria Oliveira\"},\n \"vendor_data\": \"payout_20481\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.bank.account_check(\n country=\"NGA\",\n account={\n \"account_number\": \"0123450001\",\n \"bank_code\": \"000014\",\n },\n holder={\n \"full_name\": \"Maria Oliveira\",\n },\n vendor_data=\"payout_20481\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.bank.accountCheck({\n country: \"NGA\",\n account: {\n account_number: \"0123450001\",\n bank_code: \"000014\",\n },\n holder: {\n full_name: \"Maria Oliveira\",\n },\n vendor_data: \"payout_20481\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Bank.AccountCheck(ctx, didit.BankAccountCheckRequest{\n\tCountry: \"NGA\",\n\tAccount: didit.BankAccountCheckRequestAccount{\n\t\tAccountNumber: didit.String(\"0123450001\"),\n\t\tBankCode: didit.String(\"000014\"),\n\t},\n\tHolder: didit.BankAccountCheckHolder{\n\t\tFullName: didit.String(\"Maria Oliveira\"),\n\t},\n\tVendorData: didit.String(\"payout_20481\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.BankAccountCheckHolder;\nimport me.didit.types.BankAccountCheckPersonHolder;\nimport me.didit.types.BankAccountCheckRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.bank().accountCheck(BankAccountCheckRequest.builder()\n .country(\"NGA\")\n .account(BankAccountCheckRequest.Account.builder()\n .accountNumber(\"0123450001\")\n .bankCode(\"000014\")\n .build())\n .holder(BankAccountCheckHolder.ofBankAccountCheckPersonHolder(BankAccountCheckPersonHolder.builder()\n .fullName(\"Maria Oliveira\")\n .build()))\n .vendorData(\"payout_20481\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "bank->accountCheck([\n 'country' => 'NGA',\n 'account' => [\n 'account_number' => '0123450001',\n 'bank_code' => '000014',\n ],\n 'holder' => [\n 'full_name' => 'Maria Oliveira',\n ],\n 'vendor_data' => 'payout_20481',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.bank.account_check(\n country: \"NGA\",\n account: {\n account_number: \"0123450001\",\n bank_code: \"000014\",\n },\n holder: {\n full_name: \"Maria Oliveira\",\n },\n vendor_data: \"payout_20481\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Bank.AccountCheckAsync(new BankAccountCheckRequest\n{\n Country = \"NGA\",\n Account = new()\n {\n AccountNumber = \"0123450001\",\n BankCode = \"000014\",\n },\n Holder = new()\n {\n FullName = \"Maria Oliveira\",\n },\n VendorData = \"payout_20481\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/email/send/": { "post": { "summary": "Отправить код на email", "description": "Отправьте одноразовый код (OTP) на адрес электронной почты, затем проверьте его с помощью [`POST /v3/email/check/`](/ru/standalone-apis/email-check).\n\n**Как связаны отправка и проверка.** Состояние верификации привязано к вашему приложению и адресу `email` — вызов проверки не принимает `request_id`. Каждая новая отправка создаёт незавершённую верификацию со сроком жизни **5 минут**: вызовите проверку с тем же адресом и кодом, полученным пользователем, до закрытия этого окна. Повторный вызов отправки для того же адреса при наличии незавершённой верификации генерирует новый код для той же верификации (`status: \"Retry\"`, тот же `request_id`); предыдущий код перестаёт действовать. Таким образом привязывается не более одной повторной попытки (всего две отправки); следующая отправка начинает новую верификацию с новым `request_id`. 5-минутное окно отсчитывается от первой отправки и не продлевается повторными попытками.\n\n**Предварительная проверка доставляемости.** Перед отправкой адрес проходит синтаксическую валидацию и проверку DNS/MX. Для адресов, которые не могут принимать почту, возвращается `200` со `status: \"Undeliverable\"` и `reason: \"email_can_not_be_delivered\"` — письмо не отправляется, средства не списываются, а верификация сразу завершается со статусом `Declined` (последующая проверка возвращает `Expired or Not Found`). Отправка, завершившаяся сбоем по причине, не связанной с адресом (письмо не удалось передать для доставки), возвращает вместо этого `503`: код не отправляется, средства не списываются, верификация остаётся открытой, и тот же запрос можно повторить.\n\n**Формат кода и брендинг.** Коды состоят из 4–8 символов (`options.code_size`, по умолчанию 6) и по умолчанию являются числовыми; задайте `options.alphanumeric_code: true` для использования заглавных букв и цифр (сравнение при проверке нечувствительно к регистру). Шаблон письма локализуется через `options.locale` (поддерживается 54 языка) и может использовать оформление White label вашего приложения с помощью `options.use_white_label_customization`.\n\n**Биллинг.** За каждую успешную отправку (`status: \"Success\"`) в момент отправки списывается один кредит API Проверки электронной почты. Отправки со статусом `Retry` и `Undeliverable` бесплатны, проверки также бесплатны.\n\n**Сохранение сессии.** Каждая новая верификация сохраняется как сессия типа API: `request_id` представляет собой реальный идентификатор сессии, который можно передать в `GET /v3/session/{sessionId}/decision/`, верификация отображается в Business Console, а по мере её выполнения отправляются события webhook `status.updated`.\n\n**Песочница.** API-ключи песочницы пропускают доставку и биллинг: после валидации запроса (некорректный ввод по-прежнему возвращает `400`) endpoint возвращает статический payload `Success` со случайным `request_id`; письмо не отправляется и данные не сохраняются. При проверке в песочнице используйте код `123456`.\n\n**Аутентификация.** Передавайте API-ключ вашего приложения в заголовке `x-api-key`. При отсутствии или недействительности учётных данных возвращается `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`) — этот API никогда не возвращает `401`.\n\n**Лимит запросов.** Общий лимит на запись составляет 300 запросов/мин на один API-ключ для всех endpoints POST/PATCH/DELETE; при его превышении возвращается `429`.", "operationId": "post_v3email_send", "x-didit-sdk": { "resource": "email", "method": "send_code", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/email/send/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"email\": \"alice@example.com\",\n \"options\": { \"code_size\": 6, \"locale\": \"en\" },\n \"vendor_data\": \"user-1234\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.email.send_code(\n email=\"alice@example.com\",\n options={\n \"locale\": \"en\",\n },\n vendor_data=\"user-1234\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.email.sendCode({\n email: \"alice@example.com\",\n options: {\n locale: \"en\",\n },\n vendor_data: \"user-1234\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Email.SendCode(ctx, didit.EmailSendCodeParams{\n\tEmail: \"alice@example.com\",\n\tOptions: didit.Some(didit.EmailSendCodeParamsOptions{\n\t\tLocale: didit.Some(didit.EmailSendCodeParamsOptionsLocale(\"en\")),\n\t}),\n\tVendorData: didit.String(\"user-1234\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.EmailSendCodeParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.email().sendCode(EmailSendCodeParams.builder()\n .email(\"alice@example.com\")\n .options(EmailSendCodeParams.Options.builder()\n .locale(EmailSendCodeParams.Options.Locale.of(\"en\"))\n .build())\n .vendorData(\"user-1234\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "email->sendCode([\n 'email' => 'alice@example.com',\n 'options' => [\n 'locale' => 'en',\n ],\n 'vendor_data' => 'user-1234',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.email.send_code(\n email: \"alice@example.com\",\n options: {\n locale: \"en\",\n },\n vendor_data: \"user-1234\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Email.SendCodeAsync(new EmailSendCodeParams\n{\n Email = \"alice@example.com\",\n Options = new EmailSendCodeParamsOptions\n {\n Locale = new EmailSendCodeParamsOptionsLocale(\"en\"),\n },\n VendorData = \"user-1234\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "description": "Адрес электронной почты получателя. Некорректные адреса возвращают `400`; синтаксически корректные адреса, не способные принимать почту (неудачная проверка DNS/MX), возвращают `200` со значением `status: \"Undeliverable\"`.", "example": "alice@example.com" }, "options": { "type": "object", "description": "Параметры формата, локализации и брендинга одноразового кода. Все поля необязательны.", "properties": { "code_size": { "type": "integer", "minimum": 4, "maximum": 8, "default": 6, "description": "Количество символов в OTP (по умолчанию только цифры; заглавные буквы и цифры, если `alphanumeric_code` равен `true`)." }, "alphanumeric_code": { "type": "boolean", "default": false, "description": "Когда `true`, OTP состоит из заглавных букв `A–Z` и цифр `0–9` вместо одних только цифр. Сравнение в `/v3/email/check/` нечувствительно к регистру." }, "locale": { "type": "string", "maxLength": 5, "enum": [ "en", "ar", "bn", "bg", "bs", "ca", "cs", "da", "de", "el", "es", "et", "fa", "fi", "fr", "he", "hi", "hr", "hu", "hy", "id", "it", "ja", "ka", "kk", "ko", "ky", "lt", "lv", "cnr", "mk", "mn", "ms", "nl", "no", "pl", "pt-BR", "pt", "ro", "ru", "sk", "sl", "so", "sq", "sr", "sv", "th", "tr", "uk", "uz", "vi", "zh-CN", "zh-TW", "zh" ], "description": "Язык шаблона письма с OTP. По умолчанию `en`. Неподдерживаемые значения возвращают ошибку `400` со списком всех поддерживаемых локалей.", "example": "en" }, "use_white_label_customization": { "type": "boolean", "default": false, "description": "Когда `true`, в электронном письме с OTP используется кастомизация White label вашего приложения (логотип, цвета, брендинг отправителя) вместо стандартного шаблона Didit." } } }, "signals": { "type": "object", "description": "Необязательные сигналы об устройстве и сети конечного пользователя, передаваемые на уровень защиты от фрода для улучшения обнаружения злоупотреблений или автоматизированного трафика. Все поля необязательны.", "properties": { "ip": { "type": "string", "description": "IP-адрес устройства конечного пользователя. IPv4 или IPv6.", "example": "192.0.2.1" }, "device_id": { "type": "string", "maxLength": 255, "description": "Уникальный идентификатор устройства конечного пользователя. Android: `ANDROID_ID`; iOS: `identifierForVendor`.", "example": "8F0B8FDD-C2CB-4387-B20A-56E9B2E5A0D2" }, "device_platform": { "type": "string", "enum": [ "android", "ios", "ipados", "tvos", "web" ], "description": "Платформа устройства конечного пользователя." }, "device_model": { "type": "string", "maxLength": 255, "description": "Модель устройства конечного пользователя.", "example": "iPhone17,2" }, "os_version": { "type": "string", "maxLength": 64, "description": "Версия операционной системы устройства конечного пользователя.", "example": "18.0.1" }, "app_version": { "type": "string", "maxLength": 64, "description": "Версия вашего приложения.", "example": "1.2.34" }, "user_agent": { "type": "string", "maxLength": 512, "description": "User-Agent браузера или приложения конечного пользователя.", "example": "Mozilla/5.0 (iPhone; CPU iPhone OS 14_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Mobile/15E148 Safari/604.1" } } }, "vendor_data": { "type": "string", "description": "Необязательный идентификатор, контролируемый вызывающей стороной (ваш внутренний идентификатор пользователя, email, UUID и т. д.), сохраняемый в сессии и возвращаемый в ответе на отправку, ответе проверки соответствия, webhook и Business Console. Используйте его для сопоставления `request_id` от Didit с вашей записью пользователя." }, "metadata": { "type": "object", "nullable": true, "description": "Необязательный JSON-объект в свободной форме, сохраняемый в сессии и возвращаемый в ответе на отправку, в ответе проверки соответствия, в webhook и в Business Console." } }, "required": [ "email" ] }, "examples": { "Numeric 6-digit code": { "summary": "По умолчанию — 6-значный цифровой код на английском языке", "value": { "email": "alice@example.com", "options": { "locale": "en" }, "vendor_data": "user-1234" } }, "Alphanumeric 8-character code": { "summary": "Заглавные буквы и цифры, испанский шаблон", "value": { "email": "bob@example.com", "options": { "code_size": 8, "alphanumeric_code": true, "locale": "es" } } }, "White-label branding": { "summary": "Отправьте OTP-письмо с настройками White label вашего приложения", "value": { "email": "carol@example.com", "options": { "locale": "en", "use_white_label_customization": true }, "vendor_data": "user-5678" } } } } } }, "responses": { "200": { "description": "Отправка подтверждена. Проверьте `status`: `Success` и `Retry` означают, что код в пути; `Undeliverable` означает, что адрес не может принимать почту и верификация уже завершена со статусом `Declined`. Поле `request_id` содержит сохранённый идентификатор сессии (тот же id при `Retry`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailVerificationSendResponse" }, "examples": { "Success": { "summary": "Одноразовый код отправлен по электронной почте для новой верификации (тарифицируется)", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Success", "reason": null, "vendor_data": "user-1234", "metadata": null } }, "Retry": { "summary": "Повторная отправка в течение 5-минутного окна — новый код, тот же request_id, бесплатно", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Retry", "reason": null, "vendor_data": "user-1234", "metadata": null } }, "Undeliverable": { "summary": "Адрес не прошёл DNS/MX-проверку — верификация завершена со статусом «Отклонена», списаний нет", "value": { "request_id": "cb1a5011-344d-444d-bdce-218904745d7f", "status": "Undeliverable", "reason": "email_can_not_be_delivered", "vendor_data": "user-1234", "metadata": null } } } } } }, "400": { "description": "Ошибка валидации — обёртка ошибок полей DRF: один массив сообщений на каждое некорректное поле, вложенный в `options` для ошибок опций.", "content": { "application/json": { "examples": { "Invalid email": { "summary": "Некорректный адрес электронной почты", "value": { "email": [ "Enter a valid email address." ] } }, "Unsupported locale": { "summary": "`options.locale` вне набора поддерживаемых значений", "value": { "options": { "locale": [ "Invalid locale. Supported locales are en, ar, bn, bg, bs, ca, cs, da, de, el, es, et, fa, fi, fr, he, hi, hr, hu, hy, id, it, ja, ka, kk, ko, ky, lt, lv, cnr, mk, mn, ms, nl, no, pl, pt-BR, pt, ro, ru, sk, sl, so, sq, sr, sv, th, tr, uk, uz, vi, zh-CN, zh-TW, zh." ] } } }, "Code size out of range": { "summary": "`options.code_size` вне диапазона 4–8", "value": { "options": { "code_size": [ "Ensure this value is less than or equal to 8." ] } } } } } } }, "403": { "description": "В доступе отказано. Возвращается, если заголовок `x-api-key` отсутствует (`{\"detail\": ...}`); неверный, отозванный или истекший ключ возвращает `401`. Также возвращается перед любой отправкой, если баланс организации не покрывает один кредит Email Verification API (`{\"error\": ...}`).", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Отсутствует заголовок `x-api-key`, либо ключ недействителен/отозван", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "Баланс организации недостаточен для оплаты цены отправки", "value": { "error": "You don't have enough credits to perform this request." } } } } } }, "429": { "description": "Превышен лимит запросов. Endpoint'ы POST/PATCH/DELETE делят общий лимит в 300 запросов на запись в минуту на один API-ключ (для создания транзакций и отправки событий действует отдельный лимит в 600). Ответ содержит заголовки `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` и `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Более 300 запросов на запись в текущую минуту", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "503": { "description": "Не удалось отправить письмо по причине, не связанной с адресом (почтовый провайдер недоступен, истекло время ожидания или произошёл сбой при отправке), поэтому код не был отправлен, попытка не была засчитана и тарификация не производилась. Повторите тот же запрос.", "content": { "application/json": { "examples": { "Email delivery unavailable": { "summary": "Сбой почтового провайдера после одной автоматической повторной попытки", "value": { "detail": "Email delivery is temporarily unavailable. Please try again." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/email/check/": { "post": { "summary": "Проверить код из электронной почты", "description": "Проверьте OTP, отправленный через [`POST /v3/email/send/`](/ru/standalone-apis/email-send), и получите окончательный результат верификации, а также аналитические данные об адресе: доставляемость, наличие в утечках (`is_breached` и список `breaches` из базы данных аналитики утечек), выявление одноразовых провайдеров и повторное использование адреса в ваших сессиях.\n\n**Как проверка находит верификацию.** Поиск выполняется по вашему приложению и адресу `email` — параметр `request_id` не передается. Проверяется самая последняя незавершённая верификация, созданная за последние **5 минут**. Если подходящей нет (никогда не отправлялась, уже завершена, оказалась недоставляемой на момент отправки или старше 5 минут), endpoint возвращает `200` со `status: \"Expired or Not Found\"`.\n\n**Лимит попыток.** На каждую верификацию дается **3 попытки ввода кода**. Первые два неверных кода возвращают `status: \"Failed\"` с количеством оставшихся попыток и `email: null`; третий неверный код переводит верификацию в финальный статус `Declined` с предупреждением `EMAIL_CODE_ATTEMPTS_EXCEEDED` и возвращает полный отчёт по email. Коды сравниваются без учета регистра (актуально для кодов, отправленных с `alphanumeric_code`); действителен только последний отправленный код.\n\n**Результаты.** `Approved` — верный код и отсутствие рисков отклонения. `Declined` — финальный: код был верным, но сработал риск отклонения (действие `DECLINE`, указанное ниже, адрес в списке блокировки или признание адреса недоставляемым на момент завершения) либо исчерпан лимит попыток. `Failed` — неверный код, попытки еще остались. `Expired or Not Found` — нечего проверять. При `Approved`/`Declined` значение `request_id` совпадает с `request_id` отправки (id сессии), а объект `email` содержит полный отчёт (`is_breached`, `breaches`, `is_disposable`, `is_undeliverable`, `warnings`, `lifecycle`, `matches`); при `Failed` и `Expired or Not Found` параметр `request_id` представляет собой отдельный случайный UUID.\n\n**Действия при рисках.** Параметры `duplicated_email_action`, `breached_email_action` и `disposable_email_action` определяют, что происходит при обнаружении соответствующего риска при правильном коде: `DECLINE` меняет итоговый статус на `Declined`; `NO_ACTION` (по умолчанию) фиксирует риск в `email.warnings`, не влияя на статус.\n\n**Биллинг.** Проверки бесплатны — кредит списывается за успешную отправку.\n\n**Сохранение сессии.** Завершенная проверка обновляет сессию, созданную при отправке (отображается в Business Console, доступна для запроса через `GET /v3/session/{sessionId}/decision/`), и отправляет webhook `status.updated`.\n\n**Песочница.** При использовании API-ключей песочницы вся обработка пропускается: любой корректно сформированный код (включая `123456`) возвращает статический payload `Approved` с упрощенным объектом `email` (`status`, `email`, `is_breached`, `is_disposable`, `is_undeliverable`); некорректный ввод по-прежнему возвращает `400`. Никакие данные не сохраняются.\n\n**Аутентификация.** Передавайте API-ключ вашего приложения в заголовке `x-api-key`. При отсутствии или недействительности учетных данных возвращается `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`) — этот API никогда не возвращает `401`.\n\n**Лимит запросов.** Общий лимит на запись: 300 запросов в минуту на API-ключ для всех endpoint POST/PATCH/DELETE; при превышении возвращается `429`.\n\n**Цифровой след в соцсетях.** Установите `enable_social` в значение `true`, чтобы добавить блок `email_social`: онлайн-платформы, на которых зарегистрирован этот адрес, с количеством по категориям и всеми доступными данными профиля. `profiles_registered: 0` означает, что платформы были проверены и адрес не найден ни на одной из них - валидный ответ, за который взимается плата. Блок отсутствует, если опция не была запрошена или проверку не удалось выполнить; в этом случае плата за него не начисляется. При биллинге добавляется одна единица `email_social` за запрос сверх собственной цены этого endpoint.", "operationId": "post_v3email_check", "x-didit-sdk": { "resource": "email", "method": "check_code", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/email/check/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"email\": \"alice@example.com\",\n \"code\": \"123456\",\n \"disposable_email_action\": \"DECLINE\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.email.check_code(\n email=\"alice@example.com\",\n code=\"123456\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.email.checkCode({\n email: \"alice@example.com\",\n code: \"123456\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Email.CheckCode(ctx, didit.EmailCheckCodeParams{\n\tEmail: \"alice@example.com\",\n\tCode: \"123456\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.EmailCheckCodeParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.email().checkCode(EmailCheckCodeParams.builder()\n .email(\"alice@example.com\")\n .code(\"123456\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "email->checkCode([\n 'email' => 'alice@example.com',\n 'code' => '123456',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.email.check_code(\n email: \"alice@example.com\",\n code: \"123456\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Email.CheckCodeAsync(new EmailCheckCodeParams\n{\n Email = \"alice@example.com\",\n Code = \"123456\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "description": "Тот же адрес электронной почты, что использовался в соответствующем вызове [`POST /v3/email/send/`](/ru/standalone-apis/email-send). Именно он связывает проверку с отправкой.", "example": "alice@example.com" }, "code": { "type": "string", "maxLength": 10, "description": "Одноразовый код (OTP), полученный конечным пользователем: 4–8 цифр, или 4–8 букв/цифр, если при отправке использовался параметр `alphanumeric_code: true`. Сравнение нечувствительно к регистру.", "example": "123456" }, "duplicated_email_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Что делать, если тот же адрес уже использовался и был одобрен другим пользователем (учитываются только ранее одобренные верификации) (другой `vendor_data`) вашего приложения. `DECLINE` меняет итоговый `status` на `Declined`; `NO_ACTION` фиксирует риск в `email.warnings` и заполняет `email.matches`." }, "breached_email_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Действие, если адрес фигурирует в известных утечках данных (`email.is_breached`). `DECLINE` меняет итоговый `status` на `Declined`; `NO_ACTION` фиксирует риск в `email.warnings`." }, "disposable_email_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Что делать, если домен принадлежит провайдеру одноразовой/временной почты (`email.is_disposable`). `DECLINE` меняет итоговый `status` на `Declined`; `NO_ACTION` фиксирует риск в `email.warnings`." }, "enable_enrichment": { "type": "boolean", "default": false, "description": "Когда `true`, также выполняет проверку адреса электронной почты (email intelligence): оценку риска и историю утечек. Тарифицируется как одна единица `email_intelligence_api` за запрос ($0.05 по прайс-листу) в дополнение к собственной цене этого endpoint. Запрос возвращает `403`, если ваш баланс не может покрыть списание.", "example": false }, "email_intelligence_score_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Действие, когда оценка риска при анализе электронной почты превышает порог. `DECLINE` меняет итоговый `status` на `Declined`; `NO_ACTION` фиксирует сигнал без отклонения. Действует только тогда, когда `enable_enrichment` имеет значение `true`." }, "recent_email_breach_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Действие, когда адрес фигурирует в недавней известной утечке данных. `DECLINE` меняет итоговый `status` на `Declined`; `NO_ACTION` фиксирует сигнал без отклонения. Применяется только при значении `true` для `enable_enrichment`." }, "frequent_email_breach_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Действие, когда адрес фигурирует во множестве известных утечек данных. `DECLINE` меняет итоговый `status` на `Declined`; `NO_ACTION` фиксирует сигнал без отклонения. Применяется только при значении `true` для `enable_enrichment`." }, "enable_social": { "type": "boolean", "default": false, "description": "Если true, также запрашивает цифровой след адреса: платформы электронной почты, социальные, профессиональные сети, площадки электронной коммерции и развлекательные сервисы, где он зарегистрирован. Тарифицируется как одна единица `email_social` за запрос дополнительно к цене самого endpoint.", "example": true }, "email_no_social_presence_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Действие, когда проверка цифрового следа в соцсетях не находит адрес ни на одной из поддерживаемых платформ. В этом endpoint принимаются только NO_ACTION и DECLINE; REVIEW доступно в одноимённом ключе конфигурации сценария." } }, "required": [ "email", "code" ] }, "examples": { "Default": { "summary": "Фиксировать любые риски, но никогда не отклонять автоматически", "value": { "email": "alice@example.com", "code": "123456" } }, "Strict risk policy": { "summary": "Автоматически отклонять одноразовые и скомпрометированные почтовые ящики", "value": { "email": "alice@example.com", "code": "123456", "disposable_email_action": "DECLINE", "breached_email_action": "DECLINE" } } } } } }, "responses": { "200": { "description": "Проверка завершена — неверные коды и отсутствующие верификации также возвращают `200`; проверяйте `status`, а не HTTP-код. Поле `email` заполняется только при финальных результатах (`Approved`/`Declined`), равно `null` при `Failed` и отсутствует при `Expired or Not Found`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailVerificationCheckResponse" }, "examples": { "Approved": { "summary": "Правильный код — чистый адрес, полный отчёт по электронной почте", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Approved", "message": "The verification code is correct.", "email": { "status": "Approved", "email": "alice@example.com", "is_breached": false, "breaches": [], "is_disposable": false, "is_undeliverable": false, "verification_attempts": 1, "verified_at": "2026-06-12T01:24:47.311323Z", "warnings": [], "lifecycle": [ { "type": "EMAIL_VERIFICATION_MESSAGE_SENT", "timestamp": "2026-06-12T01:23:39.580554+00:00", "details": { "status": "Success", "reason": null }, "fee": 0.02 }, { "type": "VALID_CODE_ENTERED", "timestamp": "2026-06-12T01:24:47.311201+00:00", "details": { "code_tried": "123456", "status": "Approved" }, "fee": 0 }, { "type": "EMAIL_VERIFICATION_APPROVED", "timestamp": "2026-06-12T01:24:47.384292+00:00", "details": null, "fee": 0 } ], "matches": [] }, "vendor_data": "user-1234", "metadata": null, "created_at": "2026-06-12T01:24:47.401719+00:00" } }, "Approved with breach exposure": { "summary": "Правильный код; обнаружение в утечках данных зафиксировано как предупреждение (breached_email_action=NO_ACTION)", "value": { "request_id": "3a1f2b6c-9d4e-4f7a-8b2c-1e5d6f7a8b9c", "status": "Approved", "message": "The verification code is correct.", "email": { "status": "Approved", "email": "bob@example.com", "is_breached": true, "breaches": [ { "name": "ExampleApp", "domain": "exampleapp.com", "breach_date": "2019-03-21", "breach_emails_count": 763117, "description": "In March 2019, the social platform ExampleApp suffered a data breach that exposed email addresses and passwords.", "logo_path": "https:///logos/ExampleApp.png", "data_classes": [ "email_addresses", "passwords" ], "is_verified": true } ], "is_disposable": false, "is_undeliverable": false, "verification_attempts": 1, "verified_at": "2026-06-12T01:24:47.311323Z", "warnings": [ { "feature": "EMAIL", "risk": "BREACHED_EMAIL_DETECTED", "additional_data": null, "log_type": "information", "short_description": "Breached email detected", "long_description": "This email address was found in one or more known data breaches." } ], "lifecycle": [ { "type": "EMAIL_VERIFICATION_MESSAGE_SENT", "timestamp": "2026-06-12T01:23:39.580554+00:00", "details": { "status": "Success", "reason": null }, "fee": 0.02 }, { "type": "VALID_CODE_ENTERED", "timestamp": "2026-06-12T01:24:47.311201+00:00", "details": { "code_tried": "835126", "status": "Approved" }, "fee": 0 }, { "type": "EMAIL_VERIFICATION_APPROVED", "timestamp": "2026-06-12T01:24:47.384292+00:00", "details": null, "fee": 0 } ], "matches": [] }, "vendor_data": "user-5678", "metadata": null, "created_at": "2026-06-12T01:24:47.401719+00:00" } }, "Failed (attempts remaining)": { "summary": "Неверный код — пользователь может повторить попытку; request_id здесь представляет собой одноразовый UUID", "value": { "request_id": "11111111-2222-3333-4444-555555555555", "status": "Failed", "message": "The verification code is incorrect. Attempts remaining: 2", "email": null, "vendor_data": "user-1234", "metadata": null, "created_at": "2026-06-12T01:24:21.512340+00:00" } }, "Declined (risk policy)": { "summary": "Правильный код, но адрес одноразовый и disposable_email_action=DECLINE", "value": { "request_id": "8c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f", "status": "Declined", "message": "The verification code is correct.", "email": { "status": "Declined", "email": "tempuser42@mailinator.com", "is_breached": false, "breaches": [], "is_disposable": true, "is_undeliverable": false, "verification_attempts": 1, "verified_at": "2026-06-12T01:24:47.311323Z", "warnings": [ { "feature": "EMAIL", "risk": "DISPOSABLE_EMAIL_DETECTED", "additional_data": null, "log_type": "error", "short_description": "Disposable email detected", "long_description": "The system detected that the email is disposable, which is not allowed." } ], "lifecycle": [ { "type": "EMAIL_VERIFICATION_MESSAGE_SENT", "timestamp": "2026-06-12T01:23:39.580554+00:00", "details": { "status": "Success", "reason": null }, "fee": 0.02 }, { "type": "VALID_CODE_ENTERED", "timestamp": "2026-06-12T01:24:47.311201+00:00", "details": { "code_tried": "123456", "status": "Approved" }, "fee": 0 }, { "type": "EMAIL_VERIFICATION_DECLINED", "timestamp": "2026-06-12T01:24:47.384292+00:00", "details": { "reason": "DISPOSABLE_EMAIL_DETECTED" }, "fee": 0 } ], "matches": [] }, "vendor_data": "user-1234", "metadata": null, "created_at": "2026-06-12T01:24:47.401719+00:00" } }, "Expired or Not Found": { "summary": "За последние 5 минут нет ожидающих верификаций для этого адреса", "value": { "request_id": "88808a77-06e9-4cb0-85f5-9c052ddfd987", "status": "Expired or Not Found", "message": "No pending email verification found in the last 5 minutes.", "vendor_data": null, "metadata": null, "created_at": "2026-06-12T01:24:59.887904+00:00" } } } } } }, "400": { "description": "Ошибка валидации — обёртка ошибок полей DRF: один массив сообщений на каждое некорректное поле.", "content": { "application/json": { "examples": { "Invalid email": { "summary": "Некорректный адрес электронной почты", "value": { "email": [ "Enter a valid email address." ] } }, "Missing code": { "summary": "`code` не указан в теле запроса", "value": { "code": [ "This field is required." ] } } } } } }, "403": { "description": "В доступе отказано. Возвращается, если заголовок `x-api-key` отсутствует; неверный, отозванный или истекший ключ возвращает `401`. Проверки бесплатны, поэтому проверка наличия кредитов здесь не выполняется.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Отсутствует заголовок `x-api-key`, либо ключ недействителен/отозван", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Превышен лимит запросов. Endpoint'ы POST/PATCH/DELETE делят общий лимит в 300 запросов на запись в минуту на один API-ключ (для создания транзакций и отправки событий действует отдельный лимит в 600). Ответ содержит заголовки `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` и `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Более 300 запросов на запись в текущую минуту", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/workflows/": { "get": { "summary": "Получить список сценариев", "description": "Получить список ваших сценариев, сначала новые, в конверте пагинации limit/offset (`{count, next, previous, results}`, размер страницы по умолчанию 50). Каждая строка представляет собой одну версию; `workflow_id` является стабильным идентификатором группы, а новые сессии используют последнюю версию со статусом `published`.", "operationId": "list_workflows", "x-didit-sdk": { "resource": "workflows", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Workflows" ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50 }, "description": "Размер страницы (количество сценариев на странице)." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0 }, "description": "Количество строк, пропускаемых перед первым возвращаемым сценарием." } ], "responses": { "200": { "description": "Одна страница сценариев, отсортированных по `created_at` по убыванию, обёрнутая в структуру пагинации. Каждый элемент в `results` представляет собой `WorkflowListItem`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Общее количество версий сценария для приложения." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL следующей страницы или `null` на последней странице." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL предыдущей страницы или `null` на первой странице." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowListItem" } } } }, "examples": { "Two workflows": { "summary": "Сценарий KYC по умолчанию и черновой сценарий KYC + AML", "value": { "count": 2, "next": null, "previous": null, "results": [ { "uuid": "a1b2c3d4-5678-90ab-cdef-111111111111", "workflow_id": "a1b2c3d4-5678-90ab-cdef-111111111111", "workflow_label": "Standard KYC", "workflow_type": "kyc", "is_default": true, "is_archived": false, "is_white_label_enabled": false, "total_price": 0.15, "min_price": 0.15, "max_price": 0.15, "features": "OCR + LIVENESS + FACE_MATCH", "is_simple_workflow": true, "is_editable": false, "workflow_url": "https://verify.didit.me/u/_yljPOx8RWG3UAz5ZRQGVQ", "max_retry_attempts": 3, "retry_window_days": 7, "session_expiration_time": 604800, "version": 2, "status": "published", "has_draft": false, "created_by": { "name": "Alex Mateo", "email": "alex@example.com", "type": "user" }, "updated_at": "2026-04-12T10:30:00Z" }, { "uuid": "b2c3d4e5-6789-01bc-defa-222222222222", "workflow_id": "b2c3d4e5-6789-01bc-defa-222222222222", "workflow_label": "Full Verification + AML", "workflow_type": "kyc", "is_default": false, "is_archived": false, "is_white_label_enabled": false, "total_price": 0.25, "min_price": 0.25, "max_price": 0.25, "features": "OCR + LIVENESS + FACE_MATCH + AML", "is_simple_workflow": true, "is_editable": true, "workflow_url": "https://verify.didit.me/u/Aq3kPOx8RWG3UAz5ZRQGVQ", "max_retry_attempts": 3, "retry_window_days": 7, "session_expiration_time": 604800, "version": 1, "status": "draft", "has_draft": true, "created_by": null, "updated_at": "2026-04-15T18:05:21Z" } ] } } } } } }, "403": { "description": "API-ключ отсутствует, сформирован неверно, истёк или принадлежит другому приложению. Тело ответа: `{\"detail\": \"You do not have permission to perform this action.\"}`. Обновите токен через [Auth API](/ru/auth-api/get-credentials) и повторите попытку.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Превышен лимит запросов. Повторите попытку с экспоненциальной задержкой и учитывайте любой заголовок `Retry-After`." }, "500": { "description": "Непредвиденная ошибка сервера при формировании списка. Запрос можно безопасно повторить." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X GET 'https://verification.didit.me/v3/workflows/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Accept: application/json'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.workflows.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.workflows.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Workflows.ListAutoPaging(ctx, didit.WorkflowsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.workflows().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "workflows->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.workflows.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Workflows.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] }, "post": { "summary": "Создать сценарий", "description": "Создайте простой сценарий. Передавайте `features` в порядке выполнения (применяются правила порядка); по умолчанию создаётся опубликованная (`published`) версия v1. Тело запроса принимает ТОЛЬКО поля, перечисленные в `SimpleWorkflowRequest`: любой другой ключ (включая `workflow_type`) отклоняется с кодом 400. Не идемпотентно: каждый вызов создаёт новый сценарий. Не более 50 сценариев на приложение.", "operationId": "create_workflow", "x-didit-sdk": { "resource": "workflows", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Workflows" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleWorkflowRequest" }, "examples": { "Simple KYC": { "summary": "Линейный сценарий верификации личности, проверки живости и сравнения лиц", "value": { "workflow_label": "Standard KYC", "features": [ { "feature": "OCR", "config": { "duplicated_user_action": "review" } }, { "feature": "LIVENESS", "config": { "face_liveness_method": "passive" } }, { "feature": "FACE_MATCH", "config": { "face_match_score_decline_threshold": 40, "face_match_score_review_threshold": 60 } } ] } }, "KYC + AML": { "summary": "Запустить AML после верификации личности", "value": { "workflow_label": "KYC with AML", "features": [ { "feature": "OCR" }, { "feature": "AML", "config": { "aml_score_review_threshold": 70, "aml_score_approve_threshold": 30 } } ] } }, "Questionnaire workflow": { "summary": "Запустить анкету, созданную с помощью POST /v3/questionnaires/", "value": { "workflow_label": "Source of Funds", "features": [ { "feature": "QUESTIONNAIRE", "config": { "questionnaire_uuid": "11111111-2222-3333-4444-555555555555", "review_questionnaire_manually": true } } ] } } } } } }, "responses": { "201": { "description": "Сценарий создан. Тело ответа представляет собой ПОЛНУЮ конфигурацию сценария — ту же исходную сериализацию `VerificationSettings`, возвращаемую `GET /v3/workflows/{settings_uuid}/` (~190 полей: переключатель каждой функции, порог, действие и сгенерированный `workflow_graph`), а не компактный элемент списка. Сохраните `uuid` (также доступный как `workflow_id`), чтобы ссылаться на него в последующих вызовах создания сессий. Примечание: `features` представляет собой строку, объединённую с помощью `\" + \"`, а цены являются числами JSON.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowDetail" }, "examples": { "Created (abbreviated)": { "summary": "Ключевые поля полного объекта конфигурации", "value": { "uuid": "c3d4e5f6-7890-12cd-ef34-333333333333", "workflow_id": "c3d4e5f6-7890-12cd-ef34-333333333333", "workflow_label": "Standard KYC", "workflow_type": null, "is_default": false, "is_archived": false, "total_price": 0.15, "min_price": 0.15, "max_price": 0.15, "features": "OCR + LIVENESS + FACE_MATCH", "is_simple_workflow": false, "is_editable": false, "workflow_url": "https://verify.didit.me/u/w9TkPOx8RWG3UAz5ZRQGVQ", "workflow_graph": { "start_node": "ocr", "nodes": "... one node per feature plus a final status node ..." }, "max_retry_attempts": 3, "retry_window_days": 7, "session_expiration_time": 604800, "version": 1, "status": "published", "published_at": "2026-05-17T10:30:00Z", "created_at": "2026-05-17T10:30:00Z", "updated_at": "2026-05-17T10:30:00Z" } } } } } }, "400": { "description": "Ошибка валидации. Частые причины: ключ верхнего уровня вне допустимого белого списка (например, `workflow_type`), неизвестное значение `feature`, функция, расположенная до ее зависимости (например, `FACE_MATCH` перед `OCR`), пассивная функция (`AML`, `IP_ANALYSIS`, `DATABASE_VALIDATION`, `KYB_KEY_PEOPLE`), используемая в качестве первого шага, функция `QUESTIONNAIRE`, чей `config.questionnaire_uuid` не существует для этого приложения, функция `SIGNATURE`, которая будет запущена без документа для подписания, функция `SIGNATURE` с `signature_level: \"aes\"`, когда Advanced (AES) недоступен (`aes_not_available`, см. `signature_availability` в сценарии), или порог вне допустимого диапазона. Тело представляет собой объект ошибки валидации DRF: ключами являются имена полей, а значениями являются массивы понятных человеку сообщений.", "content": { "application/json": { "examples": { "Advanced (AES) not available": { "value": { "features": { "signature_level": [ "Node 'signature': Advanced (AES) is not available yet (aes_not_available)." ] } } }, "Signature step with no document": { "value": { "features": { "non_field_errors": [ "Node 'signature': Add a document to sign, or let each session bring its own." ] } } }, "Missing feature": { "value": { "features": [ "At least one feature is required." ] } }, "Unknown top-level field": { "value": { "workflow_type": [ "The v3 workflow API only accepts `workflow_label`, `is_default`, `status`, `features`, `is_white_label_enabled`, `is_desktop_allowed`, `max_retry_attempts`, `retry_window_days`, `session_expiration_time`, `face_liveness_max_attempts`, `face_match_max_attempts`." ] } }, "Unknown feature": { "value": { "features": [ "Invalid feature 'FOO'. Allowed values: AGE_ESTIMATION, AML, DATABASE_VALIDATION, EMAIL_VERIFICATION, FACE_MATCH, IP_ANALYSIS, KYB_DOCUMENTS, KYB_KEY_PEOPLE, KYB_REGISTRY, LIVENESS, NFC, OCR, PHONE_VERIFICATION, PROOF_OF_ADDRESS, QUESTIONNAIRE." ] } }, "Ordering": { "value": { "features": [ "Feature 'FACE_MATCH' must appear after one of: OCR." ] } }, "Questionnaire not found": { "value": { "features": "Questionnaire '11111111-2222-3333-4444-555555555555' was not found for this application. Create the questionnaire first, then use its questionnaire_id." } } } } } }, "403": { "description": "API-ключ отсутствует, сформирован неверно, истёк или привязан к другому приложению. Обновите через [Auth API](/ru/auth-api/get-credentials) и повторите попытку.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "415": { "description": "Неподдерживаемый тип содержимого. Укажите `Content-Type: application/json` и передайте тело в формате JSON." }, "429": { "description": "Превышен лимит запросов. Повторите попытку с экспоненциальной задержкой." }, "500": { "description": "Непредвиденная ошибка сервера при создании сценария. Повторная попытка безопасна." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X POST 'https://verification.didit.me/v3/workflows/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"workflow_label\": \"Standard KYC\",\n \"features\": [\n {\"feature\": \"OCR\"},\n {\"feature\": \"LIVENESS\", \"config\": {\"face_liveness_method\": \"passive\"}},\n {\"feature\": \"FACE_MATCH\", \"config\": {\"face_match_score_decline_threshold\": 40, \"face_match_score_review_threshold\": 60}}\n ]\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.workflows.create(\n workflow_label=\"Standard KYC\",\n features=[{\n \"feature\": \"OCR\",\n \"config\": {\"duplicated_user_action\": \"review\"},\n }, {\n \"feature\": \"LIVENESS\",\n \"config\": {\"face_liveness_method\": \"passive\"},\n }, {\n \"feature\": \"FACE_MATCH\",\n \"config\": {\"face_match_score_decline_threshold\": 40, \"face_match_score_review_threshold\": 60},\n }],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.workflows.create({\n workflow_label: \"Standard KYC\",\n features: [{\n feature: \"OCR\",\n config: { duplicated_user_action: \"review\" },\n }, {\n feature: \"LIVENESS\",\n config: { face_liveness_method: \"passive\" },\n }, {\n feature: \"FACE_MATCH\",\n config: { face_match_score_decline_threshold: 40, face_match_score_review_threshold: 60 },\n }],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Workflows.Create(ctx, didit.SimpleWorkflowRequest{\n\tWorkflowLabel: didit.String(\"Standard KYC\"),\n\tFeatures: []didit.SimpleWorkflowFeature{{\n\t\tFeature: \"OCR\",\n\t\tConfig: didit.Some(map[string]any{\"duplicated_user_action\": \"review\"}),\n\t}, {\n\t\tFeature: \"LIVENESS\",\n\t\tConfig: didit.Some(map[string]any{\"face_liveness_method\": \"passive\"}),\n\t}, {\n\t\tFeature: \"FACE_MATCH\",\n\t\tConfig: didit.Some(map[string]any{\"face_match_score_decline_threshold\": 40, \"face_match_score_review_threshold\": 60}),\n\t}},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.SimpleWorkflowFeature;\nimport me.didit.types.SimpleWorkflowRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.workflows().create(SimpleWorkflowRequest.builder()\n .workflowLabel(\"Standard KYC\")\n .features(List.of(\n SimpleWorkflowFeature.builder()\n .feature(SimpleWorkflowFeature.Feature.of(\"OCR\"))\n .config(Map.of(\"duplicated_user_action\", \"review\"))\n .build(),\n SimpleWorkflowFeature.builder()\n .feature(SimpleWorkflowFeature.Feature.of(\"LIVENESS\"))\n .config(Map.of(\"face_liveness_method\", \"passive\"))\n .build(),\n SimpleWorkflowFeature.builder()\n .feature(SimpleWorkflowFeature.Feature.of(\"FACE_MATCH\"))\n .config(Map.of(\"face_match_score_decline_threshold\", 40, \"face_match_score_review_threshold\", 60))\n .build()))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "workflows->create([\n 'workflow_label' => 'Standard KYC',\n 'features' => [[\n 'feature' => 'OCR',\n 'config' => ['duplicated_user_action' => 'review'],\n ], [\n 'feature' => 'LIVENESS',\n 'config' => ['face_liveness_method' => 'passive'],\n ], [\n 'feature' => 'FACE_MATCH',\n 'config' => ['face_match_score_decline_threshold' => 40, 'face_match_score_review_threshold' => 60],\n ]],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.workflows.create(\n workflow_label: \"Standard KYC\",\n features: [{\n feature: \"OCR\",\n config: { duplicated_user_action: \"review\" },\n }, {\n feature: \"LIVENESS\",\n config: { face_liveness_method: \"passive\" },\n }, {\n feature: \"FACE_MATCH\",\n config: { face_match_score_decline_threshold: 40, face_match_score_review_threshold: 60 },\n }]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Workflows.CreateAsync(new SimpleWorkflowRequest\n{\n WorkflowLabel = \"Standard KYC\",\n Features = new SimpleWorkflowFeature[]\n {\n new()\n {\n Feature = \"OCR\",\n Config = new Dictionary { [\"duplicated_user_action\"] = \"review\" },\n },\n new()\n {\n Feature = \"LIVENESS\",\n Config = new Dictionary { [\"face_liveness_method\"] = \"passive\" },\n },\n new()\n {\n Feature = \"FACE_MATCH\",\n Config = new Dictionary { [\"face_match_score_decline_threshold\"] = 40, [\"face_match_score_review_threshold\"] = 60 },\n },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/workflows/{settings_uuid}/": { "get": { "summary": "Получить сценарий", "description": "Получить полную конфигурацию для одной версии сценария по `settings_uuid`: переключатели функций, пороги, разрешённые документы, граф, политика повторных попыток, обратные вызовы и цены.", "operationId": "get_workflow", "x-didit-sdk": { "resource": "workflows", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Workflows" ], "parameters": [ { "name": "settings_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID конкретной версии сценария (значение `uuid`, возвращаемое endpoint списка). Каждая версия сценария имеет собственный `settings_uuid`." } ], "responses": { "200": { "description": "Полная конфигурация сценария. Формат представляет собой сырую сериализацию `VerificationSettings` (~190 полей: переключатель каждой функции, порог, действие при предупреждении, конфигурация разрешённых документов, `workflow_graph`, политика повторных попыток, обратные вызовы и цены). Пример ниже сокращён. Примечания: `features` представляет собой строку, разделённую `\" + \"` (например, `\"OCR + LIVENESS\"`), цены являются числами JSON, а `is_editable` имеет значение `true` только для версий `draft`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowDetail" }, "examples": { "KYC workflow with face match (abbreviated)": { "value": { "uuid": "a1b2c3d4-5678-90ab-cdef-111111111111", "workflow_id": "a1b2c3d4-5678-90ab-cdef-111111111111", "workflow_label": "Standard KYC", "workflow_type": "kyc", "is_default": true, "is_archived": false, "is_liveness_enabled": true, "face_liveness_method": "passive", "face_liveness_score_decline_threshold": 50, "face_liveness_score_review_threshold": 70, "is_face_match_enabled": true, "face_match_score_decline_threshold": 40, "face_match_score_review_threshold": 60, "is_aml_enabled": false, "is_phone_verification_enabled": false, "is_email_verification_enabled": false, "is_database_validation_enabled": false, "is_ip_analysis_enabled": false, "is_nfc_enabled": false, "duplicated_user_action": "no_action", "documents_allowed": { "ESP": { "P": { "sides": 1, "enabled": 1, "subtypes": [ "EPASSPORT", "PASSPORT_GENERIC" ], "preferred_characters": "latin", "expiration_check_mode": "strict" } } }, "max_retry_attempts": 3, "retry_window_days": 7, "session_expiration_time": 604800, "version": 2, "status": "published", "published_at": "2026-04-12T10:30:00Z", "is_simple_workflow": false, "is_editable": false, "workflow_url": "https://verify.didit.me/u/_yljPOx8RWG3UAz5ZRQGVQ", "total_price": 0.15, "min_price": 0.15, "max_price": 0.15, "features": "OCR + LIVENESS + FACE_MATCH", "created_at": "2025-01-15T10:30:00Z", "updated_at": "2026-04-12T10:30:00Z" } } } } } }, "403": { "description": "API-ключ отсутствует, сформирован некорректно, истёк или относится к другому приложению.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Сценарий с таким `settings_uuid` не существует для аутентифицированного приложения. Либо UUID неверен, либо он принадлежит другому приложению — Didit намеренно не разделяет эти два случая во избежание утечки информации о существовании записей других приложений.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Превышен лимит запросов. Повторите попытку с экспоненциальной задержкой." }, "500": { "description": "Непредвиденная ошибка сервера. Повторная попытка безопасна." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X GET 'https://verification.didit.me/v3/workflows/a1b2c3d4-5678-90ab-cdef-111111111111/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.workflows.retrieve(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.workflows.retrieve(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Workflows.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.workflows().retrieve(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "workflows->retrieve('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.workflows.retrieve(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Workflows.RetrieveAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "patch": { "summary": "Обновить сценарий", "description": "Обновить сценарий. Версионирование зависит от переданного поля `status` и текущего состояния версии: (1) нет `status` для **опубликованной** версии → опубликованная версия обновляется на месте (тот же `uuid`, та же `version`); (2) нет `status` для **черновика** → черновик обновляется и сразу публикуется; (3) `status: \"published\"` для **опубликованной** версии → создаётся и возвращается НОВАЯ опубликованная версия в том же `workflow_id` (новый `uuid`, `version` + 1), а любой существующий черновик в группе удаляется; (4) `status: \"draft\"` сохраняет черновик как черновик (автосохранение), но для опубликованной версии отклоняется с ошибкой 400 (`\"Cannot revert a published version to draft.\"`). Тело запроса принимает тот же строгий список разрешённых полей, что и при создании: неизвестные ключи отклоняются с ошибкой 400.", "operationId": "update_workflow", "x-didit-sdk": { "resource": "workflows", "method": "update", "auth": "api_key", "server": true }, "tags": [ "Workflows" ], "parameters": [ { "name": "settings_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID конкретной версии обновляемого сценария." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleWorkflowUpdateRequest" }, "examples": { "Replace features": { "summary": "Отправьте полный желаемый порядок функций", "value": { "features": [ { "feature": "OCR" }, { "feature": "AML" } ] } }, "Rename": { "summary": "Переименовать сценарий", "value": { "workflow_label": "Premium KYC" } }, "Set as default": { "summary": "Назначить этот сценарий сценарием приложения по умолчанию", "value": { "is_default": true } }, "Update config": { "summary": "Изменить конфигурацию функции", "value": { "features": [ { "feature": "OCR" }, { "feature": "LIVENESS", "config": { "face_liveness_method": "passive" } } ] } }, "Publish a draft": { "summary": "Опубликовать черновик", "value": { "status": "published" } } } } } }, "responses": { "200": { "description": "Сценарий обновлён. Тело ответа представляет собой ПОЛНУЮ конфигурацию полученной версии (та же исходная структура `VerificationSettings`, что и в `GET /v3/workflows/{settings_uuid}/`). Если обновление создало новую версию (отправлено `status: \"published\"` для опубликованной строки), возвращённые `uuid` и `version` отличаются от тех, к которым вы применили патч — используйте возвращённый `uuid` для последующих вызовов.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowDetail" } } } }, "400": { "description": "Ошибка валидации — ключ верхнего уровня вне разрешённого белого списка, неизвестная функция, неверный порядок, выход порога за допустимый диапазон, ссылка на несуществующую анкету, функция `SIGNATURE`, которая будет запущена в продакшн без документа для подписания, новая функция `SIGNATURE` со значением `signature_level: \"aes\"`, когда Advanced (AES) недоступен (`aes_not_available`, см. `signature_availability` в сценарии; шаг, в котором уже сохранён `aes`, сохраняет его) или передача `status: \"draft\"` для опубликованной версии (`\"Cannot revert a published version to draft.\"`). Тело ответа представляет собой ошибку валидации DRF с ключами по именам полей." }, "403": { "description": "API-ключ отсутствует или недействителен.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Сценарий с таким `settings_uuid` не существует для аутентифицированного приложения." }, "415": { "description": "Неподдерживаемый тип содержимого. Укажите `Content-Type: application/json`." }, "429": { "description": "Превышен лимит запросов. Повторите попытку с экспоненциальной задержкой." }, "500": { "description": "Непредвиденная ошибка сервера. Повторная попытка безопасна." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X PATCH 'https://verification.didit.me/v3/workflows/a1b2c3d4-5678-90ab-cdef-111111111111/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"workflow_label\": \"Premium KYC\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.workflows.update(\n \"11111111-2222-3333-4444-555555555555\",\n features=[{\n \"feature\": \"OCR\",\n }, {\n \"feature\": \"AML\",\n }],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.workflows.update(\"11111111-2222-3333-4444-555555555555\", {\n features: [{\n feature: \"OCR\",\n }, {\n feature: \"AML\",\n }],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Workflows.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SimpleWorkflowUpdateRequest{\n\tFeatures: didit.Some([]didit.SimpleWorkflowFeature{{\n\t\tFeature: \"OCR\",\n\t}, {\n\t\tFeature: \"AML\",\n\t}}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.SimpleWorkflowFeature;\nimport me.didit.types.SimpleWorkflowUpdateRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.workflows().update(\"11111111-2222-3333-4444-555555555555\", SimpleWorkflowUpdateRequest.builder()\n .features(List.of(\n SimpleWorkflowFeature.builder()\n .feature(SimpleWorkflowFeature.Feature.of(\"OCR\"))\n .build(),\n SimpleWorkflowFeature.builder()\n .feature(SimpleWorkflowFeature.Feature.of(\"AML\"))\n .build()))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "workflows->update('11111111-2222-3333-4444-555555555555', [\n 'features' => [[\n 'feature' => 'OCR',\n ], [\n 'feature' => 'AML',\n ]],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.workflows.update(\n \"11111111-2222-3333-4444-555555555555\",\n features: [{\n feature: \"OCR\",\n }, {\n feature: \"AML\",\n }]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Workflows.UpdateAsync(\"11111111-2222-3333-4444-555555555555\", new SimpleWorkflowUpdateRequest\n{\n Features = new SimpleWorkflowFeature[]\n {\n new()\n {\n Feature = \"OCR\",\n },\n new()\n {\n Feature = \"AML\",\n },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "delete": { "summary": "Удалить сценарий", "description": "Безвозвратно удалить одну версию сценария (действие нельзя отменить). Существующие сессии сохраняют свои результаты верификации, но ссылка на сценарий в них очищается; другие версии в той же группе `workflow_id` не удаляются.", "operationId": "delete_workflow", "x-didit-sdk": { "resource": "workflows", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Workflows" ], "parameters": [ { "name": "settings_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID конкретной версии удаляемого сценария." } ], "responses": { "204": { "description": "Сценарий удалён. Тело ответа пустое." }, "403": { "description": "API-ключ отсутствует или недействителен.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Сценарий с таким `settings_uuid` не существует для аутентифицированного приложения.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Превышен лимит запросов. Повторите попытку с экспоненциальной задержкой." }, "500": { "description": "Непредвиденная ошибка сервера. Повторная попытка безопасна." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X DELETE 'https://verification.didit.me/v3/workflows/a1b2c3d4-5678-90ab-cdef-111111111111/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.workflows.delete(\n \"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.workflows.delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.Workflows.Delete(ctx, \"11111111-2222-3333-4444-555555555555\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.workflows().delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "php", "label": "PHP", "source": "workflows->delete('11111111-2222-3333-4444-555555555555');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.workflows.delete(\"11111111-2222-3333-4444-555555555555\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.Workflows.DeleteAsync(\"11111111-2222-3333-4444-555555555555\");" } ] } }, "/v3/questionnaires/": { "get": { "summary": "Получить список анкет", "description": "Получить список ваших анкет, сначала новые, в конверте пагинации limit/offset (`{count, next, previous, results}`, размер страницы по умолчанию 50). Каждая строка представляет собой одну версию; `questionnaire_group_id` является стабильным идентификатором группы, указывающим на последнюю версию со статусом `published`.", "operationId": "list_questionnaires", "x-didit-sdk": { "resource": "questionnaires", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Questionnaires" ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50 }, "description": "Размер страницы (количество анкет на странице)." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0 }, "description": "Количество строк, пропускаемых перед первой возвращаемой анкетой." } ], "responses": { "200": { "description": "Одна страница анкет, отсортированных по `created_at` по убыванию, обёрнутая в структуру пагинации. Каждый элемент в `results` представляет собой `QuestionnaireListItem`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Общее количество версий анкеты для приложения." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL следующей страницы или `null` на последней странице." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL предыдущей страницы или `null` на первой странице." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/QuestionnaireListItem" } } } }, "examples": { "One questionnaire": { "summary": "Простая двуязычная анкета", "value": { "count": 1, "next": null, "previous": null, "results": [ { "uuid": "11111111-2222-3333-4444-555555555555", "title": "KYC Questionnaire", "description": "Additional verification questions", "languages": [ "en", "es" ], "default_language": "en", "is_active": true, "is_simple_questionnaire": true, "created_at": "2026-04-23T09:55:00Z", "updated_at": "2026-04-23T10:00:00Z", "question_types": [ "SHORT_TEXT", "MULTIPLE_CHOICE", "FILE_UPLOAD" ], "workflow_names": [], "questionnaire_group_id": "11111111-2222-3333-4444-555555555555", "version": 1, "status": "published", "published_at": "2026-04-23T10:00:00Z", "is_editable": false } ] } } } } } }, "403": { "description": "API-ключ отсутствует, сформирован некорректно, истёк или относится к другому приложению.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Превышен лимит запросов. Повторите попытку с экспоненциальной задержкой." }, "500": { "description": "Непредвиденная ошибка сервера при формировании списка. Повторная попытка безопасна." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X GET 'https://verification.didit.me/v3/questionnaires/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.questionnaires.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.questionnaires.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Questionnaires.ListAutoPaging(ctx, didit.QuestionnairesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.questionnaires().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "questionnaires->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.questionnaires.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Questionnaires.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] }, "post": { "summary": "Создать анкету", "description": "Создайте простую линейную анкету. Передавайте `form_elements` в порядке отображения; для ветвления и повторяющихся групп требуется Console. По умолчанию создаётся опубликованная (`published`) версия v1.", "operationId": "create_questionnaire", "x-didit-sdk": { "resource": "questionnaires", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Questionnaires" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleQuestionnaireRequest" }, "examples": { "Simple": { "summary": "Базовая анкета", "value": { "title": "Customer Onboarding", "description": "Additional information needed for verification", "default_language": "en", "languages": [ "en" ], "is_active": true, "form_elements": [ { "id": "occupation", "element_type": "short_text", "label": { "en": "What is your occupation?" }, "is_required": true, "placeholder": { "en": "Software engineer" } }, { "id": "source_of_funds", "element_type": "multiple_choice", "label": { "en": "Source of funds" }, "is_required": true, "options": [ { "value": "employment", "label": { "en": "Employment" } }, { "value": "business", "label": { "en": "Business" } }, { "value": "investments", "label": { "en": "Investments" } }, { "value": "other", "label": { "en": "Other" } } ] } ] } } } } } }, "responses": { "201": { "description": "Анкета создана. Ответ содержит `questionnaire_id` — сохраните его, чтобы ссылаться на эту анкету из сценариев или в будущих вызовах обновления/удаления.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuestionnaireDetail" }, "examples": { "Created": { "value": { "questionnaire_id": "11111111-2222-3333-4444-555555555555", "title": "Customer Onboarding", "description": "Additional information needed for verification", "languages": [ "en" ], "default_language": "en", "is_active": true, "is_simple_questionnaire": true, "graph": { "start_node": "occupation", "nodes": { "occupation": { "element_type": "SHORT_TEXT", "is_required": true, "title": { "en": "What is your occupation?" }, "next": "source_of_funds" }, "source_of_funds": { "element_type": "MULTIPLE_CHOICE", "is_required": true, "title": { "en": "Source of funds" }, "choices": [ { "value": "employment", "label": { "en": "Employment" } }, { "value": "business", "label": { "en": "Business" } } ], "next": null } } }, "sections": [], "questionnaire_group_id": "11111111-2222-3333-4444-555555555555", "version": 1, "status": "published", "published_at": "2026-04-23T10:00:00Z", "is_editable": false } } } } } }, "400": { "description": "Ошибка валидации. Частые причины: неизвестный `element_type`, в переводимом поле отсутствует перевод для одного из `languages`, в `languages` отсутствует `en`, `default_language` отсутствует в `languages`, вариант без `label`, вопрос с `branches`/`required_if`/`repeatable_config` (не поддерживается этим endpoint) либо отправка необработанного `graph` вместо `form_elements`. В теле ответа возвращается ошибка валидации DRF с ключами по именам полей.", "content": { "application/json": { "examples": { "Graph not accepted": { "value": { "graph": "The v3 questionnaire API only accepts simple `form_elements`, not `graph`." } }, "Missing label": { "value": { "form_elements": [ { "label": [ "This field is required." ] } ] } } } } } }, "403": { "description": "API-ключ отсутствует, сформирован некорректно, истёк или относится к другому приложению.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "415": { "description": "Неподдерживаемый тип содержимого. Укажите `Content-Type: application/json` и передайте тело в формате JSON." }, "429": { "description": "Превышен лимит запросов. Повторите попытку с экспоненциальной задержкой." }, "500": { "description": "Непредвиденная ошибка сервера при создании анкеты. Повторная попытка безопасна." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X POST 'https://verification.didit.me/v3/questionnaires/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"title\": \"Customer Onboarding\",\n \"default_language\": \"en\",\n \"languages\": [\"en\"],\n \"form_elements\": [\n {\n \"id\": \"occupation\",\n \"element_type\": \"short_text\",\n \"label\": {\"en\": \"What is your occupation?\"},\n \"is_required\": true\n }\n ]\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.questionnaires.create(\n title=\"Customer Onboarding\",\n description=\"Additional information needed for verification\",\n languages=[\"en\"],\n default_language=\"en\",\n is_active=True,\n form_elements=[{\n \"id\": \"occupation\",\n \"element_type\": \"short_text\",\n \"label\": {\"en\": \"What is your occupation?\"},\n \"placeholder\": {\"en\": \"Software engineer\"},\n \"is_required\": True,\n }, {\n \"id\": \"source_of_funds\",\n \"element_type\": \"multiple_choice\",\n \"label\": {\"en\": \"Source of funds\"},\n \"is_required\": True,\n \"options\": [{\n \"value\": \"employment\",\n \"label\": {\"en\": \"Employment\"},\n }, {\n \"value\": \"business\",\n \"label\": {\"en\": \"Business\"},\n }, {\n \"value\": \"investments\",\n \"label\": {\"en\": \"Investments\"},\n }, {\n \"value\": \"other\",\n \"label\": {\"en\": \"Other\"},\n }],\n }],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.questionnaires.create({\n title: \"Customer Onboarding\",\n description: \"Additional information needed for verification\",\n languages: [\"en\"],\n default_language: \"en\",\n is_active: true,\n form_elements: [{\n id: \"occupation\",\n element_type: \"short_text\",\n label: { en: \"What is your occupation?\" },\n placeholder: { en: \"Software engineer\" },\n is_required: true,\n }, {\n id: \"source_of_funds\",\n element_type: \"multiple_choice\",\n label: { en: \"Source of funds\" },\n is_required: true,\n options: [{\n value: \"employment\",\n label: { en: \"Employment\" },\n }, {\n value: \"business\",\n label: { en: \"Business\" },\n }, {\n value: \"investments\",\n label: { en: \"Investments\" },\n }, {\n value: \"other\",\n label: { en: \"Other\" },\n }],\n }],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Questionnaires.Create(ctx, didit.SimpleQuestionnaireRequest{\n\tTitle: \"Customer Onboarding\",\n\tDescription: didit.String(\"Additional information needed for verification\"),\n\tLanguages: []string{\"en\"},\n\tDefaultLanguage: didit.String(\"en\"),\n\tIsActive: didit.Bool(true),\n\tFormElements: []didit.SimpleQuestionnaireElement{{\n\t\tID: didit.String(\"occupation\"),\n\t\tElementType: \"short_text\",\n\t\tLabel: map[string]string{\"en\": \"What is your occupation?\"},\n\t\tPlaceholder: didit.Some(map[string]string{\"en\": \"Software engineer\"}),\n\t\tIsRequired: didit.Bool(true),\n\t}, {\n\t\tID: didit.String(\"source_of_funds\"),\n\t\tElementType: \"multiple_choice\",\n\t\tLabel: map[string]string{\"en\": \"Source of funds\"},\n\t\tIsRequired: didit.Bool(true),\n\t\tOptions: didit.Some([]didit.SimpleQuestionnaireElementOptions{{\n\t\t\tValue: didit.String(\"employment\"),\n\t\t\tLabel: map[string]string{\"en\": \"Employment\"},\n\t\t}, {\n\t\t\tValue: didit.String(\"business\"),\n\t\t\tLabel: map[string]string{\"en\": \"Business\"},\n\t\t}, {\n\t\t\tValue: didit.String(\"investments\"),\n\t\t\tLabel: map[string]string{\"en\": \"Investments\"},\n\t\t}, {\n\t\t\tValue: didit.String(\"other\"),\n\t\t\tLabel: map[string]string{\"en\": \"Other\"},\n\t\t}}),\n\t}},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.SimpleQuestionnaireElement;\nimport me.didit.types.SimpleQuestionnaireRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.questionnaires().create(SimpleQuestionnaireRequest.builder()\n .title(\"Customer Onboarding\")\n .description(\"Additional information needed for verification\")\n .languages(List.of(\"en\"))\n .defaultLanguage(\"en\")\n .isActive(true)\n .formElements(List.of(\n SimpleQuestionnaireElement.builder()\n .id(\"occupation\")\n .elementType(SimpleQuestionnaireElement.ElementType.of(\"short_text\"))\n .label(Map.of(\"en\", \"What is your occupation?\"))\n .placeholder(Map.of(\"en\", \"Software engineer\"))\n .isRequired(true)\n .build(),\n SimpleQuestionnaireElement.builder()\n .id(\"source_of_funds\")\n .elementType(SimpleQuestionnaireElement.ElementType.of(\"multiple_choice\"))\n .label(Map.of(\"en\", \"Source of funds\"))\n .isRequired(true)\n .options(List.of(\n SimpleQuestionnaireElement.Options.builder()\n .value(\"employment\")\n .label(Map.of(\"en\", \"Employment\"))\n .build(),\n SimpleQuestionnaireElement.Options.builder()\n .value(\"business\")\n .label(Map.of(\"en\", \"Business\"))\n .build(),\n SimpleQuestionnaireElement.Options.builder()\n .value(\"investments\")\n .label(Map.of(\"en\", \"Investments\"))\n .build(),\n SimpleQuestionnaireElement.Options.builder()\n .value(\"other\")\n .label(Map.of(\"en\", \"Other\"))\n .build()))\n .build()))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "questionnaires->create([\n 'title' => 'Customer Onboarding',\n 'description' => 'Additional information needed for verification',\n 'languages' => ['en'],\n 'default_language' => 'en',\n 'is_active' => true,\n 'form_elements' => [[\n 'id' => 'occupation',\n 'element_type' => 'short_text',\n 'label' => ['en' => 'What is your occupation?'],\n 'placeholder' => ['en' => 'Software engineer'],\n 'is_required' => true,\n ], [\n 'id' => 'source_of_funds',\n 'element_type' => 'multiple_choice',\n 'label' => ['en' => 'Source of funds'],\n 'is_required' => true,\n 'options' => [[\n 'value' => 'employment',\n 'label' => ['en' => 'Employment'],\n ], [\n 'value' => 'business',\n 'label' => ['en' => 'Business'],\n ], [\n 'value' => 'investments',\n 'label' => ['en' => 'Investments'],\n ], [\n 'value' => 'other',\n 'label' => ['en' => 'Other'],\n ]],\n ]],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.questionnaires.create(\n title: \"Customer Onboarding\",\n description: \"Additional information needed for verification\",\n languages: [\"en\"],\n default_language: \"en\",\n is_active: true,\n form_elements: [{\n id: \"occupation\",\n element_type: \"short_text\",\n label: { en: \"What is your occupation?\" },\n placeholder: { en: \"Software engineer\" },\n is_required: true,\n }, {\n id: \"source_of_funds\",\n element_type: \"multiple_choice\",\n label: { en: \"Source of funds\" },\n is_required: true,\n options: [{\n value: \"employment\",\n label: { en: \"Employment\" },\n }, {\n value: \"business\",\n label: { en: \"Business\" },\n }, {\n value: \"investments\",\n label: { en: \"Investments\" },\n }, {\n value: \"other\",\n label: { en: \"Other\" },\n }],\n }]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Questionnaires.CreateAsync(new SimpleQuestionnaireRequest\n{\n Title = \"Customer Onboarding\",\n Description = \"Additional information needed for verification\",\n Languages = new string[] { \"en\" },\n DefaultLanguage = \"en\",\n IsActive = true,\n FormElements = new SimpleQuestionnaireElement[]\n {\n new()\n {\n Id = \"occupation\",\n ElementType = \"short_text\",\n Label = new Dictionary { [\"en\"] = \"What is your occupation?\" },\n Placeholder = new Dictionary { [\"en\"] = \"Software engineer\" },\n IsRequired = true,\n },\n new()\n {\n Id = \"source_of_funds\",\n ElementType = \"multiple_choice\",\n Label = new Dictionary { [\"en\"] = \"Source of funds\" },\n IsRequired = true,\n Options = new SimpleQuestionnaireElementOptions[]\n {\n new()\n {\n Value = \"employment\",\n Label = new Dictionary { [\"en\"] = \"Employment\" },\n },\n new()\n {\n Value = \"business\",\n Label = new Dictionary { [\"en\"] = \"Business\" },\n },\n new()\n {\n Value = \"investments\",\n Label = new Dictionary { [\"en\"] = \"Investments\" },\n },\n new()\n {\n Value = \"other\",\n Label = new Dictionary { [\"en\"] = \"Other\" },\n },\n },\n },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/questionnaires/{questionnaire_uuid}/": { "get": { "summary": "Получить анкету", "description": "Получить подробную информацию об анкете для одной версии по `questionnaire_uuid`: название, `languages`, канонический `graph`, производные `sections` и метаданные версии.", "operationId": "get_questionnaire", "x-didit-sdk": { "resource": "questionnaires", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Questionnaires" ], "parameters": [ { "name": "questionnaire_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID конкретной версии анкеты (значение `uuid`, возвращаемое endpoint списка, также возвращается как `questionnaire_id` в детальных endpoint)." } ], "responses": { "200": { "description": "Полные сведения об анкете, включая канонический `graph`, производное представление `sections`, метаданные версии и `is_editable`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuestionnaireDetail" }, "examples": { "Published questionnaire": { "value": { "questionnaire_id": "11111111-2222-3333-4444-555555555555", "title": "Customer Onboarding", "description": "Additional information needed for verification", "languages": [ "en" ], "default_language": "en", "is_active": true, "is_simple_questionnaire": true, "graph": { "start_node": "occupation", "nodes": { "occupation": { "element_type": "SHORT_TEXT", "is_required": true, "title": { "en": "What is your occupation?" }, "next": "source_of_funds" }, "source_of_funds": { "element_type": "MULTIPLE_CHOICE", "is_required": true, "title": { "en": "Source of funds" }, "choices": [ { "value": "employment", "label": { "en": "Employment" } }, { "value": "business", "label": { "en": "Business" } } ], "next": null } } }, "sections": [ { "title": {}, "description": {}, "items": [ { "uuid": "11111111-2222-3333-4444-666666666666", "value": "occupation", "element_type": "SHORT_TEXT", "is_required": true, "title": { "en": "What is your occupation?" } } ] } ], "questionnaire_group_id": "11111111-2222-3333-4444-555555555555", "version": 1, "status": "published", "published_at": "2026-04-23T10:00:00Z", "is_editable": false } } } } } }, "403": { "description": "API-ключ отсутствует, сформирован некорректно, истёк или относится к другому приложению.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Анкета с таким `questionnaire_uuid` не существует для аутентифицированного приложения. Либо UUID неверен, либо он принадлежит другому приложению — API намеренно не разделяет эти два случая.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Превышен лимит запросов. Повторите попытку с экспоненциальной задержкой." }, "500": { "description": "Непредвиденная ошибка сервера. Повторная попытка безопасна." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X GET 'https://verification.didit.me/v3/questionnaires/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.questionnaires.retrieve(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.questionnaires.retrieve(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Questionnaires.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.questionnaires().retrieve(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "questionnaires->retrieve('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.questionnaires.retrieve(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Questionnaires.RetrieveAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "patch": { "summary": "Обновить анкету", "description": "Обновить анкету. Версионирование зависит от переданного поля `status` и текущего состояния версии: (1) нет `status` для **опубликованной** версии → опубликованная версия обновляется на месте (тот же `questionnaire_id`, та же `version`); (2) нет `status` для **черновика** → черновик обновляется и сразу публикуется; (3) `status: \"published\"` для **опубликованной** версии → создаётся и возвращается НОВАЯ опубликованная версия в той же `questionnaire_group_id` (новый `questionnaire_id`, `version` + 1), а любой существующий черновик в группе удаляется; (4) `status: \"draft\"` сохраняет черновик как черновик (автосохранение), но для опубликованной версии отклоняется с ошибкой 400 (`\"Cannot revert a published version to draft.\"`).", "operationId": "update_questionnaire", "x-didit-sdk": { "resource": "questionnaires", "method": "update", "auth": "api_key", "server": true }, "tags": [ "Questionnaires" ], "parameters": [ { "name": "questionnaire_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID конкретной версии обновляемой анкеты." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleQuestionnaireUpdateRequest" }, "examples": { "Rename": { "summary": "Переименовать анкету", "value": { "title": "Updated Customer Onboarding" } }, "Replace questions": { "summary": "Заменить весь линейный список вопросов", "value": { "form_elements": [ { "id": "occupation", "element_type": "short_text", "label": { "en": "What is your occupation?" }, "is_required": true }, { "id": "source_of_funds", "element_type": "multiple_choice", "label": { "en": "Source of funds" }, "options": [ { "value": "employment", "label": { "en": "Employment" } }, { "value": "business", "label": { "en": "Business" } } ] } ] } } } } } }, "responses": { "200": { "description": "Анкета обновлена. Тело содержит последнее состояние полученной версии — обновлённую на месте версию или вновь созданную опубликованную версию, если вы передали `status: \"published\"` для опубликованной строки (в этом случае `questionnaire_id` и `version` отличаются от тех, к которым применялся патч). Поле `questionnaire_id` в ответе представляет собой UUID конкретной версии; используйте `questionnaire_group_id`, если вам нужен неизменный идентификатор группы.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuestionnaireDetail" } } } }, "400": { "description": "Ошибка валидации — неизвестный `element_type`, отсутствует перевод, неподдерживаемые поля ветвления/условий, в `languages` отсутствует `en`, `default_language` отсутствует в `languages`, вариант без метки, отправка необработанного `graph` или `status: \"draft\"` для опубликованной версии (`\"Cannot revert a published version to draft.\"`). Тело ответа представляет собой ошибку валидации DRF с ключами по именам полей." }, "403": { "description": "API-ключ отсутствует или недействителен.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Анкета с таким `questionnaire_uuid` не существует для аутентифицированного приложения." }, "415": { "description": "Неподдерживаемый тип содержимого. Укажите `Content-Type: application/json`." }, "429": { "description": "Превышен лимит запросов. Повторите попытку с экспоненциальной задержкой." }, "500": { "description": "Непредвиденная ошибка сервера. Повторная попытка безопасна." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X PATCH 'https://verification.didit.me/v3/questionnaires/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"title\": \"Updated Customer Onboarding\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.questionnaires.update(\n \"11111111-2222-3333-4444-555555555555\",\n title=\"Updated Customer Onboarding\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.questionnaires.update(\"11111111-2222-3333-4444-555555555555\", {\n title: \"Updated Customer Onboarding\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Questionnaires.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SimpleQuestionnaireUpdateRequest{\n\tTitle: didit.String(\"Updated Customer Onboarding\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SimpleQuestionnaireUpdateRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.questionnaires().update(\"11111111-2222-3333-4444-555555555555\", SimpleQuestionnaireUpdateRequest.builder()\n .title(\"Updated Customer Onboarding\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "questionnaires->update('11111111-2222-3333-4444-555555555555', [\n 'title' => 'Updated Customer Onboarding',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.questionnaires.update(\n \"11111111-2222-3333-4444-555555555555\",\n title: \"Updated Customer Onboarding\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Questionnaires.UpdateAsync(\"11111111-2222-3333-4444-555555555555\", new SimpleQuestionnaireUpdateRequest\n{\n Title = \"Updated Customer Onboarding\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "delete": { "summary": "Удалить анкету", "description": "Безвозвратно удалить одну версию анкеты (действие нельзя отменить). Сохранённые ответы на анкету, связанные с этой версией, удаляются вместе с ней, а сессии, ссылающиеся на неё, теряют связь; другие версии в той же группе не удаляются. Сценарии, ссылавшиеся на неё, продолжают выполняться, но шаг анкеты больше не сможет её загрузить.", "operationId": "delete_questionnaire", "x-didit-sdk": { "resource": "questionnaires", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Questionnaires" ], "parameters": [ { "name": "questionnaire_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID конкретной версии удаляемой анкеты." } ], "responses": { "204": { "description": "Анкета удалена. Тело ответа пустое." }, "403": { "description": "API-ключ отсутствует или недействителен.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Анкета с таким `questionnaire_uuid` не существует для аутентифицированного приложения.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Превышен лимит запросов. Повторите попытку с экспоненциальной задержкой." }, "500": { "description": "Непредвиденная ошибка сервера. Повторная попытка безопасна." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X DELETE 'https://verification.didit.me/v3/questionnaires/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.questionnaires.delete(\n \"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.questionnaires.delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.Questionnaires.Delete(ctx, \"11111111-2222-3333-4444-555555555555\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.questionnaires().delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "php", "label": "PHP", "source": "questionnaires->delete('11111111-2222-3333-4444-555555555555');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.questionnaires.delete(\"11111111-2222-3333-4444-555555555555\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.Questionnaires.DeleteAsync(\"11111111-2222-3333-4444-555555555555\");" } ] } }, "/v3/users/": { "get": { "summary": "Получить список пользователей", "description": "Получить список [пользователей](/entities/users), которых Didit формирует на основе сессий KYC с одинаковым значением `vendor_data` (произвольная строка, НЕ UUID), а также пользователей, созданных через API. С пагинацией, отсортирован по `last_session_at` по убыванию (desc). Этот endpoint не поддерживает параметры фильтрации или поиска — запрашивайте страницы и фильтруйте на стороне клиента.", "operationId": "list_users", "x-didit-sdk": { "resource": "users", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Users" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "description": "Размер страницы. По умолчанию 50, если не указан. Жёсткого максимума нет, но рекомендуется оставлять страницы небольшими для уменьшения задержки." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "description": "Смещение первой возвращаемой записи, начиная с нуля. Рекомендуется переходить по URL `next` с предыдущей страницы вместо вычисления вручную." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/users/?limit=50' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.users.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.users.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Users.ListAutoPaging(ctx, didit.UsersListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.users().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "users->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.users.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Users.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Список пользователей с пагинацией, со статусом верификации, количеством сессий и детализацией по функциям.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Количество подходящих строк: точное до 100, с ограничением в 100 сверх этого для производительности. Не используйте его для определения последней страницы; вместо этого ориентируйтесь на то, что `next` равен `null`." }, "next": { "type": "string", "nullable": true, "description": "Абсолютный URL следующей страницы или `null` на последней странице." }, "previous": { "type": "string", "nullable": true, "description": "Абсолютный URL предыдущей страницы или `null` на первой странице." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/UserListItem" } } } }, "examples": { "Example": { "value": { "count": 2, "next": null, "previous": null, "results": [ { "didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418", "vendor_data": "user-abc-123", "display_name": null, "full_name": "John Michael Doe", "date_of_birth": "1990-05-15", "effective_name": "John Michael Doe", "status": "ACTIVE", "portrait_image_url": "https:///...", "session_count": 3, "approved_count": 2, "declined_count": 0, "in_review_count": 1, "issuing_states": [ "USA" ], "approved_emails": [ "john@example.com" ], "approved_phones": [ "+14155551234" ], "features": { "ID_VERIFICATION": "Approved", "LIVENESS": "Approved", "FACE_MATCH": "Approved", "AML": "Approved" }, "features_list": [ { "feature": "ID_VERIFICATION", "status": "Approved" }, { "feature": "LIVENESS", "status": "Approved" }, { "feature": "FACE_MATCH", "status": "Approved" }, { "feature": "AML", "status": "Approved" } ], "last_session_at": "2025-06-15T10:30:00Z", "last_activity_at": "2025-06-15T10:30:00Z", "first_session_at": "2025-06-01T08:00:00Z", "tags": [ { "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "name": "VIP", "color": "#2567FF" } ], "created_at": "2025-06-01T08:00:00Z" }, { "didit_internal_id": "6ed99d53-e8f5-4cf8-9ac1-4a506cb40f6b", "vendor_data": null, "display_name": "Jane S.", "full_name": "Jane Elizabeth Smith", "date_of_birth": "1985-11-22", "effective_name": "Jane S.", "status": "FLAGGED", "portrait_image_url": null, "session_count": 1, "approved_count": 0, "declined_count": 0, "in_review_count": 1, "issuing_states": [], "approved_emails": [], "approved_phones": [], "features": { "ID_VERIFICATION": "In Review" }, "features_list": [ { "feature": "ID_VERIFICATION", "status": "In Review" } ], "last_session_at": "2025-06-20T14:00:00Z", "last_activity_at": "2025-06-20T14:05:00Z", "first_session_at": "2025-06-20T14:00:00Z", "tags": [], "created_at": "2025-06-20T14:00:00Z" } ] } } } } } }, "401": { "description": "Учетные данные не переданы. Запросы к путям `/v3/users/*` без заголовка `x-api-key` (или токена `Authorization: Bearer`) отклоняются промежуточным ПО аутентификации до попадания в API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "Ключ не может запрашивать список пользователей для этого приложения. Отсутствующий ключ возвращает `403`; неверный, отозванный или просроченный ключ возвращает `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Лимит запросов превышен; снизьте частоту запросов и повторите попытку через интервал, указанный в `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/users/{vendor_data}/": { "get": { "summary": "Получить пользователя", "description": "Получить одного [пользователя](/entities/users) по `vendor_data` (точное совпадение). Добавляет `metadata`, `comments` и `updated_at` к списочному представлению, а также переключает `tags` в подробный формат связи с тегами.", "operationId": "get_user", "x-didit-sdk": { "resource": "users", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Users" ], "parameters": [ { "name": "vendor_data", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Ваш уникальный идентификатор пользователя — произвольная строка (НЕ UUID). Это то же значение, которое вы передавали в `vendor_data` при создании сессии, в которой этот пользователь был представлен впервые; сопоставляется в точности в переданном виде.", "example": "user-abc-123" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/users/user-abc-123/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.users.retrieve(\n \"user-abc-123\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.users.retrieve(\"user-abc-123\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.Retrieve(ctx, \"user-abc-123\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.users().retrieve(\"user-abc-123\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "users->retrieve('user-abc-123');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.users.retrieve(\"user-abc-123\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Users.RetrieveAsync(\"user-abc-123\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Полные сведения о пользователе, включая метаданные, комментарии / журнал действий и агрегированные данные сессии.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetailItem" }, "examples": { "Active user": { "value": { "didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418", "vendor_data": "user-abc-123", "display_name": null, "full_name": "John Michael Doe", "date_of_birth": "1990-05-15", "effective_name": "John Michael Doe", "status": "ACTIVE", "metadata": { "tier": "premium", "source": "website" }, "portrait_image_url": "https:///...", "session_count": 3, "approved_count": 2, "declined_count": 0, "in_review_count": 1, "issuing_states": [ "USA" ], "approved_emails": [ "john@example.com" ], "approved_phones": [ "+14155551234" ], "features": { "ID_VERIFICATION": "Approved", "LIVENESS": "Approved", "FACE_MATCH": "Approved", "AML": "Approved" }, "features_list": [ { "feature": "ID_VERIFICATION", "status": "Approved" }, { "feature": "LIVENESS", "status": "Approved" }, { "feature": "FACE_MATCH", "status": "Approved" }, { "feature": "AML", "status": "Approved" } ], "last_session_at": "2025-06-15T10:30:00Z", "last_activity_at": "2025-06-15T10:30:00Z", "first_session_at": "2025-06-01T08:00:00Z", "tags": [ { "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "tag": { "uuid": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b", "name": "VIP", "color": "#2567FF", "description": null, "source": "custom", "created_at": "2025-05-01T09:00:00Z", "updated_at": "2025-05-01T09:00:00Z" }, "added_by_email": "analyst@acme.com", "added_by_name": "Jane Analyst", "created_at": "2025-06-02T11:00:00Z" } ], "comments": [ { "uuid": "c1111111-2222-4333-8444-555555555555", "comment_type": "STATUS_CHANGED", "comment": null, "actor_email": "analyst@acme.com", "actor_name": "Jane Analyst", "previous_status": "FLAGGED", "new_status": "ACTIVE", "previous_value": null, "new_value": null, "changed_fields": [], "metadata": null, "mentioned_emails": [], "created_at": "2025-06-01T10:30:00Z" } ], "created_at": "2025-06-01T08:00:00Z", "updated_at": "2025-06-15T10:30:00Z" } } } } } }, "401": { "description": "Учетные данные не переданы. Запросы к путям `/v3/users/*` без заголовка `x-api-key` (или токена `Authorization: Bearer`) отклоняются промежуточным ПО аутентификации до попадания в API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "Недействительный или отозванный API-ключ, либо ключ не может читать пользователей этого приложения. При отсутствии ключа возвращается `403`; при неверном, отозванном или истёкшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Пользователь с указанным `vendor_data` не существует для этого приложения.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Лимит запросов превышен; снизьте частоту запросов и повторите попытку через интервал, указанный в `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Обновить пользователя", "description": "Частичное обновление пользователя: `display_name`, `full_name`, `date_of_birth`, `status`, `metadata`, `approved_emails`/`approved_phones`/`issuing_states`. `metadata` заменяется полностью. Изменение `status` здесь работает аналогично [Обновить статус пользователя](#patch-/v3/users/-vendor_data-/update-status/): записывается действие `STATUS_CHANGED` с опциональным `reason`, а значение `BLOCKED` добавляет `vendor_data` в системный список блокировки (изменение статуса с `BLOCKED` удаляет эту запись). Изменения в `display_name`, `full_name`, `date_of_birth` или `metadata` фиксируются как действие `PROFILE_UPDATED`.", "operationId": "update_user", "x-didit-sdk": { "resource": "users", "method": "update", "auth": "api_key", "server": true }, "tags": [ "Users" ], "parameters": [ { "name": "vendor_data", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Ваш уникальный идентификатор пользователя (произвольная строка, НЕ UUID).", "example": "user-abc-123" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"display_name\": \"Jane S.\", \"status\": \"FLAGGED\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.users.update(\n \"user-abc-123\",\n display_name=\"Jane S.\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.users.update(\"user-abc-123\", {\n display_name: \"Jane S.\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.Update(ctx, \"user-abc-123\", didit.UsersUpdateParams{\n\tDisplayName: didit.String(\"Jane S.\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.UsersUpdateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.users().update(\"user-abc-123\", UsersUpdateParams.builder()\n .displayName(\"Jane S.\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "users->update('user-abc-123', [\n 'display_name' => 'Jane S.',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.users.update(\n \"user-abc-123\",\n display_name: \"Jane S.\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Users.UpdateAsync(\"user-abc-123\", new UsersUpdateParams\n{\n DisplayName = \"Jane S.\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Пользователь обновлён. Возвращается полная обновлённая запись пользователя (такой же структуры, как в Get User).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetailItem" }, "examples": { "Updated": { "value": { "didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418", "vendor_data": "user-abc-123", "display_name": "Jane S.", "full_name": "Jane Elizabeth Smith", "date_of_birth": "1985-11-22", "effective_name": "Jane S.", "status": "FLAGGED", "metadata": { "tier": "premium" }, "portrait_image_url": "https:///...", "session_count": 3, "approved_count": 2, "declined_count": 0, "in_review_count": 1, "issuing_states": [ "USA" ], "approved_emails": [ "john@example.com" ], "approved_phones": [ "+14155551234" ], "features": { "ID_VERIFICATION": "Approved", "LIVENESS": "Approved", "FACE_MATCH": "Approved", "AML": "Approved" }, "features_list": [ { "feature": "ID_VERIFICATION", "status": "Approved" }, { "feature": "LIVENESS", "status": "Approved" }, { "feature": "FACE_MATCH", "status": "Approved" }, { "feature": "AML", "status": "Approved" } ], "last_session_at": "2025-06-15T10:30:00Z", "last_activity_at": "2025-06-15T10:30:00Z", "first_session_at": "2025-06-01T08:00:00Z", "tags": [ { "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "tag": { "uuid": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b", "name": "VIP", "color": "#2567FF", "description": null, "source": "custom", "created_at": "2025-05-01T09:00:00Z", "updated_at": "2025-05-01T09:00:00Z" }, "added_by_email": "analyst@acme.com", "added_by_name": "Jane Analyst", "created_at": "2025-06-02T11:00:00Z" } ], "comments": [], "created_at": "2025-06-01T08:00:00Z", "updated_at": "2025-06-15T10:30:00Z" } } } } } }, "400": { "description": "Недопустимое тело запроса — обычно неизвестный `status` или `date_of_birth` не в формате `YYYY-MM-DD`.", "content": { "application/json": { "examples": { "Bad status": { "value": { "status": [ "\"INVALID\" is not a valid choice." ] } }, "Bad date_of_birth": { "value": { "date_of_birth": [ "Date has wrong format. Use one of these formats instead: YYYY-MM-DD." ] } }, "Reason too long": { "value": { "reason": [ "Ensure this field has no more than 1000 characters." ] } } } } } }, "401": { "description": "Учетные данные не переданы. Запросы к путям `/v3/users/*` без заголовка `x-api-key` (или токена `Authorization: Bearer`) отклоняются промежуточным ПО аутентификации до попадания в API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "Ключ не может обновлять пользователей для этого приложения. Отсутствующий ключ возвращает `403`; неверный, отозванный или просроченный ключ возвращает `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Пользователь с указанным `vendor_data` не существует для этого приложения.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Лимит запросов превышен; снизьте частоту запросов и повторите попытку через интервал, указанный в `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "full_name": { "type": "string", "nullable": true, "maxLength": 512, "description": "Полное имя пользователя" }, "display_name": { "type": "string", "nullable": true, "description": "Пользовательское отображаемое имя для этого пользователя" }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Дата рождения в формате ГГГГ-ММ-ДД" }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "description": "Статус жизненного цикла пользователя. Изменение фиксируется как действие `STATUS_CHANGED`, а `BLOCKED` добавляет `vendor_data` в системный список блокировки (смена статуса с `BLOCKED` удаляет эту запись)." }, "metadata": { "type": "object", "nullable": true, "description": "Произвольный JSON-объект, прикрепляемый к пользователю. **Полностью заменяет** существующие метаданные при обновлении — объединяйте на стороне клиента, если нужно лишь добавить ключи." }, "approved_emails": { "type": "array", "items": { "type": "string" }, "description": "Подтверждённые адреса электронной почты для этого пользователя, например `[\"john@example.com\"]`. Полностью заменяет сохранённый список." }, "approved_phones": { "type": "array", "items": { "type": "string" }, "description": "Подтверждённые номера телефонов для этого пользователя. Полностью заменяет сохранённый список." }, "issuing_states": { "type": "array", "items": { "type": "string" }, "description": "Страны выдачи (ISO 3166-1 alpha-3), например `[\"USA\"]`. Полностью заменяет сохранённый список." }, "reason": { "type": "string", "nullable": true, "maxLength": 1000, "description": "Причина изменения статуса. Записывается в записи об изменении статуса в активности пользователя (`comments[].comment` и раздел **Activity** в Business Console), только когда статус действительно меняется. В webhook не передается." } } }, "examples": { "Rename": { "summary": "Задать отображаемое имя", "value": { "display_name": "Jane S." } }, "Override status": { "summary": "Пометить пользователя для проверки", "value": { "status": "FLAGGED" } }, "Add metadata": { "summary": "Заменить JSON метаданных", "value": { "metadata": { "tier": "premium", "risk_level": "low" } } }, "Fix extracted DOB": { "summary": "Скорректировать извлечённые поля профиля", "value": { "full_name": "Jane Elizabeth Smith", "date_of_birth": "1985-11-22" } }, "Flag with reason": { "summary": "Пометить пользователя и зафиксировать причину", "value": { "status": "FLAGGED", "reason": "Address does not match the billing country" } } } } } } } }, "/v3/users/{vendor_data}/generate-pdf/": { "get": { "summary": "Скачать полный PDF-отчёт об истории пользователя", "description": "Сформируйте и скачайте готовый для комплаенса PDF-документ, содержащий полную историю верификаций пользователя, идентифицируемого по `vendor_data`. Это тот же самый документ, который формируется в Console по пути **User detail → Actions → Download PDF**, благодаря чему для регулярного комплаенс-экспорта больше не требуется ручная выгрузка через Console.\n\n**Что содержит отчёт.** Титульный лист со сводкой профиля (имя, дата рождения, страны выдачи, одобренные адреса электронной почты и телефоны), актуальный статус каждой функции, счётчики сессий и перечень включённых сессий — за которыми следуют стандартные отчёты по каждой включённой сессии в хронологическом порядке (сначала самые старые). Отчёт по каждой сессии представляет собой тот же документ, который возвращает `GET /v3/session/{sessionId}/generate-pdf/` для этой сессии.\n\n**Подходящие сессии.** Включаются только сессии Проверки пользователей (KYC) со статусами `Approved`, `Declined`, `In Review` или `Kyc Expired`; сессии в любых других статусах пропускаются. Если у пользователя нет ни одной сессии в указанных статусах, endpoint возвращает `403` — подробнее см. ниже.\n\n**Ограничение по количеству.** Отчёт ограничен **20 самыми последними** сессиями, доступными для отчёта. Если у пользователя их больше, включаются 20 новейших, а на титульном листе указывается, сколько более старых сессий было пропущено. Для получения полного списка в формате JSON используйте `GET /v3/sessions/?vendor_data=…`.\n\n**Брендирование.** Если в вашем приложении настроена кастомизация White label, титульный лист и отчёты по каждой сессии формируются с вашим логотипом и URL политики конфиденциальности; в противном случае они содержат брендинг Didit. Отчёты формируются на английском языке — параметра выбора языка нет.\n\n**Отсутствие кэширования.** Каждый вызов заново генерирует PDF на основе текущих данных, поэтому отчёт, сформированный после ручной проверки, отражает решение проверяющего. Два вызова для одного и того же пользователя могут вернуть файлы, различающиеся на уровне байтов — архивируйте скачанный файл, если вам требуется неизменяемая копия.\n\n**Задержка.** Рендеринг выполняется синхронно и загружает все сохранённые изображения для каждой включённой сессии, поэтому для пользователя с большим количеством сессий, содержащих медиафайлы, процесс может занять десятки секунд. Установите увеличенный таймаут чтения на клиенте (рекомендуется 120 с) и сохраняйте тело ответа потоково на диск. Генерация останавливается при достижении серверного лимита по времени, не дожидаясь разрыва соединения клиентом: если лимит исчерпан, в ответе всё равно возвращается корректный PDF с самыми последними сессиями, а на титульном листе указывается, сколько сессий было опущено.\n\n**Область действия.** Поиск пользователя выполняется в рамках приложения, которому принадлежит API-ключ. Ключ ни при каких условиях не может экспортировать пользователя другого приложения — для него такой пользователь не существует, и endpoint возвращает `404`.\n\n**Замыкающий слэш.** Канонический маршрут оканчивается замыкающим слэшем (`…/generate-pdf/`). Запрос без него обрабатывается напрямую с тем же ответом — редирект `301` отсутствует, поэтому клиенту не нужно следовать перенаправлениям, а для `curl` не требуется флаг `-L`. Используйте URL со слэшем, как показано в примерах.", "operationId": "get_user_generate_pdf", "x-didit-sdk": { "resource": "users", "method": "generate_pdf", "auth": "api_key", "server": true }, "tags": [ "Users" ], "parameters": [ { "name": "vendor_data", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Ваш уникальный идентификатор пользователя — произвольная строка (НЕ UUID). Это то же значение, которое вы передавали в `vendor_data` при создании сессий пользователя; сопоставляется в точности в переданном виде. Примените URL-encoding; значение, содержащее `/`, не может быть адресовано этим маршрутом.", "example": "user-abc-123" } ], "responses": { "200": { "description": "Сформированный PDF-документ, возвращаемый напрямую как бинарные данные `application/pdf` — без обёртки JSON и без перенаправления по URL для скачивания. Тело ответа начинается с сигнатуры `%PDF`. Сохраните его в файл `.pdf` или передайте потоком вызывающей стороне.", "headers": { "Content-Disposition": { "description": "`attachment; filename=user_{didit_internal_id}.pdf` — файл назван по постоянному идентификатору пользователя в Didit (`didit_internal_id` в `GET /v3/users/{vendor_data}/`), а не по `vendor_data`.", "schema": { "type": "string", "example": "attachment; filename=user_f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418.pdf" } }, "Content-Length": { "description": "Общий размер PDF в байтах; тело не разбивается на фрагменты.", "schema": { "type": "integer", "example": 148213 } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Учетные данные не переданы. Запросы к путям `/v3/users/*` без заголовка `x-api-key` (или токена `Authorization: Bearer`) отклоняются промежуточным ПО аутентификации до попадания в API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "Ошибка авторизации или соответствия критериям. Различайте их по строке `detail`:\n\n- `\"You do not have permission to perform this action.\"` — API-ключ недействителен или отозван, либо запрос содержит токен пользователя Консоли вместо API-ключа приложения.\n- `\"This user has no sessions in review, declined, approved or kyc expired to report.\"` — пользователь существует в вашем приложении, но ни одна из его сессий пока не находится в статусе, доступном для отчёта (например, все сессии всё ещё `In Progress`, или пользователь был создан через `POST /v3/users/create/` и ни разу не проходил верификацию). Дождитесь webhook `status.updated`, прежде чем запрашивать отчёт.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "This user has no sessions in review, declined, approved or kyc expired to report." } } }, "examples": { "Invalid credentials": { "summary": "Отозванный или недействительный API-ключ либо token пользователя Console", "value": { "detail": "You do not have permission to perform this action." } }, "No reportable sessions": { "summary": "Пользователь существует, но у него нет сессии со статусом Approved / Declined / In Review / Kyc Expired", "value": { "detail": "This user has no sessions in review, declined, approved or kyc expired to report." } } } } } }, "404": { "description": "Пользователь с указанным `vendor_data` не существует в приложении, привязанном к API-ключу. Пользователи других приложений невидимы для этого ключа и возвращают тот же `404`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "User not found." } } }, "examples": { "Unknown user": { "summary": "vendor_data не соответствует ни одному пользователю этого приложения", "value": { "detail": "User not found." } } } } } }, "429": { "description": "Превышен лимит запросов. Для генерации PDF действует выделенный лимит **50 запросов в минуту на учётные данные** (API-ключ, Bearer-токен или IP-адрес источника при неаутентифицированных запросах), общий для этого endpoint и `GET /v3/session/{sessionId}/generate-pdf/`, в дополнение к глобальному лимиту GET-запросов в 600/мин. Подождите указанное в `Retry-After` количество секунд (оно также отражено в заголовках `X-RateLimit-*`), затем повторите попытку. Отчёты не кэшируются на стороне сервера, поэтому скачивайте каждый отчёт один раз и сохраняйте файл вместо повторных запросов.", "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой запроса.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Максимальное количество генераций PDF, разрешённое в текущем окне (50).", "schema": { "type": "integer", "example": 50 } }, "X-RateLimit-Remaining": { "description": "Количество оставшихся запросов в текущем окне.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Unix-время (в секундах), когда сбрасывается текущее окно.", "schema": { "type": "integer", "example": 1750000000 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное объяснение нарушения лимита запросов.", "example": "Session PDF generation rate limit exceeded. You can make up to 50 requests per minute." } } }, "examples": { "Throttled": { "summary": "Более 50 генераций PDF за одну минуту с одними и теми же учетными данными", "value": { "detail": "Session PDF generation rate limit exceeded. You can make up to 50 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --fail \\\n 'https://verification.didit.me/v3/users/user-abc-123/generate-pdf/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n --output user-history.pdf" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\ncontent = client.users.generate_pdf(\n \"user-abc-123\",\n)\nwith open(\"download.pdf\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst content = await didit.users.generatePdf(\"user-abc-123\");\nawait writeFile(\"download.pdf\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresp, err := client.Users.GeneratePDF(ctx, \"user-abc-123\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.pdf\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.users().generatePdf(\"user-abc-123\")\n .writeTo(Path.of(\"download.pdf\"));" }, { "lang": "php", "label": "PHP", "source": "users->generatePdf('user-abc-123');\n$content->saveTo('download.pdf');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ncontent = didit.users.generate_pdf(\"user-abc-123\")\nFile.binwrite(\"download.pdf\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar content = await client.Users.GeneratePdfAsync(\"user-abc-123\");\nawait content.SaveToAsync(\"download.pdf\");" } ] } }, "/v3/users/delete/": { "post": { "summary": "Пакетное удаление пользователей", "description": "**Удалить пользователей навсегда**: записи пользователей удаляются безвозвратно. Для обычной блокировки используйте [Update User Status](#patch-/v3/users/-vendor_data-/update-status/) со статусом `BLOCKED`. Выберите пользователей с помощью `vendor_data_list`, `didit_internal_id_list` или обоих параметров одновременно, либо передайте `delete_all: true`. Этот endpoint никогда не сужает действие `delete_all` фильтрами. Фильтры раздела People в Console отклоняются с ошибкой `400` (см. ответ `400`), чтобы намерение сузить выборку не привело к полному удалению. Два исключения: `filter_has_approved_sessions` и `filter_has_declined_sessions` не отклоняются и не применяются, поэтому при `delete_all: true` они всё равно приведут к удалению каждого пользователя; не передавайте их.\n\n**Биометрические шаблоны:** если не установить `retain_face_embeddings` в `true`, каждый биометрический шаблон без изображений, сохранённый для этих пользователей после удаления сессии (см. `/v3/biometric-templates/`), удаляется перед удалением пользователя, поэтому совпадения с этим человеком перестают определяться при обнаружении дубликатов и в Поиске по лицу. При установке `retain_face_embeddings: true` и `face_retention_days` вы сохраняете по одному биометрическому шаблону без изображений на человека на указанное количество дней, при этом никакие другие данные о человеке не сохраняются. Если шаблон не удаётся очистить из-за недоступности биометрического хранилища, вызов возвращает `503`, ни один пользователь из запроса не удаляется, а повторный запрос завершит операцию.\n\n**Поданные регуляторные отчёты:** если выбранные данные входят в утверждённый регуляторный отчёт, весь запрос отклоняется с ошибкой `409`, и ничего не удаляется. Тело ответа содержит `code: in_filed_report` и указывает каждый отчёт с полями `uuid`, `report_number`, `report_type` и `case_uuid`. Удалите отчёты, затем повторите запрос.", "operationId": "batch_delete_users", "x-didit-sdk": { "resource": "users", "method": "batch_delete", "auth": "api_key", "server": true }, "tags": [ "Users" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Укажите `vendor_data_list`, `didit_internal_id_list` или `delete_all: true`. Эти два списка можно комбинировать, они объединяются по условию «ИЛИ». Если `delete_all` равен `true`, он имеет приоритет, и оба списка игнорируются.", "properties": { "vendor_data_list": { "type": "array", "items": { "type": "string" }, "description": "Ваши собственные идентификаторы для удаления, сопоставляемые в точности с переданными." }, "didit_internal_id_list": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Внутренние идентификаторы пользователей Didit для удаления: `didit_internal_id`, возвращаемый endpoints создания и получения." }, "delete_all": { "type": "boolean", "default": false, "description": "Если `true`, удаляет всех пользователей в приложении." }, "retain_face_embeddings": { "type": "boolean", "default": false, "description": "Ваш явный выбор сохранить один биометрический шаблон без изображений для каждого удалённого человека для обнаружения дубликатов в течение `face_retention_days`. Все остальные данные о человеке удаляются. Опустите его или отправьте `false`, чтобы удалить шаблоны вместе с пользователями. Если `true`, параметр `face_retention_days` обязателен." }, "face_retention_days": { "type": "integer", "minimum": 1, "maximum": 3650, "description": "Количество дней хранения биометрического шаблона без изображения, если параметр `retain_face_embeddings` равен `true`. Обязателен при его наличии; без него запрос отклоняется с кодом `400` для `face_retention_days`.", "example": 365 } } }, "examples": { "Specific users": { "summary": "Удалить пользователей по vendor_data", "value": { "vendor_data_list": [ "user-123", "user-456" ] } }, "By Didit internal ID": { "summary": "Удалить пользователей по didit_internal_id", "value": { "didit_internal_id_list": [ "3f1c0d3e-8f0a-4c2e-9a3d-9b1f5f4a2c11" ] } }, "All users": { "summary": "Удалить всех пользователей в этом приложении", "value": { "delete_all": true } }, "Keep face templates": { "summary": "Удалить пользователей и сохранить анонимные шаблоны лиц на 365 дней", "value": { "vendor_data_list": [ "user-123" ], "retain_face_embeddings": true, "face_retention_days": 365 } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/users/delete/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"vendor_data_list\": [\"user-123\", \"user-456\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.users.batch_delete(\n vendor_data_list=[\"user-123\", \"user-456\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.users.batchDelete({\n vendor_data_list: [\"user-123\", \"user-456\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.BatchDelete(ctx, didit.UsersBatchDeleteParams{\n\tVendorDataList: didit.Some([]string{\"user-123\", \"user-456\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.UsersBatchDeleteParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.users().batchDelete(UsersBatchDeleteParams.builder()\n .vendorDataList(List.of(\"user-123\", \"user-456\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "users->batchDelete([\n 'vendor_data_list' => ['user-123', 'user-456'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.users.batch_delete(vendor_data_list: [\"user-123\", \"user-456\"])\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Users.BatchDeleteAsync(new UsersBatchDeleteParams\n{\n VendorDataList = new string[] { \"user-123\", \"user-456\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Пользователи удалены. Возвращает количество фактически удалённых пользователей.", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "integer", "description": "Количество удалённых пользователей (исключает значения vendor_data, которым ничего не соответствовало)." } } }, "examples": { "Deleted some": { "value": { "deleted": 2 } }, "Nothing matched": { "value": { "deleted": 0 } } } } } }, "400": { "description": "Ошибка валидации; ничего не удалено. Ошибки указаны под ключами с именами полей. При отсутствии селектора (ни один из списков не указан и `delete_all` не равен `true`) тело ответа имеет вид `{\"vendor_data_list\": [\"This field is required unless delete_all is true.\"]}`; пустой список отклоняется под собственным ключом с сообщением `\"This list may not be empty.\"`. Фильтр, предназначенный только для Console (`filter_search`, `filter_status`, `filter_country`, `filter_date_from`, `filter_date_to`, `filter_tag`, `filter_latest_verification_status`, `filter_risk`, `filter_has_sessions`, `filter_has_open_alerts`, `filter_aml_monitoring`, `filter_can_sign_in`, `filter_auth_status`, `filter_auth_method` или `filter_auth_mfa_enabled`), отклоняется всякий раз, когда содержит значение, даже `false`, возвращая объект с ключами для каждого такого поля. Любой другой неизвестный ключ `filter_*` отклоняется с сообщением `\"Unknown filter.\"`.", "content": { "application/json": { "examples": { "Missing selector": { "summary": "Не указаны ни list, ни delete_all", "value": { "vendor_data_list": [ "This field is required unless delete_all is true." ] } }, "Console-only filter": { "value": { "filter_has_sessions": "This filter is Console-only and is not supported by this endpoint." } } } } } }, "401": { "description": "Учетные данные не переданы. Запросы к путям `/v3/users/*` без заголовка `x-api-key` (или токена `Authorization: Bearer`) отклоняются промежуточным ПО аутентификации до попадания в API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "Недействительный или отозванный API-ключ, либо ключ не может удалять пользователей для этого приложения. При отсутствии ключа возвращается `403`; при неверном, отозванном или истёкшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Лимит запросов превышен; снизьте частоту запросов и повторите попытку через интервал, указанный в `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } }, "503": { "description": "Хранилище биометрии было недоступно при сохранении или удалении биометрического шаблона. Ничего не удалено; повторите тот же запрос. Повторные попытки идемпотентны и сходятся к одному шаблону.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Retryable": { "value": { "detail": "The biometric-template operation could not finish because an external store is unavailable. The operation is retryable." } } } } } }, "409": { "description": "Ничего не удалено. `code` указывает причину: `in_filed_report`, если в выборку входит человек из окончательного регуляторного отчёта, `subject_deletion_in_progress`, если другой запрос всё ещё удаляет одного из выбранных людей. Повторите запрос после завершения этого удаления.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/InFiledReportError" }, { "$ref": "#/components/schemas/SubjectDeletionInProgressError" } ] } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/sessions/delete/": { "post": { "summary": "Массовое удаление KYC-сессий по session_number", "description": "Массовое удаление сессий Проверки пользователей (KYC) по их числовому `session_number` или всех KYC-сессий в вашем приложении с помощью `delete_all: true`.\n\n`session_number` представляет собой понятный человеку инкрементный счетчик, отображаемый в списке сессий в консоли и возвращаемый как `session_number` endpoints создания сессии и принятия решения; это **не** UUID `session_id`. Чтобы удалить сессию по UUID или удалить сессию Верификации бизнеса (KYB), которую этот endpoint никогда не затрагивает, используйте `DELETE /v3/session/{sessionId}/delete/`.\n\n**В рамках одного запроса удаляется до 20 сессий, большее количество выполняется как фоновая задача.** Количество подходящих сессий определяет поведение независимо от того, выбраны ли они через `session_numbers` или с помощью `delete_all`:\n- До 20 подходящих сессий: они удаляются до отправки ответа, который возвращается со статусом `200` и одной записью на сессию в `results[]`.\n- Более 20: возвращается ответ `202` с задачей на удаление, и сессии удаляются в фоновом режиме. Опрашивайте `GET /v3/sessions/delete/{job_id}/`, пока `status` не примет значение `COMPLETED` или `FAILED`. Задача сообщает количество по каждому результату, но не список удаленных сессий. Задача с `delete_all` удаляет только сессии, созданные до отправки запроса; сессии, запущенные во время ее выполнения, не удаляются.\n\nКаждая удаленная сессия обрабатывается точно так же, как и в endpoint удаления отдельной сессии: сессия, каждая содержащаяся в ней попытка верификации, ее решение и извлеченные данные, связанные записи функций (Верификация личности, лицо, Проверка живости, Сравнение лиц и т. д.) и все ее сохраненные файлы удаляются, она исчезает из всех endpoints чтения, а ранее выданные URL медиафайлов перестают работать. Доставки webhook, все еще находящиеся в очереди для удаленной сессии, и их повторные попытки отменяются; уже доставленные webhook не затрагиваются. Записи в списке блокировки **не** удаляются, уже израсходованные кредиты **не** возвращаются, а родительские сущности User **не** удаляются (для них используйте `POST /v3/users/delete/`); webhook на удаление не отправляется. Удаление является окончательным и необратимым.\n\n**Семантика выборки:**\n- С `delete_all: true` вы можете сузить выборку с помощью фильтров `GET /v3/sessions/`, каждый из которых имеет префикс `filter_` (например, `filter_status`, `filter_workflow_id`, `filter_date_from`). Фильтры, принимающие несколько значений в списке сессий (`status`, `workflow_id`, `country`, `region`, `document_type`, `document_name`, `session_type`, `warning`, `organization_name`), принимают строку с разделителями-запятыми или массив; остальные принимают одно значение. Пустое значение игнорируется. Фильтры применяются только вместе с `delete_all`, и задача на удаление применяет те же фильтры.\n- Неизвестный ключ `filter_*` или значение фильтра, которое невозможно прочитать, отклоняет весь запрос со статусом `400` до того, как что-либо будет удалено, поэтому опечатка в фильтре никогда не расширит удаление на все сессии.\n- Записи в `session_numbers`, которые не соответствуют активной KYC-сессии в вашем приложении (неизвестные номера, уже удаленные сессии или сессии, принадлежащие другому приложению), **автоматически пропускаются**: они не отображаются в `results` и не учитываются в `total` задачи.\n- Ошибки валидации (нечисловая запись, пустой список, отсутствие как `session_numbers`, так и `delete_all`, либо срок хранения шаблона, который приложение не может обеспечить) отклоняют **весь запрос** со статусом `400` и ничего не удаляют.\n- Сессии удаляются группами. Если группу невозможно удалить (например, из-за недоступности сервиса хранения данных), для каждой сессии в этой группе возвращается `face_retention_outcome: failed_retryable`, и она остается без изменений; остальные группы не затрагиваются. Повторите запрос для этих сессий. Задача повторяет попытку для такой группы автоматически.\n- Документированного ограничения на длину списка нет; практическим ограничением служит общий лимит запросов на запись (см. ниже).\n\n**Биометрические данные лица:** необязательные поля `retain_face_embeddings`, `face_retention_days`, `face_retention_deadline`, `deletion_instruction` и `instruction_id` имеют то же значение, что и в `DELETE /v3/session/{sessionId}/delete/`, и применяются к каждой подходящей сессии. Каждый результат сообщает свой собственный `face_retention_outcome`.\n\n**Ответ:** `200 OK` с `results[]` для до 20 подходящих сессий или `202 Accepted` с задачей на удаление для большего количества. Каждый результат подтверждает удаление, за исключением `face_retention_outcome: failed_retryable`, который сообщает о сессии, которая НЕ была удалена и для которой следует повторить попытку. Более ранние версии этого endpoint возвращали `204 No Content`; обновите клиенты, ожидающие `204`.\n\n**Идемпотентность:** повторение одного и того же запроса больше ничего не удаляет: номера, которые больше не соответствуют сессии, пропускаются.\n\n**`delete_all: true` (деструктивное действие):** удаляет **каждую** оставшуюся KYC-сессию в приложении; если параметр задан, `session_numbers` игнорируется. Подтверждение не требуется, а отменить удаление невозможно.\n\n**Аутентификация:** API-ключ в заголовке `x-api-key`. Отсутствующие или недействительные учетные данные возвращают `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`); этот API никогда не возвращает `401`.\n\n**Лимит запросов:** общий лимит на запись составляет 300 запросов/мин на API-ключ для всех endpoints POST/PATCH/DELETE; его превышение возвращает `429`.\n\nЭтот endpoint принимает только API-ключи. Bearer-токены пользователей Business Console отклоняются со статусом `403` (в отличие от удаления отдельной сессии, которое принимает и то, и другое).\n\n**Поданные регуляторные отчёты:** если выбранные данные содержатся в окончательно сформированном регуляторном отчёте, весь запрос отклоняется со статусом `409` и ничего не удаляется. В теле ответа используется `code: in_filed_report` и указывается каждый отчёт с полями `uuid`, `report_number`, `report_type` и `case_uuid`. Удалите отчёты, затем повторите запрос.", "operationId": "batch_delete_sessions", "x-didit-sdk": { "resource": "sessions", "method": "batch_delete", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "session_numbers": { "type": "array", "description": "Числовые значения `session_number` удаляемых KYC-сессий в виде строк, состоящих только из цифр (числа JSON также принимаются и приводятся к нужному типу). Обязательно, если `delete_all` не равен `true`; пустой список возвращает `400`. Любой элемент, содержащий не только цифры, отклоняет весь запрос с кодом `400` (если только `delete_all` не равен `true`, и в этом случае валидация пропускается, а элементы игнорируются). Номера, которые не соответствуют активной сессии в вашем приложении, молча пропускаются.", "items": { "type": "string", "pattern": "^[0-9]+$", "example": "1001" }, "minItems": 1, "example": [ "1001", "1002", "1003" ] }, "delete_all": { "type": "boolean", "description": "Когда `true`, все оставшиеся KYC-сессии в вызывающем приложении удаляются, а `session_numbers` игнорируется, если вы не сузите выборку с помощью ключей `filter_*`. Если совпадает более 20 сессий, они обрабатываются как задача удаления (`202`), охватывающая только сессии, созданные до момента запроса. По умолчанию `false`. Действие необратимо; шаг подтверждения отсутствует.", "default": false, "example": false }, "retain_face_embeddings": { "type": "boolean", "nullable": true, "description": "Переопределить `face_retention_policy` приложения для этого удаления. При значении `true` после удаления сессии сохраняется один биометрический шаблон лица без изображения, привязанный к пользователю сессии; при `false` эмбеддинг лица удаляется вместе с сессией; опустите или укажите `null`, чтобы использовать политику приложения. Игнорируется для KYB-сессий и сессий без эмбеддинга лица.", "example": true }, "face_retention_days": { "type": "integer", "minimum": 1, "maximum": 3650, "description": "Ограниченный срок хранения в днях для сохраняемого шаблона. Обязателен при сохранении шаблона, если в приложении ещё не задан `face_retention_days`. Значение `expires_at` шаблона является наименьшим из этого срока, общего окна хранения данных приложения и `face_retention_deadline`.", "example": 365 }, "face_retention_deadline": { "type": "string", "format": "date-time", "description": "Необязательный точный срок действия сохранённого шаблона. Должен быть в будущем.", "example": "2027-08-28T00:00:00Z" }, "deletion_instruction": { "type": "string", "enum": [ "operational_session_delete", "privacy_erasure" ], "default": "operational_session_delete", "description": "Класс передаваемой инструкции. `operational_session_delete` удаляет сессию и сохраняет шаблон только тогда, когда это предусмотрено политикой или параметром `retain_face_embeddings`. `privacy_erasure` полностью удаляет каждый сохранённый биометрический шаблон, привязанный к пользователю сессии, перед удалением самой сессии, не может быть переопределён политикой приложения и не может сочетаться с `retain_face_embeddings: true` (`400`).", "example": "operational_session_delete" }, "instruction_id": { "type": "string", "maxLength": 255, "description": "Ваш постоянный идентификатор для этой инструкции по удалению (например, id тикета на удаление). Фиксируется в журнале аудита и на любом сохраненном шаблоне. Генерируется Didit, если опущен.", "example": "dsar-2026-0142" }, "filter_status": { "description": "Ограничивает действие `delete_all` сессиями, соответствующими фильтру `status` метода [List Sessions](/ru/sessions-api/list-sessions), с теми же значениями. Строка с разделителями-запятыми или массив. Игнорируется без `delete_all`. Пустое значение игнорируется и не сужает выборку.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_vendor_data": { "description": "Ограничивает действие `delete_all` сессиями, соответствующими фильтру `vendor_data` метода [List Sessions](/ru/sessions-api/list-sessions), с тем же значением. Одно значение, не список: массив объединяется в одну строку через запятую, поэтому несколько значений не сопоставляются как альтернативы. Игнорируется без `delete_all`. Пустое значение игнорируется и не сужает выборку.", "type": "string" }, "filter_search": { "description": "Ограничивает действие `delete_all` сессиями, соответствующими фильтру `search` метода [List Sessions](/ru/sessions-api/list-sessions), с тем же значением. Одно значение, не список: массив объединяется в одну строку через запятую, поэтому несколько значений не сопоставляются как альтернативы. Игнорируется без `delete_all`. Пустое значение игнорируется и не сужает выборку.", "type": "string" }, "filter_workflow_id": { "description": "Ограничивает действие `delete_all` сессиями, соответствующими фильтру `workflow_id` метода [List Sessions](/ru/sessions-api/list-sessions), с теми же значениями. Строка с разделителями-запятыми или массив. Игнорируется без `delete_all`. Пустое значение игнорируется и не сужает выборку.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_date_from": { "description": "Ограничивает операцию `delete_all` сессиями, которые соответствуют фильтру `date_from` метода [List Sessions](/ru/sessions-api/list-sessions) с тем же значением. Одно значение, не список: массив объединяется в одну строку через запятую, поэтому несколько значений отклоняются с ошибкой `400`. Игнорируется без `delete_all`. Пустое значение игнорируется и не сужает выборку.", "type": "string", "format": "date" }, "filter_date_to": { "description": "Ограничивает операцию `delete_all` сессиями, которые соответствуют фильтру `date_to` метода [List Sessions](/ru/sessions-api/list-sessions) с тем же значением. Одно значение, не список: массив объединяется в одну строку через запятую, поэтому несколько значений отклоняются с ошибкой `400`. Игнорируется без `delete_all`. Пустое значение игнорируется и не сужает выборку.", "type": "string", "format": "date" }, "filter_country": { "description": "Ограничивает операцию `delete_all` сессиями, которые соответствуют фильтру `country` метода [List Sessions](/ru/sessions-api/list-sessions) с теми же значениями. Строка со значениями через запятую или массив. Игнорируется без `delete_all`. Пустое значение игнорируется и не сужает выборку.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_document_type": { "description": "Ограничивает операцию `delete_all` сессиями, которые соответствуют фильтру `document_type` метода [List Sessions](/ru/sessions-api/list-sessions) с теми же значениями. Строка со значениями через запятую или массив. Игнорируется без `delete_all`. Пустое значение игнорируется и не сужает выборку.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_document_name": { "description": "Ограничивает операцию `delete_all` сессиями, которые соответствуют фильтру `document_name` метода [List Sessions](/ru/sessions-api/list-sessions) с теми же значениями. Строка со значениями через запятую или массив. Игнорируется без `delete_all`. Пустое значение игнорируется и не сужает выборку.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_region": { "description": "Ограничивает действие `delete_all` сессиями, соответствующими фильтру `region` метода [List Sessions](/ru/sessions-api/list-sessions), с теми же значениями. Строка с разделителями-запятыми или массив. Игнорируется без `delete_all`. Пустое значение игнорируется и не сужает выборку.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_didit_internal_id": { "description": "Ограничивает операцию `delete_all` сессиями, которые соответствуют фильтру `didit_internal_id` метода [List Sessions](/ru/sessions-api/list-sessions) с тем же значением. Одно значение, не список: массив объединяется в одну строку через запятую, поэтому несколько значений отклоняются с ошибкой `400`. Игнорируется без `delete_all`. Пустое значение игнорируется и не сужает выборку.", "type": "string", "format": "uuid" }, "filter_session_type": { "description": "Ограничивает действие `delete_all` сессиями, соответствующими фильтру `session_type` метода [List Sessions](/ru/sessions-api/list-sessions), с теми же значениями. Строка с разделителями-запятыми или массив. Игнорируется без `delete_all`. Пустое значение игнорируется и не сужает выборку.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_api_service": { "description": "Ограничивает операцию `delete_all` сессиями, которые соответствуют фильтру `api_service` метода [List Sessions](/ru/sessions-api/list-sessions) с тем же значением. Одно значение, не список: массив объединяется в одну строку через запятую, поэтому несколько значений отклоняются с ошибкой `400`. Игнорируется без `delete_all`. Пустое значение игнорируется и не сужает выборку.", "type": "string" }, "filter_screened_full_name": { "description": "Ограничивает действие `delete_all` сессиями, соответствующими фильтру `screened_full_name` метода [List Sessions](/ru/sessions-api/list-sessions), с тем же значением. Одно значение, не список: массив объединяется в одну строку через запятую, поэтому несколько значений не сопоставляются как альтернативы. Игнорируется без `delete_all`. Пустое значение игнорируется и не сужает выборку.", "type": "string" }, "filter_warning": { "description": "Ограничивает действие `delete_all` сессиями, соответствующими фильтру `warning` метода [List Sessions](/ru/sessions-api/list-sessions), с теми же значениями. Строка с разделителями-запятыми или массив. Игнорируется без `delete_all`. Пустое значение игнорируется и не сужает выборку.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_status_initialized_as_in_review": { "description": "Ограничивает действие `delete_all` сессиями, соответствующими фильтру `status_initialized_as_in_review` метода [List Sessions](/ru/sessions-api/list-sessions), с теми же значениями. Игнорируется без `delete_all`. Пустое значение игнорируется и не сужает выборку.", "type": "boolean" }, "filter_is_kyc_to_be_reviewed": { "description": "Ограничивает операцию `delete_all` сессиями, которые соответствуют фильтру `is_kyc_to_be_reviewed` метода [List Sessions](/ru/sessions-api/list-sessions) с теми же значениями. Игнорируется без `delete_all`. Пустое значение игнорируется и не сужает выборку.", "type": "boolean" }, "filter_euuid": { "description": "Ограничивает операцию `delete_all` сессиями, которые соответствуют фильтру `euuid` метода [List Sessions](/ru/sessions-api/list-sessions) с тем же значением. Одно значение, не список: массив объединяется в одну строку через запятую, поэтому несколько значений отклоняются с ошибкой `400`. Игнорируется без `delete_all`. Пустое значение игнорируется и не сужает выборку.", "type": "string", "format": "uuid" }, "filter_organization_name": { "description": "Ограничивает действие `delete_all` сессиями, соответствующими фильтру `organization_name` метода [List Sessions](/ru/sessions-api/list-sessions), с теми же значениями. Строка с разделителями-запятыми или массив. При использовании API-ключа может совпадать только с названием вашей собственной организации, поэтому выбираются либо все ваши сессии, либо ни одной. Игнорируется без `delete_all`. Пустое значение игнорируется и не сужает выборку.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } }, "examples": { "Specific sessions": { "summary": "Удалить конкретные сессии по номерам", "value": { "session_numbers": [ "1001", "1002", "1003" ] } }, "All sessions": { "summary": "Удалить все KYC-сессии в приложении", "value": { "delete_all": true } }, "Delete and retain templates": { "summary": "Удалить сессии, но сохранить биометрические шаблоны без изображений на 365 дней", "value": { "session_numbers": [ "1001", "1002" ], "retain_face_embeddings": true, "face_retention_days": 365, "instruction_id": "post-approval-cleanup-2026-08" } }, "Privacy erasure": { "summary": "Удалить сессии и стереть все сохраненные шаблоны для их пользователей", "value": { "session_numbers": [ "1001" ], "deletion_instruction": "privacy_erasure", "instruction_id": "dsar-2026-0142" } }, "Filtered delete_all": { "summary": "Удалить все сессии одного сценария со статусом «отклонена», созданные в сентябре 2026 года", "value": { "delete_all": true, "filter_status": [ "Declined" ], "filter_workflow_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "filter_date_from": "2026-09-01", "filter_date_to": "2026-09-30" } } } } } }, "responses": { "200": { "description": "До 20 сессий совпали и были обработаны в запросе. По одному результату на каждую совпавшую сессию; номера без совпадений (неизвестные или уже удалённые) пропускаются и не отображаются. Результат подтверждает удаление, за исключением случаев, когда `face_retention_outcome` имеет значение `failed_retryable`: такая сессия НЕ была удалена, и попытку следует повторить.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "Удалённая сессия." }, "session_number": { "type": "integer", "nullable": true, "description": "Номер удалённой сессии." }, "face_retention_outcome": { "type": "string", "enum": [ "retained_with_user", "deleted", "none", "ineligible_no_vendor_user", "failed_retryable" ], "description": "Что произошло с лицевыми биометрическими данными сессии. `deleted`: эмбеддинг лица был удалён вместе с сессией (по умолчанию). `retained_with_user`: сессия удалена, а один биометрический шаблон без изображения остаётся привязанным к пользователю; см. `biometric_template_uuid`. `none`: в сессии не было эмбеддинга лица (например, сессия KYC только по документам без селфи для проверки живости; сессии KYB никогда не выбираются этим endpoint). `ineligible_no_vendor_user`: было запрошено сохранение, но у сессии нет связанного пользователя, поэтому эмбеддинг был удалён вместе с сессией. `failed_retryable` (только для пакетного endpoint): группу, вместе с которой удалялась эта сессия, не удалось удалить (служба хранения, биометрическое хранилище или провайдер мониторинга были недоступны); эта сессия всё ещё существует, повторите запрос для неё." }, "biometric_template_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "Идентификатор сохранённого биометрического шаблона, если `face_retention_outcome` имеет значение `retained_with_user`; в противном случае `null`. Управляется через `/v3/biometric-templates/{template_uuid}/`." }, "biometric_template_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Время удаления сохранённого биометрического шаблона, когда `face_retention_outcome` имеет значение `retained_with_user`; `null`, если шаблон не сохраняется." }, "deleted_child_verifications": { "type": "integer", "description": "Всегда `0` на этом endpoint, который удаляет только сессии KYC. Удаление сессии Верификации бизнеса (KYB) через `DELETE /v3/session/{sessionId}/delete/` сообщает о созданных ею верификациях, которые были удалены вместе с ней." } } } } } }, "examples": { "Mixed outcomes": { "value": { "results": [ { "session_id": "4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02", "session_number": 1001, "face_retention_outcome": "deleted", "biometric_template_uuid": null, "biometric_template_expires_at": null, "deleted_child_verifications": 0 }, { "session_id": "b8e1d2c3-4f5a-4b6c-8d7e-9f0a1b2c3d4e", "session_number": 1002, "face_retention_outcome": "retained_with_user", "biometric_template_uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "biometric_template_expires_at": "2027-10-09T10:15:00Z", "deleted_child_verifications": 0 }, { "session_id": "7a1e9c2d-5f4b-4c3a-8e2d-1b0a9f8e7d6c", "session_number": 1003, "face_retention_outcome": "ineligible_no_vendor_user", "biometric_template_uuid": null, "biometric_template_expires_at": null, "deleted_child_verifications": 0 }, { "session_id": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f", "session_number": 1004, "face_retention_outcome": "failed_retryable", "biometric_template_uuid": null, "biometric_template_expires_at": null, "deleted_child_verifications": 0 } ] } } } } } }, "202": { "description": "Найдено более 20 сессий. Они удаляются в фоновом режиме; опрашивайте `GET /v3/sessions/delete/{job_id}/`, пока `status` не станет `COMPLETED` или `FAILED`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionDeletionJob" }, "examples": { "Job accepted": { "value": { "job_id": "5b8f2c1e-7d3a-4f6b-9e2c-1a0d8f7e6c5b", "status": "PENDING", "total": 250, "processed": 0, "outcomes": { "deleted": 0, "none": 0, "retained_with_user": 0, "ineligible_no_vendor_user": 0, "failed_retryable": 0, "already_deleted": 0 }, "deleted_child_verifications": 0, "error": null, "created_at": "2026-10-09T10:15:00Z", "completed_at": null } } } } } }, "400": { "description": "Ошибка валидации — ничего не было удалено. Значения ошибок представляют собой массивы строк сообщений с ключами по именам полей.", "content": { "application/json": { "schema": { "type": "object", "properties": { "session_numbers": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": { "description": "Другие ключи: ключ `filter_*`, который не является фильтром List Sessions (`\"Unknown filter.\"`), или ключ `filter_*`, значение которого невозможно прочитать (с ключом в виде этого `filter_*` и массивом сообщений)." } }, "examples": { "Missing selector": { "summary": "Не указаны ни session_numbers, ни delete_all", "value": { "session_numbers": [ "This field is required unless delete_all is true." ] } }, "Empty list": { "summary": "session_numbers является пустым массивом", "value": { "session_numbers": [ "This list may not be empty." ] } }, "Non-numeric entry": { "summary": "session_numbers содержит нецифровую строку", "value": { "session_numbers": [ "All session_numbers must be numeric." ] } }, "Privacy erasure cannot retain": { "summary": "deletion_instruction privacy_erasure в сочетании с retain_face_embeddings true", "value": { "retain_face_embeddings": [ "Privacy erasure cannot retain biometric templates." ] } }, "No finite retention duration": { "summary": "Запрошено хранение без указания face_retention_days в запросе или приложении", "value": { "detail": "A finite biometric-template retention duration is required." } }, "Unknown filter": { "summary": "Ключ filter_*, которого нет в методе получения списка сессий", "value": { "filter_reviewer": "Unknown filter." } }, "Unreadable filter value": { "summary": "Значение фильтра, которое не удаётся прочитать", "value": { "filter_date_from": [ "Enter a valid date." ] } } } } } }, "403": { "description": "Отсутствует API-ключ. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid API key": { "summary": "Заголовок x-api-key отсутствует, либо ключ недействителен", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Превышен общий лимит запросов на запись (300 запросов POST/PATCH/DELETE в минуту на один API-ключ). Проверьте заголовок `Retry-After` и заголовки ответа `X-RateLimit-*` перед повторной попыткой.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Исчерпан бюджет на запись", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } }, "409": { "description": "Выбранная сессия входит в завершённый регуляторный отчёт. Ничего не удалено.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InFiledReportError" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST \\\n https://verification.didit.me/v3/sessions/delete/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"session_numbers\": [\"1001\", \"1002\", \"1003\"]\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.batch_delete(\n session_numbers=[\"1001\", \"1002\", \"1003\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.batchDelete({\n session_numbers: [\"1001\", \"1002\", \"1003\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.BatchDelete(ctx, didit.SessionsBatchDeleteParams{\n\tSessionNumbers: didit.Some([]string{\"1001\", \"1002\", \"1003\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.SessionsBatchDeleteParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().batchDelete(SessionsBatchDeleteParams.builder()\n .sessionNumbers(List.of(\"1001\", \"1002\", \"1003\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->batchDelete([\n 'session_numbers' => ['1001', '1002', '1003'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.batch_delete(session_numbers: [\"1001\", \"1002\", \"1003\"])\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.BatchDeleteAsync(new SessionsBatchDeleteParams\n{\n SessionNumbers = new string[] { \"1001\", \"1002\", \"1003\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/sessions/delete/{job_id}/": { "get": { "summary": "Получить задачу массового удаления сессий", "description": "Прогресс массового удаления сессий, на запрос которого `POST /v3/sessions/delete/` вернул `202` (более 20 подходящих сессий, выбранных по `session_numbers` или с помощью `delete_all`). Опрашивайте раз в несколько секунд, пока `status` равен `PENDING` или `PROCESSING`; прекратите опрос, когда статус изменится на `COMPLETED` или `FAILED`.\n\nЗадача сообщает, сколько сессий завершилось с каждым из исходов и сколько сессий уже обработано, но никогда не указывает, какие именно сессии были удалены. Задача со статусом `FAILED` содержит причину в поле `error`; сессии, до которых задача ещё не дошла, остаются на месте, поэтому повторите запрос на удаление, чтобы удалить их.\n\n**Аутентификация:** API-ключ в заголовке `x-api-key`. Задача видна только тому приложению, которое её создало; любой другой `job_id` возвращает `404`. При отсутствии или недействительности учётных данных возвращается `403`; этот API никогда не возвращает `401`.", "operationId": "get_session_deletion_job", "x-didit-sdk": { "resource": "sessions", "method": "retrieve_deletion_job", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Параметр `job_id`, возвращённый вместе со статусом `202` из `POST /v3/sessions/delete/`." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl 'https://verification.didit.me/v3/sessions/delete/JOB_ID/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.retrieve_deletion_job(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.retrieveDeletionJob(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.RetrieveDeletionJob(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().retrieveDeletionJob(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->retrieveDeletionJob('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.retrieve_deletion_job(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.RetrieveDeletionJobAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Задание.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionDeletionJob" }, "examples": { "Processing": { "value": { "job_id": "5b8f2c1e-7d3a-4f6b-9e2c-1a0d8f7e6c5b", "status": "PROCESSING", "total": 250, "processed": 100, "outcomes": { "deleted": 82, "none": 18, "retained_with_user": 0, "ineligible_no_vendor_user": 0, "failed_retryable": 0, "already_deleted": 0 }, "deleted_child_verifications": 0, "error": null, "created_at": "2026-10-09T10:15:00Z", "completed_at": null } }, "Completed": { "value": { "job_id": "5b8f2c1e-7d3a-4f6b-9e2c-1a0d8f7e6c5b", "status": "COMPLETED", "total": 250, "processed": 250, "outcomes": { "deleted": 204, "none": 44, "retained_with_user": 0, "ineligible_no_vendor_user": 0, "failed_retryable": 0, "already_deleted": 2 }, "deleted_child_verifications": 0, "error": null, "created_at": "2026-10-09T10:15:00Z", "completed_at": "2026-10-09T10:16:40Z" } }, "Failed": { "value": { "job_id": "5b8f2c1e-7d3a-4f6b-9e2c-1a0d8f7e6c5b", "status": "FAILED", "total": 250, "processed": 100, "outcomes": { "deleted": 82, "none": 18, "retained_with_user": 0, "ineligible_no_vendor_user": 0, "failed_retryable": 0, "already_deleted": 0 }, "deleted_child_verifications": 0, "error": "The deletion stopped before it finished. The sessions it had not reached are still in place; repeat the request to delete them.", "created_at": "2026-10-09T10:15:00Z", "completed_at": "2026-10-09T10:15:52Z" } } } } } }, "403": { "description": "Отсутствует API-ключ. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid API key": { "summary": "Заголовок x-api-key отсутствует, либо ключ недействителен", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Задания на удаление с таким `job_id` для вызывающего приложения не существует. Задания видны только создавшему их приложению." } } } }, "/v3/sessions/{session_id}/reviews/": { "get": { "summary": "Получить список проверок сессии и журнал активности", "description": "Возвращает журнал аудита / ленту активности для сессии Проверки пользователей (KYC), начиная с самых новых, в виде объекта с пагинацией (`count` / `next` / `previous` / `results`, по умолчанию 50 записей на страницу).\n\nЗаписи в ленту добавляются каждым участником, взаимодействующим с сессией: ручные решения, принятые через `PATCH /v3/session/{session_id}/update-status/` (где фиксируется `previous_status` → `new_status`), действия проверяющего в Console (комментарии с упоминаниями `@email`, изменения данных KYC/POA, загрузка и удаление файлов, изменение тегов, просмотры страницы с деталями), совпадения постоянного мониторинга AML и заметки, добавленные через `POST` по этому же пути. Чтение этой ленты со стороны API эквивалентно панели **Activity** в режиме просмотра сессии Didit Console.\n\nЗдесь доступны только сессии Проверки пользователей (KYC); для идентификаторов сессий Верификации бизнеса (KYB) возвращается `404`.", "operationId": "list_session_reviews", "x-didit-sdk": { "resource": "sessions.reviews", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "description": "UUID сессии Проверки пользователей (KYC). Должен принадлежать тому же приложению, что и API-ключ — UUID из других приложений, удалённые сессии и идентификаторы сессий Верификации бизнеса (KYB) возвращают `404`.", "schema": { "type": "string", "format": "uuid", "example": "8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d" } }, { "name": "limit", "in": "query", "required": false, "description": "Размер страницы. По умолчанию `50`.", "schema": { "type": "integer", "default": 50, "example": 50 } }, { "name": "offset", "in": "query", "required": false, "description": "Количество записей, которые нужно пропустить от начала (упорядоченной) ленты. По умолчанию: `0`. URL `next` / `previous` в ответе содержат корректные значения для перемещения по ленте.", "schema": { "type": "integer", "default": 0, "example": 0 } }, { "name": "ordering", "in": "query", "required": false, "description": "Порядок сортировки. По умолчанию в ленте сначала идут самые новые (`-created_at`); передайте `created_at`, чтобы читать сначала самые старые. Неизвестные значения молча игнорируются (используется порядок по умолчанию); имена других полей сериализатора также принимаются.", "schema": { "type": "string", "default": "-created_at", "example": "created_at" } } ], "responses": { "200": { "description": "Лента активности с пагинацией, по умолчанию сначала новые. `count` содержит общее количество записей; `next` / `previous` представляют собой готовые URL страниц (`null` на границах). Значение `count`, равное `0`, с пустым `results` означает, что активность ещё не зафиксирована.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Общее количество записей ленты для этой сессии (по всем страницам).", "example": 3 }, "next": { "type": "string", "nullable": true, "description": "URL следующей страницы или `null` на последней странице.", "example": null }, "previous": { "type": "string", "nullable": true, "description": "URL предыдущей страницы или `null` на первой странице.", "example": null }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewItem" }, "description": "Записи ленты для этой страницы." } } }, "examples": { "DecisionTrail": { "summary": "Ручное одобрение и примечания, добавленные через API", "value": { "count": 3, "next": null, "previous": null, "results": [ { "uuid": "de0561bc-5583-4409-9171-1a31a4c8a5f4", "activity_type": "STATUS_UPDATED", "actor_display": "API Client", "actor_email": null, "actor_type": "API_KEY", "new_status": "Approved", "previous_status": "In Review", "comment": "Document re-checked manually; address matches.", "mentioned_emails": [], "previous_value": { "status": "In Review" }, "new_value": { "status": "Approved" }, "changed_fields": [ "status" ], "metadata": null, "created_at": "2026-06-12T00:19:31.918735Z" }, { "uuid": "35370f58-5098-44ee-8a06-8c9af80b2455", "activity_type": "STATUS_UPDATED", "actor_display": "Unknown", "actor_email": null, "actor_type": "CONSOLE_USER", "new_status": null, "previous_status": null, "comment": "Note without status.", "mentioned_emails": [], "previous_value": null, "new_value": null, "changed_fields": [], "metadata": null, "created_at": "2026-06-12T00:18:44.504157Z" }, { "uuid": "00338f82-f1c5-4f57-8614-c49bb258af1a", "activity_type": "STATUS_UPDATED", "actor_display": "Unknown", "actor_email": null, "actor_type": "CONSOLE_USER", "new_status": "In Review", "previous_status": null, "comment": "Flagging for manual document re-check.", "mentioned_emails": [], "previous_value": null, "new_value": null, "changed_fields": [], "metadata": null, "created_at": "2026-06-12T00:18:44.466537Z" } ] } }, "PaginatedFirstPage": { "summary": "Первая страница с limit=2 — next содержит URL для продолжения", "value": { "count": 4, "next": "https://verification.didit.me/v3/sessions/8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d/reviews/?limit=2&offset=2", "previous": null, "results": [ { "uuid": "de0561bc-5583-4409-9171-1a31a4c8a5f4", "activity_type": "STATUS_UPDATED", "actor_display": "API Client", "actor_email": null, "actor_type": "API_KEY", "new_status": "Approved", "previous_status": "In Review", "comment": "Document re-checked manually; address matches.", "mentioned_emails": [], "previous_value": { "status": "In Review" }, "new_value": { "status": "Approved" }, "changed_fields": [ "status" ], "metadata": null, "created_at": "2026-06-12T00:19:31.918735Z" }, { "uuid": "bd4e6227-bdd2-42b2-a726-1d12f785a457", "activity_type": "STATUS_UPDATED", "actor_display": "Unknown", "actor_email": null, "actor_type": "CONSOLE_USER", "new_status": null, "previous_status": null, "comment": null, "mentioned_emails": [], "previous_value": null, "new_value": null, "changed_fields": [], "metadata": null, "created_at": "2026-06-12T00:18:44.540238Z" } ] } }, "Empty": { "summary": "Сессия без зарегистрированных действий на данный момент", "value": { "count": 0, "next": null, "previous": null, "results": [] } } } } } }, "403": { "description": "Отсутствующий, некорректный, истекший или отозванный `x-api-key`. Аутентификация проверяется до поиска сессии, поэтому при отсутствии ключа возвращается `403`, даже если UUID сессии не существует.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "You do not have permission to perform this action." } } }, "examples": { "InvalidKey": { "summary": "Отсутствует или недействителен заголовок x-api-key", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Сессия Проверки пользователей (KYC) с этим UUID не видна вашему приложению: UUID не существует, сессия была удалена или принадлежит другому приложению. Идентификаторы сессий Верификации бизнеса (KYB) также возвращают здесь `404` — лента проверок доступна только для KYC-сессий.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "Session not found." } } }, "examples": { "NotFound": { "summary": "Неизвестный, удалённый или принадлежащий другому приложению UUID сессии", "value": { "detail": "Session not found." } } } } } }, "429": { "description": "Превышен лимит запросов. Проверьте заголовки ответа `Retry-After` и `X-RateLimit-*`. См. раздел [Лимиты запросов](/ru/integration/rate-limiting)." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -s 'https://verification.didit.me/v3/sessions/8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d/reviews/?limit=50' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.sessions.reviews.list(\n \"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.sessions.reviews.list(\"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Sessions.Reviews.ListAutoPaging(ctx, \"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\", didit.SessionsReviewsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.sessions().reviews().list(\"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "sessions->reviews->list('8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.sessions.reviews.list(\"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Sessions.Reviews.ListAsync(\"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] }, "post": { "summary": "Добавить заметку проверки в журнал аудита сессии", "description": "Добавляет заметку в ленту проверки / активности сессии Проверки пользователей (KYC). **Этот endpoint только записывает событие — он никогда не изменяет саму сессию.** Поле `status` сессии остаётся нетронутым, проверка переходов статусов не выполняется, и webhook не отправляется. Чтобы действительно одобрить, отклонить или повторно открыть сессию (что также создаёт запись `STATUS_UPDATED` с полной атрибуцией в этой ленте), используйте `PATCH /v3/session/{session_id}/update-status/`.\n\nОба поля тела запроса необязательны, допускается пустой JSON-объект. `new_status` сохраняется исключительно как метка записи и принимает любое из десяти значений статуса сессии (с учётом регистра). Упоминания `@email` в `comment` сохраняются только как обычный текст — они не вызывают уведомлений в этом endpoint, а поле записи `mentioned_emails` остаётся пустым.\n\nПримечание об атрибуции: создаваемые здесь записи не содержат информации об исполнителе. В ленте они отображаются с `actor_display: \"Unknown\"`, `actor_type: \"CONSOLE_USER\"` и `activity_type: \"STATUS_UPDATED\"` (значения хранилища по умолчанию), а в теле ответа `201` поле `user` содержит `\"Unknown\"`.", "operationId": "create_session_review", "x-didit-sdk": { "resource": "sessions.reviews", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "Content-Type", "in": "header", "required": false, "description": "Укажите `application/json` при отправке тела запроса в формате JSON.", "schema": { "type": "string", "example": "application/json" } }, { "name": "session_id", "in": "path", "required": true, "description": "UUID сессии Проверки пользователей (KYC). Должен принадлежать тому же приложению, что и API-ключ — UUID из других приложений, удалённые сессии и идентификаторы сессий Верификации бизнеса (KYB) возвращают `404`.", "schema": { "type": "string", "format": "uuid", "example": "8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "new_status": { "type": "string", "nullable": true, "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Необязательная метка статуса для сохранения в записи. Принимает любое значение статуса сессии с учётом регистра (`\"approved\"` отклоняется с ошибкой `400`). Сохранение статуса здесь **не** меняет фактический статус сессии — используйте для этого endpoint обновления статуса.", "example": "In Review" }, "comment": { "type": "string", "nullable": true, "description": "Необязательная текстовая заметка в свободной форме (без строгого ограничения по длине). Сохраняется без изменений; упоминания вида `@email` на этом endpoint не обрабатываются.", "example": "Flagging for manual document re-check." } } }, "examples": { "NoteWithStatusLabel": { "summary": "Заметка с меткой статуса (статус сессии не изменён)", "value": { "new_status": "In Review", "comment": "Flagging for manual document re-check." } }, "CommentOnly": { "summary": "Обычная заметка без метки статуса", "value": { "comment": "Customer emailed an updated utility bill; awaiting upload." } } } } } }, "responses": { "201": { "description": "Запись внесена в журнал аудита сессии. Сама сессия не меняется — её `status` сохраняет предыдущее значение, а webhook не отправляется. Новая запись также отображается вверху `GET …/reviews/` (с `actor_display: \"Unknown\"`).", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "string", "description": "Отображаемое имя автора записи. Всегда `\"Unknown\"` для записей, созданных через этот endpoint, поскольку он не фиксирует авторство действия.", "example": "Unknown" }, "new_status": { "type": "string", "nullable": true, "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Метка статуса, зафиксированная в записи, или `null`, если метка не передавалась. Фактический статус сессии не меняется.", "example": "In Review" }, "comment": { "type": "string", "nullable": true, "description": "Заметка, прикрепленная к записи, или `null`, если она не передавалась.", "example": "Flagging for manual document re-check." }, "created_at": { "type": "string", "format": "date-time", "description": "Когда запись была внесена, ISO 8601 UTC.", "example": "2026-06-12T00:18:44.466537Z" } } }, "examples": { "NoteWithStatusLabel": { "summary": "Заметка с меткой статуса", "value": { "user": "Unknown", "new_status": "In Review", "comment": "Flagging for manual document re-check.", "created_at": "2026-06-12T00:18:44.466537Z" } }, "CommentOnly": { "summary": "Обычная заметка", "value": { "user": "Unknown", "new_status": null, "comment": "Note without status.", "created_at": "2026-06-12T00:18:44.504157Z" } } } } } }, "400": { "description": "Ошибка валидации, возвращаемая в виде сопоставления сообщений по полям. Обычно вызвана значением `new_status`, не входящим в число десяти допустимых статусов — проверка чувствительна к регистру.", "content": { "application/json": { "schema": { "type": "object", "properties": { "new_status": { "type": "array", "items": { "type": "string" }, "example": [ "\"approved\" is not a valid choice." ] } } }, "examples": { "InvalidStatusChoice": { "summary": "Значение статуса в нижнем регистре / неизвестное значение", "value": { "new_status": [ "\"approved\" is not a valid choice." ] } } } } } }, "403": { "description": "Отсутствующий, некорректный, истекший или отозванный `x-api-key`. Аутентификация проверяется до поиска сессии, поэтому при отсутствии ключа возвращается `403`, даже если UUID сессии не существует.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "You do not have permission to perform this action." } } }, "examples": { "InvalidKey": { "summary": "Отсутствует или недействителен заголовок x-api-key", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Сессия Проверки пользователей (KYC) с этим UUID не видна вашему приложению: UUID не существует, сессия была удалена или принадлежит другому приложению. Идентификаторы сессий Верификации бизнеса (KYB) также возвращают здесь `404` — лента проверок доступна только для KYC-сессий.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "Session not found." } } }, "examples": { "NotFound": { "summary": "Неизвестный, удалённый или принадлежащий другому приложению UUID сессии", "value": { "detail": "Session not found." } } } } } }, "429": { "description": "Превышен лимит запросов. Проверьте заголовки ответа `Retry-After` и `X-RateLimit-*`. См. раздел [Лимиты запросов](/ru/integration/rate-limiting)." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "# Records an audit-trail note only -- the session's status does NOT change.\ncurl -s -X POST https://verification.didit.me/v3/sessions/8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d/reviews/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"new_status\": \"In Review\",\n \"comment\": \"Flagging for manual document re-check.\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.reviews.create(\n \"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\",\n new_status=\"In Review\",\n comment=\"Flagging for manual document re-check.\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.reviews.create(\"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\", {\n new_status: \"In Review\",\n comment: \"Flagging for manual document re-check.\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Reviews.Create(ctx, \"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\", didit.SessionsReviewsCreateParams{\n\tNewStatus: didit.Some(didit.SessionsReviewsCreateParamsNewStatus(\"In Review\")),\n\tComment: didit.String(\"Flagging for manual document re-check.\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsReviewsCreateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().reviews().create(\"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\", SessionsReviewsCreateParams.builder()\n .newStatus(SessionsReviewsCreateParams.NewStatus.of(\"In Review\"))\n .comment(\"Flagging for manual document re-check.\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->reviews->create('8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d', [\n 'new_status' => 'In Review',\n 'comment' => 'Flagging for manual document re-check.',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.reviews.create(\n \"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\",\n new_status: \"In Review\",\n comment: \"Flagging for manual document re-check.\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Reviews.CreateAsync(\"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\", new SessionsReviewsCreateParams\n{\n NewStatus = new SessionsReviewsCreateParamsNewStatus(\"In Review\"),\n Comment = \"Flagging for manual document re-check.\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/billing/balance/": { "get": { "summary": "Получить кредитный баланс", "description": "Получить текущий баланс предоплаченных кредитов в USD (на уровне организации), а также конфигурацию автопополнения. Суммы указаны в виде десятичных строк — разбирайте их с помощью библиотеки для работы с десятичными числами.", "operationId": "get_billing_balance", "x-didit-sdk": { "resource": "billing", "method": "retrieve_balance", "auth": "api_key", "server": true }, "tags": [ "Billing" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/billing/balance/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.billing.retrieve_balance()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.billing.retrieveBalance();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Billing.RetrieveBalance(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.billing().retrieveBalance();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "billing->retrieveBalance();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.billing.retrieve_balance\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Billing.RetrieveBalanceAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Текущий кредитный баланс и конфигурация автопополнения организации.", "content": { "application/json": { "schema": { "type": "object", "required": [ "balance", "auto_refill_enabled" ], "properties": { "balance": { "type": "string", "description": "Текущий баланс предоплаченных кредитов в USD в виде строки с десятичным числом в формате с фиксированной точкой. Уменьшается по мере списания средств за верификации и увеличивается после проведения пополнения баланса." }, "auto_refill_enabled": { "type": "boolean", "description": "Когда `true`, Didit автоматически списывает средства с сохраненного способа оплаты для добавления кредитов, как только баланс пересекает `auto_refill_threshold`. Настраивается в разделе Console → Billing." }, "auto_refill_amount": { "type": "string", "nullable": true, "description": "Сумма в USD, которая будет списана и зачислена на баланс при каждом автопополнении по номиналу. Настраивается от \\$50 до \\$20,000 в разделе Консоль → Биллинг. `null`, если автопополнение отключено или не настроено." }, "auto_refill_threshold": { "type": "string", "nullable": true, "description": "Порог срабатывания в USD. Автопополнение срабатывает, когда `balance` опускается ниже этого значения. `null`, если автопополнение отключено или не настроено." } } }, "examples": { "Healthy balance with auto-refill": { "value": { "balance": "1234.5600", "auto_refill_enabled": true, "auto_refill_amount": "500.00", "auto_refill_threshold": "100.00" } }, "Low balance, manual top-up only": { "value": { "balance": "12.0000", "auto_refill_enabled": false, "auto_refill_amount": null, "auto_refill_threshold": null } } } } } }, "403": { "description": "Отсутствующий, недействительный или отозванный API-ключ, либо у ключа нет прав на чтение данных биллинга для этой организации. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Лимит запросов превышен; снизьте частоту запросов и повторите попытку через интервал, указанный в `Retry-After`.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/billing/top-up/": { "post": { "summary": "Пополнить баланс кредитов", "description": "Пополните баланс кредитов через размещённую сессию Stripe Checkout (**от \\$50 до \\$20,000** за одно пополнение). Пополнения доступны на тарифах Free, Growth и Scale, начисляются по номиналу без скидок и бонусов и действуют 12 месяцев; для годовых контрактов Enterprise пополнение недоступно. Перенаправьте клиента по URL-адресу `checkout_session_url`, полученному в ответе.", "operationId": "billing_top_up", "x-didit-sdk": { "resource": "billing", "method": "top_up", "auth": "api_key", "server": true }, "tags": [ "Billing" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "amount_in_dollars" ], "properties": { "amount_in_dollars": { "type": "number", "minimum": 50, "maximum": 20000, "description": "Сумма к списанию в USD. **Должна быть от 50 до 20,000.** На баланс поступает та же сумма, без скидок или бонусов. Налог добавляется автоматически при оформлении заказа на основе адреса выставления счетов клиента." }, "success_url": { "type": "string", "format": "uri", "description": "URL, на который размещённая страница оплаты перенаправляет клиента после успешного платежа. В настоящее время по умолчанию используется `https://console.didit.me`. Передавайте рабочий URL явно; хост по умолчанию недоступен. Добавьте текстовый плейсхолдер `{CHECKOUT_SESSION_ID}`, если хотите, чтобы размещённая страница оплаты подставила ID сессии." }, "cancel_url": { "type": "string", "format": "uri", "description": "URL, на который размещённая страница оплаты перенаправляет клиента при отмене или закрытии окна Checkout. В настоящее время по умолчанию используется `https://console.didit.me`. Передавайте рабочий URL явно; хост по умолчанию недоступен." } } }, "examples": { "Minimum top-up": { "value": { "amount_in_dollars": 50 } }, "Custom amount with redirects": { "value": { "amount_in_dollars": 500, "success_url": "https://yourapp.com/billing/top-up/success", "cancel_url": "https://yourapp.com/billing/top-up/cancel" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/billing/top-up/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"amount_in_dollars\": 500,\n \"success_url\": \"https://yourapp.com/billing/success\",\n \"cancel_url\": \"https://yourapp.com/billing/cancel\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.billing.top_up(\n amount_in_dollars=50.0,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.billing.topUp({\n amount_in_dollars: 50.0,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Billing.TopUp(ctx, didit.BillingTopUpParams{\n\tAmountInDollars: 50.0,\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.BillingTopUpParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.billing().topUp(BillingTopUpParams.builder()\n .amountInDollars(50.0)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "billing->topUp([\n 'amount_in_dollars' => 50.0,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.billing.top_up(amount_in_dollars: 50.0)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Billing.TopUpAsync(new BillingTopUpParams\n{\n AmountInDollars = 50.0,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Размещённая сессия оформления заказа создана. Перенаправьте пользователя на `checkout_session_url` для завершения оплаты.", "content": { "application/json": { "schema": { "type": "object", "required": [ "checkout_session_id", "checkout_session_url" ], "properties": { "checkout_session_id": { "type": "string", "description": "Идентификатор размещённой сессии оформления заказа (например, `cs_test_a1B2c3...`). Используется для сверки на стороне сервера." }, "checkout_session_url": { "type": "string", "format": "uri", "description": "Одноразовый URL размещенной страницы оплаты. Перенаправьте клиента сюда для завершения платежа." } } }, "examples": { "Created": { "value": { "checkout_session_id": "cs_test_a1B2c3D4e5F6g7H8i9J0", "checkout_session_url": "https://checkout.example.com/c/pay/cs_test_a1B2c3D4e5F6g7H8i9J0" } } } } } }, "400": { "description": "Недопустимый payload: сумма отсутствует, не является числом, меньше минимальной суммы в \\$50 или больше максимальной в \\$20,000, либо организация находится на годовом контракте Enterprise. Тело ошибки представляет собой массив JSON.", "content": { "application/json": { "examples": { "Missing amount": { "value": [ "amount_in_dollars is required." ] }, "Not a number": { "value": [ "amount_in_dollars must be a number." ] }, "Below minimum": { "value": [ "Amount must be at least $50." ] }, "Above maximum": { "value": [ "Amount must be at most $20,000." ] }, "Annual plan": { "value": [ "You have an annual plan. Contact your account manager to top up." ] } } } } }, "403": { "description": "Отсутствует, недействителен или отозван API-ключ, либо ключ не позволяет создавать сессии пополнения баланса для этой организации. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Лимит запросов превышен; снизьте частоту запросов и повторите попытку через интервал, указанный в `Retry-After`.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/webhook/destinations/": { "get": { "summary": "Получить список адресов назначения webhook", "description": "Получить список всех адресов назначения webhook (массив без пагинации, сначала старые). Каждый элемент содержит конфигурацию адреса назначения, его метрики доставки за последние 30 дней (`metrics_window_days`) с одной записью `daily_points` на день, а также его состояние (`health_status`, `failing_streak`, `failing_since`, `last_success_at`). В списке нет объекта `summary`, и он никогда не включает секрет подписи: каждый элемент показывает только `secret_last4`. Запросите отдельный адрес назначения (`GET /v3/webhook/destinations/{destination_uuid}/`), чтобы прочитать `secret_shared_key`.", "operationId": "list_webhook_destinations", "x-didit-sdk": { "resource": "webhooks.destinations", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/webhook/destinations/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.webhooks.destinations.list()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.webhooks.destinations.list();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.Destinations.List(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.webhooks().destinations().list();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->list();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.webhooks.destinations.list.each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Webhooks.Destinations.ListAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Список адресов назначения webhook (без пагинации, сначала самые старые).", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Постоянный идентификатор назначения; используйте как `{destination_uuid}` для обновления или удаления." }, "label": { "type": "string", "description": "Понятное имя, отображаемое в Console." }, "url": { "type": "string", "format": "uri", "description": "URL адреса назначения, принимающий `POST`-запросы с payload webhook." }, "enabled": { "type": "boolean", "description": "Если `false`, Didit без уведомления пропускает доставку на этот адрес назначения." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Версия схемы payload, отправляемая по этому адресу назначения. `v3` является текущим и рекомендуемым форматом." }, "subscribed_events": { "$ref": "#/components/schemas/WebhookSubscribedEvents" }, "subscribed_events_count": { "type": "integer", "description": "Кэшированная длина `subscribed_events`, полезна для отрисовки в UI." }, "deliveries_count": { "type": "integer", "description": "Попытки доставки (включая повторные попытки), выполненные на этот адрес назначения за последние 30 дней." }, "failed_deliveries_count": { "type": "integer", "description": "Попытки доставки за последние 30 дней, на которые адрес назначения ответил кодом HTTP 400 или выше либо не ответил (тайм-аут, отклонённое соединение или заблокированный адрес)." }, "average_response_time_ms": { "type": "integer", "nullable": true, "description": "Среднее время ответа в миллисекундах за последние 30 дней, округлённое до целого числа. `null`, если за этот период доставок не было." }, "error_rate_percentage": { "type": "integer", "description": "`round(failed_deliveries_count / deliveries_count * 100)` за последние 30 дней; `0`, если доставок не было." }, "last_delivery_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Временная метка последней попытки доставки (успешной или неудачной). `null`, если доставка не выполнялась." }, "metrics_window_days": { "type": "integer", "description": "Длина окна в днях, охватываемого полями `deliveries_count`, `failed_deliveries_count`, `average_response_time_ms`, `error_rate_percentage` и `daily_points`. Всегда `30`." }, "health_status": { "type": "string", "enum": [ "healthy", "degraded", "failing" ], "description": "Состояние доставки. `failing`: 3 или более последовательных событий завершились неудачей при первой попытке доставки с момента последнего успешного ответа адреса назначения (см. `failing_streak`). `degraded`: не failing, но за последние 24 часа произошла неудачная попытка доставки, и ни одна последующая попытка пока не доставила это событие; повторная попытка или повторная отправка, которая доставит его, сбрасывает этот статус. `healthy`: ни то, ни другое. Не зависит от `enabled`. Неудачной считается попытка, получившая ответ HTTP 400 или выше, либо оставшаяся вовсе без ответа." }, "failing_streak": { "type": "integer", "description": "Количество последовательных событий, первая попытка доставки которых завершилась неудачно с момента последнего успешного ответа адреса назначения за последние 30 дней. Повторные попытки не учитываются, и любая успешная попытка, включая повторную попытку или повторную отправку, прерывает серию. Значение равно `0`, если с момента последнего успеха не было ни одного сбоя." }, "failing_since": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда была совершена первая неудачная попытка из текущей серии ошибок `failing_streak`. `null`, если `failing_streak` равен `0`." }, "last_success_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда адрес назначения в последний раз ответил на доставку с HTTP-статусом ниже 400 за последние 30 дней. `null`, если ответов в этот период не было." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Среда приложения, которому принадлежит адрес назначения." }, "daily_points": { "type": "array", "description": "Одна запись на каждый день по UTC за последние 30 дней, начиная с самых старых, включая дни без доставок. Учитывает каждую попытку, включая повторные попытки.", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "День по UTC." }, "total_deliveries": { "type": "integer", "description": "Попытки доставки, выполненные в этот день." }, "failed_deliveries": { "type": "integer", "description": "Попытки, сделанные в этот день, на которые был получен ответ с HTTP 400 или выше, либо ответ не был получен вовсе." } } } }, "secret_last4": { "type": "string", "description": "Последние четыре символа текущего секрета подписи адреса назначения, позволяющие различать секреты. Недостаточно для проверки подписи." }, "created_by_email": { "type": "string", "nullable": true, "description": "Электронная почта участника Business Console, создавшего адрес назначения. `null` для адреса назначения, созданного с помощью API-ключа." }, "created_by_name": { "type": "string", "nullable": true, "description": "Имя участника Business Console, создавшего адрес назначения. `null` для адреса назначения, созданного с помощью API-ключа." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } }, "examples": { "Two destinations": { "value": [ { "uuid": "11111111-2222-3333-4444-555555555555", "label": "Production session webhooks", "url": "https://yourapp.com/webhooks/didit", "enabled": true, "webhook_version": "v3", "subscribed_events": [ "status.updated", "data.updated" ], "subscribed_events_count": 2, "deliveries_count": 12453, "failed_deliveries_count": 14, "average_response_time_ms": 187, "error_rate_percentage": 0, "last_delivery_at": "2026-05-17T09:21:18Z", "metrics_window_days": 30, "health_status": "healthy", "failing_streak": 0, "failing_since": null, "last_success_at": "2026-05-17T09:21:18Z", "environment": "live", "daily_points": [ { "date": "2026-04-18", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-19", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-20", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-21", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-22", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-23", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-24", "total_deliveries": 415, "failed_deliveries": 9 }, { "date": "2026-04-25", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-26", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-27", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-28", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-29", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-30", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-01", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-02", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-03", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-04", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-05", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-06", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-07", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-08", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-09", "total_deliveries": 415, "failed_deliveries": 5 }, { "date": "2026-05-10", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-11", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-12", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-13", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-14", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-15", "total_deliveries": 416, "failed_deliveries": 0 }, { "date": "2026-05-16", "total_deliveries": 416, "failed_deliveries": 0 }, { "date": "2026-05-17", "total_deliveries": 416, "failed_deliveries": 0 } ], "secret_last4": "0xnQ", "created_by_email": null, "created_by_name": null, "created_at": "2026-01-04T08:00:00Z", "updated_at": "2026-04-22T14:09:11Z" }, { "uuid": "22222222-3333-4444-5555-666666666666", "label": "Staging mirror", "url": "https://staging.yourapp.com/webhooks/didit", "enabled": false, "webhook_version": "v3", "subscribed_events": [ "status.updated" ], "subscribed_events_count": 1, "deliveries_count": 0, "failed_deliveries_count": 0, "average_response_time_ms": null, "error_rate_percentage": 0, "last_delivery_at": null, "metrics_window_days": 30, "health_status": "healthy", "failing_streak": 0, "failing_since": null, "last_success_at": null, "environment": "live", "daily_points": [ { "date": "2026-04-18", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-19", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-20", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-21", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-22", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-23", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-24", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-25", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-26", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-27", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-28", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-29", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-30", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-01", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-02", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-03", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-04", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-05", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-06", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-07", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-08", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-09", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-10", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-11", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-12", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-13", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-14", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-15", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-16", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-17", "total_deliveries": 0, "failed_deliveries": 0 } ], "secret_last4": "k9Qe", "created_by_email": "reviewer@example.com", "created_by_name": "Example Reviewer", "created_at": "2026-03-12T10:15:02Z", "updated_at": "2026-03-12T10:15:02Z" } ] } } } } }, "403": { "description": "API-ключ отсутствует, сформирован некорректно, истёк или относится к другому приложению. При отсутствии ключа возвращается `403`; при неверном, отозванном или истёкшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Лимит запросов превышен; снизьте частоту запросов и повторите попытку.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Создать адрес назначения webhook", "description": "Создайте адрес назначения webhook. Ответ содержит автоматически сгенерированный секрет подписи HMAC `secret_shared_key` (также доступный позже через `GET /v3/webhook/destinations/{destination_uuid}/`). Обязательно передавайте `subscribed_events` хотя бы с одним событием (подстановочные символы не поддерживаются): пустой список отклоняется с кодом 400, а отсутствие поля создаёт адрес назначения без подписок, который никогда не получит webhook. Пара `(application, url)` должна быть уникальной среди адресов назначения приложения.", "operationId": "create_webhook_destination", "x-didit-sdk": { "resource": "webhooks.destinations", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/webhook/destinations/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"label\": \"Production session webhooks\",\n \"url\": \"https://yourapp.com/webhooks/didit\",\n \"webhook_version\": \"v3\",\n \"subscribed_events\": [\"status.updated\", \"data.updated\"]\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.webhooks.destinations.create(\n label=\"Production session webhooks\",\n url=\"https://yourapp.com/webhooks/didit\",\n webhook_version=\"v3\",\n subscribed_events=[\"status.updated\", \"data.updated\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.webhooks.destinations.create({\n label: \"Production session webhooks\",\n url: \"https://yourapp.com/webhooks/didit\",\n webhook_version: \"v3\",\n subscribed_events: [\"status.updated\", \"data.updated\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.Destinations.Create(ctx, didit.WebhooksDestinationsCreateParams{\n\tLabel: \"Production session webhooks\",\n\tURL: \"https://yourapp.com/webhooks/didit\",\n\tWebhookVersion: didit.Some(didit.WebhooksDestinationsCreateParamsWebhookVersion(\"v3\")),\n\tSubscribedEvents: didit.Some([]didit.WebhookEvent{didit.WebhookEvent(\"status.updated\"), didit.WebhookEvent(\"data.updated\")}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.WebhookEvent;\nimport me.didit.types.WebhooksDestinationsCreateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.webhooks().destinations().create(WebhooksDestinationsCreateParams.builder()\n .label(\"Production session webhooks\")\n .url(\"https://yourapp.com/webhooks/didit\")\n .webhookVersion(WebhooksDestinationsCreateParams.WebhookVersion.of(\"v3\"))\n .subscribedEvents(List.of(WebhookEvent.of(\"status.updated\"), WebhookEvent.of(\"data.updated\")))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->create([\n 'label' => 'Production session webhooks',\n 'url' => 'https://yourapp.com/webhooks/didit',\n 'webhook_version' => 'v3',\n 'subscribed_events' => ['status.updated', 'data.updated'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.webhooks.destinations.create(\n label: \"Production session webhooks\",\n url: \"https://yourapp.com/webhooks/didit\",\n webhook_version: \"v3\",\n subscribed_events: [\"status.updated\", \"data.updated\"]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Webhooks.Destinations.CreateAsync(new WebhooksDestinationsCreateParams\n{\n Label = \"Production session webhooks\",\n Url = \"https://yourapp.com/webhooks/didit\",\n WebhookVersion = new WebhooksDestinationsCreateParamsWebhookVersion(\"v3\"),\n SubscribedEvents = new WebhookEvent[] { \"status.updated\", \"data.updated\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "label", "url" ], "properties": { "label": { "type": "string", "maxLength": 255, "description": "Понятное имя, отображаемое в Console → Webhooks. Помогает различать адреса назначения, если их несколько (например, «Prod», «Staging mirror»)." }, "url": { "type": "string", "format": "uri", "description": "HTTPS-URL, который будет принимать `POST`-запросы. Должен быть уникальным среди адресов назначения приложения. Используйте стабильный, защищённый endpoint: Didit выполняет повторные попытки неудавшейся доставки по схеме задержек между повторными попытками.", "maxLength": 2000 }, "enabled": { "type": "boolean", "default": true, "description": "Если `false`, адрес назначения сохраняется, но Didit не отправляет на него никакие webhook. Полезно для staging-конфигураций, которые вы хотите оставить неактивными." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Версия схемы payload, которую отправит Didit. `v3` является текущим и рекомендуемым форматом; более старые версии сохранены для обратной совместимости с устаревшими интеграциями." }, "subscribed_events": { "allOf": [ { "$ref": "#/components/schemas/WebhookSubscribedEvents" } ], "description": "События для доставки. Фактически обязательно: явный массив `[]` отклоняется с кодом 400, а пропуск поля создаёт адрес назначения без подписок, который ничего не получает." } } }, "examples": { "session_updates": { "summary": "Обновления статуса и данных сессии", "value": { "label": "Production session webhooks", "url": "https://yourapp.com/webhooks/didit", "webhook_version": "v3", "subscribed_events": [ "status.updated", "data.updated" ] } }, "transaction_updates": { "summary": "Обновления мониторинга транзакций", "value": { "label": "Transaction monitoring webhooks", "url": "https://yourapp.com/webhooks/didit-transactions", "webhook_version": "v3", "subscribed_events": [ "transaction.created", "transaction.status.updated" ] } }, "entity_updates": { "summary": "Обновления сущностей пользователя и компании", "value": { "label": "Entity lifecycle webhooks", "url": "https://yourapp.com/webhooks/didit-entities", "webhook_version": "v3", "subscribed_events": [ "user.status.updated", "user.data.updated", "business.status.updated", "business.data.updated", "activity.created" ] } } } } } }, "responses": { "201": { "description": "Адрес назначения создан. `secret_shared_key` — это секрет подписи HMAC, сохраните его сейчас.", "content": { "application/json": { "schema": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Постоянный идентификатор назначения. Используйте как `{destination_uuid}` в последующих вызовах." }, "label": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "enabled": { "type": "boolean" }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ] }, "secret_shared_key": { "type": "string", "description": "Автоматически сгенерированный секрет подписи HMAC, привязанный к этому адресу назначения (URL-безопасный token из 43 символов). Используйте его для проверки заголовков подписи во входящих webhook. При запросе с API-ключом всегда возвращается полностью; пользователям Консоли требуется разрешение `read:webhooks`, иначе они увидят пустую строку." }, "secret_last4": { "type": "string", "description": "Последние четыре символа текущего секрета подписи адреса назначения, позволяющие различать секреты. Недостаточно для проверки подписи." }, "previous_secret_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Устанавливается на 24 часа после ротации секрета подписи адреса назначения в Business Console. До истечения этого времени каждая доставка на адрес назначения также содержит `X-Signature-Previous`, `X-Signature-V2-Previous` и `X-Signature-Simple-Previous`, созданные с заменённым секретом (см. [Проверка подписи](/ru/integration/webhooks#проверка-подписи)). `null`, если за последние 24 часа ротация не проводилась." }, "subscribed_events": { "$ref": "#/components/schemas/WebhookSubscribedEvents" }, "created_by_email": { "type": "string", "nullable": true, "description": "Электронная почта участника Business Console, создавшего адрес назначения. `null` для адреса назначения, созданного с помощью API-ключа." }, "created_by_name": { "type": "string", "nullable": true, "description": "Имя участника Business Console, создавшего адрес назначения. `null` для адреса назначения, созданного с помощью API-ключа." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "health_status": { "type": "string", "enum": [ "healthy", "degraded", "failing" ], "description": "Состояние доставки. `failing`: 3 или более последовательных событий завершились неудачей при первой попытке доставки с момента последнего успешного ответа адреса назначения (см. `failing_streak`). `degraded`: не failing, но за последние 24 часа произошла неудачная попытка доставки, и ни одна последующая попытка пока не доставила это событие; повторная попытка или повторная отправка, которая доставит его, сбрасывает этот статус. `healthy`: ни то, ни другое. Не зависит от `enabled`. Неудачной считается попытка, получившая ответ HTTP 400 или выше, либо оставшаяся вовсе без ответа." }, "failing_streak": { "type": "integer", "description": "Количество последовательных событий, первая попытка доставки которых завершилась неудачно с момента последнего успешного ответа адреса назначения за последние 30 дней. Повторные попытки не учитываются, и любая успешная попытка, включая повторную попытку или повторную отправку, прерывает серию. Значение равно `0`, если с момента последнего успеха не было ни одного сбоя." }, "failing_since": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда была совершена первая неудачная попытка из текущей серии ошибок `failing_streak`. `null`, если `failing_streak` равен `0`." }, "last_success_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда адрес назначения в последний раз ответил на доставку с HTTP-статусом ниже 400 за последние 30 дней. `null`, если ответов в этот период не было." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Среда приложения, которому принадлежит адрес назначения." }, "summary": { "type": "object", "description": "Метрики доставки за последние `metrics_window_days` (30) дней. `last_delivery_at` представляет собой самую последнюю попытку, когда бы она ни выполнялась.", "properties": { "total_deliveries": { "type": "integer" }, "failed_deliveries": { "type": "integer" }, "error_rate_percentage": { "type": "integer" }, "min_response_time_ms": { "type": "integer", "nullable": true }, "avg_response_time_ms": { "type": "integer", "nullable": true }, "max_response_time_ms": { "type": "integer", "nullable": true }, "last_delivery_at": { "type": "string", "format": "date-time", "nullable": true }, "metrics_window_days": { "type": "integer", "description": "Длина окна в днях, охватываемого остальными сводными метриками. Всегда `30`." } } } } }, "examples": { "Created": { "value": { "uuid": "11111111-2222-3333-4444-555555555555", "label": "Production session webhooks", "url": "https://yourapp.com/webhooks/didit", "enabled": true, "webhook_version": "v3", "secret_shared_key": "tno2NTeRC1ZK3sBOYlBJDyEzBVENl3pQ1AcZyAW0xnQ", "secret_last4": "0xnQ", "previous_secret_expires_at": null, "subscribed_events": [ "status.updated", "data.updated" ], "created_by_email": null, "created_by_name": null, "created_at": "2026-05-17T10:00:00Z", "updated_at": "2026-05-17T10:00:00Z", "health_status": "healthy", "failing_streak": 0, "failing_since": null, "last_success_at": null, "environment": "live", "summary": { "total_deliveries": 0, "failed_deliveries": 0, "error_rate_percentage": 0, "min_response_time_ms": null, "avg_response_time_ms": null, "max_response_time_ms": null, "last_delivery_at": null, "metrics_window_days": 30 } } } } } } }, "400": { "description": "Ошибка валидации — обычно повторяющийся URL, отсутствующий/недопустимый `subscribed_events` или неизвестное имя события.", "content": { "application/json": { "examples": { "Duplicate URL": { "value": { "url": [ "This webhook destination already exists for the application." ] } }, "Empty events list": { "value": { "subscribed_events": [ "At least one subscribed event is required." ] } }, "Unknown event": { "value": { "subscribed_events": [ "Unsupported webhook events: foo.bar" ] } } } } } }, "403": { "description": "API-ключ отсутствует, сформирован некорректно, истёк или относится к другому приложению. При отсутствии ключа возвращается `403`; при неверном, отозванном или истёкшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Лимит запросов превышен; снизьте частоту запросов и повторите попытку.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/webhook/destinations/{destination_uuid}/": { "get": { "summary": "Получить адрес назначения webhook", "description": "Получить один адрес назначения webhook с его секретом подписи `secret_shared_key`, состоянием (`health_status`, `failing_streak`, `failing_since`, `last_success_at`) и сводкой доставок `summary` за последние 30 дней. Вызывающие стороны с API-ключом всегда получают секрет полностью; пользователи консоли без разрешения `read:webhooks` видят пустую строку.", "operationId": "get_webhook_destination", "x-didit-sdk": { "resource": "webhooks.destinations", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "parameters": [ { "name": "destination_uuid", "in": "path", "required": true, "description": "UUID адреса назначения webhook (`uuid`, возвращённый при создании или получении списка).", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.webhooks.destinations.retrieve(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.webhooks.destinations.retrieve(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.Destinations.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.webhooks().destinations().retrieve(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->retrieve('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.webhooks.destinations.retrieve(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Webhooks.Destinations.RetrieveAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Сведения об адресе назначения webhook.", "content": { "application/json": { "schema": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "label": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "enabled": { "type": "boolean" }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ] }, "secret_shared_key": { "type": "string", "description": "Секрет подписи HMAC (43-символьный URL-безопасный token). Всегда возвращается полностью при вызовах с API-ключом; пользователям Консоли требуется `read:webhooks`, иначе возвращается пустая строка." }, "secret_last4": { "type": "string", "description": "Последние четыре символа текущего секрета подписи адреса назначения, позволяющие различать секреты. Недостаточно для проверки подписи." }, "previous_secret_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Устанавливается на 24 часа после ротации секрета подписи адреса назначения в Business Console. До истечения этого времени каждая доставка на адрес назначения также содержит `X-Signature-Previous`, `X-Signature-V2-Previous` и `X-Signature-Simple-Previous`, созданные с заменённым секретом (см. [Проверка подписи](/ru/integration/webhooks#проверка-подписи)). `null`, если за последние 24 часа ротация не проводилась." }, "subscribed_events": { "$ref": "#/components/schemas/WebhookSubscribedEvents" }, "created_by_email": { "type": "string", "nullable": true, "description": "Электронная почта участника Business Console, создавшего адрес назначения. `null` для адреса назначения, созданного с помощью API-ключа." }, "created_by_name": { "type": "string", "nullable": true, "description": "Имя участника Business Console, создавшего адрес назначения. `null` для адреса назначения, созданного с помощью API-ключа." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "health_status": { "type": "string", "enum": [ "healthy", "degraded", "failing" ], "description": "Состояние доставки. `failing`: 3 или более последовательных событий завершились неудачей при первой попытке доставки с момента последнего успешного ответа адреса назначения (см. `failing_streak`). `degraded`: не failing, но за последние 24 часа произошла неудачная попытка доставки, и ни одна последующая попытка пока не доставила это событие; повторная попытка или повторная отправка, которая доставит его, сбрасывает этот статус. `healthy`: ни то, ни другое. Не зависит от `enabled`. Неудачной считается попытка, получившая ответ HTTP 400 или выше, либо оставшаяся вовсе без ответа." }, "failing_streak": { "type": "integer", "description": "Количество последовательных событий, первая попытка доставки которых завершилась неудачно с момента последнего успешного ответа адреса назначения за последние 30 дней. Повторные попытки не учитываются, и любая успешная попытка, включая повторную попытку или повторную отправку, прерывает серию. Значение равно `0`, если с момента последнего успеха не было ни одного сбоя." }, "failing_since": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда была совершена первая неудачная попытка из текущей серии ошибок `failing_streak`. `null`, если `failing_streak` равен `0`." }, "last_success_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда адрес назначения в последний раз ответил на доставку с HTTP-статусом ниже 400 за последние 30 дней. `null`, если ответов в этот период не было." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Среда приложения, которому принадлежит адрес назначения." }, "summary": { "type": "object", "description": "Метрики доставки за последние `metrics_window_days` (30) дней. `last_delivery_at` представляет собой самую последнюю попытку, когда бы она ни выполнялась.", "properties": { "total_deliveries": { "type": "integer" }, "failed_deliveries": { "type": "integer" }, "error_rate_percentage": { "type": "integer" }, "min_response_time_ms": { "type": "integer", "nullable": true }, "avg_response_time_ms": { "type": "integer", "nullable": true }, "max_response_time_ms": { "type": "integer", "nullable": true }, "last_delivery_at": { "type": "string", "format": "date-time", "nullable": true }, "metrics_window_days": { "type": "integer", "description": "Длина окна в днях, охватываемого остальными сводными метриками. Всегда `30`." } } } } }, "examples": { "Healthy destination": { "value": { "uuid": "11111111-2222-3333-4444-555555555555", "label": "Production session webhooks", "url": "https://yourapp.com/webhooks/didit", "enabled": true, "webhook_version": "v3", "secret_shared_key": "tno2NTeRC1ZK3sBOYlBJDyEzBVENl3pQ1AcZyAW0xnQ", "secret_last4": "0xnQ", "previous_secret_expires_at": null, "subscribed_events": [ "status.updated", "data.updated" ], "created_by_email": null, "created_by_name": null, "created_at": "2026-01-04T08:00:00Z", "updated_at": "2026-04-22T14:09:11Z", "health_status": "healthy", "failing_streak": 0, "failing_since": null, "last_success_at": "2026-05-17T09:21:18Z", "environment": "live", "summary": { "total_deliveries": 12453, "failed_deliveries": 14, "error_rate_percentage": 0, "min_response_time_ms": 41, "avg_response_time_ms": 187, "max_response_time_ms": 2103, "last_delivery_at": "2026-05-17T09:21:18Z", "metrics_window_days": 30 } } } } } } }, "403": { "description": "API-ключ отсутствует, сформирован некорректно, истёк или относится к другому приложению. При отсутствии ключа возвращается `403`; при неверном, отозванном или истёкшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Адреса назначения с таким UUID не существует, он принадлежит другому приложению или был удален.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Webhook destination not found." } } } } } }, "429": { "description": "Лимит запросов превышен; снизьте частоту запросов и повторите попытку.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Обновить адрес назначения webhook", "description": "Обновить адрес назначения webhook. **`subscribed_events` ЗАМЕНЯЕТСЯ целиком, а не объединяется**: сначала получите список, добавьте события и отправьте повторно. Секрет не ротируется. Значение `uuid` в теле запроса игнорируется: адрес назначения указывается в пути запроса.", "operationId": "update_webhook_destination", "x-didit-sdk": { "resource": "webhooks.destinations", "method": "update", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "parameters": [ { "name": "destination_uuid", "in": "path", "required": true, "description": "UUID обновляемого адреса назначения webhook.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "description": "Новое понятное пользователю имя." }, "url": { "type": "string", "format": "uri", "description": "Новый целевой URL. Должен быть уникальным в рамках приложения." }, "enabled": { "type": "boolean", "description": "Установите значение `false`, чтобы приостановить доставку на этот адрес назначения без его удаления." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Новая версия схемы payload для будущих доставок." }, "subscribed_events": { "$ref": "#/components/schemas/WebhookSubscribedEvents" } } }, "examples": { "Pause destination": { "value": { "enabled": false } }, "Add transaction events": { "value": { "subscribed_events": [ "status.updated", "data.updated", "transaction.created", "transaction.status.updated" ] } }, "Move target URL": { "value": { "label": "Production session webhooks v2", "url": "https://api.yourapp.com/webhooks/didit/v2" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"subscribed_events\": [\n \"status.updated\",\n \"data.updated\",\n \"transaction.created\"\n ]\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.webhooks.destinations.update(\n \"11111111-2222-3333-4444-555555555555\",\n enabled=False,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.webhooks.destinations.update(\"11111111-2222-3333-4444-555555555555\", {\n enabled: false,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.Destinations.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.WebhooksDestinationsUpdateParams{\n\tEnabled: didit.Bool(false),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.WebhooksDestinationsUpdateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.webhooks().destinations().update(\"11111111-2222-3333-4444-555555555555\", WebhooksDestinationsUpdateParams.builder()\n .enabled(false)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->update('11111111-2222-3333-4444-555555555555', [\n 'enabled' => false,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.webhooks.destinations.update(\n \"11111111-2222-3333-4444-555555555555\",\n enabled: false\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Webhooks.Destinations.UpdateAsync(\"11111111-2222-3333-4444-555555555555\", new WebhooksDestinationsUpdateParams\n{\n Enabled = false,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Обновлённый адрес назначения webhook. Тело имеет ту же структуру, что и `GET /v3/webhook/destinations/{destination_uuid}/`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "label": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "enabled": { "type": "boolean" }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ] }, "secret_shared_key": { "type": "string" }, "secret_last4": { "type": "string", "description": "Последние четыре символа текущего секрета подписи адреса назначения, позволяющие различать секреты. Недостаточно для проверки подписи." }, "previous_secret_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Устанавливается на 24 часа после ротации секрета подписи адреса назначения в Business Console. До истечения этого времени каждая доставка на адрес назначения также содержит `X-Signature-Previous`, `X-Signature-V2-Previous` и `X-Signature-Simple-Previous`, созданные с заменённым секретом (см. [Проверка подписи](/ru/integration/webhooks#проверка-подписи)). `null`, если за последние 24 часа ротация не проводилась." }, "subscribed_events": { "$ref": "#/components/schemas/WebhookSubscribedEvents" }, "created_by_email": { "type": "string", "nullable": true, "description": "Электронная почта участника Business Console, создавшего адрес назначения. `null` для адреса назначения, созданного с помощью API-ключа." }, "created_by_name": { "type": "string", "nullable": true, "description": "Имя участника Business Console, создавшего адрес назначения. `null` для адреса назначения, созданного с помощью API-ключа." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "health_status": { "type": "string", "enum": [ "healthy", "degraded", "failing" ], "description": "Состояние доставки. `failing`: 3 или более последовательных событий завершились неудачей при первой попытке доставки с момента последнего успешного ответа адреса назначения (см. `failing_streak`). `degraded`: не failing, но за последние 24 часа произошла неудачная попытка доставки, и ни одна последующая попытка пока не доставила это событие; повторная попытка или повторная отправка, которая доставит его, сбрасывает этот статус. `healthy`: ни то, ни другое. Не зависит от `enabled`. Неудачной считается попытка, получившая ответ HTTP 400 или выше, либо оставшаяся вовсе без ответа." }, "failing_streak": { "type": "integer", "description": "Количество последовательных событий, первая попытка доставки которых завершилась неудачно с момента последнего успешного ответа адреса назначения за последние 30 дней. Повторные попытки не учитываются, и любая успешная попытка, включая повторную попытку или повторную отправку, прерывает серию. Значение равно `0`, если с момента последнего успеха не было ни одного сбоя." }, "failing_since": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда была совершена первая неудачная попытка из текущей серии ошибок `failing_streak`. `null`, если `failing_streak` равен `0`." }, "last_success_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда адрес назначения в последний раз ответил на доставку с HTTP-статусом ниже 400 за последние 30 дней. `null`, если ответов в этот период не было." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Среда приложения, которому принадлежит адрес назначения." }, "summary": { "type": "object", "properties": { "total_deliveries": { "type": "integer" }, "failed_deliveries": { "type": "integer" }, "error_rate_percentage": { "type": "integer" }, "min_response_time_ms": { "type": "integer", "nullable": true }, "avg_response_time_ms": { "type": "integer", "nullable": true }, "max_response_time_ms": { "type": "integer", "nullable": true }, "last_delivery_at": { "type": "string", "format": "date-time", "nullable": true }, "metrics_window_days": { "type": "integer", "description": "Длина окна в днях, охватываемого остальными сводными метриками. Всегда `30`." } }, "description": "Метрики доставки за последние `metrics_window_days` (30) дней. `last_delivery_at` представляет собой самую последнюю попытку, когда бы она ни выполнялась." } } }, "examples": { "Paused": { "value": { "uuid": "11111111-2222-3333-4444-555555555555", "label": "Production session webhooks", "url": "https://yourapp.com/webhooks/didit", "enabled": false, "webhook_version": "v3", "secret_shared_key": "tno2NTeRC1ZK3sBOYlBJDyEzBVENl3pQ1AcZyAW0xnQ", "secret_last4": "0xnQ", "previous_secret_expires_at": null, "subscribed_events": [ "status.updated", "data.updated" ], "created_by_email": null, "created_by_name": null, "created_at": "2026-01-04T08:00:00Z", "updated_at": "2026-05-17T11:02:55Z", "health_status": "healthy", "failing_streak": 0, "failing_since": null, "last_success_at": "2026-05-17T09:21:18Z", "environment": "live", "summary": { "total_deliveries": 12453, "failed_deliveries": 14, "error_rate_percentage": 0, "min_response_time_ms": 41, "avg_response_time_ms": 187, "max_response_time_ms": 2103, "last_delivery_at": "2026-05-17T09:21:18Z", "metrics_window_days": 30 } } } } } } }, "400": { "description": "Ошибка валидации (дубликат URL, пустой или неизвестный список событий, некорректное тело запроса).", "content": { "application/json": { "examples": { "Duplicate URL": { "value": { "url": [ "This webhook destination already exists for the application." ] } }, "Empty events": { "value": { "subscribed_events": [ "At least one subscribed event is required." ] } } } } } }, "403": { "description": "API-ключ отсутствует, сформирован некорректно, истёк или относится к другому приложению. При отсутствии ключа возвращается `403`; при неверном, отозванном или истёкшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Адрес назначения с таким UUID не существует (или удалён, или принадлежит другому приложению).", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Webhook destination not found." } } } } } }, "429": { "description": "Лимит запросов превышен; снизьте частоту запросов и повторите попытку.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "summary": "Удалить адрес назначения webhook", "description": "Безвозвратно удалить адрес назначения webhook, его секрет подписи и весь журнал доставки. Это действие нельзя отменить. Новые webhook не будут отправляться на URL этого адреса назначения; другие адреса назначения, подписанные на те же события, продолжат их получать. После этого адрес назначения больше не отображается в `GET /v3/webhook/destinations/`, а каждый маршрут в `/v3/webhook/destinations/{destination_uuid}/`, включая его доставки, детализацию доставки и её повторную отправку, возвращает 404. Устаревший `webhook_url` приложения устанавливается в URL самого старого из оставшихся активных адресов назначения или очищается, если активных адресов не осталось. Повторный вызов DELETE возвращает 404.", "operationId": "delete_webhook_destination", "x-didit-sdk": { "resource": "webhooks.destinations", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "parameters": [ { "name": "destination_uuid", "in": "path", "required": true, "description": "UUID удаляемого адреса назначения webhook.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.webhooks.destinations.delete(\n \"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.webhooks.destinations.delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.Webhooks.Destinations.Delete(ctx, \"11111111-2222-3333-4444-555555555555\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.webhooks().destinations().delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->delete('11111111-2222-3333-4444-555555555555');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.webhooks.destinations.delete(\"11111111-2222-3333-4444-555555555555\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.Webhooks.Destinations.DeleteAsync(\"11111111-2222-3333-4444-555555555555\");" } ], "responses": { "204": { "description": "Адрес назначения, секрет подписи и журнал доставки удалены навсегда. Тело ответа отсутствует." }, "403": { "description": "API-ключ отсутствует, сформирован некорректно, истёк или относится к другому приложению. При отсутствии ключа возвращается `403`; при неверном, отозванном или истёкшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Адреса назначения с таким UUID для этого приложения не существует (уже удален или никогда не существовал).", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Webhook destination not found." } } } } } }, "429": { "description": "Лимит запросов превышен; снизьте частоту запросов и повторите попытку.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/wallet-screening/": { "post": { "summary": "Выполнить скрининг адреса", "description": "Запустить AML-скрининг по запросу для отдельного криптокошелька/адреса без создания транзакции. Определяет настроенного для вашего приложения провайдера блокчейн-аналитики, синхронно проверяет адрес и возвращает нормализованный результат риска. Вариант LIGHTNING доступен только при наличии подключения BYOK от Elliptic или Chainalysis, добавленного через Marketplace. В таблицу транзакций ничего не записывается. За каждый успешный скрининг списывается одно использование AML-мониторинга (для приложений в песочнице плата не взимается).", "operationId": "screenWallet", "x-didit-sdk": { "resource": "wallet_screening", "method": "screen", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "wallet_address" ], "properties": { "wallet_address": { "type": "string", "description": "Криптоадрес или сетевой идентификатор для скрининга. Должен соответствовать выбранной сети (например, 40-значный шестнадцатеричный адрес с префиксом `0x` для сетей EVM). Псевдоним: `address`.", "example": "0x94f1b9b64e2932f6a2db338f616844400cd58e8a" }, "blockchain": { "type": "string", "description": "Необязательный идентификатор сети. Если он опущен, сеть определяется по формату адреса: адреса `bc1`, `1` и `3` относятся к Bitcoin (BTC), адреса `T` относятся к Tron (TRX), а открытые ключи base58 относятся к Solana (SOL). Адрес `0x` действителен во всех сетях EVM, поэтому, если для него не указан параметр `blockchain`, возвращается ответ 422 со списком возможных сетей в `candidate_chains`. Управляемый скрининг поддерживает BTC, ETH, LTC, XRP, BCH, DOGE, TRX, SOL, MATIC, BNB, BASE (Base), OP (Optimism), ARB (Arbitrum One), AVAX (Avalanche C-Chain), ADA (Cardano), XLM (Stellar) и HBAR (Hedera). USDT и USDC являются устаревшими псевдонимами Ethereum, а не мультисетевым поиском. Покрытие подключённых провайдеров варьируется. Для LIGHTNING требуется поддерживаемый подключённый провайдер. Скрининг для CELO (Celo), MODE (Mode) и PLUME (Plume) выполняется через подключённый аккаунт TRM Labs; управляемый скрининг возвращает для них 400. Псевдоним: `currency`.", "enum": [ "BTC", "LIGHTNING", "ETH", "LTC", "XRP", "BCH", "DOGE", "TRX", "SOL", "MATIC", "BNB", "USDT", "USDC", "BASE", "OP", "ARB", "AVAX", "ADA", "XLM", "HBAR", "CELO", "MODE", "PLUME" ], "example": "ETH" }, "direction": { "type": "string", "description": "Необязательно. Проверяется ли адрес как входящий (депозит) или исходящий (вывод) контрагент. Принимает значения `inbound`, `outbound`, `deposit` или `withdrawal`. По умолчанию используется нейтральный скрининг перед переводом, если параметр не указан. Это передается провайдеру исключительно в качестве контекста; это не влияет на возвращаемые `risk_score`, `severity` или детализацию `source_of_funds`/`destination_of_funds`, которые возвращаются всегда вне зависимости от `direction`. Таким образом, изменение или пропуск `direction` не требует повторного скрининга адреса.", "enum": [ "inbound", "outbound", "deposit", "withdrawal" ] } } }, "example": { "wallet_address": "0x94f1b9b64e2932f6a2db338f616844400cd58e8a", "blockchain": "ETH" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/wallet-screening/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"wallet_address\": \"0x94f1b9b64e2932f6a2db338f616844400cd58e8a\",\n \"blockchain\": \"ETH\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.wallet_screening.screen(\n wallet_address=\"0x94f1b9b64e2932f6a2db338f616844400cd58e8a\",\n blockchain=\"ETH\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.walletScreening.screen({\n wallet_address: \"0x94f1b9b64e2932f6a2db338f616844400cd58e8a\",\n blockchain: \"ETH\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.WalletScreening.Screen(ctx, didit.WalletScreeningScreenParams{\n\tWalletAddress: \"0x94f1b9b64e2932f6a2db338f616844400cd58e8a\",\n\tBlockchain: didit.Some(didit.WalletScreeningScreenParamsBlockchain(\"ETH\")),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.WalletScreeningScreenParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.walletScreening().screen(WalletScreeningScreenParams.builder()\n .walletAddress(\"0x94f1b9b64e2932f6a2db338f616844400cd58e8a\")\n .blockchain(WalletScreeningScreenParams.Blockchain.of(\"ETH\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "walletScreening->screen([\n 'wallet_address' => '0x94f1b9b64e2932f6a2db338f616844400cd58e8a',\n 'blockchain' => 'ETH',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.wallet_screening.screen(\n wallet_address: \"0x94f1b9b64e2932f6a2db338f616844400cd58e8a\",\n blockchain: \"ETH\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.WalletScreening.ScreenAsync(new WalletScreeningScreenParams\n{\n WalletAddress = \"0x94f1b9b64e2932f6a2db338f616844400cd58e8a\",\n Blockchain = new WalletScreeningScreenParamsBlockchain(\"ETH\"),\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Нормализованный результат скрининга кошелька.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletScreeningResult" }, "example": { "provider": "merklescience", "screening_type": "WALLET_SCREENING", "risk_score": 95, "severity": "CRITICAL", "status": "SCREENED", "summary": "Merkle Science risk: Critical (5/5). SANCTIONS HIT. Dominant risk: sanctioned. Driven by: the address is attributed to Sanctions / OFAC (Example Sanctions)", "wallet_address": "0x94f1b9b64e2932f6a2db338f616844400cd58e8a", "transaction_hash": null, "blockchain": "ETH", "block_timestamp": null, "total_value_usd": null, "fee_usd": null, "sender_rows": [], "receiver_rows": [], "transaction_flows": [], "transaction_flows_status": null, "transaction_flows_error": null, "source_of_funds": [ { "category": "sanctioned", "percentage": 100.0, "amount_usd": 9813695.0, "entity_name": "Example Sanctions", "entity_type": "Sanctions", "entity_subtype": "OFAC", "hops": null, "description": "Sanctions / OFAC", "is_direct": true, "exposure_direction": "incoming", "exposure_type": "direct", "provider_entity_id": "118885", "provider_entity_type_id": "30", "provider_entity_subtype_id": "125", "country": "", "raw_amount": null, "raw_currency": null } ], "destination_of_funds": [ { "category": "defi", "percentage": 84.824453, "amount_usd": 7783414.38, "entity_name": "Example DeFi 7", "entity_type": "DeFi", "entity_subtype": "Bridges", "hops": null, "description": "DeFi / Bridges", "is_direct": false, "exposure_direction": "outgoing", "exposure_type": "indirect", "provider_entity_id": "118459", "provider_entity_type_id": "33", "provider_entity_subtype_id": "143", "country": "", "raw_amount": null, "raw_currency": null }, { "category": "defi", "percentage": 15.175547, "amount_usd": 1392494.37, "entity_name": "Example DeFi 2", "entity_type": "DeFi", "entity_subtype": "Yield Aggregator", "hops": null, "description": "DeFi / Yield Aggregator", "is_direct": false, "exposure_direction": "outgoing", "exposure_type": "indirect", "provider_entity_id": "90192", "provider_entity_type_id": "33", "provider_entity_subtype_id": "142", "country": "", "raw_amount": null, "raw_currency": null } ], "counterparty_connections": [ { "entity_name": "Example Sanctions", "entity_type": "Sanctions", "entity_subtype": "OFAC", "risk_level": "critical", "categories": [ "sanctioned" ], "received_usd": null, "sent_usd": null, "received_hops": null, "sent_hops": null, "percentage": 0.0, "is_direct": true, "country": null, "provider_entity_id": null }, { "entity_name": "Example Sanctions", "entity_type": "Sanctions", "entity_subtype": "OFAC", "risk_level": "critical", "categories": [ "sanctioned" ], "received_usd": null, "sent_usd": null, "received_hops": null, "sent_hops": null, "percentage": 0.0, "is_direct": true, "country": null, "provider_entity_id": null } ], "network_nodes": [], "network_edges": [], "sanctions_hit": true, "pep_counterparty": null, "dominant_risk_category": "sanctioned", "risk_factors": [ { "source": "attribution", "category": "sanctioned", "label": "Sanctions / OFAC", "entity_name": "Example Sanctions", "direction": "attribution", "exposure_type": "attribution", "amount_usd": null, "percentage": 0.0, "is_high_risk": true, "description": "the address is attributed to Sanctions / OFAC (Example Sanctions)" }, { "source": "exposure", "category": "sanctioned", "label": "Sanctions / OFAC", "entity_name": "Example Sanctions", "direction": "incoming", "exposure_type": "direct", "amount_usd": 9813695.0, "percentage": 51.679304, "is_high_risk": true, "description": "51.6793% direct incoming exposure to Sanctions / OFAC (Example Sanctions)" }, { "source": "exposure", "category": "defi", "label": "DeFi / Bridges", "entity_name": "Example DeFi 7", "direction": "outgoing", "exposure_type": "indirect", "amount_usd": 7783414.38, "percentage": 40.987766, "is_high_risk": false, "description": "40.9878% indirect outgoing exposure to DeFi / Bridges (Example DeFi 7)" }, { "source": "exposure", "category": "defi", "label": "DeFi / Yield Aggregator", "entity_name": "Example DeFi 2", "direction": "outgoing", "exposure_type": "indirect", "amount_usd": 1392494.37, "percentage": 7.33293, "is_high_risk": false, "description": "7.33293% indirect outgoing exposure to DeFi / Yield Aggregator (Example DeFi 2)" } ], "raw_response": { "...": "provider-specific details" }, "report_signature": "" } } } }, "400": { "description": "Ошибка валидации — некорректный адрес кошелька, отсутствует `wallet_address`, неподдерживаемый `blockchain`, `blockchain` не указан для адреса, формат которого не определяет сеть, или LIGHTNING без подключения к Elliptic или Chainalysis BYOK Marketplace." }, "401": { "description": "Отсутствует или недействителен `x-api-key`." }, "409": { "description": "Для приложения не настроен AML-провайдер, либо настроенный провайдер пока не поддерживает скрининг кошельков. Сначала настройте мониторинг транзакций." }, "422": { "description": "`blockchain` опущен для адреса `0x`, который является общим для всех сетей EVM. Скрининг не проводится, и плата не взимается; отправьте запрос повторно, указав в `blockchain` одну из сетей из `candidate_chains`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "blockchain": { "type": "array", "items": { "type": "string" }, "example": [ "A 0x address is valid on every EVM chain. Send blockchain as one of: ETH, BNB, MATIC, BASE, ARB, OP, CELO, MODE, PLUME." ] }, "candidate_chains": { "type": "array", "items": { "type": "string" }, "example": [ "ETH", "BNB", "MATIC", "BASE", "ARB", "OP", "CELO", "MODE", "PLUME" ] } } } } } }, "502": { "description": "AML-провайдер не смог завершить скрининг. Повторите попытку позже." } } } }, "/v3/wallet-screening/pdf/": { "post": { "summary": "Сформировать результат скрининга кошельков в формате PDF", "description": "Дополнение без сохранения состояния к `POST /v3/wallet-screening/`: отправьте повторно точное тело JSON, возвращённое этим endpoint — включая добавленную им `report_signature` — и получите фирменный PDF Didit с тем же результатом. Провайдеры не вызываются, плата не взимается и данные не сохраняются; выполняется лишь повторный рендеринг результата, ранее сформированного Didit. Подпись привязывает PDF к неизменённому результату: изменение `risk_score`, `severity`, `sanctions_hit` или любого другого подписанного поля перед повторной отправкой приведёт к ошибке `400`.", "operationId": "screenWalletPdf", "x-didit-sdk": { "resource": "wallet_screening", "method": "screen_pdf", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "description": "Неизменённый JSON-объект, возвращённый `POST /v3/wallet-screening/`, включая `report_signature`.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WalletScreeningResult" } ], "required": [ "report_signature" ], "description": "Та же структура, что и в ответе `POST /v3/wallet-screening/` — передайте тело этого ответа без изменений, включая `report_signature`." } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "# $RESULT is the saved JSON body from POST /v3/wallet-screening/\ncurl -X POST 'https://verification.didit.me/v3/wallet-screening/pdf/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d \"$RESULT\" \\\n -o wallet_screening_report.pdf" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\ncontent = client.wallet_screening.screen_pdf(\n provider=\"your-provider\",\n screening_type=\"WALLET_SCREENING\",\n risk_score=1,\n severity=\"UNKNOWN\",\n status=\"SCREENED\",\n summary=\"your-summary\",\n wallet_address=\"your-wallet-address\",\n blockchain=\"your-blockchain\",\n source_of_funds=[{}],\n destination_of_funds=[{}],\n counterparty_connections=[{}],\n sanctions_hit=True,\n dominant_risk_category=\"your-dominant-risk-category\",\n report_signature=\"your-report-signature\",\n)\nwith open(\"download.pdf\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst content = await didit.walletScreening.screenPdf({\n provider: \"your-provider\",\n screening_type: \"WALLET_SCREENING\",\n risk_score: 1,\n severity: \"UNKNOWN\",\n status: \"SCREENED\",\n summary: \"your-summary\",\n wallet_address: \"your-wallet-address\",\n blockchain: \"your-blockchain\",\n source_of_funds: [{}],\n destination_of_funds: [{}],\n counterparty_connections: [{}],\n sanctions_hit: true,\n dominant_risk_category: \"your-dominant-risk-category\",\n report_signature: \"your-report-signature\",\n});\nawait writeFile(\"download.pdf\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresp, err := client.WalletScreening.ScreenPDF(ctx, didit.WalletScreeningResultParam{\n\tProvider: \"your-provider\",\n\tScreeningType: \"WALLET_SCREENING\",\n\tRiskScore: 1,\n\tSeverity: \"UNKNOWN\",\n\tStatus: \"SCREENED\",\n\tSummary: \"your-summary\",\n\tWalletAddress: \"your-wallet-address\",\n\tBlockchain: \"your-blockchain\",\n\tSourceOfFunds: []didit.WalletScreeningResultParamSourceOfFunds{{}},\n\tDestinationOfFunds: []didit.WalletScreeningResultParamDestinationOfFunds{{}},\n\tCounterpartyConnections: []didit.WalletScreeningResultParamCounterpartyConnections{{}},\n\tSanctionsHit: true,\n\tDominantRiskCategory: didit.String(\"your-dominant-risk-category\"),\n\tReportSignature: \"your-report-signature\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.pdf\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.WalletScreeningResult;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.walletScreening().screenPdf(WalletScreeningResult.builder()\n .provider(\"your-provider\")\n .screeningType(WalletScreeningResult.ScreeningType.of(\"WALLET_SCREENING\"))\n .riskScore(1L)\n .severity(WalletScreeningResult.Severity.of(\"UNKNOWN\"))\n .status(WalletScreeningResult.Status.of(\"SCREENED\"))\n .summary(\"your-summary\")\n .walletAddress(\"your-wallet-address\")\n .blockchain(\"your-blockchain\")\n .sourceOfFunds(List.of(WalletScreeningResult.SourceOfFunds.builder()\n .build()))\n .destinationOfFunds(List.of(WalletScreeningResult.DestinationOfFunds.builder()\n .build()))\n .counterpartyConnections(List.of(WalletScreeningResult.CounterpartyConnections.builder()\n .build()))\n .sanctionsHit(true)\n .dominantRiskCategory(\"your-dominant-risk-category\")\n .reportSignature(\"your-report-signature\")\n .build())\n .writeTo(Path.of(\"download.pdf\"));" }, { "lang": "php", "label": "PHP", "source": "walletScreening->screenPdf([\n 'provider' => 'your-provider',\n 'screening_type' => 'WALLET_SCREENING',\n 'risk_score' => 1,\n 'severity' => 'UNKNOWN',\n 'status' => 'SCREENED',\n 'summary' => 'your-summary',\n 'wallet_address' => 'your-wallet-address',\n 'blockchain' => 'your-blockchain',\n 'source_of_funds' => [[]],\n 'destination_of_funds' => [[]],\n 'counterparty_connections' => [[]],\n 'sanctions_hit' => true,\n 'dominant_risk_category' => 'your-dominant-risk-category',\n 'report_signature' => 'your-report-signature',\n]);\n$content->saveTo('download.pdf');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ncontent = didit.wallet_screening.screen_pdf(\n provider: \"your-provider\",\n screening_type: \"WALLET_SCREENING\",\n risk_score: 1,\n severity: \"UNKNOWN\",\n status: \"SCREENED\",\n summary: \"your-summary\",\n wallet_address: \"your-wallet-address\",\n blockchain: \"your-blockchain\",\n source_of_funds: [{}],\n destination_of_funds: [{}],\n counterparty_connections: [{}],\n sanctions_hit: true,\n dominant_risk_category: \"your-dominant-risk-category\",\n report_signature: \"your-report-signature\"\n)\nFile.binwrite(\"download.pdf\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar content = await client.WalletScreening.ScreenPdfAsync(new WalletScreeningResult\n{\n Provider = \"your-provider\",\n ScreeningType = \"WALLET_SCREENING\",\n RiskScore = 1,\n Severity = \"UNKNOWN\",\n Status = \"SCREENED\",\n Summary = \"your-summary\",\n WalletAddress = \"your-wallet-address\",\n Blockchain = \"your-blockchain\",\n SourceOfFunds = new WalletScreeningResultSourceOfFunds[] { new() },\n DestinationOfFunds = new WalletScreeningResultDestinationOfFunds[] { new() },\n CounterpartyConnections = new WalletScreeningResultCounterpartyConnections[] { new() },\n SanctionsHit = true,\n DominantRiskCategory = \"your-dominant-risk-category\",\n ReportSignature = \"your-report-signature\",\n});\nawait content.SaveToAsync(\"download.pdf\");" } ], "responses": { "200": { "description": "Сформированный PDF-документ, возвращаемый напрямую как бинарные данные `application/pdf` — без обёртки JSON.", "headers": { "Content-Disposition": { "description": "`attachment; filename=wallet_screening_{address}.pdf`, сформированное на основе `wallet_address` (или `transaction_hash`) в повторно отправленном результате.", "schema": { "type": "string", "example": "attachment; filename=wallet_screening_0x28c6c06298d514db0899.pdf" } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Тело запроса не является JSON-объектом, соответствующим структуре результата скрининга кошельков, либо `report_signature` отсутствует или не совпадает с повторно отправленными полями (было изменено или усечено перед повторной отправкой).", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Not an object": { "value": { "non_field_errors": [ "Expected a JSON object matching a wallet-screening result." ] } }, "Missing or invalid signature": { "value": { "report_signature": [ "This wallet-screening result is missing or fails its report signature - repost the exact JSON returned by the wallet-screening endpoint, unmodified." ] } } } } } }, "401": { "description": "Отсутствует или недействителен `x-api-key`." } } } }, "/v3/transactions/": { "get": { "summary": "Получить список транзакций", "description": "Список отслеживаемых транзакций с пагинацией, сначала новые (`txn_date` desc). Значение `count` ограничено 100; используйте `total_transactions` для получения точного количества строк. Этот endpoint не поддерживает параметры фильтрации или поиска.", "operationId": "listTransactions", "x-didit-sdk": { "resource": "transactions", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "description": "Размер страницы. По умолчанию 50, если не указан. Жёсткого максимума нет, но рекомендуется оставлять страницы небольшими для уменьшения задержки." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "description": "Смещение первой возвращаемой записи, начиная с нуля. Рекомендуется переходить по URL `next` с предыдущей страницы." }, { "name": "travel_rule_status", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Возвращает только те транзакции, перевод Travel Rule которых находится именно в этом статусе (например, `ON_HOLD` или `AWAITING_COUNTERPARTY`). Значение `count` учитывает этот фильтр; `total_transactions` по-прежнему считает все транзакции в приложении." }, { "name": "assignee", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Разделены запятыми; транзакция соответствует при совпадении с любым значением. `unassigned` означает то, что ещё ни за кем не закреплено, `rules` означает то, по чему правила вынесли решение самостоятельно без проверяющего, а email участника сопоставляется с назначенным проверяющим. `me` означает вошедшего в Console проверяющего, поэтому API-ключ, отправляющий `me`, возвращает `400`." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/transactions/?limit=50' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.transactions.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.transactions.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Transactions.ListAutoPaging(ctx, didit.TransactionsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.transactions().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "transactions->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.transactions.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Transactions.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Список сводок по транзакциям с пагинацией, сначала новые.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Ограниченное количество подходящих транзакций (точное значение до 100, далее ограничено). Используйте `total_transactions` для получения точного количества при пагинации." }, "next": { "type": "string", "nullable": true, "description": "Абсолютный URL следующей страницы или `null` на последней странице." }, "previous": { "type": "string", "nullable": true, "description": "Абсолютный URL предыдущей страницы или `null` на первой странице." }, "total_transactions": { "type": "integer", "description": "Точное общее количество (неудалённых) транзакций приложения. Присутствует в постраничных ответах." }, "results": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Постоянный идентификатор транзакции Didit. Используйте как `{transaction_id}` в вызовах для получения деталей, заметок и связанных данных." }, "transaction_number": { "type": "integer", "description": "Порядковый номер транзакции в рамках приложения, отображаемый в консоли (например, `4123`)." }, "txn_id": { "type": "string", "description": "Идентификатор, предоставленный клиентом при вызове создания (максимум 128 символов). Уникален в рамках приложения." }, "transaction_type": { "type": "string", "description": "Категория верхнего уровня в том виде, в котором она сохранена: `finance`, `kyc`, `travelRule`, `userPlatformEvent`, `gamblingBet`, `gamblingLimitChange`, `gamblingBonusChange`, `auditTrailEvent`. Обратите внимание, что значения из нескольких слов возвращаются в camelCase, даже если они были переданы в snake_case." }, "action_type": { "type": "string", "description": "Подтип внутри категории (например, `deposit`, `withdrawal`, `transfer`)." }, "status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Текущий вердикт мониторинга." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Направление относительно субъекта. Сохраняется в верхнем регистре независимо от переданного регистра." }, "amount": { "type": "string", "description": "Сумма транзакции в виде десятичной строки без завершающих нулей (например, `\"1500\"`, `\"0.5\"`, `\"0.123456789012345678\"`). До 18 знаков после запятой." }, "currency": { "type": "string", "description": "Код валюты для `amount`. Принимается любой буквенный код ISO 4217 (например, `EUR`, `USD`, `NGN`), а также символ криптоактива (например, `BTC`). Предпочтительно использовать находящийся в обращении код. Не для каждого принятого кода доступен обменный курс: если для кода курс отсутствует (например, расчетная единица ISO `XSU` или символ криптовалюты, для которого Didit не рассчитывает цену), автоматическая конвертация завершается ошибкой и `preferred_currency_amount` возвращается со значением null, если только в запросе не был передан предварительно сконвертированный `amount_in_default_currency`." }, "preferred_currency_amount": { "type": "string", "nullable": true, "description": "Значение `amount`, конвертированное в предпочтительную валюту приложения, если доступно." }, "preferred_currency_code": { "type": "string", "nullable": true, "description": "Предпочтительный код валюты, используемый для `preferred_currency_amount` - базовая валюта приложения, любой код ISO 4217, находящийся в обращении в настоящее время. При отсутствии доступного обменного курса для кода `preferred_currency_amount` остаётся null, если только в запросе не была передана предварительно сконвертированная `amount_in_default_currency`." }, "payment_details": { "type": "string", "nullable": true, "description": "Назначение платежа или примечание из отправленных данных в виде произвольного текста." }, "score": { "type": "integer", "description": "Оценка риска (обычно 0–100). Выше = рискованнее." }, "severity": { "type": "string", "nullable": true, "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "description": "Категориальный уровень риска, установленный правилами/провайдерами (`UNKNOWN`, `LOW`, `MEDIUM`, `HIGH`, `CRITICAL`). `null`, пока он не будет задан." }, "subject_name": { "type": "string", "nullable": true, "description": "Полное имя стороны `APPLICANT`." }, "subject_vendor_data": { "type": "string", "nullable": true, "description": "Ваш внутренний идентификатор пользователя/бизнеса для заявителя." }, "subject_country": { "type": "string", "nullable": true, "description": "Код страны заявителя из переданного `address.country` (обычно ISO 3166-1 alpha-3)." }, "counterparty_name": { "type": "string", "nullable": true, "description": "Полное имя стороны `COUNTERPARTY`, если применимо." }, "counterparty_vendor_data": { "type": "string", "nullable": true, "description": "Ваш внутренний идентификатор контрагента." }, "counterparty_country": { "type": "string", "nullable": true, "description": "Код страны контрагента из переданного `address.country`." }, "tags": { "type": "array", "description": "Теги, прикрепленные к транзакции (вручную или правилами).", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "color": { "type": "string" }, "description": { "type": "string", "nullable": true }, "source": { "type": "string", "enum": [ "didit", "custom" ], "description": "Является ли тег предустановленным тегом Didit или пользовательским." } } } }, "txn_date": { "type": "string", "format": "date-time", "description": "Когда произошла транзакция (из `transaction_at` при создании)." }, "created_at": { "type": "string", "format": "date-time", "description": "Когда Didit зафиксировал отправку." }, "decision_reason_code": { "type": "string", "nullable": true, "description": "Машиночитаемая причина текущего `status` (например, `WALLET_HIGH_RISK`)." }, "decision_reason_label": { "type": "string", "nullable": true, "description": "Понятная метка для `decision_reason_code`." }, "assigned_to_name": { "type": "string", "nullable": true, "description": "Отображаемое имя проверяющего в Console, назначенного на эту транзакцию." }, "travel_rule_status": { "type": "string", "nullable": true, "description": "Статус передачи Travel Rule для транзакции (например, `COMPLETED`), или `null`, если её нет." }, "travel_rule": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/TransactionTravelRule" } ], "description": "Перевод Travel Rule транзакции, тот же блок, что и `travel_rule` в `GET /v3/transactions/{transaction_id}/`, или `null`, если у транзакции его нет." } } } } } }, "examples": { "Single transaction": { "value": { "count": 1, "next": null, "previous": null, "total_transactions": 1, "results": [ { "uuid": "abcdef12-3456-4890-abcd-ef1234567890", "transaction_number": 4123, "txn_id": "your-txn-2026-05-17-001", "transaction_type": "finance", "action_type": "withdrawal", "status": "IN_REVIEW", "direction": "OUTBOUND", "amount": "1500", "currency": "EUR", "preferred_currency_amount": "1620.45", "preferred_currency_code": "USD", "payment_details": "Withdrawal to crypto wallet", "txn_date": "2026-05-17T08:42:00Z", "created_at": "2026-05-17T08:42:11Z", "score": 78, "severity": "HIGH", "decision_reason_code": "WALLET_HIGH_RISK", "decision_reason_label": "Destination wallet flagged as high risk", "tags": [ { "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "name": "Manual review", "color": "#F59E0B", "description": null, "source": "custom" } ], "subject_name": "Maria Garcia", "subject_vendor_data": "user-12345", "counterparty_name": null, "counterparty_vendor_data": null, "counterparty_country": null, "subject_country": null, "assigned_to_name": "Alex Reviewer", "travel_rule_status": null, "travel_rule": null } ] } } } } } }, "403": { "description": "Отсутствующий, недействительный или отозванный API-ключ, либо у ключа нет прав на получение списка транзакций для этого приложения. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Лимит запросов превышен; снизьте частоту запросов и повторите попытку через интервал, указанный в `Retry-After`.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Создать транзакцию", "description": "Отправьте транзакцию для синхронного AML/риск-мониторинга. Транзакция создается со статусом `APPROVED`, затем ваши правила (и криптоскрининг, если применимо) выполняются синхронно и могут изменить возвращаемый `status` на `IN_REVIEW` или `DECLINED`. **`transaction_id` является вашим ключом идемпотентности** (макс. 128 символов, уникальный для каждого приложения); его повторное использование возвращает 400. При успешном выполнении для продакшн-приложений отправляется webhook `transaction.created`. За приложения в песочнице плата не взимается, и они не отправляют webhook `transaction.created` или `transaction.status.updated`. Обмены в рамках Travel Rule в песочнице отправляют webhook `travel_rule.status.updated` со значением `environment: sandbox`. Перевод Travel Rule сохраняется и возвращается до обращения к какому-либо контрагенту: `travel_rule.status` возвращается как `AWAITING_COUNTERPARTY` (или `NOT_APPLICABLE` ниже вашего порога, `UNCONFIRMED_OWNERSHIP` для заявленного некастодиального кошелька, `COMPLETED`, когда второй кошелёк является вашим собственным проверенным кошельком), а `travel_rule.protocol` имеет значение null. Затем Didit выбирает канал и отправляет обмен, а каждое последующее изменение статуса перевода, включая `COUNTERPARTY_VASP_NOT_FOUND`, когда ни один канал не может связаться с контрагентом, поступает в виде webhook `travel_rule.status.updated`. Ваши правила выполняются повторно при изменении канала или статуса.", "operationId": "createTransaction", "tags": [ "Transactions" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/transactions/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"transaction_id\": \"your-txn-2026-05-17-001\",\n \"transaction_category\": \"finance\",\n \"transaction_details\": {\n \"direction\": \"outbound\",\n \"amount\": 1500,\n \"currency\": \"EUR\",\n \"action_type\": \"withdrawal\"\n },\n \"subject\": {\n \"entity_type\": \"individual\",\n \"vendor_data\": \"user-12345\",\n \"full_name\": \"Maria Garcia\"\n }\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.create(\n transaction_id=\"your-txn-2026-05-17-001\",\n transaction_category=\"finance\",\n transaction_details={\n \"direction\": \"outbound\",\n \"amount\": 1500.0,\n \"currency\": \"EUR\",\n \"action_type\": \"withdrawal\",\n },\n subject={\n \"entity_type\": \"individual\",\n \"vendor_data\": \"user-12345\",\n \"full_name\": \"Maria Garcia\",\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.create({\n transaction_id: \"your-txn-2026-05-17-001\",\n transaction_category: \"finance\",\n transaction_details: {\n direction: \"outbound\",\n amount: 1500.0,\n currency: \"EUR\",\n action_type: \"withdrawal\",\n },\n subject: {\n entity_type: \"individual\",\n vendor_data: \"user-12345\",\n full_name: \"Maria Garcia\",\n },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Create(ctx, didit.TransactionsCreateParams{\n\tTransactionID: \"your-txn-2026-05-17-001\",\n\tTransactionCategory: \"finance\",\n\tTransactionDetails: didit.TransactionsCreateParamsTransactionDetails{\n\t\tDirection: \"outbound\",\n\t\tAmount: 1500.0,\n\t\tCurrency: \"EUR\",\n\t\tActionType: didit.String(\"withdrawal\"),\n\t},\n\tSubject: didit.TransactionsCreateParamsSubject{\n\t\tEntityType: didit.String(\"individual\"),\n\t\tVendorData: \"user-12345\",\n\t\tFullName: \"Maria Garcia\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TransactionsCreateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().create(TransactionsCreateParams.builder()\n .transactionId(\"your-txn-2026-05-17-001\")\n .transactionCategory(TransactionsCreateParams.TransactionCategory.of(\"finance\"))\n .transactionDetails(TransactionsCreateParams.TransactionDetails.builder()\n .direction(TransactionsCreateParams.TransactionDetails.Direction.of(\"outbound\"))\n .amount(1500.0)\n .currency(\"EUR\")\n .actionType(\"withdrawal\")\n .build())\n .subject(TransactionsCreateParams.Subject.builder()\n .entityType(\"individual\")\n .vendorData(\"user-12345\")\n .fullName(\"Maria Garcia\")\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->create([\n 'transaction_id' => 'your-txn-2026-05-17-001',\n 'transaction_category' => 'finance',\n 'transaction_details' => [\n 'direction' => 'outbound',\n 'amount' => 1500.0,\n 'currency' => 'EUR',\n 'action_type' => 'withdrawal',\n ],\n 'subject' => [\n 'entity_type' => 'individual',\n 'vendor_data' => 'user-12345',\n 'full_name' => 'Maria Garcia',\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.create(\n transaction_id: \"your-txn-2026-05-17-001\",\n transaction_category: \"finance\",\n transaction_details: {\n direction: \"outbound\",\n amount: 1500.0,\n currency: \"EUR\",\n action_type: \"withdrawal\",\n },\n subject: {\n entity_type: \"individual\",\n vendor_data: \"user-12345\",\n full_name: \"Maria Garcia\",\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.CreateAsync(new TransactionsCreateParams\n{\n TransactionId = \"your-txn-2026-05-17-001\",\n TransactionCategory = \"finance\",\n TransactionDetails = new()\n {\n Direction = \"outbound\",\n Amount = 1500.0,\n Currency = \"EUR\",\n ActionType = \"withdrawal\",\n },\n Subject = new()\n {\n EntityType = \"individual\",\n VendorData = \"user-12345\",\n FullName = \"Maria Garcia\",\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "transaction_id": { "type": "string", "description": "Ваш уникальный идентификатор этой транзакции (не более 128 символов).", "example": "your-txn-2026-05-17-001" }, "transaction_at": { "type": "string", "format": "date-time", "description": "Когда произошла транзакция. По умолчанию текущее время, если значение не указано." }, "time_zone": { "type": "string", "description": "Идентификатор часового пояса IANA, например `Europe/Madrid`." }, "transaction_category": { "type": "string", "description": "Категория транзакции. Псевдонимы в CamelCase (`travelRule`, `userPlatformEvent`, `gamblingBet`, …) также принимаются; сохраняемое/возвращаемое значение приводится к camelCase для категорий из нескольких слов.", "example": "finance", "enum": [ "finance", "kyc", "travel_rule", "user_event", "audit_trail_event", "gambling_bet", "gambling_limit_change", "gambling_bonus_change", "travelRule" ] }, "transaction_details": { "type": "object", "description": "Основные финансовые реквизиты транзакции.", "required": [ "direction", "amount", "currency" ], "properties": { "direction": { "type": "string", "description": "Направление транзакции относительно субъекта. Регистронезависимо; `in`/`out` принимаются в качестве псевдонимов. Возвращается в верхнем регистре (`INBOUND`/`OUTBOUND`).", "example": "outbound", "enum": [ "inbound", "outbound", "in", "out" ] }, "amount": { "type": "number", "description": "Сумма транзакции (до 18 знаков после запятой). Отправляйте её в виде десятичной строки (например, `\"0.123456789012345678\"`), если важна точность: число JSON сначала парсится как двоичное число с плавающей запятой, поэтому цифры сверх примерно 15 значащих знаков округляются до сохранения суммы. Должна быть нулём или больше: знак определяется направлением, а отрицательная сумма возвращает `400`.", "example": 1500 }, "currency": { "type": "string", "description": "Код валюты. Принимается любой буквенный код ISO 4217 (например, `EUR`, `USD`, `NGN`), а также символ криптоактива (например, `BTC`). Предпочтительно использовать находящийся в обращении код. Не для каждого принятого кода доступен обменный курс: если для кода курс отсутствует (например, расчетная единица ISO `XSU` или символ криптовалюты, для которого Didit не рассчитывает цену), автоматическая конвертация завершается ошибкой и `preferred_currency_amount` возвращается со значением null, если только в запросе не был передан предварительно сконвертированный `amount_in_default_currency`.", "example": "EUR" }, "currency_kind": { "type": "string", "description": "Является ли валюта `fiat` или `crypto`." }, "amount_in_default_currency": { "type": "number", "nullable": true, "description": "Предварительно сконвертированная сумма в валюте по умолчанию. Если поле опущено, предпринимается попытка автоматической конвертации валют (FX). Должна быть нулём или больше." }, "default_currency": { "type": "string", "description": "Код валюты по умолчанию для сконвертированной суммы. Любой находящийся в обращении код ISO 4217." }, "payment_details": { "type": "string", "nullable": true, "description": "Назначение платежа или примечание в виде произвольного текста." }, "payment_reference_id": { "type": "string", "nullable": true, "description": "Внешний идентификатор платёжной системы. Для AML-скрининга криптовалютных транзакций по хэшу транзакции отправьте хэш блокчейн-транзакции, а также укажите связанный адрес в `subject.payment_method.account_id`." }, "action_type": { "type": "string", "nullable": true, "description": "Подтип транзакции, например `deposit`, `withdrawal`, `transfer`." }, "crypto_params": { "type": "object", "description": "Выбор криптосети, отдельно от валюты (символа актива). Указание пользовательского символа токена не гарантирует покрытие хеша транзакции для его контракта.", "properties": { "crypto_chain": { "type": "string", "description": "Фактическая сеть, использованная для скрининга. Управляемый скрининг поддерживает BTC, ETH, LTC, XRP, BCH, DOGE, TRX, SOL, MATIC, BNB, BASE (Base), OP (Optimism), ARB (Arbitrum One), AVAX (Avalanche C-Chain), ADA (Cardano), XLM (Stellar) и HBAR (Hedera). Также принимаются распространённые названия сетей, например POLYGON или POL для MATIC, BSC для BNB и TRON для TRX. Всегда указывайте это поле для токенов, работающих в нескольких сетях. Если оно отсутствует для USDT, USDC или ETH, переданных с 0x-хешем транзакции, Didit ищет этот хеш в Ethereum, BNB Chain, Polygon, Base, Arbitrum и Optimism и выполняет скрининг в той сети, где он найден; если транзакция не найдена ни в одной сети, скрининг транзакции не выполняется, а custom_values.aml_screening_status принимает значение FAILED с причиной в custom_values.aml_screening_error. Если оно отсутствует для USDT или USDC, проверяемых по кошельку (без хеша транзакции), адрес Tron проверяется в Tron, адрес Solana проверяется в Solana, а 0x-адрес проверяется в первой из этих шести сетей, где он отправлял транзакцию или хранит токен, либо в Ethereum, если он не активен ни в одной из них. Покрытие подключённых провайдеров различается; для LIGHTNING требуется поддерживаемый подключённый провайдер.", "example": "BASE" } } } } }, "subject": { "type": "object", "description": "Субъект (заявитель) транзакции.", "required": [ "vendor_data", "full_name" ], "properties": { "entity_type": { "type": "string", "description": "Тип сущности: `individual` или `company`." }, "vendor_data": { "type": "string", "description": "Ваш внутренний идентификатор пользователя/бизнеса.", "example": "user-12345" }, "full_name": { "type": "string", "description": "Полное имя субъекта.", "example": "Maria Garcia" }, "first_name": { "type": "string", "description": "Имя субъекта." }, "last_name": { "type": "string", "description": "Фамилия субъекта." }, "date_of_birth": { "type": "string", "format": "date", "description": "Дата рождения (ГГГГ-ММ-ДД)." }, "address": { "type": "object", "description": "Объект адреса.", "properties": { "country": { "type": "string", "description": "Код страны (рекомендуется ISO 3166-1 alpha-3). Копируется в `country_code` стороны." }, "town": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" }, "post_code": { "type": "string" } } }, "institution_details": { "type": "object", "description": "Сведения об учреждении (для институциональных субъектов).", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "address": { "type": "object" } } }, "device_context": { "type": "object", "description": "Контекст устройства, зафиксированный в момент транзакции. browser_family и platform должны передаваться как явные ключи верхнего уровня — они не извлекаются из user_agent. В запросе также поддерживается псевдоним в camelCase device.", "properties": { "fingerprint": { "type": "string", "description": "Уникальный цифровой отпечаток устройства." }, "persistent_device_id": { "type": "string", "description": "Постоянный межсессионный идентификатор устройства (схема фингерпринта v2)." }, "user_agent": { "type": "string", "description": "Строка user agent браузера или приложения. Псевдоним в CamelCase: userAgent." }, "browser_family": { "type": "string", "description": "Семейство браузеров (например, Chrome, Firefox, Safari). Должно передаваться явно — оно не извлекается из user_agent. Псевдоним в CamelCase: browserFamily." }, "browser_version": { "type": "string", "description": "Строка версии браузера. Должна передаваться явно. Псевдоним в CamelCase: browserVersion." }, "platform": { "type": "string", "description": "Идентификатор платформы (web, ios, android, macos, windows, linux). Должен передаваться явно — он не извлекается из user_agent." }, "os_family": { "type": "string", "description": "Семейство операционной системы (например, iOS, Android, Windows). Псевдоним в CamelCase: osFamily." }, "os_version": { "type": "string", "description": "Строка версии операционной системы. Псевдоним в CamelCase: osVersion." }, "accept_language": { "type": "string", "description": "Значение заголовка Accept-Language. Псевдоним в CamelCase: acceptLang." }, "session_id": { "type": "string", "description": "Идентификатор текущей сессии пользователя. Сохраняется в метаданных. Псевдоним в CamelCase: sessionId." }, "session_age_ms": { "type": "number", "description": "Возраст сессии пользователя в миллисекундах на момент транзакции. Псевдоним в camelCase: sessionAgeMs." }, "network_context": { "type": "object", "description": "Сетевой контекст с IP-адресом и геолокацией. Блок ipInfo верхнего уровня также включён в этот объект.", "properties": { "ip_address": { "type": "string", "description": "IP-адрес клиента. Псевдоним в CamelCase: ip." }, "ip_country_code": { "type": "string", "description": "Страна, определённая по IP (ISO 3166-1 alpha-3). Псевдоним в CamelCase: countryCode3." }, "latitude": { "type": "number", "description": "Географическая широта IP-адреса. Псевдоним в CamelCase: lat." }, "longitude": { "type": "number", "description": "Географическая долгота IP-адреса. Псевдоним в CamelCase: lon." } } } } }, "payment_method": { "type": "object", "description": "Способ оплаты, используемый субъектом.", "properties": { "method_type": { "type": "string", "description": "Тип способа оплаты: `bank_card`, `bank_account`, `crypto_wallet`, `ewallet`, `unhosted_wallet`, `other`." }, "account_id": { "type": "string", "description": "Идентификатор счёта (например, IBAN, адрес). Для криптовалютного скрининга это поле должно содержать адрес данного участника. Для входящего скрининга по хешу транзакции требуется депозитный адрес сервиса/клиента у субъекта. Для исходящего скрининга используется адрес назначения у контрагента. При криптовалютном переводе в сети bitcoin или Lightning это может быть платёжный запрос Lightning (инвойс BOLT11, предложение BOLT12, LNURL) или Lightning Address: Didit сохраняет указанного в нём получателя в качестве счёта (\"\", если получатель не указан), а также данные запроса в поле `chain_details.lightning` перевода Travel Rule. Не более 255 символов после сохранения. При криптовалютном переводе в сети bitcoin или Lightning это может быть платёжный запрос Lightning (инвойс BOLT11, предложение BOLT12, LNURL) или Lightning Address: Didit сохраняет указанного в нём получателя в качестве счёта (\"\", если получатель не указан), а также данные запроса в поле `chain_details.lightning` перевода Travel Rule. Не более 255 символов после сохранения." }, "memo": { "type": "string", "maxLength": 256, "description": "Destination tag или memo, являющиеся частью кошелька в сети с поддержкой memo (XRP, XLM, EOS, ATOM, HBAR). На одном общем адресе биржи каждое memo представляет собой отдельный способ оплаты. XRP: destination tag, целое число от 0 до 4294967295 (принимается число JSON). XLM: текстовое memo длиной до 28 байт, 64-битный id или 32-байтный хеш в шестнадцатеричном виде. EOS: до 256 байт. ATOM: до 256 символов. HBAR: до 100 байт. Кошельки Bitcoin, EVM, Solana, Tron, Litecoin, Bitcoin Cash, Dogecoin и Lightning не поддерживают memo: их передача приведёт к ошибке `400`. Псевдоним: `destinationTag` или `destination_tag`." }, "issuing_country": { "type": "string", "description": "Код страны эмитента по стандарту ISO 3166-1 alpha-3." } } } } }, "counterparty": { "type": "object", "description": "Контрагент транзакции (необязательно).", "properties": { "entity_type": { "type": "string", "description": "Тип сущности: `individual` или `company`." }, "vendor_data": { "type": "string", "description": "Ваш внутренний идентификатор контрагента." }, "full_name": { "type": "string", "description": "Полное имя контрагента." }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "date_of_birth": { "type": "string", "format": "date" }, "address": { "type": "object", "description": "Объект адреса с `country` (ISO 3166-1 alpha-3)." }, "institution_details": { "type": "object" }, "device_context": { "type": "object", "description": "Контекст устройства для контрагента. browser_family и platform должны передаваться как явные ключи верхнего уровня — они не определяются из user_agent.", "properties": { "fingerprint": { "type": "string", "description": "Уникальный цифровой отпечаток устройства." }, "persistent_device_id": { "type": "string", "description": "Постоянный межсессионный идентификатор устройства (схема фингерпринта v2)." }, "user_agent": { "type": "string", "description": "Строка user agent браузера или приложения. Псевдоним в CamelCase: userAgent." }, "browser_family": { "type": "string", "description": "Семейство браузеров (например, Chrome, Firefox, Safari). Должно передаваться явно — оно не извлекается из user_agent. Псевдоним в CamelCase: browserFamily." }, "browser_version": { "type": "string", "description": "Строка версии браузера. Должна передаваться явно. Псевдоним в CamelCase: browserVersion." }, "platform": { "type": "string", "description": "Идентификатор платформы (web, ios, android, macos, windows, linux). Должен передаваться явно — он не извлекается из user_agent." }, "os_family": { "type": "string", "description": "Семейство операционной системы (например, iOS, Android, Windows). Псевдоним в CamelCase: osFamily." }, "os_version": { "type": "string", "description": "Строка версии операционной системы. Псевдоним в CamelCase: osVersion." }, "accept_language": { "type": "string", "description": "Значение заголовка Accept-Language. Псевдоним в CamelCase: acceptLang." }, "session_id": { "type": "string", "description": "Идентификатор сессии контрагента. Сохраняется в метаданных. Псевдоним в CamelCase: sessionId." }, "session_age_ms": { "type": "number", "description": "Возраст сессии пользователя в миллисекундах на момент транзакции. Псевдоним в camelCase: sessionAgeMs." }, "network_context": { "type": "object", "description": "Сетевой контекст с IP-адресом и геолокацией. Блок ipInfo верхнего уровня также включён в этот объект.", "properties": { "ip_address": { "type": "string", "description": "IP-адрес клиента. Псевдоним в CamelCase: ip." }, "ip_country_code": { "type": "string", "description": "Страна, определённая по IP (ISO 3166-1 alpha-3). Псевдоним в CamelCase: countryCode3." }, "latitude": { "type": "number", "description": "Географическая широта IP-адреса. Псевдоним в CamelCase: lat." }, "longitude": { "type": "number", "description": "Географическая долгота IP-адреса. Псевдоним в CamelCase: lon." } } } } }, "payment_method": { "type": "object", "description": "Способ оплаты, используемый контрагентом. В транзакциях travelRule значение `method_type: \"unhosted_wallet\"` объявляет кошелёк контрагента некастодиальным: перевод пропускает маршрутизацию к VASP контрагента, создаётся напрямую со статусом `UNCONFIRMED_OWNERSHIP`, и (если включён `auto_wallet_verification`) автоматически создаётся сессия виджета подтверждения владения кошельком, возвращаемая в блоке `action_required` транзакции.", "properties": { "method_type": { "type": "string", "description": "Тип способа оплаты: `bank_card`, `bank_account`, `crypto_wallet`, `ewallet`, `unhosted_wallet`, `other`. Используйте `unhosted_wallet`, чтобы объявить некастодиальный кошелёк для Travel Rule." }, "account_id": { "type": "string", "description": "Идентификатор счёта (например, IBAN или адрес). При криптовалютном переводе в сети bitcoin или Lightning это может быть платёжный запрос Lightning (инвойс BOLT11, предложение BOLT12, LNURL) или Lightning Address: Didit сохраняет указанного в нём получателя в качестве счёта (\"\", если получатель не указан), а также данные запроса в поле `chain_details.lightning` перевода Travel Rule. Не более 255 символов после сохранения. При криптовалютном переводе в сети bitcoin или Lightning это может быть платёжный запрос Lightning (инвойс BOLT11, предложение BOLT12, LNURL) или Lightning Address: Didit сохраняет указанного в нём получателя в качестве счёта (\"\", если получатель не указан), а также данные запроса в поле `chain_details.lightning` перевода Travel Rule. Не более 255 символов после сохранения." }, "memo": { "type": "string", "maxLength": 256, "description": "Destination tag или memo, являющиеся частью кошелька в сети с поддержкой memo (XRP, XLM, EOS, ATOM, HBAR). На одном общем адресе биржи каждое memo представляет собой отдельный способ оплаты. XRP: destination tag, целое число от 0 до 4294967295 (принимается число JSON). XLM: текстовое memo длиной до 28 байт, 64-битный id или 32-байтный хеш в шестнадцатеричном виде. EOS: до 256 байт. ATOM: до 256 символов. HBAR: до 100 байт. Кошельки Bitcoin, EVM, Solana, Tron, Litecoin, Bitcoin Cash, Dogecoin и Lightning не поддерживают memo: их передача приведёт к ошибке `400`. Псевдоним: `destinationTag` или `destination_tag`." }, "issuing_country": { "type": "string" } } } } }, "custom_properties": { "type": "object", "description": "Произвольные пары ключ-значение, прикреплённые к транзакции. На каждый ключ можно ссылаться в условиях правил по пути к полю `custom_values.`.", "additionalProperties": true, "example": { "merchant_id": "test", "bank_name": "test_2" } }, "travel_rule_details": { "type": "object", "description": "Данные Travel Rule. Когда Travel Rule включён и transaction_category имеет значение travel_rule, Didit выполняет обмен данными самостоятельно: статус, протокол, required и obligations_count игнорируются, а используются originator_data, beneficiary_data и metadata. В противном случае Didit сохраняет эти значения как пассивную запись Travel Rule. Пока включён Travel Rule, исходящий перевод на сумму, равную или превышающую ваш порог, должен содержать сведения, требуемые применимым режимом (EU TFR или Рекомендация 16 ФАТФ/FATF), проверяемые для отправляемых вами сторон: при отсутствии обязательного поля возвращается ответ 400 в `travel_rule_details.originator_data` или `travel_rule_details.beneficiary_data`, например «EU TFR requires the originator name».", "required": [ "status" ], "properties": { "status": { "type": "string", "description": "Обязательно при передаче travel_rule_details. Один из статусов перевода Travel Rule (например, AWAITING_COUNTERPARTY, COMPLETED, NOT_APPLICABLE); также принимаются и сопоставляются написания в нижнем регистре и camelCase, а также устаревшие значения UNKNOWN, COMPLIANT, PENDING_ACTION, PENDING_COUNTERPARTY, FAILED и EXEMPT. Любое другое значение возвращает 400." }, "protocol": { "type": "string" }, "required": { "type": "boolean" }, "obligations_count": { "type": "integer" }, "originator_data": { "type": "object", "description": "Сторона-отправитель в виде плоских полей или одного лица формата IVMS 101. Для вашего пользователя с одобренной верификацией KYC Didit заменяет поля, содержащиеся в верификации, проверенными значениями (см. `metadata.originator_provenance`). Это должен быть объект: любое другое значение вызовет `400`. В сетях с memo ключ `memo` указывает memo или tag кошелька отправителя." }, "beneficiary_data": { "type": "object", "description": "Сторона-получатель в виде плоских полей или одного лица в формате IVMS 101. Должна быть объектом: любое другое значение вызовет ошибку `400`. Для маршрутизации перевода Didit считывает `wallet_address` (пустое значение заполняется из `counterparty.payment_method.account_id`), `chain` (заполняется из `transaction_details.crypto_params.crypto_chain` или `currency`, если в ней указана поддерживаемая сеть), `name` (с откатом к `counterparty.full_name`), `travel_address`, `counterparty_vasp_name`, `counterparty_vasp_lei` и `counterparty_vasp_email`. В сети с memo `memo` указывает memo или тег кошелька получателя; `wallet_address` и `memo` имеют приоритет над методом оплаты контрагента." }, "metadata": { "type": "object" }, "utxo": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleUtxo" } ], "description": "Необязательно, только для сетей UTXO (BTC, LTC, BCH, DOGE). Входы и выходы транзакции, по которым Didit определяет кошелёк отправителя и выход получателя, если вы не указали их явно." }, "originator": { "type": "object", "description": "Блок отправителя IVMS 101: `originatorPersons` (одно `naturalPerson` или `legalPerson`; юридическое лицо делает сторону компанией) и `accountNumber` (адреса кошельков). Используется для `originator_data`, когда этот объект пуст. Некорректно сформированный блок возвращает 400 с указанием пути ошибки, например `originator.originatorPersons`." }, "beneficiary": { "type": "object", "description": "Блок получателя IVMS 101: `beneficiaryPersons` (одно `naturalPerson` или `legalPerson`; юридическое лицо делает сторону компанией) и `accountNumber` (адреса кошельков). Используется для `beneficiary_data`, когда этот объект пуст. Некорректно сформированный блок возвращает 400 с указанием пути ошибки, например `beneficiary.beneficiaryPersons`." }, "ivms101": { "type": "object", "description": "Блоки `originator` и `beneficiary`, обёрнутые в один объект IVMS 101 (также принимается `IVMS101`). Блоки верхнего уровня имеют приоритет над блоками в обёртке." } } }, "network_snapshot": { "type": "object", "description": "Предварительно вычисленный снимок графа сети.", "properties": { "nodes": { "type": "array", "items": { "type": "object" } }, "edges": { "type": "array", "items": { "type": "object" } }, "metrics": { "type": "object" } } }, "include_crypto_screening": { "type": "boolean", "nullable": true, "description": "Переопределение для конкретной транзакции для скрининга криптовалютной блокчейн-аналитики. Если `true`, скрининг криптовалют выполняется независимо от настроек приложения по умолчанию. Если `false`, скрининг криптовалют пропускается, даже если он включён в настройках приложения. Если опущено или `null`, используется значение по умолчанию на уровне приложения, настроенное в Console. Для скрининга криптовалют требуются `transaction_details.direction`, `currency_kind: \"crypto\"`, сеть/валюта, а также адрес кошелька, определяемый направлением: при скрининге входящих транзакций до перевода используется `counterparty.payment_method.account_id`, при скрининге входящих транзакций по хешу транзакции используется `subject.payment_method.account_id`, а при скрининге исходящих транзакций используется `counterparty.payment_method.account_id`. Если `transaction_details.payment_reference_id` содержит хеш транзакции в блокчейне, Didit выполняет скрининг транзакций и возвращает обогащённую сводку по транзакции при её наличии." } }, "required": [ "transaction_id", "transaction_category", "transaction_details", "subject" ] }, "examples": { "Minimal fiat withdrawal": { "summary": "Минимально допустимый payload для исходящего фиатного перевода", "value": { "transaction_id": "your-txn-2026-05-17-001", "transaction_category": "finance", "transaction_details": { "direction": "outbound", "amount": 1500, "currency": "EUR", "action_type": "withdrawal" }, "subject": { "entity_type": "individual", "vendor_data": "user-12345", "full_name": "Maria Garcia" } } }, "Crypto outbound with screening": { "summary": "Исходящий вывод криптовалюты на некастодиальный кошелёк, опциональный скрининг", "value": { "transaction_id": "your-txn-2026-05-17-002", "transaction_category": "finance", "include_crypto_screening": true, "transaction_details": { "direction": "outbound", "amount": 0.5, "currency": "BTC", "currency_kind": "crypto", "amount_in_default_currency": 32500, "default_currency": "USD", "action_type": "withdrawal" }, "subject": { "entity_type": "individual", "vendor_data": "user-12345", "full_name": "Maria Garcia", "payment_method": { "method_type": "crypto_wallet", "account_id": "bc1qexampleexchangewalletaddressxyz", "issuing_country": "ESP" } }, "counterparty": { "entity_type": "individual", "payment_method": { "method_type": "unhosted_wallet", "account_id": "bc1qexampleexternalwalletaddressabc" } } } }, "Travel Rule transfer": { "summary": "Исходящий криптовалютный перевод с данными отправителя/получателя по Travel Rule", "value": { "transaction_id": "your-txn-2026-05-17-003", "transaction_category": "travel_rule", "transaction_details": { "direction": "outbound", "amount": 25000, "currency": "USDT", "currency_kind": "crypto", "action_type": "transfer" }, "subject": { "entity_type": "individual", "vendor_data": "user-12345", "full_name": "Maria Garcia", "date_of_birth": "1992-03-14", "address": { "country": "ESP", "town": "Madrid", "street": "Calle Mayor 1", "post_code": "28013" } }, "counterparty": { "entity_type": "individual", "full_name": "John Beneficiary", "institution_details": { "name": "Beneficiary VASP, Inc.", "code": "BVASP-US" } }, "travel_rule_details": { "status": "AWAITING_COUNTERPARTY", "protocol": "IVMS101", "required": true, "originator_data": { "name": "Maria Garcia" }, "beneficiary_data": { "name": "John Beneficiary" } } } } } } } }, "responses": { "201": { "description": "Транзакция отправлена и поставлена на мониторинг. Тело содержит полную информацию о транзакции (тот же формат, что и в `GET /v3/transactions/{transaction_id}/`), отражая все уже применённые результаты правил.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionDetail" }, "examples": { "Approved with no rule hits": { "value": { "uuid": "abcdef12-3456-4890-abcd-ef1234567890", "environment": "live", "transaction_number": 4123, "txn_id": "your-txn-2026-05-17-001", "txn_date": "2026-05-17T08:42:00Z", "zone_id": "Europe/Madrid", "transaction_type": "finance", "action_type": "withdrawal", "direction": "OUTBOUND", "status": "APPROVED", "source": "LIVE", "amount": "1500", "currency": "EUR", "currency_type": "fiat", "amount_in_default_currency": "1620.45", "default_currency_code": "USD", "preferred_currency_amount": "1620.45", "preferred_currency_code": "USD", "payment_details": "Withdrawal to crypto wallet", "payment_txn_id": null, "score": 0, "severity": null, "decision_reason_code": null, "decision_reason_label": null, "vendor_data": "user-12345", "metadata": { "subject": { "entity_type": "individual", "vendor_data": "user-12345", "full_name": "Maria Garcia", "address": {}, "institution_details": {}, "device_context": {} }, "counterparty": {} }, "props": {}, "tags": [], "parties": [ { "uuid": "b1111111-2222-4333-8444-555555555555", "role": "APPLICANT", "entity_type": "individual", "kind": "USER", "vendor_data": "user-12345", "full_name": "Maria Garcia", "first_name": null, "last_name": null, "country_code": null, "dob": null, "address": {}, "institution_info": {}, "device": {}, "external_party_snapshot": null } ], "payment_methods": [], "documents": [], "activities": [ { "uuid": "d4e5f6a7-8901-4bcd-9ef0-123456789abc", "activity_type": "TRANSACTION_CREATED", "source": "TRANSACTION", "status": "APPROVED", "title": "withdrawal", "description": "Transaction recorded.", "metadata": {}, "occurred_at": "2026-05-17T08:42:11Z" } ], "alerts": [], "rule_runs": [], "provider_results": [], "travel_rule": null, "network_snapshot": null, "remediation": null, "action_required": null, "cost_breakdown": null } }, "Flagged for review": { "value": { "uuid": "abcdef12-3456-4890-abcd-ef1234567891", "environment": "live", "transaction_number": 4124, "txn_id": "your-txn-2026-05-17-002", "txn_date": "2026-05-17T08:42:00Z", "zone_id": "Europe/Madrid", "transaction_type": "finance", "action_type": "withdrawal", "direction": "OUTBOUND", "status": "IN_REVIEW", "source": "LIVE", "amount": "0.5", "currency": "BTC", "currency_type": "crypto", "amount_in_default_currency": "32500", "default_currency_code": "USD", "preferred_currency_amount": "32500", "preferred_currency_code": "USD", "payment_details": "Withdrawal to crypto wallet", "payment_txn_id": null, "score": 78, "severity": "HIGH", "decision_reason_code": "WALLET_HIGH_RISK", "decision_reason_label": "Destination wallet flagged as high risk", "vendor_data": "user-12345", "metadata": { "subject": { "entity_type": "individual", "vendor_data": "user-12345", "full_name": "Maria Garcia", "address": {}, "institution_details": {}, "device_context": {} }, "counterparty": {} }, "props": { "order_id": "ord-9988" }, "tags": [], "parties": [ { "uuid": "b1111111-2222-4333-8444-555555555555", "role": "APPLICANT", "entity_type": "individual", "kind": "USER", "vendor_data": "user-12345", "full_name": "Maria Garcia", "first_name": null, "last_name": null, "country_code": null, "dob": null, "address": {}, "institution_info": {}, "device": {}, "external_party_snapshot": null } ], "payment_methods": [], "documents": [], "activities": [], "alerts": [ { "uuid": "a7b8c9d0-1234-4abc-9def-567890abcdef", "title": "Destination wallet flagged as high risk", "description": "Provider risk score exceeded the configured threshold.", "severity": "HIGH", "status": "OPEN", "source": "RULE", "metadata": {}, "created_at": "2026-05-17T08:42:12Z", "due_at": null } ], "rule_runs": [ { "uuid": "e5f6a7b8-9012-4cde-af01-23456789abcd", "rule": "f6a7b8c9-0123-4def-b012-3456789abcde", "rule_title": "High-risk wallet screening", "rule_description": null, "rule_category": "crypto", "matched": true, "is_test": false, "mode": "ACTIVE", "severity": "HIGH", "score_delta": 78, "status_target": "IN_REVIEW", "action_summary": "score +78; change_status:IN_REVIEW", "metadata": {}, "created_at": "2026-05-17T08:42:12Z" } ], "provider_results": [], "travel_rule": null, "network_snapshot": null, "remediation": null, "action_required": null, "cost_breakdown": null } } } } } }, "400": { "description": "Ошибка валидации (отсутствуют обязательные поля, дубликат `transaction_id`, неизвестное значение enum, недопустимая валюта и т. д.).", "content": { "application/json": { "examples": { "Missing required field": { "value": { "transaction_details": { "amount": [ "This field is required." ] } } }, "Duplicate transaction_id": { "value": { "transaction_id": [ "A transaction with this transaction_id already exists." ] } }, "Invalid category": { "value": { "non_field_errors": [ "Unsupported transaction category." ] } }, "Missing subject identity": { "value": { "subject": [ "subject.vendor_data and subject.full_name are required." ] } }, "Blocklisted participant": { "value": { "vendor_data": [ "The individual 'user-12345' is in the blocklist and cannot participate in transactions." ] } } } } } }, "403": { "description": "Отсутствующий, недействительный или отозванный API-ключ, либо у ключа нет прав на отправку транзакций для этого приложения. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "409": { "description": "Другой запрос с тем же `transaction_id` создал транзакцию во время обработки этого запроса, поэтому успешным оказывается только один из двух одновременных запросов. Прочитайте существующую транзакцию вместо повторной отправки.", "content": { "application/json": { "examples": { "Concurrent duplicate": { "value": { "detail": "A transaction with this transaction_id already exists." } } } } } }, "429": { "description": "Лимит запросов превышен: создание транзакций и приём событий (`POST /v3/transactions/`, `POST /v3/events/`, `POST /v3/events/batch/`) разделяют лимит в 600 запросов в минуту на один API-ключ, отдельно от лимита в 300 запросов для всех остальных запросов на запись. Подождите `Retry-After` секунд, затем повторите попытку.", "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой, округлённое в большую сторону, чтобы повторный запрос попал в следующее окно.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } }, "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Ingestion rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-didit-sdk": { "resource": "transactions", "method": "create", "auth": "api_key", "server": true } } }, "/v3/transactions/{transaction_id}/": { "get": { "summary": "Получить транзакцию", "description": "Получить полную запись мониторинга для одной транзакции: стороны, скоринг/уровень критичности, выполнение правил, оповещения, результат Travel Rule, сессия устранения нарушений.", "operationId": "getTransaction", "x-didit-sdk": { "resource": "transactions", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "description": "Стабильный UUID транзакции Didit (`uuid`, возвращаемый из create / list, а **не** ваш `txn_id`).", "schema": { "type": "string", "format": "uuid" }, "example": "abcdef12-3456-7890-abcd-ef1234567890" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/transactions/abcdef12-3456-7890-abcd-ef1234567890/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.retrieve(\n \"abcdef12-3456-7890-abcd-ef1234567890\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.retrieve(\"abcdef12-3456-7890-abcd-ef1234567890\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Retrieve(ctx, \"abcdef12-3456-7890-abcd-ef1234567890\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().retrieve(\"abcdef12-3456-7890-abcd-ef1234567890\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->retrieve('abcdef12-3456-7890-abcd-ef1234567890');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.retrieve(\"abcdef12-3456-7890-abcd-ef1234567890\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.RetrieveAsync(\"abcdef12-3456-7890-abcd-ef1234567890\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Полные сведения о транзакции.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionDetail" }, "examples": { "In review with an alert": { "value": { "uuid": "abcdef12-3456-4890-abcd-ef1234567890", "environment": "live", "transaction_number": 4123, "txn_id": "your-txn-2026-05-17-001", "txn_date": "2026-05-17T08:42:00Z", "zone_id": "Europe/Madrid", "transaction_type": "finance", "action_type": "withdrawal", "direction": "OUTBOUND", "status": "IN_REVIEW", "source": "LIVE", "amount": "1500", "currency": "EUR", "currency_type": "fiat", "amount_in_default_currency": "1620.45", "default_currency_code": "USD", "preferred_currency_amount": "1620.45", "preferred_currency_code": "USD", "payment_details": "Withdrawal to crypto wallet", "payment_txn_id": null, "score": 78, "severity": "HIGH", "decision_reason_code": "WALLET_HIGH_RISK", "decision_reason_label": "Destination wallet flagged as high risk", "vendor_data": "user-12345", "metadata": { "subject": { "entity_type": "individual", "vendor_data": "user-12345", "full_name": "Maria Garcia", "address": {}, "institution_details": {}, "device_context": {} }, "counterparty": {} }, "props": { "order_id": "ord-9988" }, "tags": [], "parties": [ { "uuid": "b1111111-2222-4333-8444-555555555555", "role": "APPLICANT", "entity_type": "individual", "kind": "USER", "vendor_data": "user-12345", "full_name": "Maria Garcia", "first_name": null, "last_name": null, "country_code": null, "dob": null, "address": {}, "institution_info": {}, "device": {}, "external_party_snapshot": null } ], "payment_methods": [], "documents": [], "activities": [], "alerts": [ { "uuid": "a7b8c9d0-1234-4abc-9def-567890abcdef", "title": "Destination wallet flagged as high risk", "description": "Provider risk score exceeded the configured threshold.", "severity": "HIGH", "status": "OPEN", "source": "RULE", "metadata": {}, "created_at": "2026-05-17T08:42:12Z", "due_at": null } ], "rule_runs": [], "provider_results": [], "travel_rule": null, "network_snapshot": null, "remediation": null, "action_required": null, "cost_breakdown": null } } } } } }, "403": { "description": "Отсутствующий, недействительный или отозванный API-ключ, либо у ключа нет прав на чтение транзакций этого приложения. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Транзакция с этим UUID не существует для данного приложения (удалена, никогда не создавалась, принадлежит другому приложению или сегмент пути не является валидным UUID).", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Лимит запросов превышен; снизьте частоту запросов и повторите попытку через интервал, указанный в `Retry-After`.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/transactions/sdk-token/": { "post": { "summary": "Выпустить token транзакции для SDK", "description": "Выпустить кратковременный token с ограниченной областью действия, который ваше приложение передает в Didit SDK для прямой отправки транзакций с устройства конечного пользователя через `POST /v1/transactions/`. Token привязан к одному `vendor_data` (вашему идентификатору пользователя): для каждой транзакции, отправленной с его помощью, идентификатор субъекта принудительно устанавливается на стороне сервера на основе этой привязки, поэтому изменённый клиент не может отправлять данные от имени другого пользователя. Выпускайте токены со своего бэкенда: никогда не встраивайте сам API-ключ в приложение. Алиасы в camelCase (`vendorData`, `ttlSeconds`, `maxUses`) также поддерживаются.", "operationId": "createTransactionSdkToken", "x-didit-sdk": { "resource": "transactions", "method": "create_sdk_token", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "vendor_data": { "type": "string", "description": "Ваш внутренний идентификатор конечного пользователя, для которого действует этот token. Применяется как идентификатор субъекта каждой транзакции, отправленной с этим token.", "example": "user-042" }, "ttl_seconds": { "type": "integer", "default": 900, "maximum": 86400, "description": "Срок действия token в секундах. По умолчанию 900 (15 минут); максимум 86400 (24 часа)." }, "max_uses": { "type": "integer", "nullable": true, "description": "Максимальное количество успешных отправок, разрешённых с этим токеном. Не указывайте параметр или передайте null для неограниченного использования в пределах TTL." } }, "required": [ "vendor_data" ] }, "example": { "vendor_data": "user-042", "ttl_seconds": 900, "max_uses": 3 } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/transactions/sdk-token/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"vendor_data\": \"user-042\", \"ttl_seconds\": 900, \"max_uses\": 3}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.create_sdk_token(\n vendor_data=\"user-042\",\n ttl_seconds=900,\n max_uses=3,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.createSdkToken({\n vendor_data: \"user-042\",\n ttl_seconds: 900,\n max_uses: 3,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.CreateSDKToken(ctx, didit.TransactionsCreateSDKTokenParams{\n\tVendorData: \"user-042\",\n\tTTLSeconds: didit.Int(900),\n\tMaxUses: didit.Int(3),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TransactionsCreateSdkTokenParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().createSdkToken(TransactionsCreateSdkTokenParams.builder()\n .vendorData(\"user-042\")\n .ttlSeconds(900L)\n .maxUses(3L)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->createSdkToken([\n 'vendor_data' => 'user-042',\n 'ttl_seconds' => 900,\n 'max_uses' => 3,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.create_sdk_token(\n vendor_data: \"user-042\",\n ttl_seconds: 900,\n max_uses: 3\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.CreateSdkTokenAsync(new TransactionsCreateSdkTokenParams\n{\n VendorData = \"user-042\",\n TtlSeconds = 900,\n MaxUses = 3,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Сгенерированный token. Передайте `sdk_token` вашему приложению; он аутентифицирует endpoints `/v1/transactions/` на стороне устройства через заголовок `X-Transaction-Token` до `expires_at`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "sdk_token": { "type": "string", "description": "Токен транзакции с ограниченной областью действия для передачи в SDK." }, "expires_at": { "type": "string", "format": "date-time", "description": "Когда token перестает приниматься." } } }, "example": { "sdk_token": "q7Zt...urlsafe", "expires_at": "2026-07-07T12:15:00Z" } } } }, "400": { "description": "Ошибка валидации: отсутствует `vendor_data` или `ttl_seconds` находится вне допустимого диапазона.", "content": { "application/json": { "examples": { "Missing vendor_data": { "value": { "vendor_data": [ "This field is required." ] } } } } } }, "403": { "description": "Отсутствующий, недействительный или отозванный API-ключ.", "content": { "application/json": { "examples": { "Invalid API Key": { "value": { "detail": "Invalid API Key." } } } } } } } } }, "/v1/transactions/": { "post": { "summary": "Отправить транзакцию из SDK", "description": "Endpoint, предназначенный для вызова с устройства, который Didit SDK вызывают для отправки транзакции напрямую с устройства конечного пользователя. Аутентификация выполняется с помощью токена с ограниченной областью действия из `POST /v3/transactions/sdk-token/`, передаваемого в заголовке `X-Transaction-Token` вместо API-ключа; endpoint поддерживает CORS, поэтому браузеры могут вызывать его кросс-доменно. В payload используются псевдонимы в camelCase, приведённые ниже (методы SDK `submitTransaction` формируют его автоматически). Три гарантии на стороне сервера: приложение всегда берётся из токена; идентификатор субъекта (`externalUserId`) всегда принудительно устанавливается из `vendor_data` токена, поэтому поддельные значения payload игнорируются; аналитические данные устройства (отпечаток устройства от SDK плюс полученные сервером IP-адрес и user agent) привязываются к субъекту автоматически.", "operationId": "submitTransactionFromSdk", "x-didit-sdk": { "resource": "transactions", "method": "submit_from_device", "auth": "device_token", "server": false }, "tags": [ "Transactions" ], "security": [ { "TransactionTokenAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "txnId": { "type": "string", "description": "Ваш уникальный идентификатор этой транзакции (сопоставляется с `transaction_id`, не более 128 символов).", "example": "wd-2026-07-07-0042" }, "txnDate": { "type": "string", "format": "date-time", "description": "Когда произошла транзакция (соответствует `transaction_at`). По умолчанию текущее время, если значение не указано." }, "zoneId": { "type": "string", "description": "Идентификатор часового пояса IANA (сопоставляется с `time_zone`), например `Europe/Madrid`." }, "type": { "type": "string", "description": "Категория транзакции (сопоставляется с `transaction_category`), например `finance`, `kyc`, `travelRule`, `userPlatformEvent`, `gamblingBet`.", "example": "travelRule" }, "info": { "type": "object", "description": "Основные финансовые реквизиты транзакции (сопоставляются с `transaction_details`).", "required": [ "direction", "amount", "currency" ], "properties": { "direction": { "type": "string", "description": "Направление относительно субъекта. Регистронезависимо; `in`/`out` принимаются в качестве псевдонимов. Возвращается в верхнем регистре (`INBOUND`/`OUTBOUND`).", "example": "out" }, "amount": { "type": "number", "description": "Сумма транзакции (до 18 знаков после запятой). Также принимается десятичная строка, и это единственный способ сохранить более ~15 значащих цифр: число JSON сначала парсится как двоичное число с плавающей запятой, поэтому `0.123456789012345678` сохраняется как `0.12345678901234568`.", "example": 0.25 }, "currency": { "type": "string", "description": "Код валюты. Принимается любой буквенный код ISO 4217 (например, `EUR`, `USD`, `NGN`), а также символ криптоактива (например, `BTC`). Предпочтительно использовать находящийся в обращении код. Не для каждого принятого кода доступен обменный курс: если для кода курс отсутствует (например, расчетная единица ISO `XSU` или символ криптовалюты, для которого Didit не рассчитывает цену), автоматическая конвертация завершается ошибкой и `preferred_currency_amount` возвращается со значением null, если только в запросе не был передан предварительно сконвертированный `amountInDefaultCurrency`.", "example": "ETH" }, "currencyType": { "type": "string", "description": "Является ли валюта `fiat` или `crypto` (сопоставляется с `currency_kind`)." }, "amountInDefaultCurrency": { "type": "number", "nullable": true, "description": "Предварительно сконвертированная сумма в валюте по умолчанию (сопоставляется с `amount_in_default_currency`). Если поле опущено, предпринимается попытка автоматической конвертации валют (FX)." }, "defaultCurrencyCode": { "type": "string", "description": "Код валюты по умолчанию для сконвертированной суммы (сопоставляется с `default_currency`). Любой находящийся в обращении код ISO 4217." }, "paymentDetails": { "type": "string", "nullable": true, "description": "Назначение платежа или примечание в виде произвольного текста (сопоставляется с `payment_details`)." }, "paymentTxnId": { "type": "string", "nullable": true, "description": "Внешний идентификатор платежа (соответствует `payment_reference_id`); ончейн-хэш транзакции для криптовалютных транзакций." }, "type": { "type": "string", "nullable": true, "description": "Подтип транзакции (сопоставляется с `action_type`), например `deposit`, `withdrawal`, `transfer`." }, "cryptoParams": { "type": "object", "description": "Параметры, специфичные для криптовалюты, например `{\"crypto_chain\": \"ETH\"}`." } } }, "subject": { "type": "object", "description": "Субъект (заявитель) транзакции. `externalUserId` здесь игнорируется: личность субъекта всегда определяется на основе `vendor_data` token.", "required": [ "fullName" ], "properties": { "type": { "type": "string", "description": "Тип сущности (сопоставляется с `entity_type`): `individual` (по умолчанию) или `company`." }, "externalUserId": { "type": "string", "description": "Игнорируется для субъекта - применяется на стороне сервера из `vendor_data` токена." }, "fullName": { "type": "string", "example": "Jane Doe" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "dob": { "type": "string", "format": "date", "description": "Дата рождения (ГГГГ-ММ-ДД; соответствует `date_of_birth`)." }, "address": { "type": "object", "description": "Объект адреса с `country` (ISO 3166-1 alpha-3), `town`, `state`, `street`, `post_code`." }, "institutionInfo": { "type": "object", "description": "Сведения об учреждении для институциональных участников (соответствуют `institution_details`)." }, "device": { "type": "object", "description": "Необязательный явный контекст устройства. Объединяется с автоматически собранными данными об устройстве; при конфликте приоритет имеют поля, полученные сервером." }, "paymentMethod": { "type": "object", "description": "Способ оплаты, используемый субъектом (сопоставляется с `payment_method`).", "properties": { "type": { "type": "string", "description": "Тип способа оплаты (сопоставляется с `method_type`), например `bank_card`, `bank_account`, `crypto_wallet`, `ewallet`, `unhosted_wallet`, `other`." }, "accountId": { "type": "string", "description": "Идентификатор счёта (соответствует `account_id`): IBAN, цифровой отпечаток карты или адрес." }, "issuingCountry": { "type": "string", "description": "Код страны эмитента по стандарту ISO 3166-1 alpha-3 (сопоставляется с `issuing_country`)." } } } } }, "counterparty": { "type": "object", "description": "Контрагент транзакции (необязательно). Та же структура, что и у `subject`; поле `externalUserId` имеет здесь значение.", "properties": { "type": { "type": "string", "description": "Тип сущности (сопоставляется с `entity_type`): `individual` или `company`." }, "externalUserId": { "type": "string", "description": "Ваш внутренний идентификатор контрагента (сопоставляется с `vendor_data`)." }, "fullName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "dob": { "type": "string", "format": "date" }, "address": { "type": "object" }, "institutionInfo": { "type": "object" }, "device": { "type": "object" }, "paymentMethod": { "type": "object", "description": "Способ оплаты, используемый контрагентом (сопоставляется с `payment_method`). В транзакциях travelRule значение `type: \"unhosted_wallet\"` объявляет кошелёк контрагента некастодиальным: перевод пропускает маршрутизацию к VASP контрагента, создаётся напрямую со статусом `UNCONFIRMED_OWNERSHIP`, и (если включён `auto_wallet_verification`) автоматически создаётся сессия виджета подтверждения владения кошельком, возвращаемая в `action_required` для запуска через SDK.", "properties": { "type": { "type": "string", "description": "Тип способа оплаты (сопоставляется с `method_type`), например `bank_card`, `bank_account`, `crypto_wallet`, `ewallet`, `unhosted_wallet`, `other`. Используйте `unhosted_wallet`, чтобы объявить некастодиальный кошелёк для Travel Rule." }, "accountId": { "type": "string", "description": "Идентификатор счёта (соответствует `account_id`): IBAN, цифровой отпечаток карты или адрес." }, "issuingCountry": { "type": "string" } } } } }, "props": { "type": "object", "additionalProperties": true, "description": "Пользовательские пары «ключ-значение» (сопоставляются с `custom_properties`). Каждый ключ можно использовать в условиях правил как `custom_values.`." }, "travelRule": { "type": "object", "description": "Детали Travel Rule (сопоставляется с `travel_rule_details`). Когда Travel Rule включён для приложения, Didit игнорирует любой отправленный вами `status` и управляет обменом самостоятельно.", "required": [ "status" ], "properties": { "status": { "type": "string" }, "protocol": { "type": "string" }, "required": { "type": "boolean" }, "obligationsCount": { "type": "integer" }, "originatorData": { "type": "object" }, "beneficiaryData": { "type": "object" }, "metadata": { "type": "object" } } }, "includeCryptoScreening": { "type": "boolean", "nullable": true, "description": "Переопределение для конкретной транзакции для скрининга криптовалютной блокчейн-аналитики (сопоставляется с `include_crypto_screening`)." }, "fingerprint_v2": { "type": "object", "description": "payload цифрового отпечатка устройства `didit-fp-v2`. Внедряется SDK автоматически; актуально только при прямом вызове wire API." } }, "required": [ "txnId", "type", "info", "subject" ] }, "example": { "txnId": "wd-2026-07-07-0042", "type": "travelRule", "info": { "direction": "out", "amount": "0.25", "currency": "ETH", "currencyType": "crypto", "cryptoParams": { "crypto_chain": "ETH" } }, "subject": { "fullName": "Jane Doe" }, "counterparty": { "fullName": "Ana Diaz", "paymentMethod": { "type": "unhosted_wallet", "accountId": "0xBeneficiaryWallet01" } }, "travelRule": { "status": "AWAITING_COUNTERPARTY", "beneficiaryData": { "wallet_address": "0xBeneficiaryWallet01", "name": "Ana Diaz" } }, "includeCryptoScreening": true } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v1/transactions/ \\\n -H 'X-Transaction-Token: SDK_TOKEN' -H 'Content-Type: application/json' \\\n -d '{\"txnId\": \"wd-2026-07-07-0042\", \"type\": \"travelRule\", \"info\": {\"direction\": \"out\", \"amount\": \"0.25\", \"currency\": \"ETH\", \"currencyType\": \"crypto\"}, \"subject\": {\"fullName\": \"Jane Doe\"}, \"counterparty\": {\"fullName\": \"Ana Diaz\", \"paymentMethod\": {\"type\": \"unhosted_wallet\", \"accountId\": \"0xBeneficiaryWallet01\"}}, \"travelRule\": {\"status\": \"AWAITING_COUNTERPARTY\", \"beneficiaryData\": {\"wallet_address\": \"0xBeneficiaryWallet01\", \"name\": \"Ana Diaz\"}}, \"includeCryptoScreening\": true}'" }, { "lang": "javascript", "label": "Web SDK", "source": "import { DiditSdk } from '@didit-protocol/sdk-web';\n\nconst result = await DiditSdk.shared.submitTransaction({\n transactionToken: sdkToken,\n transaction: {\n txnId: 'wd-2026-07-07-0042',\n category: 'travelRule',\n details: { direction: 'out', amount: '0.25', currency: 'ETH', currencyType: 'crypto' },\n subject: { fullName: 'Jane Doe' },\n counterparty: { fullName: 'Ana Diaz', paymentMethod: { type: 'unhosted_wallet', accountId: '0xBeneficiaryWallet01' } },\n travelRule: { status: 'AWAITING_COUNTERPARTY', beneficiaryData: { wallet_address: '0xBeneficiaryWallet01', name: 'Ana Diaz' } },\n includeCryptoScreening: true\n },\n onActionCompleted: (refreshed) => console.log(refreshed.status)\n});" } ], "responses": { "201": { "description": "Транзакция отправлена и поставлена на мониторинг. Формат данных совпадает с `GET /v3/transactions/{transaction_id}/`, включая блок `action_required`, когда конечный пользователь должен выполнить дополнительное действие (SDK запускают его автоматически по умолчанию).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionDetail" }, "examples": { "Wallet ownership required": { "value": { "uuid": "22222222-3333-4444-5555-666666666666", "txn_id": "wd-2026-07-07-0042", "transaction_type": "travelRule", "direction": "OUTBOUND", "status": "APPROVED", "amount": "0.25", "currency": "ETH", "travel_rule": { "uuid": "33333333-4444-5555-6666-777777777777", "status": "UNCONFIRMED_OWNERSHIP", "required": true }, "action_required": { "type": "wallet_ownership", "url": "https://verify.didit.me/wallet-ownership/3s9x...urlsafe", "widget_session_id": "77777777-8888-9999-aaaa-bbbbbbbbbbbb", "expires_at": "2026-07-07T13:00:00Z" } } } } } } }, "400": { "description": "Ошибка валидации (отсутствуют обязательные поля, дубликат `txnId`, неизвестная категория).", "content": { "application/json": { "examples": { "Missing fields": { "value": { "transaction_details": { "currency": [ "This field is required." ] } } }, "Duplicate txnId": { "value": { "transaction_id": [ "A transaction with this transaction_id already exists." ] } } } } } }, "401": { "description": "Токен транзакции был отклонен: отсутствует, неизвестен, отозван, превысил `max_uses` или его срок действия истек. Ответы с истекшим сроком действия токена всегда содержат слово `expired` в описании ошибки (detail), с помощью чего SDK отличают ошибки `expired_token` от `invalid_token`.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "Invalid transaction token." } }, "Expired token": { "value": { "detail": "Transaction token expired." } } } } } }, "409": { "description": "Другой запрос с тем же `txnId` создал транзакцию во время обработки этого запроса, поэтому успешным оказывается только один из двух одновременных запросов. Прочитайте существующую транзакцию вместо повторной отправки.", "content": { "application/json": { "examples": { "Concurrent duplicate": { "value": { "detail": "A transaction with this transaction_id already exists." } } } } } } } } }, "/v1/transactions/{transaction_id}/": { "get": { "summary": "Получить транзакцию из SDK", "description": "Endpoint чтения, предназначенный для вызова с устройства, аутентифицируемый тем же токеном `X-Transaction-Token`, который использовался при отправке. SDK опрашивают его после завершения автоматически запущенного сценария действия или закрытия его окна, поэтому финальное состояние никогда не зависит от единичного уведомления. Возвращает те же подробные сведения о транзакции, что и ответ на отправку, включая текущий блок `action_required` (`null` после выполнения действия).", "operationId": "getTransactionFromSdk", "x-didit-sdk": { "resource": "transactions", "method": "retrieve_from_device", "auth": "device_token", "server": false }, "tags": [ "Transactions" ], "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "description": "Стабильный UUID транзакции Didit (`uuid` из ответа на отправку, а **не** ваш `txnId`).", "schema": { "type": "string", "format": "uuid" }, "example": "22222222-3333-4444-5555-666666666666" } ], "security": [ { "TransactionTokenAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v1/transactions/22222222-3333-4444-5555-666666666666/' \\\n -H 'X-Transaction-Token: SDK_TOKEN'" } ], "responses": { "200": { "description": "Полные детали транзакции, включая `action_required` (`null`, как только ожидающее действие урегулировано).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionDetail" } } } }, "401": { "description": "Токен транзакции был отклонен: отсутствует, неизвестен, отозван, превысил `max_uses` или его срок действия истек.", "content": { "application/json": { "examples": { "Expired token": { "value": { "detail": "Transaction token expired." } } } } } }, "404": { "description": "Транзакция с этим UUID не существует для приложения токена, либо сегмент пути не является валидным UUID.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } } } } }, "/v3/businesses/": { "get": { "summary": "Получить список компаний", "description": "Получить список [компаний](/entities/businesses), которые Didit формирует на основе сессий KYB с одинаковым значением `vendor_data` (произвольная строка, НЕ UUID), а также компаний, созданных через API. С пагинацией, отсортирован по `last_session_at` по убыванию (desc). Этот endpoint не поддерживает параметры фильтрации или поиска — запрашивайте страницы и фильтруйте на стороне клиента.", "operationId": "list_businesses", "x-didit-sdk": { "resource": "businesses", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Businesses" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "description": "Размер страницы. По умолчанию 50, если не указан. Жёсткого максимума нет, но рекомендуется оставлять страницы небольшими для уменьшения задержки." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "description": "Смещение первой возвращаемой записи, начиная с нуля. Рекомендуется переходить по URL `next` с предыдущей страницы вместо вычисления вручную." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/businesses/?limit=50' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.businesses.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.businesses.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Businesses.ListAutoPaging(ctx, didit.BusinessesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.businesses().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "businesses->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.businesses.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Businesses.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Список компаний с пагинацией, со статусом, количеством сессий и детализацией по функциям.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Количество подходящих строк: точное до 100, с ограничением в 100 сверх этого для производительности. Не используйте его для определения последней страницы; вместо этого ориентируйтесь на то, что `next` равен `null`." }, "next": { "type": "string", "nullable": true, "description": "Абсолютный URL следующей страницы или `null` на последней странице." }, "previous": { "type": "string", "nullable": true, "description": "Абсолютный URL предыдущей страницы или `null` на первой странице." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessListItem" } } } }, "examples": { "Example": { "value": { "count": 1, "next": null, "previous": null, "results": [ { "didit_internal_id": "a1b2c3d4-e5f6-4890-abcd-ef1234567890", "vendor_data": "company-123", "display_name": null, "legal_name": "Acme Trading Ltd", "registration_number": "12345678", "country_code": "GB", "effective_name": "Acme Trading Ltd", "status": "ACTIVE", "session_count": 2, "approved_count": 1, "declined_count": 0, "in_review_count": 1, "features": { "KYB": "Approved" }, "features_list": [ { "feature": "KYB", "status": "Approved" } ], "last_session_at": "2026-03-15T10:30:00Z", "last_activity_at": "2026-03-15T10:30:00Z", "first_session_at": "2026-01-10T08:00:00Z", "tags": [ { "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "name": "VIP", "color": "#2567FF" } ], "created_at": "2026-01-10T08:00:00Z" } ] } } } } } }, "403": { "description": "Отсутствующий, недействительный или отозванный API-ключ, либо у ключа нет прав на получение списка компаний для этого приложения. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Лимит запросов превышен; снизьте частоту запросов и повторите попытку через интервал, указанный в `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/customization/": { "get": { "summary": "Получить кастомизацию брендинга", "description": "Возвращает брендинг White label для приложения, определённого по API-ключу: цвета, шрифты, радиусы скругления границ, URL-адреса логотипов и параметры UI/UX. Настройки кастомного домена и электронной почты White label управляются только в Business Console и не входят в этот ответ.", "operationId": "get_customization", "x-didit-sdk": { "resource": "customization", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Customization" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/customization/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.customization.retrieve()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.customization.retrieve();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Customization.Retrieve(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.customization().retrieve();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "customization->retrieve();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.customization.retrieve\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Customization.RetrieveAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Текущие настройки брендинга для приложения.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandingCustomization" }, "examples": { "Default branding": { "value": { "color_primary": "#000000", "color_secondary": "#9DA1A1", "color_background": "#FFFFFF", "color_panel": "#2567FF", "color_panel_10": "#1A1A1A", "color_on_panel_1": "#9DA1A1", "color_on_panel_2": "#F4F4F6", "color_on_background": "#000000", "color_button_1": "#2567FF", "color_button_2": "#F8F8F8", "color_button_text_1": "#FFFFFF", "color_button_text_2": "#000000", "color_pill_text": "#111827", "border_radius_panel": 10, "border_radius_buttons": 12, "font_family": "Inter", "font_weight": "regular", "font_url": "https://fonts.googleapis.com/css2?family=Inter", "logo_square": null, "logo_rectangular": null, "logo_rectangular_dark": null, "favicon": null, "app_public_name": "Acme Verify", "privacy_policy_url": "https://acme.com/privacy", "skip_welcome_screen": false, "disable_login_with_didit": false, "hide_progress_bar": false, "callback_seconds": 3 } } } } } }, "403": { "description": "API-ключ отсутствует, сформирован некорректно, истёк или относится к другому приложению. При отсутствии ключа возвращается `403`; при неверном, отозванном или истёкшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Превышен лимит запросов. Повторите попытку с экспоненциальной задержкой." } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Обновить параметры брендинга", "description": "Частичное обновление брендинга приложения по модели White label. Отправьте `application/json` для изменения цветов, шрифтов, радиусов скругления и параметров интерфейса или `multipart/form-data` для загрузки файлов логотипа. Изменяются только переданные поля. Пользовательский домен и email в стиле White label нельзя настроить через этот endpoint — используйте для этого Business Console.", "operationId": "update_customization", "x-didit-sdk": { "resource": "customization", "method": "update", "auth": "api_key", "server": true }, "tags": [ "Customization" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandingCustomizationUpdate" }, "examples": { "Update colors and font": { "summary": "Изменить цвета брендинга и шрифт", "value": { "color_primary": "#123456", "color_button_1": "#2567FF", "font_family": "AR One Sans", "border_radius_buttons": 16 } }, "Update UI options": { "summary": "Изменить публичное имя и параметры сценария", "value": { "app_public_name": "Acme Verify", "privacy_policy_url": "https://acme.com/privacy", "skip_welcome_screen": true, "hide_progress_bar": true, "callback_seconds": 5 } }, "Remove a logo": { "summary": "Удалить текущий прямоугольный логотип", "value": { "delete_logo_rectangular": true } }, "Remove the dark-mode logo": { "summary": "Удалить текущий логотип для темной темы", "value": { "delete_logo_rectangular_dark": true } } } }, "multipart/form-data": { "schema": { "type": "object", "description": "Используйте multipart/form-data только для загрузки изображений логотипа. Приведённые выше поля брендинга также можно передать как поля формы в том же запросе.", "properties": { "image_square": { "type": "string", "format": "binary", "description": "Квадратный логотип (соотношение сторон 1:1). PNG, JPG или WebP, не менее 512 px по длинной стороне, не более **1 МБ**." }, "image_rectangular": { "type": "string", "format": "binary", "description": "Прямоугольный логотип (соотношение сторон 2:1). PNG, JPG или WebP, не менее 512 пикселей по длинной стороне, не более **1 MB**." }, "image_rectangular_dark": { "type": "string", "format": "binary", "description": "Прямоугольный логотип для тёмной темы (соотношение сторон 2:1), отображаемый на тёмном фоне. PNG, JPG или WebP, не менее 512 пикселей по длинной стороне, не более **1 MB**. Возвращается как `logo_rectangular_dark`." }, "image_favicon": { "type": "string", "format": "binary", "description": "Изображение favicon. Макс. **500 KB**." } } }, "example": { "image_rectangular": "(binary PNG logo, 2:1)", "image_rectangular_dark": "(binary PNG logo for dark mode, 2:1)", "image_favicon": "(binary favicon)" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/customization/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"color_primary\": \"#123456\", \"font_family\": \"AR One Sans\"}'" }, { "lang": "curl", "label": "curl (logo upload)", "source": "curl -X PATCH 'https://verification.didit.me/v3/customization/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'image_rectangular=@logo.png' \\\n -F 'image_rectangular_dark=@logo-dark.png' \\\n -F 'image_favicon=@favicon.ico'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.customization.update(\n image_rectangular=open(\"image_rectangular.jpg\", \"rb\"),\n image_rectangular_dark=open(\"image_rectangular_dark.jpg\", \"rb\"),\n image_favicon=open(\"image_favicon.jpg\", \"rb\"),\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.customization.update({\n image_rectangular: await fileFromPath(\"image_rectangular.jpg\"),\n image_rectangular_dark: await fileFromPath(\"image_rectangular_dark.jpg\"),\n image_favicon: await fileFromPath(\"image_favicon.jpg\"),\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Customization.Update(ctx, didit.CustomizationUpdateParams{\n\tImageRectangular: didit.Some(didit.FileFromPath(\"image_rectangular.jpg\")),\n\tImageRectangularDark: didit.Some(didit.FileFromPath(\"image_rectangular_dark.jpg\")),\n\tImageFavicon: didit.Some(didit.FileFromPath(\"image_favicon.jpg\")),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\nimport me.didit.types.CustomizationUpdateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.customization().update(CustomizationUpdateParams.builder()\n .imageRectangular(Path.of(\"image_rectangular.jpg\"))\n .imageRectangularDark(Path.of(\"image_rectangular_dark.jpg\"))\n .imageFavicon(Path.of(\"image_favicon.jpg\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "customization->update([\n 'image_rectangular' => File::fromPath('image_rectangular.jpg'),\n 'image_rectangular_dark' => File::fromPath('image_rectangular_dark.jpg'),\n 'image_favicon' => File::fromPath('image_favicon.jpg'),\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.customization.update(\n image_rectangular: Pathname(\"image_rectangular.jpg\"),\n image_rectangular_dark: Pathname(\"image_rectangular_dark.jpg\"),\n image_favicon: Pathname(\"image_favicon.jpg\")\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Customization.UpdateAsync(new CustomizationUpdateParams\n{\n ImageRectangular = FileUpload.FromPath(\"image_rectangular.jpg\"),\n ImageRectangularDark = FileUpload.FromPath(\"image_rectangular_dark.jpg\"),\n ImageFavicon = FileUpload.FromPath(\"image_favicon.jpg\"),\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Брендинг обновлён. Возвращается ПОЛНЫЙ объект брендинга (все поля, а не только изменённые).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandingCustomization" }, "examples": { "Updated": { "value": { "color_primary": "#123456", "color_secondary": "#9DA1A1", "color_background": "#FFFFFF", "color_panel": "#2567FF", "color_panel_10": "#1A1A1A", "color_on_panel_1": "#9DA1A1", "color_on_panel_2": "#F4F4F6", "color_on_background": "#000000", "color_button_1": "#2567FF", "color_button_2": "#F8F8F8", "color_button_text_1": "#FFFFFF", "color_button_text_2": "#000000", "color_pill_text": "#111827", "border_radius_panel": 10, "border_radius_buttons": 16, "font_family": "AR One Sans", "font_weight": "400", "font_url": "https://fonts.googleapis.com/css2?family=AR+One+Sans", "logo_square": null, "logo_rectangular": "https://cdn.didit.me/white_label/logo_rectangular/...", "logo_rectangular_dark": null, "favicon": null, "app_public_name": "Acme Verify", "privacy_policy_url": "https://acme.com/privacy", "skip_welcome_screen": true, "disable_login_with_didit": false, "hide_progress_bar": false, "callback_seconds": 3 } } } } } }, "400": { "description": "Недопустимое тело запроса. Например: некорректный шестнадцатеричный цвет (HEX), неизвестное семейство или начертание шрифта, поле только для Business Console (`domain`, `from_email`, `verify_domain`, `force_remove_domain`, `verify_email_domain`, `force_remove_email_domain` и связанные с ними поля только для чтения), либо загрузка логотипа, который не является изображением PNG, JPG или WebP, имеет размер менее 512 px по длинной стороне, превышает 1 МБ или имеет неверное соотношение сторон. Также возвращается при установке `disable_login_with_didit` в значение `false`, если настроен собственный домен.", "content": { "application/json": { "examples": { "Bad color": { "value": { "color_primary": [ "Invalid color format. Use '#RRGGBB' or '#RRGGBBAA' format." ] } }, "Bad logo": { "value": { "image_rectangular": [ "Image aspect ratio must be 2:1. Got 1024x1024 image dimensions" ] } }, "Unsupported logo format": { "summary": "Изображение не в формате PNG, JPG или WebP (например, SVG)", "value": { "image_rectangular_dark": [ "Upload a PNG, JPG or WebP image." ] } }, "Logo too small": { "summary": "Менее 512 px по длинной стороне", "value": { "image_rectangular": [ "Image must be at least 512 px on its long side. Got 400x200 image dimensions" ] } }, "Logo too large": { "summary": "Более 1 МБ", "value": { "image_square": [ "File size should not exceed 1 MB" ] } }, "Console-only field": { "value": { "domain": [ "Manage this field in the Business Console." ] } }, "Bad font weight": { "value": { "font_weight": [ "Font weight 950 is not available for Inter. Available weights are: 100, 200, 300, 400, 500, 600, 700, 800, 900" ] } } } } } }, "403": { "description": "API-ключ отсутствует, сформирован некорректно, истёк или относится к другому приложению. При отсутствии ключа возвращается `403`; при неверном, отозванном или истёкшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Превышен лимит запросов. Повторите попытку с экспоненциальной задержкой." } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/businesses/{vendor_data}/": { "get": { "summary": "Получить компанию", "description": "Получить одну [компанию](/entities/businesses) по `vendor_data` (точное совпадение). Добавляет `metadata` и `updated_at` к списочному представлению. Удалённые компании возвращают 404.", "operationId": "get_business", "x-didit-sdk": { "resource": "businesses", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Businesses" ], "parameters": [ { "name": "vendor_data", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Ваш уникальный идентификатор компании — произвольная строка (НЕ UUID), сопоставляется в точности в переданном виде.", "example": "company-123" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/businesses/company-123/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.businesses.retrieve(\n \"company-123\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.businesses.retrieve(\"company-123\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.Retrieve(ctx, \"company-123\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.businesses().retrieve(\"company-123\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->retrieve('company-123');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.businesses.retrieve(\"company-123\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.RetrieveAsync(\"company-123\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Полные сведения о компании, включая метаданные и агрегированные данные сессий.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessDetailItem" }, "examples": { "Active business": { "value": { "didit_internal_id": "a1b2c3d4-e5f6-4890-abcd-ef1234567890", "vendor_data": "company-123", "display_name": null, "legal_name": "Acme Trading Ltd", "registration_number": "12345678", "country_code": "GB", "effective_name": "Acme Trading Ltd", "status": "ACTIVE", "session_count": 2, "approved_count": 1, "declined_count": 0, "in_review_count": 1, "features": { "KYB": "Approved" }, "features_list": [ { "feature": "KYB", "status": "Approved" } ], "last_session_at": "2026-03-15T10:30:00Z", "last_activity_at": "2026-03-15T10:30:00Z", "first_session_at": "2026-01-10T08:00:00Z", "tags": [ { "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "name": "VIP", "color": "#2567FF" } ], "created_at": "2026-01-10T08:00:00Z", "metadata": { "industry": "fintech" }, "updated_at": "2026-03-15T10:30:00Z" } } } } } }, "403": { "description": "Отсутствующий, недействительный или отозванный API-ключ, либо у ключа нет прав на чтение компаний этого приложения. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Для этого приложения не найдена (неудалённая) компания с указанным `vendor_data`.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Лимит запросов превышен; снизьте частоту запросов и повторите попытку через интервал, указанный в `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Обновить компанию", "description": "Частичное обновление компании: `display_name`, `legal_name`, `registration_number`, `country_code`, `status`, `metadata`. `metadata` заменяется полностью. Установка `status` в значение `BLOCKED` добавляет `vendor_data` в системный список блокировки; изменение со статуса `BLOCKED` удаляет эту запись. Каждое изменение фиксируется в активности компании: смена статуса с опциональным указанием `reason`, а изменение `display_name`, `legal_name`, `registration_number`, `country_code` или `metadata` как обновление профиля.", "operationId": "update_business", "x-didit-sdk": { "resource": "businesses", "method": "update", "auth": "api_key", "server": true }, "tags": [ "Businesses" ], "parameters": [ { "name": "vendor_data", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Ваш уникальный идентификатор компании (произвольная строка, НЕ UUID).", "example": "company-123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Тело частичного обновления. Передавайте только те поля, которые хотите изменить.", "properties": { "display_name": { "type": "string", "nullable": true, "description": "Понятное отображаемое имя, показываемое в консоли (имеет приоритет над `legal_name` при отображении в интерфейсе)." }, "legal_name": { "type": "string", "nullable": true, "description": "Официальное юридическое наименование из реестра или ручного ввода." }, "registration_number": { "type": "string", "nullable": true, "description": "Регистрационный номер или номер инкорпорации компании." }, "country_code": { "type": "string", "nullable": true, "description": "Страна инкорпорации (ISO 3166-1 alpha-2, например, `GB`, `US`)." }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "description": "Статус жизненного цикла компании. Установка значения `BLOCKED` автоматически добавляет `vendor_data` в системный список блокировки; смена со статуса `BLOCKED` удаляет эту запись из списка блокировки." }, "metadata": { "type": "object", "nullable": true, "description": "Произвольный JSON-объект, прикрепляемый к компании. **Полностью заменяет** существующие метаданные при обновлении — объединяйте на стороне клиента, если нужно лишь добавить ключи." }, "reason": { "type": "string", "nullable": true, "maxLength": 1000, "description": "Причина изменения статуса. Записывается в записи об изменении статуса в разделе **Activity** компании в Business Console, только когда статус действительно меняется. В webhook не передается." } } }, "examples": { "Update name": { "summary": "Обновить отображаемое имя", "value": { "display_name": "Acme Corp" } }, "Flag for review": { "summary": "Переключить статус", "value": { "status": "FLAGGED" } }, "Add metadata": { "summary": "Заменить JSON метаданных", "value": { "metadata": { "industry": "fintech", "risk_level": "low" } } }, "Fix registry data": { "summary": "Скорректировать извлечённые поля", "value": { "legal_name": "Acme Trading International Ltd", "registration_number": "12345678", "country_code": "GB" } }, "Flag with reason": { "summary": "Пометить компанию и зафиксировать причину", "value": { "status": "FLAGGED", "reason": "Ownership structure under review" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/businesses/company-123/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"display_name\": \"Acme Corp\", \"status\": \"FLAGGED\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.businesses.update(\n \"company-123\",\n display_name=\"Acme Corp\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.businesses.update(\"company-123\", {\n display_name: \"Acme Corp\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.Update(ctx, \"company-123\", didit.BusinessesUpdateParams{\n\tDisplayName: didit.String(\"Acme Corp\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.BusinessesUpdateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.businesses().update(\"company-123\", BusinessesUpdateParams.builder()\n .displayName(\"Acme Corp\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->update('company-123', [\n 'display_name' => 'Acme Corp',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.businesses.update(\n \"company-123\",\n display_name: \"Acme Corp\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.UpdateAsync(\"company-123\", new BusinessesUpdateParams\n{\n DisplayName = \"Acme Corp\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Компания обновлена. Возвращается полная обновлённая запись компании.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessDetailItem" }, "examples": { "Updated": { "value": { "didit_internal_id": "a1b2c3d4-e5f6-4890-abcd-ef1234567890", "vendor_data": "company-123", "display_name": "Acme Corp", "legal_name": "Acme Trading Ltd", "registration_number": "12345678", "country_code": "GB", "effective_name": "Acme Corp", "status": "FLAGGED", "session_count": 2, "approved_count": 1, "declined_count": 0, "in_review_count": 1, "features": { "KYB": "Approved" }, "features_list": [ { "feature": "KYB", "status": "Approved" } ], "last_session_at": "2026-03-15T10:30:00Z", "last_activity_at": "2026-03-15T10:30:00Z", "first_session_at": "2026-01-10T08:00:00Z", "tags": [ { "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "name": "VIP", "color": "#2567FF" } ], "created_at": "2026-01-10T08:00:00Z", "metadata": { "industry": "fintech", "risk_level": "low" }, "updated_at": "2026-03-15T10:30:00Z" } } } } } }, "400": { "description": "Недопустимое тело запроса: обычно неизвестный `status`, некорректные `metadata` или `reason` длиннее 1000 символов.", "content": { "application/json": { "examples": { "Bad status": { "value": { "status": [ "Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED" ] } }, "Bad metadata": { "value": { "metadata": [ "Metadata must be a JSON object." ] } }, "Reason too long": { "value": { "reason": [ "Ensure this field has no more than 1000 characters." ] } } } } } }, "403": { "description": "Отсутствующий, недействительный или отозванный API-ключ, либо у ключа нет прав на обновление компаний для этого приложения. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Для этого приложения не найдена (неудалённая) компания с указанным `vendor_data`.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Лимит запросов превышен; снизьте частоту запросов и повторите попытку через интервал, указанный в `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/businesses/{vendor_data}/update-status/": { "patch": { "summary": "Обновить статус компании", "description": "Переключает только жизненный цикл `status` компании: `ACTIVE`, `FLAGGED` или `BLOCKED` (не статусы сессии). `BLOCKED` добавляет `vendor_data` в системный список блокировки; выход из `BLOCKED` удаляет эту запись. Каждое изменение фиксируется в журнале активности компании с необязательным `reason`. Отправка текущего статуса ничего не меняет и не записывает `reason`. Webhook `business.status.updated` не содержит `reason`.", "operationId": "update_business_status", "x-didit-sdk": { "resource": "businesses", "method": "update_status", "auth": "api_key", "server": true }, "tags": [ "Businesses" ], "parameters": [ { "name": "vendor_data", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Ваш уникальный идентификатор компании (произвольная строка, НЕ UUID).", "example": "company-123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EntityStatusUpdateRequest" }, { "type": "object", "properties": { "reason": { "type": "string", "nullable": true, "maxLength": 1000, "description": "Причина изменения статуса. Записывается в записи об изменении статуса в разделе **Activity** компании в Business Console, только когда статус действительно меняется. В webhook не передается." } } } ] }, "examples": { "Flag": { "summary": "Пометить компанию для проверки", "value": { "status": "FLAGGED" } }, "Block": { "summary": "Заблокировать компанию (добавляет в системный список блокировки)", "value": { "status": "BLOCKED" } }, "Reactivate": { "summary": "Повторно активировать компанию", "value": { "status": "ACTIVE" } }, "Block with reason": { "summary": "Заблокировать компанию и указать причину", "value": { "status": "BLOCKED", "reason": "Registry shows the company dissolved" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/businesses/company-123/update-status/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"status\": \"BLOCKED\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.businesses.update_status(\n \"company-123\",\n status=\"FLAGGED\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.businesses.updateStatus(\"company-123\", {\n status: \"FLAGGED\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.UpdateStatus(ctx, \"company-123\", didit.BusinessesUpdateStatusParams{\n\tStatus: \"FLAGGED\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.BusinessesUpdateStatusParams;\nimport me.didit.types.EntityStatusUpdateRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.businesses().updateStatus(\"company-123\", BusinessesUpdateStatusParams.builder()\n .status(EntityStatusUpdateRequest.Status.of(\"FLAGGED\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->updateStatus('company-123', [\n 'status' => 'FLAGGED',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.businesses.update_status(\n \"company-123\",\n status: \"FLAGGED\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.UpdateStatusAsync(\"company-123\", new BusinessesUpdateStatusParams\n{\n Status = \"FLAGGED\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Статус компании обновлён. Возвращается полная запись компании.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessDetailItem" }, "examples": { "Blocked": { "value": { "didit_internal_id": "a1b2c3d4-e5f6-4890-abcd-ef1234567890", "vendor_data": "company-123", "display_name": null, "legal_name": "Acme Trading Ltd", "registration_number": "12345678", "country_code": "GB", "effective_name": "Acme Trading Ltd", "status": "BLOCKED", "session_count": 2, "approved_count": 1, "declined_count": 0, "in_review_count": 1, "features": { "KYB": "Approved" }, "features_list": [ { "feature": "KYB", "status": "Approved" } ], "last_session_at": "2026-03-15T10:30:00Z", "last_activity_at": "2026-03-15T10:30:00Z", "first_session_at": "2026-01-10T08:00:00Z", "tags": [ { "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "name": "VIP", "color": "#2567FF" } ], "created_at": "2026-01-10T08:00:00Z", "metadata": { "industry": "fintech" }, "updated_at": "2026-03-15T10:30:00Z" } } } } } }, "400": { "description": "Отсутствует или недействителен `status`, либо `reason` превышает 1000 символов.", "content": { "application/json": { "examples": { "Missing status": { "value": { "status": [ "This field is required." ] } }, "Bad status": { "value": { "status": [ "Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED" ] } }, "Reason too long": { "value": { "reason": [ "Ensure this field has no more than 1000 characters." ] } } } } } }, "403": { "description": "Отсутствующий, недействительный или отозванный API-ключ, либо у ключа нет прав на обновление компаний для этого приложения. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Для этого приложения не найдена (неудалённая) компания с указанным `vendor_data`.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Лимит запросов превышен; снизьте частоту запросов и повторите попытку через интервал, указанный в `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/businesses/delete/": { "post": { "summary": "Пакетное удаление компаний", "description": "**Удалить компании навсегда** — это действие необратимо. Для блокировки используйте [Update Business Status](#patch-/v3/businesses/-vendor_data-/update-status/) со статусом `BLOCKED`.\n\n**Поданные регуляторные отчёты:** если выбранные данные входят в финализированный регуляторный отчёт, весь запрос отклоняется с ошибкой `409`, и ничего не удаляется. Тело ответа содержит `code: in_filed_report` и указывает каждый отчёт с полями `uuid`, `report_number`, `report_type` и `case_uuid`. Удалите отчёты, затем повторите запрос.", "operationId": "batch_delete_businesses", "x-didit-sdk": { "resource": "businesses", "method": "batch_delete", "auth": "api_key", "server": true }, "tags": [ "Businesses" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Укажите `vendor_data_list`, `didit_internal_id_list` или `delete_all: true`. Приоритет при отправке нескольких параметров: `delete_all` > `vendor_data_list` > `didit_internal_id_list` (используется только селектор с наивысшим приоритетом).", "properties": { "vendor_data_list": { "type": "array", "items": { "type": "string" }, "description": "Ваши собственные идентификаторы для удаления, сопоставляемые в точности с переданными." }, "didit_internal_id_list": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Внутренние UUID Didit (`didit_internal_id`) для удаления." }, "delete_all": { "type": "boolean", "default": false, "description": "Если `true`, удаляет все компании в приложении. Не может сочетаться с селекторами списка." } } }, "examples": { "Specific businesses": { "summary": "Удалить по vendor_data", "value": { "vendor_data_list": [ "company-123", "company-456" ] } }, "Specific internal IDs": { "summary": "Удалить по didit_internal_id", "value": { "didit_internal_id_list": [ "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "b2c3d4e5-f6a7-8901-bcde-f12345678901" ] } }, "All businesses": { "summary": "Удалить все компании в этом приложении", "value": { "delete_all": true } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/businesses/delete/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"vendor_data_list\": [\"company-123\", \"company-456\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.businesses.batch_delete(\n vendor_data_list=[\"company-123\", \"company-456\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.businesses.batchDelete({\n vendor_data_list: [\"company-123\", \"company-456\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.BatchDelete(ctx, didit.BusinessesBatchDeleteParams{\n\tVendorDataList: didit.Some([]string{\"company-123\", \"company-456\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.BusinessesBatchDeleteParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.businesses().batchDelete(BusinessesBatchDeleteParams.builder()\n .vendorDataList(List.of(\"company-123\", \"company-456\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->batchDelete([\n 'vendor_data_list' => ['company-123', 'company-456'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.businesses.batch_delete(vendor_data_list: [\"company-123\", \"company-456\"])\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.BatchDeleteAsync(new BusinessesBatchDeleteParams\n{\n VendorDataList = new string[] { \"company-123\", \"company-456\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Компании удалены. Возвращает количество фактически удалённых строк.", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "integer", "description": "Количество удалённых компаний (исключает значения vendor_data, для которых ничего не найдено)." } } }, "examples": { "Deleted some": { "value": { "deleted": 2 } }, "Nothing matched": { "value": { "deleted": 0 } } } } } }, "400": { "description": "Селектор не указан (все поля `vendor_data_list`, `didit_internal_id_list` и `delete_all` отсутствуют или пусты). Тело ошибки представляет собой JSON-массив.", "content": { "application/json": { "examples": { "Missing selector": { "value": [ "Provide vendor_data_list, didit_internal_id_list, or set delete_all=true." ] } } } } }, "403": { "description": "Отсутствующий, недействительный или отозванный API-ключ, либо у ключа нет прав на удаление компаний для этого приложения. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Лимит запросов превышен; снизьте частоту запросов и повторите попытку через интервал, указанный в `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } }, "409": { "description": "Ничего не удалено. `code` указывает причину: `in_filed_report`, если в выборку входит компания из окончательного регуляторного отчёта, `subject_deletion_in_progress`, если другой запрос всё ещё удаляет одну из выбранных компаний. Повторите запрос после завершения этого удаления.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/InFiledReportError" }, { "$ref": "#/components/schemas/SubjectDeletionInProgressError" } ] } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/users/aml-monitoring/": { "post": { "summary": "Включить или отключить постоянный AML-мониторинг для пользователей", "description": "Включает или выключает постоянный AML-мониторинг для выбранных пользователей с той же семантикой, что и в Business Console. Для каждого пользователя сохраняется ровно один отслеживаемый AML-скрининг, поэтому профиль, прошедший верификацию несколько раз, отслеживается и тарифицируется единожды; отключение выключает мониторинг во всех скринингах этого профиля. Пользователи без какого-либо AML-скрининга сначала проходят скрининг (тарифицируется как обычный AML-скрининг), если у них есть необходимые для этого полное имя, дата рождения и страна; в противном случае они отмечаются как `skipped_no_identity_data`.\n\nЗадайте `estimate_only: true`, чтобы предварительно просмотреть количество и затраты без внесения изменений. Выборки из 20 профилей или менее обрабатываются синхронно и возвращают `200` с завершённой задачей; более крупные выборки возвращают `202` и выполняются в фоновом режиме: опрашивайте [Get AML monitoring job](#get-/v3/aml-monitoring/jobs/-job_id-/) с возвращённым `job_id`. Во включении будет отказано с кодом `403`, если баланс организации не покрывает расчётную стоимость. Идентификаторы, по которым ничего не найдено, перечисляются в `unmatched` и никогда не приводят к ошибке запроса: выборка без совпадений завершается как пустая задача (`total` 0), аналогично endpoints пакетного удаления.", "operationId": "toggle_users_aml_monitoring", "x-didit-sdk": { "resource": "users", "method": "set_aml_monitoring", "auth": "api_key", "server": true }, "tags": [ "AML Ongoing Monitoring" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "is_enabled" ], "description": "Выберите пользователей с помощью `vendor_data_list`, `didit_internal_id_list` или обоих параметров (два списка объединяются через OR). Не более 1000 идентификаторов на запрос в сумме по обоим спискам.", "properties": { "is_enabled": { "type": "boolean", "description": "true для включения мониторинга, false для его отключения." }, "estimate_only": { "type": "boolean", "default": false, "description": "Если true, возвращает предварительную оценку стоимости и не выполняет операций записи: без скрининга, без биллинга, без создания задачи." }, "vendor_data_list": { "type": "array", "items": { "type": "string" }, "description": "Ваши собственные идентификаторы пользователей для переключения, сопоставляемые в точности с переданными." }, "didit_internal_id_list": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Внутренние идентификаторы пользователей в Didit для переключения: `didit_internal_id`, возвращаемый endpoints создания, получения и вывода списка." } } }, "examples": { "Estimate first": { "summary": "Предварительный просмотр стоимости без записи", "value": { "is_enabled": true, "estimate_only": true, "vendor_data_list": [ "user-123", "user-456" ] } }, "Enable": { "summary": "Включить мониторинг для двух пользователей", "value": { "is_enabled": true, "vendor_data_list": [ "user-123", "user-456" ] } }, "Disable": { "summary": "Отключить мониторинг по внутреннему id Didit", "value": { "is_enabled": false, "didit_internal_id_list": [ "3f1c0d3e-8f0a-4c2e-9a3d-9b1f5f4a2c11" ] } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/users/aml-monitoring/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"is_enabled\": true, \"vendor_data_list\": [\"user-123\", \"user-456\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.users.set_aml_monitoring(\n is_enabled=True,\n estimate_only=True,\n vendor_data_list=[\"user-123\", \"user-456\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.users.setAmlMonitoring({\n is_enabled: true,\n estimate_only: true,\n vendor_data_list: [\"user-123\", \"user-456\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.SetAMLMonitoring(ctx, didit.UsersSetAMLMonitoringParams{\n\tIsEnabled: true,\n\tEstimateOnly: didit.Bool(true),\n\tVendorDataList: didit.Some([]string{\"user-123\", \"user-456\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.UsersSetAmlMonitoringParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.users().setAmlMonitoring(UsersSetAmlMonitoringParams.builder()\n .isEnabled(true)\n .estimateOnly(true)\n .vendorDataList(List.of(\"user-123\", \"user-456\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "users->setAmlMonitoring([\n 'is_enabled' => true,\n 'estimate_only' => true,\n 'vendor_data_list' => ['user-123', 'user-456'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.users.set_aml_monitoring(\n is_enabled: true,\n estimate_only: true,\n vendor_data_list: [\"user-123\", \"user-456\"]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Users.SetAmlMonitoringAsync(new UsersSetAmlMonitoringParams\n{\n IsEnabled = true,\n EstimateOnly = true,\n VendorDataList = new string[] { \"user-123\", \"user-456\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Предварительная оценка (когда `estimate_only` равно true) или завершённое задание для выборки, обработанной синхронно.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AMLMonitoringToggleResult" } } } }, "202": { "description": "Более крупные выборки обрабатываются в фоновом режиме. Опрашивайте endpoint задачи с `job_id`; `results` заполняется по мере обработки профилей.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AMLMonitoringJob" } } } }, "400": { "description": "Ошибка валидации: отсутствует `is_enabled`, нет селектора или в обоих списках суммарно указано более 1000 идентификаторов." }, "401": { "description": "Отсутствует или недействителен API-ключ." }, "403": { "description": "Недостаточно средств на балансе для включения мониторинга для этого выбора. Ответ содержит `estimate`, чтобы вы могли пополнить баланс на нужную сумму.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "estimate": { "type": "object", "description": "Предварительный расчёт стоимости. Возвращается напрямую, если estimate_only имеет значение true (ничего не записывается).", "properties": { "users_total": { "type": "integer", "description": "Профили, соответствующие выборке." }, "already_enabled": { "type": "integer", "description": "Профили, которые уже находятся на мониторинге (при включении действий не требуется; это профили, которые отключаются при деактивации)." }, "with_existing_aml": { "type": "integer", "description": "Профили, для которых существующий AML-скрининг будет переведён в статус постоянного мониторинга (новый скрининг не проводится)." }, "needing_screening": { "type": "integer", "description": "Профили без AML-скрининга, для которых скрининг будет проведён впервые (оплачивается как обычный AML-скрининг)." }, "skipped_no_identity_data": { "type": "integer", "description": "Профили, для которых невозможно провести скрининг из-за отсутствия идентификационных данных." }, "skipped_blocked": { "type": "integer", "description": "Заблокированные пользователи, которые будут пропущены (всегда 0 для компаний)." }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2, "description": "Разовая стоимость новых проверок." }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07, "description": "Ежегодная стоимость мониторинга профилей, которые будут отслеживаться." }, "balance_sufficient": { "type": "boolean", "description": "Покрывает ли баланс организации скрининг плюс первый год мониторинга." } } } } } } } } } } }, "/v3/businesses/aml-monitoring/": { "post": { "summary": "Включить или отключить постоянный AML-мониторинг для компаний", "description": "Включает или выключает постоянный AML-мониторинг для выбранных компаний с той же семантикой, что и в Business Console. Для каждой компании сохраняется ровно один отслеживаемый AML-скрининг, поэтому профиль, прошедший верификацию несколько раз, отслеживается и тарифицируется единожды; отключение выключает мониторинг во всех скринингах этого профиля. Компании без какого-либо AML-скрининга сначала проходят скрининг (тарифицируется как обычный AML-скрининг), если у них есть необходимое юридическое или отображаемое наименование; в противном случае они отмечаются как `skipped_no_identity_data`.\n\nЗадайте `estimate_only: true`, чтобы предварительно просмотреть количество и затраты без внесения изменений. Выборки из 20 профилей или менее обрабатываются синхронно и возвращают `200` с завершённой задачей; более крупные выборки возвращают `202` и выполняются в фоновом режиме: опрашивайте [Get AML monitoring job](#get-/v3/aml-monitoring/jobs/-job_id-/) с возвращённым `job_id`. Во включении будет отказано с кодом `403`, если баланс организации не покрывает расчётную стоимость. Идентификаторы, по которым ничего не найдено, перечисляются в `unmatched` и никогда не приводят к ошибке запроса: выборка без совпадений завершается как пустая задача (`total` 0), аналогично endpoint пакетного удаления.", "operationId": "toggle_businesses_aml_monitoring", "x-didit-sdk": { "resource": "businesses", "method": "set_aml_monitoring", "auth": "api_key", "server": true }, "tags": [ "AML Ongoing Monitoring" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "is_enabled" ], "description": "Выберите компании с помощью `vendor_data_list`, `didit_internal_id_list` или обоих параметров (два списка объединяются через OR). Не более 1000 идентификаторов на запрос в сумме по обоим спискам.", "properties": { "is_enabled": { "type": "boolean", "description": "true для включения мониторинга, false для его отключения." }, "estimate_only": { "type": "boolean", "default": false, "description": "Если true, возвращает предварительную оценку стоимости и не выполняет операций записи: без скрининга, без биллинга, без создания задачи." }, "vendor_data_list": { "type": "array", "items": { "type": "string" }, "description": "Ваши собственные идентификаторы компаний для переключения, сопоставляемые в точности с переданными." }, "didit_internal_id_list": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Внутренние идентификаторы компаний в Didit для переключения: `didit_internal_id`, возвращаемый endpoints создания, получения и вывода списка." } } }, "examples": { "Estimate first": { "summary": "Предварительный просмотр стоимости без записи", "value": { "is_enabled": true, "estimate_only": true, "vendor_data_list": [ "company-123", "company-456" ] } }, "Enable": { "summary": "Включить мониторинг для двух компаний", "value": { "is_enabled": true, "vendor_data_list": [ "company-123", "company-456" ] } }, "Disable": { "summary": "Отключить мониторинг по внутреннему id Didit", "value": { "is_enabled": false, "didit_internal_id_list": [ "3f1c0d3e-8f0a-4c2e-9a3d-9b1f5f4a2c11" ] } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/businesses/aml-monitoring/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"is_enabled\": true, \"vendor_data_list\": [\"company-123\", \"company-456\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.businesses.set_aml_monitoring(\n is_enabled=True,\n estimate_only=True,\n vendor_data_list=[\"company-123\", \"company-456\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.businesses.setAmlMonitoring({\n is_enabled: true,\n estimate_only: true,\n vendor_data_list: [\"company-123\", \"company-456\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.SetAMLMonitoring(ctx, didit.BusinessesSetAMLMonitoringParams{\n\tIsEnabled: true,\n\tEstimateOnly: didit.Bool(true),\n\tVendorDataList: didit.Some([]string{\"company-123\", \"company-456\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.BusinessesSetAmlMonitoringParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.businesses().setAmlMonitoring(BusinessesSetAmlMonitoringParams.builder()\n .isEnabled(true)\n .estimateOnly(true)\n .vendorDataList(List.of(\"company-123\", \"company-456\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->setAmlMonitoring([\n 'is_enabled' => true,\n 'estimate_only' => true,\n 'vendor_data_list' => ['company-123', 'company-456'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.businesses.set_aml_monitoring(\n is_enabled: true,\n estimate_only: true,\n vendor_data_list: [\"company-123\", \"company-456\"]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.SetAmlMonitoringAsync(new BusinessesSetAmlMonitoringParams\n{\n IsEnabled = true,\n EstimateOnly = true,\n VendorDataList = new string[] { \"company-123\", \"company-456\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Предварительная оценка (когда `estimate_only` равно true) или завершённое задание для выборки, обработанной синхронно.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AMLMonitoringToggleResult" } } } }, "202": { "description": "Более крупные выборки обрабатываются в фоновом режиме. Опрашивайте endpoint задачи с `job_id`; `results` заполняется по мере обработки профилей.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AMLMonitoringJob" } } } }, "400": { "description": "Ошибка валидации: отсутствует `is_enabled`, нет селектора или в обоих списках суммарно указано более 1000 идентификаторов." }, "401": { "description": "Отсутствует или недействителен API-ключ." }, "403": { "description": "Недостаточно средств на балансе для включения мониторинга для этого выбора. Ответ содержит `estimate`, чтобы вы могли пополнить баланс на нужную сумму.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "estimate": { "type": "object", "description": "Предварительный расчёт стоимости. Возвращается напрямую, если estimate_only имеет значение true (ничего не записывается).", "properties": { "users_total": { "type": "integer", "description": "Профили, соответствующие выборке." }, "already_enabled": { "type": "integer", "description": "Профили, которые уже находятся на мониторинге (при включении действий не требуется; это профили, которые отключаются при деактивации)." }, "with_existing_aml": { "type": "integer", "description": "Профили, для которых существующий AML-скрининг будет переведён в статус постоянного мониторинга (новый скрининг не проводится)." }, "needing_screening": { "type": "integer", "description": "Профили без AML-скрининга, для которых скрининг будет проведён впервые (оплачивается как обычный AML-скрининг)." }, "skipped_no_identity_data": { "type": "integer", "description": "Профили, для которых невозможно провести скрининг из-за отсутствия идентификационных данных." }, "skipped_blocked": { "type": "integer", "description": "Заблокированные пользователи, которые будут пропущены (всегда 0 для компаний)." }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2, "description": "Разовая стоимость новых проверок." }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07, "description": "Ежегодная стоимость мониторинга профилей, которые будут отслеживаться." }, "balance_sufficient": { "type": "boolean", "description": "Покрывает ли баланс организации скрининг плюс первый год мониторинга." } } } } } } } } } } }, "/v3/aml-monitoring/jobs/{job_id}/": { "get": { "summary": "Получить задачу постоянного AML-мониторинга", "description": "Статус, счётчики результатов и построчные результаты задачи переключения мониторинга, запущенной с помощью `POST /v3/users/aml-monitoring/` или `POST /v3/businesses/aml-monitoring/`. Опрашивайте каждые несколько секунд, пока `status` равен `PENDING` или `PROCESSING`; массив `results` заполняется полностью после перехода в `COMPLETED`.", "operationId": "get_aml_monitoring_job", "x-didit-sdk": { "resource": "aml_monitoring", "method": "retrieve_job", "auth": "api_key", "server": true }, "tags": [ "AML Ongoing Monitoring" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Параметр `job_id`, возвращённый endpoint переключения." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl 'https://verification.didit.me/v3/aml-monitoring/jobs/JOB_ID/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.aml_monitoring.retrieve_job(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.amlMonitoring.retrieveJob(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.AMLMonitoring.RetrieveJob(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.amlMonitoring().retrieveJob(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "amlMonitoring->retrieveJob('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.aml_monitoring.retrieve_job(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.AmlMonitoring.RetrieveJobAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Задание.", "content": { "application/json": { "schema": { "type": "object", "properties": { "job_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "COMPLETED", "FAILED" ] }, "is_enabled": { "type": "boolean", "description": "true, если задача включает мониторинг; false, если отключает его." }, "target_type": { "type": "string", "enum": [ "user", "business" ], "description": "Какое семейство профилей переключает задача." }, "total": { "type": "integer", "description": "Профили, обрабатываемые задачей." }, "processed": { "type": "integer", "description": "Профили, обработанные к настоящему моменту." }, "outcomes": { "type": "object", "description": "Счётчики результатов по записям. Каждый выбранный профиль относится ровно к одному счётчику; ничто не пропускается незаметно.", "properties": { "enabled": { "type": "integer", "description": "Мониторинг включен для существующего AML-скрининга." }, "screened_and_enabled": { "type": "integer", "description": "Новый AML-скрининг был создан (списана оплата) и на нём включён мониторинг." }, "already_enabled": { "type": "integer", "description": "Мониторинг уже был активен; ничего не изменилось, средства не списывались." }, "disabled": { "type": "integer", "description": "Мониторинг отключен для каждого AML-скрининга профиля." }, "skipped_no_identity_data": { "type": "integer", "description": "Пропущено: в профиле отсутствуют полное имя, дата рождения и страна (для пользователей) или наименование (для компаний), необходимые для проведения проверки." }, "skipped_blocked": { "type": "integer", "description": "Пропущено: пользователь заблокирован." }, "skipped_sandbox": { "type": "integer", "description": "Пропущено: приложение песочницы, скрининг не создается." }, "failed_provider": { "type": "integer", "description": "Скрининг не удалось завершить; повторите попытку позже." }, "failed_insufficient_balance": { "type": "integer", "description": "Баланс исчерпан во время выполнения задания." } } }, "results": { "type": "array", "description": "Одна запись на каждый обработанный профиль в порядке обработки. Пополняется во время выполнения задания; заполняется полностью после перехода статуса в COMPLETED. Фиксируется для заданий, запущенных через API; задание, запущенное из Business Console, возвращает только счётчики.", "items": { "type": "object", "properties": { "didit_internal_id": { "type": "string", "format": "uuid", "description": "Внутренний идентификатор профиля в Didit." }, "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный идентификатор профиля." }, "outcome": { "type": "string", "enum": [ "enabled", "screened_and_enabled", "already_enabled", "disabled", "skipped_no_identity_data", "skipped_blocked", "skipped_sandbox", "failed_provider", "failed_insufficient_balance" ] } } } }, "error": { "type": "string", "nullable": true, "description": "Общее сообщение об ошибке, когда статус FAILED; подробная причина сохраняется на стороне платформы." }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time", "nullable": true } } } } } }, "401": { "description": "Отсутствует или недействителен API-ключ." }, "404": { "description": "Такая задача отсутствует для этого приложения." } } } }, "/v3/users/{vendor_data}/update-status/": { "patch": { "summary": "Обновить статус пользователя", "description": "Переключить только `status` жизненного цикла пользователя: `ACTIVE`, `FLAGGED` или `BLOCKED` (не статусы сессии). `BLOCKED` добавляет `vendor_data` в системный список блокировки; выход из `BLOCKED` удаляет эту запись. Каждое изменение фиксируется как действие `STATUS_CHANGED` пользователя с необязательным `reason` в качестве `comment`. Отправка текущего статуса ничего не меняет и не записывает `reason`. Webhook `user.status.updated` не содержит `reason`.", "operationId": "update_user_status", "x-didit-sdk": { "resource": "users", "method": "update_status", "auth": "api_key", "server": true }, "tags": [ "Users" ], "parameters": [ { "name": "vendor_data", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Ваш уникальный идентификатор пользователя." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EntityStatusUpdateRequest" }, { "type": "object", "properties": { "reason": { "type": "string", "nullable": true, "maxLength": 1000, "description": "Причина изменения статуса. Записывается в записи об изменении статуса в активности пользователя (`comments[].comment` и раздел **Activity** в Business Console), только когда статус действительно меняется. В webhook не передается." } } } ] }, "examples": { "Activate": { "summary": "Повторно активировать пользователя", "value": { "status": "ACTIVE" } }, "Flag": { "summary": "Пометить пользователя для проверки", "value": { "status": "FLAGGED" } }, "Block": { "summary": "Заблокировать пользователя (добавляет в системный список блокировки)", "value": { "status": "BLOCKED" } }, "Block with reason": { "summary": "Заблокировать пользователя и указать причину", "value": { "status": "BLOCKED", "reason": "Chargeback fraud pattern confirmed" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/update-status/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"status\": \"BLOCKED\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.users.update_status(\n \"user-123\",\n status=\"ACTIVE\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.users.updateStatus(\"user-123\", {\n status: \"ACTIVE\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.UpdateStatus(ctx, \"user-123\", didit.UsersUpdateStatusParams{\n\tStatus: \"ACTIVE\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.EntityStatusUpdateRequest;\nimport me.didit.types.UsersUpdateStatusParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.users().updateStatus(\"user-123\", UsersUpdateStatusParams.builder()\n .status(EntityStatusUpdateRequest.Status.of(\"ACTIVE\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "users->updateStatus('user-123', [\n 'status' => 'ACTIVE',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.users.update_status(\n \"user-123\",\n status: \"ACTIVE\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Users.UpdateStatusAsync(\"user-123\", new UsersUpdateStatusParams\n{\n Status = \"ACTIVE\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Статус пользователя обновлён. Возвращается полная запись пользователя.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetailItem" }, "examples": { "Blocked": { "value": { "didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418", "vendor_data": "user-abc-123", "display_name": null, "full_name": "John Michael Doe", "date_of_birth": "1990-05-15", "effective_name": "John Michael Doe", "status": "BLOCKED", "metadata": { "tier": "premium", "source": "website" }, "portrait_image_url": "https:///...", "session_count": 3, "approved_count": 2, "declined_count": 0, "in_review_count": 1, "issuing_states": [ "USA" ], "approved_emails": [ "john@example.com" ], "approved_phones": [ "+14155551234" ], "features": { "ID_VERIFICATION": "Approved", "LIVENESS": "Approved", "FACE_MATCH": "Approved", "AML": "Approved" }, "features_list": [ { "feature": "ID_VERIFICATION", "status": "Approved" }, { "feature": "LIVENESS", "status": "Approved" }, { "feature": "FACE_MATCH", "status": "Approved" }, { "feature": "AML", "status": "Approved" } ], "last_session_at": "2025-06-15T10:30:00Z", "last_activity_at": "2025-06-15T10:30:00Z", "first_session_at": "2025-06-01T08:00:00Z", "tags": [ { "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "tag": { "uuid": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b", "name": "VIP", "color": "#2567FF", "description": null, "source": "custom", "created_at": "2025-05-01T09:00:00Z", "updated_at": "2025-05-01T09:00:00Z" }, "added_by_email": "analyst@acme.com", "added_by_name": "Jane Analyst", "created_at": "2025-06-02T11:00:00Z" } ], "comments": [ { "uuid": "c1111111-2222-4333-8444-555555555555", "comment_type": "STATUS_CHANGED", "comment": "Chargeback fraud pattern confirmed", "actor_email": null, "actor_name": null, "previous_status": "ACTIVE", "new_status": "BLOCKED", "previous_value": null, "new_value": null, "changed_fields": [], "metadata": null, "mentioned_emails": [], "created_at": "2025-06-15T10:30:00Z" } ], "created_at": "2025-06-01T08:00:00Z", "updated_at": "2025-06-15T10:30:00Z" } } } } } }, "400": { "description": "Отсутствует или недействителен `status`, либо `reason` превышает 1000 символов.", "content": { "application/json": { "examples": { "Missing status": { "value": { "status": [ "This field is required." ] } }, "Bad status": { "value": { "status": [ "Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED" ] } }, "Reason too long": { "value": { "reason": [ "Ensure this field has no more than 1000 characters." ] } } } } } }, "401": { "description": "Учетные данные не переданы. Запросы к путям `/v3/users/*` без заголовка `x-api-key` (или токена `Authorization: Bearer`) отклоняются промежуточным ПО аутентификации до попадания в API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "Ключ не может обновлять пользователей для этого приложения. Отсутствующий ключ возвращает `403`; неверный, отозванный или просроченный ключ возвращает `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Для этого приложения не найден (неудалённый) пользователь с указанным `vendor_data`.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Лимит запросов превышен; снизьте частоту запросов и повторите попытку через интервал, указанный в `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/businesses/create/": { "post": { "summary": "Создать компанию", "description": "Предварительно создать [компанию](/entities/businesses) *без* KYB-сессии. Все поля опциональны, но вам всегда следует передавать `vendor_data` — без этого запись невозможно связать с сессиями или транзакциями. При передаче `vendor_data` должно быть уникальным среди неудалённых компаний (точное совпадение; при конфликте возвращается 400). Операция не является идемпотентной.", "operationId": "create_business", "x-didit-sdk": { "resource": "businesses", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Businesses" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш уникальный идентификатор этой компании (произвольная строка, НЕ UUID). Необязательно, но настоятельно рекомендуется. При указании должен быть уникальным среди неудалённых компаний приложения; сопоставляется в точности в переданном виде." }, "display_name": { "type": "string", "nullable": true, "maxLength": 255, "description": "Понятное отображаемое имя, показываемое в консоли (имеет приоритет над `legal_name` при отображении в интерфейсе)." }, "legal_name": { "type": "string", "nullable": true, "maxLength": 255, "description": "Официальное юридическое наименование компании." }, "registration_number": { "type": "string", "nullable": true, "maxLength": 100, "description": "Регистрационный номер или номер инкорпорации компании." }, "country_code": { "type": "string", "nullable": true, "maxLength": 10, "description": "Страна инкорпорации (ISO 3166-1 alpha-2, например, `GB`, `US`)." }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "default": "ACTIVE", "description": "Начальный статус жизненного цикла. По умолчанию `ACTIVE`." }, "metadata": { "type": "object", "nullable": true, "description": "Произвольный JSON-объект, прикрепляемый к компании. По умолчанию `{}`." } } }, "examples": { "Basic": { "summary": "Рекомендуемый минимум", "value": { "vendor_data": "company-456", "legal_name": "New Corp Ltd", "country_code": "US" } }, "Full": { "summary": "Все поля", "value": { "vendor_data": "company-789", "display_name": "New Corp", "legal_name": "New Corp International Ltd", "registration_number": "98765432", "country_code": "DE", "status": "ACTIVE", "metadata": { "industry": "fintech", "tier": "enterprise" } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/businesses/create/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"vendor_data\": \"company-456\", \"legal_name\": \"New Corp Ltd\", \"country_code\": \"US\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.businesses.create(\n vendor_data=\"company-456\",\n legal_name=\"New Corp Ltd\",\n country_code=\"US\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.businesses.create({\n vendor_data: \"company-456\",\n legal_name: \"New Corp Ltd\",\n country_code: \"US\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.Create(ctx, didit.BusinessesCreateParams{\n\tVendorData: didit.String(\"company-456\"),\n\tLegalName: didit.String(\"New Corp Ltd\"),\n\tCountryCode: didit.String(\"US\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.BusinessesCreateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.businesses().create(BusinessesCreateParams.builder()\n .vendorData(\"company-456\")\n .legalName(\"New Corp Ltd\")\n .countryCode(\"US\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->create([\n 'vendor_data' => 'company-456',\n 'legal_name' => 'New Corp Ltd',\n 'country_code' => 'US',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.businesses.create(\n vendor_data: \"company-456\",\n legal_name: \"New Corp Ltd\",\n country_code: \"US\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.CreateAsync(new BusinessesCreateParams\n{\n VendorData = \"company-456\",\n LegalName = \"New Corp Ltd\",\n CountryCode = \"US\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Компания создана. Возвращается полная запись компании (в том же формате, что и Get Business).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessDetailItem" }, "examples": { "Created": { "value": { "didit_internal_id": "a1b2c3d4-e5f6-4890-abcd-ef1234567890", "vendor_data": "company-456", "display_name": null, "legal_name": "New Corp Ltd", "registration_number": null, "country_code": "US", "effective_name": "New Corp Ltd", "status": "ACTIVE", "session_count": 0, "approved_count": 0, "declined_count": 0, "in_review_count": 0, "features": {}, "features_list": [], "last_session_at": null, "last_activity_at": "2026-03-15T10:30:00Z", "first_session_at": null, "tags": [], "created_at": "2026-03-15T10:30:00Z", "metadata": {}, "updated_at": "2026-03-15T10:30:00Z" } } } } } }, "400": { "description": "Недопустимое тело запроса — обычно дубликат `vendor_data`, неизвестный `status` или некорректные `metadata`.", "content": { "application/json": { "examples": { "Duplicate": { "value": { "vendor_data": [ "A business with this vendor_data already exists." ] } }, "Bad status": { "value": { "status": [ "Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED" ] } }, "Bad metadata": { "value": { "metadata": [ "Metadata must be a JSON object." ] } } } } } }, "403": { "description": "Отсутствует, недействителен или отозван API-ключ, либо ключ не позволяет создавать компании для этого приложения. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Лимит запросов превышен; снизьте частоту запросов и повторите попытку через интервал, указанный в `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/users/create/": { "post": { "summary": "Создать пользователя", "description": "Создайте [пользователя](/entities/users) по `vendor_data` до сессии верификации или без неё. Поле `vendor_data` должно быть уникальным среди пользователей приложения (при обнаружении дубликата возвращается `400`). Не идемпотентно.\n\n**Контактные данные:** `email` и `phone_number` сохраняются в `metadata.contact`, а `country` сохраняется в `metadata.address`. Если вы передаёте `first_name` или `last_name` без `full_name`, Didit объединяет их в `full_name`.\n\n**Ссылка на верификацию:** при `send_verification_link: true` Didit также создаёт для пользователя сессию верификации на основе `workflow_id` и отправляет ему ссылку на `email`. В рамках сессии выполняются те же проверки, что и в [Создании сессии](/ru/sessions-api/create-session), например проверка по списку блокировки и проверка баланса кредитов. Пользователь и сессия создаются только вместе: если любая из проверок завершается ошибкой, ничего не записывается и письмо не отправляется. Поле `verification_link` в ответе содержит сведения о сессии, и возвращается `null`, если ссылка не запрашивалась.\n\n**Доступ по API-ключу:** API-ключу с ограниченным доступом требуется разрешение на запись в `users`. При `send_verification_link: true` ему также требуется разрешение на запись в `sessions`, иначе запрос возвращает `403` до внесения каких-либо изменений. Ключи с полным доступом работают без изменений. См. [API-ключи](/ru/console/api-keys).", "operationId": "create_user", "x-didit-sdk": { "resource": "users", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Users" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "vendor_data" ], "properties": { "vendor_data": { "type": "string", "description": "Ваш уникальный идентификатор этого пользователя (произвольная строка, НЕ UUID). Должен быть уникальным среди пользователей приложения; сопоставляется в точности в переданном виде." }, "full_name": { "type": "string", "nullable": true, "maxLength": 512, "description": "Полное юридическое имя пользователя." }, "display_name": { "type": "string", "nullable": true, "description": "Понятное отображаемое имя, показываемое в консоли (имеет приоритет над `full_name` при отображении в интерфейсе).", "maxLength": 255 }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Дата рождения в формате `YYYY-MM-DD`." }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "default": "ACTIVE", "description": "Начальный статус жизненного цикла. По умолчанию `ACTIVE`." }, "metadata": { "type": "object", "nullable": true, "description": "Произвольный JSON-объект, прикрепляемый к пользователю. По умолчанию `{}`." }, "approved_emails": { "type": "array", "items": { "type": "string" }, "description": "Заранее добавленные в доверенные адреса электронной почты для этого пользователя, например `[\"john@example.com\"]`." }, "approved_phones": { "type": "array", "items": { "type": "string" }, "description": "Заранее добавленные в доверенные номера телефонов для этого пользователя, например `[\"+14155551234\"]`." }, "issuing_states": { "type": "array", "items": { "type": "string" }, "description": "Заранее указанные страны выдачи (ISO 3166-1 alpha-3), например `[\"USA\"]`." }, "first_name": { "type": "string", "maxLength": 255, "description": "Имя. Если `full_name` не передан, Didit объединяет `first_name` и `last_name` через пробел в `full_name`. Не возвращается отдельным полем." }, "last_name": { "type": "string", "maxLength": 255, "description": "Фамилия. Объединяется с `first_name` в `full_name`, если `full_name` не передан. Не возвращается отдельным полем." }, "email": { "type": "string", "format": "email", "description": "Контактный email, сохраняемый в `metadata.contact.email` (заменяет `email`, переданный вами внутри `metadata.contact`). Обязателен, если `send_verification_link` равен `true`: ссылка отправляется на этот адрес. Если `metadata.contact` не является объектом JSON, вызов возвращает ошибку `400` для этого поля." }, "phone_number": { "type": "string", "maxLength": 32, "description": "Контактный номер телефона, сохранённый в `metadata.contact.phone_number`. Если `metadata.contact` не является JSON-объектом, вызов возвращает `400` для этого поля." }, "country": { "type": "string", "maxLength": 3, "description": "Страна в виде кода ISO 3166, alpha-2 или alpha-3 (`ES` или `ESP`). Сохраняется в верхнем регистре в `metadata.address.country`. Если `metadata.address` не является JSON-объектом, вызов вернёт `400` для этого поля." }, "send_verification_link": { "type": "boolean", "default": false, "description": "Когда `true`, Didit создает сессию верификации для человека по `workflow_id` и отправляет ему ссылку по электронной почте на `email`. Требуются `email` и `workflow_id`. API-ключу с ограниченной областью действия также требуется разрешение на запись в `sessions`." }, "workflow_id": { "type": "string", "format": "uuid", "description": "Сценарий сессии верификации. Обязателен, если `send_verification_link` имеет значение `true`. Должен верифицировать физическое лицо: сценарий Верификация бизнеса (KYB) будет отклонён. В остальных случаях игнорируется." }, "language": { "type": "string", "maxLength": 10, "description": "Язык письма для верификации в виде кода [поддерживаемого языка](/ru/integration/supported-languages). Если значение не указано, используется английский. Игнорируется, если `send_verification_link` не равен `true`." } } }, "examples": { "Basic": { "summary": "Создать с базовой информацией", "value": { "vendor_data": "user-abc-123", "full_name": "John Doe" } }, "Full": { "summary": "Все поля", "value": { "vendor_data": "user-abc-456", "full_name": "Jane Smith", "display_name": "Jane S.", "date_of_birth": "1990-05-15", "status": "ACTIVE", "metadata": { "tier": "premium", "source": "api" }, "approved_emails": [ "jane@example.com" ] } }, "Contact details": { "summary": "Имя, адрес электронной почты, номер телефона и страна", "value": { "vendor_data": "user-abc-789", "first_name": "Julia", "last_name": "Martin", "email": "julia.martin@example.com", "phone_number": "+34600000000", "country": "ES" } }, "With verification link": { "summary": "Создать физлицо и отправить ему ссылку на верификацию по электронной почте", "value": { "vendor_data": "user-abc-789", "first_name": "Julia", "last_name": "Martin", "email": "julia.martin@example.com", "send_verification_link": true, "workflow_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "language": "es" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/users/create/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"vendor_data\": \"user-abc-123\", \"full_name\": \"John Doe\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.users.create(\n vendor_data=\"user-abc-123\",\n full_name=\"John Doe\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.users.create({\n vendor_data: \"user-abc-123\",\n full_name: \"John Doe\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.Create(ctx, didit.UsersCreateParams{\n\tVendorData: \"user-abc-123\",\n\tFullName: didit.String(\"John Doe\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.UsersCreateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.users().create(UsersCreateParams.builder()\n .vendorData(\"user-abc-123\")\n .fullName(\"John Doe\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "users->create([\n 'vendor_data' => 'user-abc-123',\n 'full_name' => 'John Doe',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.users.create(\n vendor_data: \"user-abc-123\",\n full_name: \"John Doe\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Users.CreateAsync(new UsersCreateParams\n{\n VendorData = \"user-abc-123\",\n FullName = \"John Doe\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Пользователь создан. Полная запись пользователя (такой же структуры, как в Get User), а также `verification_link`: сессия верификации, отправленная Didit по электронной почте, если `send_verification_link` был равен `true`, иначе `null`.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserDetailItem" }, { "type": "object", "required": [ "verification_link" ], "properties": { "verification_link": { "type": "object", "nullable": true, "description": "Сессия верификации, созданная Didit и отправленная пользователю по электронной почте. Присутствует всегда: `null`, если `send_verification_link` не был равен `true`.", "required": [ "session_id", "session_number", "status", "url", "workflow_id", "email" ], "properties": { "session_id": { "type": "string", "format": "uuid", "description": "ID сессии верификации." }, "session_number": { "type": "integer", "description": "Порядковый номер сессии внутри вашего приложения." }, "status": { "type": "string", "description": "Статус сессии; `Not Started` для только что созданной сессии." }, "url": { "type": "string", "format": "uri", "description": "Ссылка на верификацию, отправленная Didit пользователю по электронной почте." }, "workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Сценарий, который выполняет сессия." }, "email": { "type": "string", "format": "email", "description": "Адрес, на который была отправлена ссылка." } } } } } ] }, "examples": { "Created": { "value": { "didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418", "vendor_data": "user-abc-123", "display_name": null, "full_name": "John Doe", "date_of_birth": null, "effective_name": "John Doe", "status": "ACTIVE", "metadata": {}, "portrait_image_url": null, "session_count": 0, "approved_count": 0, "declined_count": 0, "in_review_count": 0, "issuing_states": [], "approved_emails": [], "approved_phones": [], "features": {}, "features_list": [], "last_session_at": null, "last_activity_at": "2025-06-15T10:30:00Z", "first_session_at": null, "tags": [], "comments": [], "created_at": "2025-06-15T10:30:00Z", "updated_at": "2025-06-15T10:30:00Z", "verification_link": null } }, "Created with verification link": { "value": { "didit_internal_id": "9b2f6c1e-3d4a-4e5f-8a7b-1c2d3e4f5a6b", "vendor_data": "user-abc-789", "display_name": null, "full_name": "Julia Martin", "date_of_birth": null, "effective_name": "Julia Martin", "status": "ACTIVE", "metadata": { "contact": { "email": "julia.martin@example.com" } }, "portrait_image_url": null, "session_count": 1, "approved_count": 0, "declined_count": 0, "in_review_count": 0, "issuing_states": [], "approved_emails": [], "approved_phones": [], "features": {}, "features_list": [], "last_session_at": "2025-06-15T10:30:00Z", "last_activity_at": "2025-06-15T10:30:00Z", "first_session_at": "2025-06-15T10:30:00Z", "tags": [], "comments": [], "created_at": "2025-06-15T10:30:00Z", "updated_at": "2025-06-15T10:30:00Z", "verification_link": { "session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa7", "session_number": 43762, "status": "Not Started", "url": "https://verify.didit.me/en/session/3FaJ9wLqX2Mz", "workflow_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "email": "julia.martin@example.com" } } } } } } }, "400": { "description": "Недопустимое тело запроса с разбивкой по полям: обычно дубликат `vendor_data`, отсутствие обязательного поля или некорректное значение. При `send_verification_link: true` также отсутствие `email` или `workflow_id`, неизвестный сценарий или сценарий Верификация бизнеса (KYB), неподдерживаемый `language` (с ключом `contact_details.email_lang`), `vendor_data` из списка блокировки или недостаточное количество кредитов для запуска сессии. Никаких данных не записано.", "content": { "application/json": { "examples": { "Duplicate": { "value": { "vendor_data": [ "A user with this vendor_data already exists." ] } }, "Missing vendor_data": { "value": { "vendor_data": [ "This field is required." ] } }, "Bad metadata": { "value": { "metadata": [ "Metadata must be a JSON object." ] } }, "Bad status": { "value": { "status": [ "Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED" ] } }, "Bad country": { "value": { "country": [ "Use an ISO 3166 country code, like ES or ESP." ] } }, "Contact not an object": { "value": { "email": [ "metadata.contact must be a JSON object to store this value." ] } }, "Address not an object": { "value": { "country": [ "metadata.address must be a JSON object to store this value." ] } }, "Link without email or workflow": { "value": { "email": [ "An email address is required to send a verification link." ], "workflow_id": [ "Pick the workflow to send a verification link for." ] } }, "Unknown workflow": { "value": { "workflow_id": [ "Invalid workflow_id." ] } }, "Business workflow": { "value": { "workflow_id": [ "This workflow verifies a business. Pick a workflow that verifies a person to send them a verification link." ] } }, "Blocklisted vendor_data": { "value": { "vendor_data": "This user or business has been blocked and cannot create new verification sessions." } }, "Insufficient credits": { "value": { "detail": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "401": { "description": "Учетные данные не переданы. Запросы к путям `/v3/users/*` без заголовка `x-api-key` (или токена `Authorization: Bearer`) отклоняются промежуточным ПО аутентификации до попадания в API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "Недействительный или отозванный API-ключ, либо ключ не может создавать пользователей для этого приложения. API-ключу с ограниченной областью действия требуется разрешение на запись `users`, а также запись `sessions`, если `send_verification_link` равен `true`; никакие данные не записаны. При отсутствии ключа возвращается `403`; при неверном, отозванном или истёкшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } }, "No sessions write": { "summary": "Ключ с ограниченной областью действия запрашивает ссылку на верификацию без прав на запись сессий", "value": { "detail": "This API key has no write access to sessions." } } } } } }, "429": { "description": "Лимит запросов превышен; снизьте частоту запросов и повторите попытку через интервал, указанный в `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/vendor-users/by-id/{didit_internal_id}/faces/upload/": { "post": { "summary": "Загрузить лицо пользователя", "description": "Прикрепить доверенное импортированное изображение лица к существующему профилю пользователя. Используйте этот метод после создания или получения пользователя по `vendor_data` и чтения его `didit_internal_id`. Загруженное лицо сохраняется в профиле пользователя и индексируется для обнаружения дубликатов и поиска по лицу. Оно не добавляется в список блокировки лиц.", "operationId": "upload_user_face", "x-didit-sdk": { "resource": "users", "method": "upload_face", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Users" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации, владеющей приложением." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения, которому принадлежит профиль пользователя." }, { "name": "didit_internal_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Внутренний UUID пользователя Didit, возвращаемый как `didit_internal_id` методами `GET /v3/users/{vendor_data}/` и `POST /v3/users/create/`." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "image" ], "properties": { "image": { "type": "string", "format": "byte", "description": "Необработанное изображение лица в формате JPG или PNG в кодировке base64. Не включайте префикс `data:image/...;base64,`. Максимальный размер после декодирования: 2 МБ." }, "comment": { "type": "string", "description": "Необязательная видимая оператору заметка для загруженного лица.", "default": "" } } }, "examples": { "Imported face": { "summary": "Прикрепить лицо, импортированное от предыдущего провайдера", "value": { "image": "/9j/4AAQSkZJRgABAQEA...", "comment": "Imported from previous KYC provider" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/vendor-users/by-id/f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418/faces/upload/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"image\": \"/9j/4AAQSkZJRgABAQEA...\", \"comment\": \"Imported from previous KYC provider\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.users.upload_face(\n \"11111111-2222-3333-4444-555555555555\",\n image=\"/9j/4AAQSkZJRgABAQEA...\",\n comment=\"Imported from previous KYC provider\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.users.uploadFace(\"11111111-2222-3333-4444-555555555555\", {\n image: \"/9j/4AAQSkZJRgABAQEA...\",\n comment: \"Imported from previous KYC provider\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Users.UploadFace(ctx, \"11111111-2222-3333-4444-555555555555\", didit.UsersUploadFaceParams{\n\tImage: \"/9j/4AAQSkZJRgABAQEA...\",\n\tComment: didit.String(\"Imported from previous KYC provider\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.UsersUploadFaceParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.users().uploadFace(\"11111111-2222-3333-4444-555555555555\", UsersUploadFaceParams.builder()\n .image(\"/9j/4AAQSkZJRgABAQEA...\")\n .comment(\"Imported from previous KYC provider\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "users->uploadFace('11111111-2222-3333-4444-555555555555', [\n 'image' => '/9j/4AAQSkZJRgABAQEA...',\n 'comment' => 'Imported from previous KYC provider',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.users.upload_face(\n \"11111111-2222-3333-4444-555555555555\",\n image: \"/9j/4AAQSkZJRgABAQEA...\",\n comment: \"Imported from previous KYC provider\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Users.UploadFaceAsync(\"11111111-2222-3333-4444-555555555555\", new UsersUploadFaceParams\n{\n Image = \"/9j/4AAQSkZJRgABAQEA...\",\n Comment = \"Imported from previous KYC provider\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Лицо загружено и прикреплено к профилю пользователя.", "content": { "application/json": { "schema": { "type": "object", "required": [ "uuid", "image_url", "comment", "uploaded_by", "created_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID загруженной записи лица пользователя." }, "image_url": { "type": "string", "format": "uri", "nullable": true, "description": "Подписанный URL для загруженного изображения лица." }, "comment": { "type": "string", "nullable": true, "description": "Комментарий, указанный при загрузке лица." }, "uploaded_by": { "type": "string", "nullable": true, "description": "Электронная почта или идентификатор пользователя, выполнившего загрузку, если доступны." }, "created_at": { "type": "string", "format": "date-time", "description": "Временная метка загрузки." } } }, "examples": { "Uploaded": { "value": { "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "image_url": "https://signed-url.example/face.jpg", "comment": "Imported from previous KYC provider", "uploaded_by": "api", "created_at": "2026-05-18T12:00:00Z" } } } } } }, "400": { "description": "Недопустимое тело запроса или изображение. Распространённые причины: некорректный base64, некорректное изображение, лицо не обнаружено, размер изображения более 2 МБ, отсутствует эмбеддинг или у пользователя уже загружено 5 лиц.", "content": { "application/json": { "examples": { "No face": { "value": { "image": "No face detected in the image. Please upload a clear photo with a visible face." } }, "Too many faces": { "value": { "detail": "Maximum of 5 faces per user reached." } }, "Too large": { "value": { "image": "Image exceeds maximum size of 2 MB." } } } } } }, "401": { "description": "Отсутствует или недействителен API-ключ.", "content": { "application/json": { "examples": { "Missing key": { "value": { "detail": "Authentication credentials were not provided." } } } } } }, "403": { "description": "Учетные данные действительны, но не могут записывать профили пользователей для этого приложения.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "В приложении нет пользователя с таким `didit_internal_id`.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Лимит запросов превышен; снизьте частоту запросов и повторите попытку.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/update-data/": { "patch": { "summary": "Обновить данные KYC, извлечённые из документа, удостоверяющего личность, в сессии верификации", "description": "Скорректируйте идентификационные поля, извлечённые (OCR / NFC) из документа пользователя (неправильно распознанные имена, даты, номера документов и т. д.), после завершения верификации. Обычно этот endpoint вызывают комплаенс-аналитики из вашего собственного бэк-офиса или автоматические задачи сверки данных. Все поля в теле запроса необязательны: обновляются только переданные ключи, всё остальное остаётся без изменений (семантика `PATCH`).\n\nСессия должна принадлежать вашему приложению и находиться в статусе `Approved`, `Declined`, `In Review` или `Kyc Expired`. Сессии в любом другом состоянии (например, всё ещё `In Progress`) возвращают `404` с сообщением `\"No Session matches the given query.\"` — в отличие от `\"Not found.\"`, возвращаемого для неизвестного или удалённого `sessionId`. Сессия также должна содержать запись верификации личности (KYC): сессии, чей сценарий не выполнял шаг верификации личности, возвращают `404` (`\"The session does not have a KYC.\"`). Для сценариев на основе графа с несколькими шагами верификации личности укажите конкретный шаг с помощью `node_id` (параметр запроса или поле тела); если он не указан, обновляется самая последняя запись KYC.\n\nДва производных поля пересчитываются при каждом вызове: `full_name` (из `first_name` + `last_name`) и `issuing_state_name` (из `issuing_state`). При изменении адреса в свободной форме в `address` сервер может заново выполнить геокодирование и обновить `parsed_address` (пропускается для сессий в песочнице). `extra_fields` и `parsed_address` объединяются по ключам, а не заменяются целиком — см. описание отдельных полей для информации об удалении значений с помощью `null`.\n\nОтправка хотя бы одного валидного поля вызывает [webhook](/ru/integration/webhooks) `data.updated` (триггер `manual_review`) — даже если переданные значения совпадают с сохранёнными. Когда значения действительно изменяются, запись об активности `KYC_DATA_UPDATED`, фиксирующая изменённые поля с предыдущими и новыми значениями, добавляется в `reviews` сессии и отображается в [Get Decision](#get-/v3/session/-sessionId-/decision/) и в ленте активности консоли. Статус и решение по сессии **не** пересматриваются — используйте [Update Status](#patch-/v3/session/-sessionId-/update-status/), чтобы изменить результат. Пустое JSON-тело (`{}`) принимается и просто возвращает текущие данные KYC без отправки webhook.\n\nПринимает API-ключ или токен пользователя консоли; в любом случае учётные данные должны иметь разрешение `write:sessions`. Ошибки аутентификации и разрешений возвращают `403` — этот API никогда не возвращает `401`. Обратите внимание, что поиск сессии выполняется до проверки учётных данных, поэтому неизвестный `sessionId` вернёт `404`, даже если учётные данные отсутствуют. Для этого endpoint действует отдельный лимит запросов: 10 запросов в минуту на API-ключ (невалидные запросы также учитываются); общий лимит на запись в 300 запросов в минуту также применяется.", "operationId": "patch_v3_session_update_data", "x-didit-sdk": { "resource": "sessions", "method": "update_data", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID сессии Проверки пользователей (KYC), извлечённые данные документа которой вы исправляете. Идентификаторы сессий Верификации бизнеса (KYB) здесь недействительны — для данных компаний используйте [Update KYB Company Data](#patch-/v3/session/-sessionId-/kyb/-companyUuid-/update-data/).", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "node_id", "in": "query", "required": false, "description": "Узел графа сценария, запись KYC которого нужно обновить методом PATCH, для графовых сценариев с несколькими шагами верификации личности (также принимается в поле `node_id` тела запроса). Если не указано, обновляется последняя запись KYC в сессии. Если для указанного узла KYC отсутствует, вызов возвращает `404` (`\"The session does not have a KYC for node ''.\"`).", "schema": { "type": "string", "example": "feature_ocr" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Все поля необязательны — передавайте только то, что хотите изменить.", "properties": { "document_type": { "type": "string", "description": "Код типа документа. Принимает короткие коды из перечисления enum, а также шесть полных псевдонимов, нормализуемых на стороне сервера перед валидацией: `Passport` → `P`, `Identity Card` → `ID`, `Driver's License` → `DL`, `Residence Permit` → `RP`, `Health Insurance Card` → `HIC`, `Tax Card` → `TC`. Любое другое значение (включая `PASSPORT` заглавными буквами) возвращает `400`.", "enum": [ "P", "DL", "ID", "RP", "SSC", "HIC", "WP", "TC", "VISA", "PSC", "BC", "OTHER" ], "nullable": true, "example": "P" }, "document_subtype": { "type": "string", "maxLength": 128, "nullable": true, "description": "Подтип документа из реестра документов, включая региональный префикс, если реестр различает региональные варианты." }, "document_number": { "type": "string", "maxLength": 255, "nullable": true, "description": "Номер документа, как он напечатан на удостоверении личности.", "example": "PAB123456" }, "personal_number": { "type": "string", "maxLength": 255, "nullable": true, "description": "Личный или национальный идентификационный номер, если он указан в документе (например, испанский DNI в паспорте).", "example": "99999999R" }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Дата рождения в формате `YYYY-MM-DD`. Любой другой формат возвращает `400`.", "example": "1980-01-01" }, "date_of_issue": { "type": "string", "format": "date", "nullable": true, "description": "Дата выдачи документа в формате `YYYY-MM-DD`." }, "expiration_date": { "type": "string", "format": "date", "nullable": true, "description": "Дата окончания срока действия документа в формате `YYYY-MM-DD`." }, "issuing_state": { "type": "string", "nullable": true, "description": "Страна выдачи в виде кода ISO 3166-1 alpha-3. Регистронезависимо (`esp` сохраняется как `ESP`); понятное человеку значение `issuing_state_name`, отображаемое в [Get Decision](#get-/v3/session/-sessionId-/decision/), пересчитывается на основе этого значения. Недопустимые коды возвращают `400`.", "example": "ESP" }, "first_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "Имя (имена). Сохранённое `full_name` пересчитывается как `first_name + ' ' + last_name` при каждом вызове этого endpoint.", "example": "Carmen" }, "last_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "Фамилия (фамилии). Также используется при пересчете `full_name`.", "example": "Espanola Espanola" }, "gender": { "type": "string", "enum": [ "M", "F", "U" ], "nullable": true, "description": "Пол, как он указан в документе: `M` (мужской), `F` (женский) или `U` (неизвестно). Любое другое значение — включая `X` — возвращает `400`." }, "address": { "type": "string", "maxLength": 255, "nullable": true, "description": "Адрес в виде произвольного текста, как он напечатан на документе. При изменении этого значения (только для сессий вне песочницы) и если структурированный адрес всё ещё отсутствует или неполон, сервер синхронно выполняет повторное геокодирование перед отправкой ответа — тело ответа 200 уже содержит обновлённый `parsed_address`. Повторное геокодирование также требует наличия `issuing_state` в записи KYC." }, "place_of_birth": { "type": "string", "maxLength": 255, "nullable": true, "description": "Место рождения, как указано в документе." }, "nationality": { "type": "string", "maxLength": 32, "nullable": true, "description": "Гражданство в том виде, в каком оно указано в документе. Произвольный текст до 32 символов — обычно код ISO 3166-1 alpha-3 (например, `ESP`), но валидация на соответствие формату не выполняется." }, "marital_status": { "type": "string", "enum": [ "SINGLE", "MARRIED", "DIVORCED", "WIDOWED", "UNKNOWN" ], "description": "Семейное положение, если оно указано в документе. Любое другое значение возвращает `400`." }, "extra_fields": { "type": "object", "additionalProperties": true, "nullable": true, "description": "Переопределения для отдельных дополнительных полей документа (например, `blood_group`, `dl_categories`, `mrz_string`). Ключи объединяются с существующей картой переопределений: отправьте ключ со значением, чтобы задать его, или со значением `null` / `\"\"`, чтобы удалить этот ключ из объединённого представления. Отправьте всё поле как `null`, чтобы сбросить все ранее применённые переопределения. Должно быть JSON-объектом, иначе возвращается `400`. Ответ всегда содержит объединённое представление (значения, извлечённые с помощью OCR, с применёнными переопределениями)." }, "parsed_address": { "type": "object", "nullable": true, "description": "Структурированный адрес. Допускаются только следующие вложенные ключи: `address_type`, `city`, `region`, `street_1`, `street_2`, `postal_code`, `country` — любой другой ключ возвращает `400`. Семантика ключей: переданное значение устанавливает значение ключа, `null` удаляет его. Поле `formatted_address` пересчитывается на стороне сервера путем объединения `street_1`, `street_2`, `city`, `region`, `postal_code` и `country` и возвращается в ответе — задать его напрямую невозможно.", "properties": { "address_type": { "type": "string", "nullable": true, "description": "Классификация адреса в свободной форме (например, `home`)." }, "city": { "type": "string", "nullable": true, "example": "Madrid" }, "region": { "type": "string", "nullable": true, "description": "Штат / провинция / автономное сообщество." }, "street_1": { "type": "string", "nullable": true, "example": "Avda de Madrid 34" }, "street_2": { "type": "string", "nullable": true }, "postal_code": { "type": "string", "nullable": true, "example": "28013" }, "country": { "type": "string", "nullable": true, "description": "Двухбуквенный код страны ISO 3166-1 alpha-2. Входные данные в нижнем регистре приводятся к верхнему регистру; трехбуквенные коды (alpha-3) отклоняются с ошибкой `400`.", "example": "ES" } } } } }, "examples": { "Correct name and DOB": { "summary": "Исправить имя, дату рождения и структурированный адрес, неверно распознанные с помощью OCR", "value": { "first_name": "Carmen", "last_name": "Espanola Espanola", "date_of_birth": "1980-01-01", "issuing_state": "ESP", "marital_status": "MARRIED", "extra_fields": { "blood_group": "O+" }, "parsed_address": { "street_1": "Avda de Madrid 34", "city": "Madrid", "postal_code": "28013", "country": "ES" } } }, "Remove an extra field": { "summary": "Удалить один ключ дополнительного поля, сохранив остальные", "value": { "extra_fields": { "blood_group": null } } }, "Long-form document type": { "summary": "Длинный псевдоним нормализуется до короткого кода (в данном случае P)", "value": { "document_type": "Passport" } } } } } }, "responses": { "200": { "description": "Данные KYC обновлены. Возвращает **полную текущую запись KYC** (каждое обновляемое поле с его сохранённым значением, плюс объединённые `extra_fields` и текущий `parsed_address`) — а не только отправленные вами поля. Webhook `data.updated` срабатывает, когда в payload было хотя бы одно валидное поле.", "content": { "application/json": { "schema": { "type": "object", "properties": { "document_type": { "type": "string", "description": "Код типа документа. Принимает короткие коды из перечисления enum, а также шесть полных псевдонимов, нормализуемых на стороне сервера перед валидацией: `Passport` → `P`, `Identity Card` → `ID`, `Driver's License` → `DL`, `Residence Permit` → `RP`, `Health Insurance Card` → `HIC`, `Tax Card` → `TC`. Любое другое значение (включая `PASSPORT` заглавными буквами) возвращает `400`.", "enum": [ "P", "DL", "ID", "RP", "SSC", "HIC", "WP", "TC", "VISA", "PSC", "BC", "OTHER" ], "nullable": true, "example": "P" }, "document_subtype": { "type": "string", "maxLength": 128, "nullable": true, "description": "Подтип документа из реестра документов, включая региональный префикс, если реестр различает региональные варианты." }, "document_number": { "type": "string", "maxLength": 255, "nullable": true, "description": "Номер документа, как он напечатан на удостоверении личности.", "example": "PAB123456" }, "personal_number": { "type": "string", "maxLength": 255, "nullable": true, "description": "Личный или национальный идентификационный номер, если он указан в документе (например, испанский DNI в паспорте).", "example": "99999999R" }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Дата рождения в формате `YYYY-MM-DD`. Любой другой формат возвращает `400`.", "example": "1980-01-01" }, "date_of_issue": { "type": "string", "format": "date", "nullable": true, "description": "Дата выдачи документа в формате `YYYY-MM-DD`." }, "expiration_date": { "type": "string", "format": "date", "nullable": true, "description": "Дата окончания срока действия документа в формате `YYYY-MM-DD`." }, "issuing_state": { "type": "string", "nullable": true, "description": "Страна выдачи в виде кода ISO 3166-1 alpha-3. Регистронезависимо (`esp` сохраняется как `ESP`); понятное человеку значение `issuing_state_name`, отображаемое в [Get Decision](#get-/v3/session/-sessionId-/decision/), пересчитывается на основе этого значения. Недопустимые коды возвращают `400`.", "example": "ESP" }, "first_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "Имя (имена). Сохранённое `full_name` пересчитывается как `first_name + ' ' + last_name` при каждом вызове этого endpoint.", "example": "Carmen" }, "last_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "Фамилия (фамилии). Также используется при пересчете `full_name`.", "example": "Espanola Espanola" }, "gender": { "type": "string", "enum": [ "M", "F", "U" ], "nullable": true, "description": "Пол, как он указан в документе: `M` (мужской), `F` (женский) или `U` (неизвестно). Любое другое значение — включая `X` — возвращает `400`." }, "address": { "type": "string", "maxLength": 255, "nullable": true, "description": "Адрес в виде произвольного текста, как он напечатан на документе. При изменении этого значения (только для сессий вне песочницы) и если структурированный адрес всё ещё отсутствует или неполон, сервер повторно геокодирует его в фоновом режиме того же запроса и может перезаписать `parsed_address` результатом геокодера." }, "place_of_birth": { "type": "string", "maxLength": 255, "nullable": true, "description": "Место рождения, как указано в документе." }, "nationality": { "type": "string", "maxLength": 32, "nullable": true, "description": "Гражданство в том виде, в каком оно указано в документе. Произвольный текст до 32 символов — обычно код ISO 3166-1 alpha-3 (например, `ESP`), но валидация на соответствие формату не выполняется." }, "marital_status": { "type": "string", "enum": [ "SINGLE", "MARRIED", "DIVORCED", "WIDOWED", "UNKNOWN" ], "description": "Семейное положение, если оно указано в документе. Любое другое значение возвращает `400`." }, "extra_fields": { "type": "object", "additionalProperties": true, "nullable": true, "description": "Объединённое представление дополнительных полей документа: извлечённые с помощью OCR значения с учётом всех переопределений оператора. Ключи, удалённые через переопределение со значением `null`, отсутствуют в этом объекте." }, "parsed_address": { "type": "object", "nullable": true, "description": "Текущий структурированный адрес (без внутренних служебных ключей) или `null`, если он отсутствует. Включает пересчитанный `formatted_address` наряду с семью редактируемыми ключами.", "properties": { "address_type": { "type": "string", "nullable": true, "description": "Классификация адреса в свободной форме (например, `home`)." }, "city": { "type": "string", "nullable": true, "example": "Madrid" }, "region": { "type": "string", "nullable": true, "description": "Штат / провинция / автономное сообщество." }, "street_1": { "type": "string", "nullable": true, "example": "Avda de Madrid 34" }, "street_2": { "type": "string", "nullable": true }, "postal_code": { "type": "string", "nullable": true, "example": "28013" }, "country": { "type": "string", "nullable": true, "description": "Двухбуквенный код страны ISO 3166-1 alpha-2. Входные данные в нижнем регистре приводятся к верхнему регистру; трехбуквенные коды (alpha-3) отклоняются с ошибкой `400`.", "example": "ES" }, "formatted_address": { "type": "string", "nullable": true, "description": "Объединённое, понятное человеку представление структурированного адреса. Пересчитывается на стороне сервера после каждого изменения `parsed_address`.", "example": "Avda de Madrid 34, Madrid, 28013, ES" } } } } }, "examples": { "Updated KYC": { "summary": "Полная запись KYC после исправления", "value": { "document_type": "P", "document_subtype": null, "document_number": "PAB123456", "personal_number": "99999999R", "date_of_birth": "1980-01-01", "date_of_issue": "2021-02-09", "expiration_date": "2031-02-08", "issuing_state": "ESP", "first_name": "Carmen", "last_name": "Espanola Espanola", "gender": "F", "address": "AVDA DE MADRID 34, MADRID, MADRID 28013", "place_of_birth": "MADRID", "nationality": "ESP", "marital_status": "MARRIED", "extra_fields": { "mrz_string": "P\": [\"\"]}`; ошибки во вложенных ключах `parsed_address` / `extra_fields` используют объектное значение: `{\"parsed_address\": {\"\": \"\"}}`.", "content": { "application/json": { "examples": { "Invalid gender": { "summary": "gender должен быть M, F или U", "value": { "gender": [ "\"X\" is not a valid choice." ] } }, "Invalid document type": { "summary": "Не является коротким кодом или длинным псевдонимом", "value": { "document_type": [ "\"PASSPORT\" is not a valid choice." ] } }, "Invalid issuing state": { "summary": "issuing_state не соответствует стандарту ISO 3166-1 alpha-3", "value": { "issuing_state": [ "Invalid ISO 3166-1 alpha-3 country code for issuing_state." ] } }, "Invalid marital status": { "summary": "marital_status отсутствует в enum", "value": { "marital_status": [ "\"ENGAGED\" is not a valid choice." ] } }, "Bad date format": { "summary": "Даты должны быть в формате YYYY-MM-DD", "value": { "date_of_birth": [ "Date has wrong format. Use one of these formats instead: YYYY-MM-DD." ] } }, "Unsupported parsed_address key": { "summary": "Разрешены только семь задокументированных ключей", "value": { "parsed_address": { "zipcode": "Unsupported key. Allowed keys: address_type, city, region, street_1, street_2, postal_code, country" } } }, "Invalid parsed_address country": { "summary": "Вложенная страна должна быть в формате alpha-2, а не alpha-3", "value": { "parsed_address": { "country": "Invalid ISO 3166-1 alpha-2 country code." } } }, "extra_fields not an object": { "summary": "extra_fields должно быть объектом JSON", "value": { "extra_fields": [ "This field must be a JSON object." ] } } } } } }, "403": { "description": "Отсутствуют учетные данные или недостаточно разрешений. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Отсутствует или недействителен x-api-key", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "В учётных данных отсутствует разрешение write:sessions", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Неизвестная сессия, сессия в нередактируемом состоянии или отсутствие записи KYC для обновления. Для каждого кейса предусмотрено отдельное сообщение в `detail` (см. примеры). Поиск неизвестной сессии выполняется до проверки учетных данных.", "content": { "application/json": { "examples": { "Unknown session": { "summary": "Сессия с этим ID отсутствует в вашем приложении (или была удалена)", "value": { "detail": "Not found." } }, "Wrong session state": { "summary": "Сессия существует, но её статус отличается от Approved / Declined / In Review / Kyc Expired", "value": { "detail": "No Session matches the given query." } }, "No KYC record": { "summary": "В сценарии не выполнялся шаг Верификация личности", "value": { "detail": "The session does not have a KYC." } }, "No KYC for node": { "summary": "node_id указан, но KYC для него отсутствует", "value": { "detail": "The session does not have a KYC for node 'feature_missing'." } } } } } }, "429": { "description": "Превышен выделенный лимит запросов — 10 обновлений данных KYC в минуту на один API-ключ (отклонённые запросы учитываются в лимите). Общий лимит на запись 300 запросов/мин также может сработать со своим сообщением. Проверьте заголовок `Retry-After` и заголовки ответа `X-RateLimit-*` перед повторной попыткой.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Бюджет на обновление KYC исчерпан", "value": { "detail": "Session KYC data update rate limit exceeded. You can make up to 10 requests per minute." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/update-data/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"first_name\": \"Carmen\",\n \"last_name\": \"Espanola Espanola\",\n \"date_of_birth\": \"1980-01-01\",\n \"issuing_state\": \"ESP\",\n \"parsed_address\": {\n \"street_1\": \"Avda de Madrid 34\",\n \"city\": \"Madrid\",\n \"postal_code\": \"28013\",\n \"country\": \"ES\"\n }\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_data(\n \"11111111-2222-3333-4444-555555555555\",\n date_of_birth=\"1980-01-01\",\n issuing_state=\"ESP\",\n first_name=\"Carmen\",\n last_name=\"Espanola Espanola\",\n marital_status=\"MARRIED\",\n extra_fields={\"blood_group\": \"O+\"},\n parsed_address={\n \"city\": \"Madrid\",\n \"street_1\": \"Avda de Madrid 34\",\n \"postal_code\": \"28013\",\n \"country\": \"ES\",\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updateData(\"11111111-2222-3333-4444-555555555555\", {\n date_of_birth: \"1980-01-01\",\n issuing_state: \"ESP\",\n first_name: \"Carmen\",\n last_name: \"Espanola Espanola\",\n marital_status: \"MARRIED\",\n extra_fields: { blood_group: \"O+\" },\n parsed_address: {\n city: \"Madrid\",\n street_1: \"Avda de Madrid 34\",\n postal_code: \"28013\",\n country: \"ES\",\n },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateData(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsUpdateDataParams{\n\tDateOfBirth: didit.String(\"1980-01-01\"),\n\tIssuingState: didit.String(\"ESP\"),\n\tFirstName: didit.String(\"Carmen\"),\n\tLastName: didit.String(\"Espanola Espanola\"),\n\tMaritalStatus: didit.Some(didit.SessionsUpdateDataParamsMaritalStatus(\"MARRIED\")),\n\tExtraFields: didit.Some(map[string]any{\"blood_group\": \"O+\"}),\n\tParsedAddress: didit.Some(didit.SessionsUpdateDataParamsParsedAddress{\n\t\tCity: didit.String(\"Madrid\"),\n\t\tStreet1: didit.String(\"Avda de Madrid 34\"),\n\t\tPostalCode: didit.String(\"28013\"),\n\t\tCountry: didit.String(\"ES\"),\n\t}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.LocalDate;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.SessionsUpdateDataParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updateData(\"11111111-2222-3333-4444-555555555555\", SessionsUpdateDataParams.builder()\n .dateOfBirth(LocalDate.parse(\"1980-01-01\"))\n .issuingState(\"ESP\")\n .firstName(\"Carmen\")\n .lastName(\"Espanola Espanola\")\n .maritalStatus(SessionsUpdateDataParams.MaritalStatus.of(\"MARRIED\"))\n .extraFields(Map.of(\"blood_group\", \"O+\"))\n .parsedAddress(SessionsUpdateDataParams.ParsedAddress.builder()\n .city(\"Madrid\")\n .street1(\"Avda de Madrid 34\")\n .postalCode(\"28013\")\n .country(\"ES\")\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updateData('11111111-2222-3333-4444-555555555555', [\n 'date_of_birth' => '1980-01-01',\n 'issuing_state' => 'ESP',\n 'first_name' => 'Carmen',\n 'last_name' => 'Espanola Espanola',\n 'marital_status' => 'MARRIED',\n 'extra_fields' => ['blood_group' => 'O+'],\n 'parsed_address' => [\n 'city' => 'Madrid',\n 'street_1' => 'Avda de Madrid 34',\n 'postal_code' => '28013',\n 'country' => 'ES',\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_data(\n \"11111111-2222-3333-4444-555555555555\",\n date_of_birth: \"1980-01-01\",\n issuing_state: \"ESP\",\n first_name: \"Carmen\",\n last_name: \"Espanola Espanola\",\n marital_status: \"MARRIED\",\n extra_fields: { blood_group: \"O+\" },\n parsed_address: {\n city: \"Madrid\",\n street_1: \"Avda de Madrid 34\",\n postal_code: \"28013\",\n country: \"ES\",\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdateDataAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsUpdateDataParams\n{\n DateOfBirth = \"1980-01-01\",\n IssuingState = \"ESP\",\n FirstName = \"Carmen\",\n LastName = \"Espanola Espanola\",\n MaritalStatus = new SessionsUpdateDataParamsMaritalStatus(\"MARRIED\"),\n ExtraFields = new Dictionary { [\"blood_group\"] = \"O+\" },\n ParsedAddress = new SessionsUpdateDataParamsParsedAddress\n {\n City = \"Madrid\",\n Street1 = \"Avda de Madrid 34\",\n PostalCode = \"28013\",\n Country = \"ES\",\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/features/{nodeId}/update-status/": { "patch": { "summary": "Обновить статус отдельной функции (шага)", "description": "Устанавливает статус отдельной функции верификации (шага) в рамках сессии. Выберите функцию по её `nodeId` в графе сценария. В сценариях без графа, где у шагов нет узлов, используйте `default`, а также передайте `feature_type`, чтобы указать нужный шаг.\n\nРаботает как для сессий Проверки пользователей (KYC), так и для сессий Верификации бизнеса (KYB), а также для каждого типа шагов: ID/OCR, Проверка живости, Сравнение лиц, NFC, AML-скрининг, Подтверждение адреса, Проверка телефона, Проверка электронной почты, Проверка по базам данных, Анкеты, а также проверок реестра компаний, документов и ключевых лиц для KYB. Этот endpoint **недоступен** для автономных сессий API (`session_type = API`).\n\nПараметр `new_status` должен принимать одно из значений: `Approved`, `Declined` или `In Review`, и должен отличаться от текущего статуса функции.\n\n**Когда применяется переопределение.** Без `defer_until_flow_finishes` (или со значением `false`) переопределение применяется немедленно, как и раньше; если пользователь всё ещё проходит сценарий, оно фиксируется как `forced`. При `defer_until_flow_finishes: true`, пока пользователь всё ещё проходит сценарий (сессия находится в статусе `Not Started`, `In Progress` или `Resubmitted` и ещё не завершена), переопределение сохраняется как `pending_until_flow_finishes` и применяется после завершения сценария, когда сценарий сформирует собственное решение. Для сессии, прохождение которой уже завершилось, оно в любом случае применяется немедленно. Ожидающее переопределение отменяется, если пользователь повторно выполняет этот шаг до завершения, если его заменяет более новое переопределение для той же проверки, если сессия выходит из процесса незавершённой (прервана, истекла или решение принято в середине процесса), либо при отмене через `POST /v3/session/{sessionId}/features/overrides/{overrideId}/cancel/`. Список переопределений сессии можно получить с помощью `GET /v3/session/{sessionId}/features/overrides/`.\n\n**Влияние на сессию.** Сессия, у которой уже есть решение, сохраняет его: меняется только проверка. Если у сессии ещё нет решения и её сценарий ожидает именно этот шаг, применение переопределения завершает шаг: сценарий переходит дальше, выполняются последующие шаги, а узел статуса может установить решение по сессии и инициировать отправку `status.updated`.\n\n**Webhook и активность.** Webhook `data.updated` отправляется при применении переопределения (сразу или после завершения процесса) и никогда не отправляется во время ожидания или при отмене. Каждое переопределение фиксируется в журнале активности сессии как `FEATURE_OVERRIDE_PENDING`, `FEATURE_OVERRIDE_APPLIED` или `FEATURE_OVERRIDE_CANCELLED` с указанием того, кто его выполнил; запись запроса содержит ваш `comment`.\n\nВыполняйте аутентификацию с помощью API-ключа (`x-api-key`) или пользовательского заголовка авторизации с правом `write:sessions`; API-ключу с ограниченной областью видимости требуется доступ на запись к решениям.", "operationId": "patch_v3_session_update_feature_status", "x-didit-sdk": { "resource": "sessions", "method": "update_feature_status", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID сессии верификации. Принимает ID сессий как пользователей (KYC), так и компаний (KYB) — сервис сопоставляет ID для обоих типов сессий.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "in": "path", "name": "nodeId", "required": true, "description": "ID узла графа сценария для обновляемой функции (например, `feature_ocr_1`). Используйте строковое значение `default` для сценариев без графа (одношаговых), где у функции нет ID узла.", "schema": { "type": "string", "example": "feature_ocr_1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "new_status" ], "properties": { "new_status": { "type": "string", "description": "Целевой статус для этой функции. Должен отличаться от текущего значения.", "enum": [ "Approved", "Declined", "In Review" ], "example": "Approved" }, "comment": { "type": "string", "description": "Необязательная текстовая заметка в свободной форме, фиксируемая в журнале проверки сессии при изменении этой функции.", "example": "Document manually verified by compliance." }, "feature_type": { "type": "string", "enum": [ "ID_VERIFICATION", "OCR", "OCR_BACK", "NFC", "LIVENESS", "FACE", "AGE_ESTIMATION", "AGE_VERIFICATION", "FACE_SEARCH", "FACE_MATCH", "IP_ANALYSIS", "AML", "PHONE", "PHONE_VERIFICATION", "EMAIL", "EMAIL_VERIFICATION", "POA", "PROOF_OF_ADDRESS", "DATABASE_VALIDATION", "DATA_VALIDATION", "QUESTIONNAIRE", "DOCUMENT_AI", "KYB_REGISTRY", "KYB_DOCUMENTS", "KYB_KEY_PEOPLE", "BANK_VERIFICATION", "GEOLOCATION" ], "description": "На какой тип шага нацелено действие. Требуется в неграфовых сценариях (`nodeId` = `default`), где шаги не привязаны к общему узлу; в остальных случаях необязательно. Неизвестное значение возвращает `400`.", "example": "LIVENESS" }, "defer_until_flow_finishes": { "type": "boolean", "default": false, "description": "Пока человек всё ещё проходит сценарий, сохранить переопределение как `pending_until_flow_finishes` и применить его после завершения сценария, а не сразу. Если параметр опущен или равен `false`, переопределение применяется сразу. В сессии, сценарий которой уже завершился, оно применяется сразу в любом случае.", "example": false } } }, "examples": { "Apply Now": { "summary": "Одобрить шаг верификации личности сразу", "value": { "new_status": "Approved", "comment": "Document manually verified by compliance." } }, "Wait For The Flow": { "summary": "Одобрить шаг проверки живости, как только человек завершит сценарий", "value": { "new_status": "Approved", "comment": "Liveness retried with a reviewer present.", "defer_until_flow_finishes": true } }, "Non-graph Workflow": { "summary": "Нацелить на шаг проверки живости сценария без узлов (nodeId = default)", "value": { "new_status": "In Review", "feature_type": "LIVENESS" } } } } } }, "responses": { "200": { "description": "Переопределение сохранено. `new_status` представляет собой сохранённый статус проверки: запрошенный статус после применения переопределения либо неизменённый статус, пока ожидается завершение сценария. `override` указывает, что именно произошло.", "content": { "application/json": { "schema": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid" }, "node_id": { "type": "string", "nullable": true, "description": "Узел сценария для обновлённого шага или `null` для шага без узла (путь `default` в сценарии без графа).", "example": "feature_ocr_1" }, "feature_type": { "type": "string", "description": "Название модели обновленной функции (например, `KYC`, `Face`, `FaceMatch`, `AML`, `POA`).", "example": "KYC" }, "new_status": { "type": "string", "description": "Сохранённый статус проверки: запрошенный после применения переопределения либо неизменённый, пока переопределение ожидает завершения сценария.", "example": "Approved" }, "override": { "$ref": "#/components/schemas/FeatureStatusOverride" } }, "required": [ "session_id", "node_id", "feature_type", "new_status", "override" ] }, "examples": { "Applied": { "summary": "Переопределение применилось немедленно", "value": { "session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "node_id": "feature_ocr_1", "feature_type": "KYC", "new_status": "Approved", "override": { "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "node_id": "feature_ocr_1", "feature_type": "", "feature_model": "KYC", "previous_status": "In Review", "new_status": "Approved", "state": "applied", "forced": false, "reason": "Document manually verified by compliance.", "requested_by": { "email": "reviewer@example.com", "name": "Alex Reviewer", "type": "CONSOLE_USER" }, "requested_at": "2026-10-13T09:15:00Z", "applied_at": "2026-10-13T09:15:00Z", "cancelled_at": null, "cancel_reason": null } } }, "Waiting For The Flow": { "summary": "defer_until_flow_finishes, пока человек всё ещё находится в сценарии", "value": { "session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "node_id": "feature_liveness_1", "feature_type": "Face", "new_status": "Declined", "override": { "id": "9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3", "node_id": "feature_liveness_1", "feature_type": "", "feature_model": "Face", "previous_status": "Declined", "new_status": "Approved", "state": "pending_until_flow_finishes", "forced": false, "reason": "Liveness retried with a reviewer present.", "requested_by": { "email": "reviewer@example.com", "name": "Alex Reviewer", "type": "CONSOLE_USER" }, "requested_at": "2026-10-13T09:15:00Z", "applied_at": null, "cancelled_at": null, "cancel_reason": null } } } } } } }, "400": { "description": "Ошибка валидации. Возвращается, если `new_status` недействителен или не изменился, если `feature_type` неизвестен или если сессия является автономной API-сессией.", "content": { "application/json": { "examples": { "Same Status": { "summary": "new_status совпадает с текущим статусом", "value": { "new_status": [ "The new status is the same as the current status." ] } }, "API Session": { "summary": "Статус функции нельзя изменить для автономных сессий API", "value": [ "Cannot change feature status for API sessions." ] }, "Unknown feature_type": { "summary": "feature_type не является известным типом шага", "value": { "feature_type": [ "Unknown feature_type 'SELFIE'." ] } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "API-ключ с ограниченной областью действия с истёкшим сроком действия", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Отсутствуют учетные данные или недостаточно разрешений.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Отсутствует или недействителен x-api-key", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "У API-ключа отсутствует разрешение write:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "API-ключ с ограниченной областью действия без прав на запись решений", "value": { "detail": "This API key has no write access to decisions." } } } } } }, "404": { "description": "Сессия не найдена, либо в ней нет функции с указанным `nodeId`.", "content": { "application/json": { "examples": { "Session Not Found": { "summary": "Неизвестный session_id", "value": { "detail": "Session not found." } }, "Feature Not Found": { "summary": "Нет функции для этого node_id", "value": { "detail": "No feature found with node_id 'feature_ocr_1' in this session." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/features/feature_ocr_1/update-status/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"new_status\": \"Approved\",\n \"comment\": \"Document manually verified by compliance.\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_feature_status(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_ocr_1\",\n new_status=\"Approved\",\n comment=\"Document manually verified by compliance.\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updateFeatureStatus(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_ocr_1\",\n {\n new_status: \"Approved\",\n comment: \"Document manually verified by compliance.\",\n },\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateFeatureStatus(ctx, \"11111111-2222-3333-4444-555555555555\", \"feature_ocr_1\", didit.SessionsUpdateFeatureStatusParams{\n\tNewStatus: \"Approved\",\n\tComment: didit.String(\"Document manually verified by compliance.\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsUpdateFeatureStatusParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updateFeatureStatus(\"11111111-2222-3333-4444-555555555555\", \"feature_ocr_1\", SessionsUpdateFeatureStatusParams.builder()\n .newStatus(SessionsUpdateFeatureStatusParams.NewStatus.of(\"Approved\"))\n .comment(\"Document manually verified by compliance.\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updateFeatureStatus('11111111-2222-3333-4444-555555555555', 'feature_ocr_1', [\n 'new_status' => 'Approved',\n 'comment' => 'Document manually verified by compliance.',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_feature_status(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_ocr_1\",\n new_status: \"Approved\",\n comment: \"Document manually verified by compliance.\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdateFeatureStatusAsync(\"11111111-2222-3333-4444-555555555555\", \"feature_ocr_1\", new SessionsUpdateFeatureStatusParams\n{\n NewStatus = \"Approved\",\n Comment = \"Document manually verified by compliance.\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/update-aml-hit-status/": { "patch": { "summary": "Обновить статус проверки AML-срабатывания", "description": "Установите статус проверки для **одного совпадения AML** (потенциальное совпадение по санкциям / PEP / спискам наблюдения / негативным публикациям в СМИ), возвращённого AML-скринингом, без изменения общего решения по сессии. Укажите совпадение по его `hit_id` (поле `id` записи в массиве `hits` проверки AML — см. решение по сессии). Идентификатор совпадения, возвращённый в более раннем формате, по-прежнему принимается; ответ всегда указывает совпадение по его текущему `id`.\n\nПоле `review_status` принимает одно из значений: `Unreviewed`, `Confirmed Match`, `False Positive` или `Inconclusive`. Решения проверяющего сохраняются при обновлениях постоянного мониторинга, поэтому совпадение, отмеченное вами как `False Positive`, остаётся таковым при повторном скрининге провайдером.\n\nУспешный вызов отправляет webhook `data.updated` и добавляет запись об активности (с указанием исполнителя) в журнал проверки сессии. Для графовых сценариев с несколькими проверками AML передайте `node_id`, чтобы указать конкретную проверку.\n\nАутентифицируйтесь с помощью вашего API-ключа (`x-api-key`) или заголовка авторизации пользователя — любой из них должен содержать разрешение `write:sessions`.", "operationId": "patch_v3_session_update_aml_hit_status", "x-didit-sdk": { "resource": "sessions", "method": "update_aml_hit_status", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID сессии верификации. Принимает ID сессий как пользователей (KYC), так и компаний (KYB) — сервис сопоставляет ID для обоих типов сессий.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "in": "query", "name": "node_id", "required": false, "description": "ID узла графа сценария. Требуется, только если в сессии есть несколько AML-проверок (по одной на узел); опустите для сессий с одной AML-проверкой.", "schema": { "type": "string", "example": "feature_aml_1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "hit_id", "review_status" ], "properties": { "hit_id": { "type": "string", "description": "Идентификатор `id` совпадения в массиве `hits` AML-проверки (`hit_...`). Идентификатор совпадения, возвращённый в прежнем формате, по-прежнему принимается.", "example": "hit_7c1e9a40b2d35f86e0a4c912" }, "review_status": { "type": "string", "description": "Новый статус проверки для совпадения.", "enum": [ "Unreviewed", "Confirmed Match", "False Positive", "Inconclusive" ], "example": "False Positive" }, "node_id": { "type": "string", "description": "Необязательный ID узла графа. Используйте его (здесь или в качестве query-параметра), если в сессии есть несколько AML-проверок.", "example": "feature_aml_1" } } }, "example": { "hit_id": "hit_7c1e9a40b2d35f86e0a4c912", "review_status": "False Positive" } } } }, "responses": { "200": { "description": "Статус проверки срабатывания обновлён.", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "hit_id", "review_status" ], "properties": { "message": { "type": "string", "description": "Всегда `Hit status updated successfully`." }, "hit_id": { "type": "string", "description": "`id` обновлённого совпадения в том виде, как его возвращает решение по сессии, в том числе когда в запросе совпадение было указано по id в прежнем формате." }, "review_status": { "type": "string", "enum": [ "Unreviewed", "Confirmed Match", "False Positive", "Inconclusive" ], "description": "Статус проверки, сохранённый в срабатывании." } } }, "example": { "message": "Hit status updated successfully", "hit_id": "hit_7c1e9a40b2d35f86e0a4c912", "review_status": "False Positive" } } } }, "400": { "description": "Ошибка валидации — `hit_id` пуст или `review_status` не входит в список допустимых значений.", "content": { "application/json": { "example": { "review_status": [ "\"Maybe\" is not a valid choice." ] } } } }, "403": { "description": "Отсутствуют учетные данные или недостаточно разрешений. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Отсутствует или недействителен x-api-key", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "У API-ключа отсутствует разрешение write:sessions", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Сессия не найдена, в сессии нет AML-проверки (при необходимости для указанного `node_id`), либо совпадение с `hit_id` отсутствует.", "content": { "application/json": { "examples": { "No AML Check": { "summary": "В сессии нет AML-проверки", "value": { "detail": "The session does not have an AML check." } }, "Hit Not Found": { "summary": "Неизвестный hit_id", "value": { "detail": "Hit with ID 'hit_9d2e7f41c0a8b3e65d1f0c47' not found in the AML check." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/update-aml-hit-status/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"hit_id\": \"abc123\",\n \"review_status\": \"False Positive\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_aml_hit_status(\n \"11111111-2222-3333-4444-555555555555\",\n hit_id=\"hit_7c1e9a40b2d35f86e0a4c912\",\n review_status=\"False Positive\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updateAmlHitStatus(\"11111111-2222-3333-4444-555555555555\", {\n hit_id: \"hit_7c1e9a40b2d35f86e0a4c912\",\n review_status: \"False Positive\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateAMLHitStatus(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsUpdateAMLHitStatusParams{\n\tHitID: \"hit_7c1e9a40b2d35f86e0a4c912\",\n\tReviewStatus: \"False Positive\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsUpdateAmlHitStatusParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updateAmlHitStatus(\"11111111-2222-3333-4444-555555555555\", SessionsUpdateAmlHitStatusParams.builder()\n .hitId(\"hit_7c1e9a40b2d35f86e0a4c912\")\n .reviewStatus(SessionsUpdateAmlHitStatusParams.ReviewStatus.of(\"False Positive\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updateAmlHitStatus('11111111-2222-3333-4444-555555555555', [\n 'hit_id' => 'hit_7c1e9a40b2d35f86e0a4c912',\n 'review_status' => 'False Positive',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_aml_hit_status(\n \"11111111-2222-3333-4444-555555555555\",\n hit_id: \"hit_7c1e9a40b2d35f86e0a4c912\",\n review_status: \"False Positive\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdateAmlHitStatusAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsUpdateAmlHitStatusParams\n{\n HitId = \"hit_7c1e9a40b2d35f86e0a4c912\",\n ReviewStatus = \"False Positive\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/bulk-update-aml-hit-status/": { "patch": { "summary": "Массовое обновление статусов проверки совпадений AML", "description": "Обновите статус проверки **нескольких совпадений AML** за один вызов. Передайте `hit_updates`, список пар `{ hit_id, review_status }`. Поле `review_status` принимает одно из значений: `Unreviewed`, `Confirmed Match`, `False Positive` или `Inconclusive`.\n\nОбновление выполняется по принципу «всё или ничего»: если хотя бы один `hit_id` не найден в проверке AML, запрос возвращает `404`, и ни одно совпадение не изменяется. Успешный вызов отправляет один webhook `data.updated` и фиксирует одну запись активности, охватывающую все изменения. Для графовых сценариев с несколькими проверками AML передайте `node_id`, чтобы указать конкретную проверку.\n\nВыполняйте аутентификацию с помощью API-ключа (`x-api-key`) или пользовательского заголовка авторизации: любой из них должен содержать право `write:sessions`.", "operationId": "patch_v3_session_bulk_update_aml_hit_status", "x-didit-sdk": { "resource": "sessions", "method": "bulk_update_aml_hit_status", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID сессии верификации. Принимает ID сессий как пользователей (KYC), так и компаний (KYB) — сервис сопоставляет ID для обоих типов сессий.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "in": "query", "name": "node_id", "required": false, "description": "ID узла графа сценария. Требуется, только если в сессии есть несколько AML-проверок (по одной на узел); опустите для сессий с одной AML-проверкой.", "schema": { "type": "string", "example": "feature_aml_1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "hit_updates" ], "properties": { "hit_updates": { "type": "array", "description": "Непустой список обновлений совпадений.", "items": { "type": "object", "required": [ "hit_id", "review_status" ], "properties": { "hit_id": { "type": "string", "example": "hit_7c1e9a40b2d35f86e0a4c912", "description": "Идентификатор `id` совпадения в массиве `hits` AML-проверки (`hit_...`). Идентификатор совпадения, возвращённый в прежнем формате, по-прежнему принимается." }, "review_status": { "type": "string", "enum": [ "Unreviewed", "Confirmed Match", "False Positive", "Inconclusive" ], "example": "Confirmed Match" } } } }, "node_id": { "type": "string", "description": "Необязательный ID узла графа. Используйте его (здесь или в качестве query-параметра), если в сессии есть несколько AML-проверок.", "example": "feature_aml_1" } } }, "example": { "hit_updates": [ { "hit_id": "hit_7c1e9a40b2d35f86e0a4c912", "review_status": "Confirmed Match" }, { "hit_id": "hit_3b8f20d6a91c4e75f0b2d6a8", "review_status": "False Positive" } ] } } } }, "responses": { "200": { "description": "Все совпадения обновлены.", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "updated_hits" ], "properties": { "message": { "type": "string", "description": "`Updated {n} hit(s) successfully`, где `n` равно количеству записей в `hit_updates`." }, "updated_hits": { "type": "array", "items": { "type": "string" }, "description": "`id` совпадения, указанного в каждой записи `hit_updates`, в том виде, как его возвращает решение по сессии, в порядке запроса, включая совпадения, статус которых не изменился." } } }, "example": { "message": "Updated 2 hit(s) successfully", "updated_hits": [ "hit_7c1e9a40b2d35f86e0a4c912", "hit_3b8f20d6a91c4e75f0b2d6a8" ] } } } }, "400": { "description": "Ошибка валидации — `hit_updates` пуст, либо в записи отсутствует `hit_id` / `review_status`, либо указано недопустимое значение.", "content": { "application/json": { "example": { "hit_updates": [ "hit_updates cannot be empty" ] } } } }, "403": { "description": "Отсутствуют учетные данные или недостаточно разрешений. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Отсутствует или недействителен x-api-key", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "У API-ключа отсутствует разрешение write:sessions", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Сессия не найдена, в сессии нет AML-проверки, либо один или несколько `hit_id` не существуют (в этом случае ни одно совпадение не изменяется).", "content": { "application/json": { "example": { "detail": "Hits not found: hit_9d2e7f41c0a8b3e65d1f0c47" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/bulk-update-aml-hit-status/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"hit_updates\": [\n { \"hit_id\": \"abc123\", \"review_status\": \"Confirmed Match\" },\n { \"hit_id\": \"def456\", \"review_status\": \"False Positive\" }\n ]\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.bulk_update_aml_hit_status(\n \"11111111-2222-3333-4444-555555555555\",\n hit_updates=[{\n \"hit_id\": \"hit_7c1e9a40b2d35f86e0a4c912\",\n \"review_status\": \"Confirmed Match\",\n }, {\n \"hit_id\": \"hit_3b8f20d6a91c4e75f0b2d6a8\",\n \"review_status\": \"False Positive\",\n }],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.bulkUpdateAmlHitStatus(\"11111111-2222-3333-4444-555555555555\", {\n hit_updates: [{\n hit_id: \"hit_7c1e9a40b2d35f86e0a4c912\",\n review_status: \"Confirmed Match\",\n }, {\n hit_id: \"hit_3b8f20d6a91c4e75f0b2d6a8\",\n review_status: \"False Positive\",\n }],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.BulkUpdateAMLHitStatus(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsBulkUpdateAMLHitStatusParams{\n\tHitUpdates: []didit.SessionsBulkUpdateAMLHitStatusParamsHitUpdates{{\n\t\tHitID: \"hit_7c1e9a40b2d35f86e0a4c912\",\n\t\tReviewStatus: \"Confirmed Match\",\n\t}, {\n\t\tHitID: \"hit_3b8f20d6a91c4e75f0b2d6a8\",\n\t\tReviewStatus: \"False Positive\",\n\t}},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.SessionsBulkUpdateAmlHitStatusParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().bulkUpdateAmlHitStatus(\"11111111-2222-3333-4444-555555555555\", SessionsBulkUpdateAmlHitStatusParams.builder()\n .hitUpdates(List.of(\n SessionsBulkUpdateAmlHitStatusParams.HitUpdates.builder()\n .hitId(\"hit_7c1e9a40b2d35f86e0a4c912\")\n .reviewStatus(SessionsBulkUpdateAmlHitStatusParams.HitUpdates.ReviewStatus.of(\"Confirmed Match\"))\n .build(),\n SessionsBulkUpdateAmlHitStatusParams.HitUpdates.builder()\n .hitId(\"hit_3b8f20d6a91c4e75f0b2d6a8\")\n .reviewStatus(SessionsBulkUpdateAmlHitStatusParams.HitUpdates.ReviewStatus.of(\"False Positive\"))\n .build()))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->bulkUpdateAmlHitStatus('11111111-2222-3333-4444-555555555555', [\n 'hit_updates' => [[\n 'hit_id' => 'hit_7c1e9a40b2d35f86e0a4c912',\n 'review_status' => 'Confirmed Match',\n ], [\n 'hit_id' => 'hit_3b8f20d6a91c4e75f0b2d6a8',\n 'review_status' => 'False Positive',\n ]],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.bulk_update_aml_hit_status(\n \"11111111-2222-3333-4444-555555555555\",\n hit_updates: [{\n hit_id: \"hit_7c1e9a40b2d35f86e0a4c912\",\n review_status: \"Confirmed Match\",\n }, {\n hit_id: \"hit_3b8f20d6a91c4e75f0b2d6a8\",\n review_status: \"False Positive\",\n }]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.BulkUpdateAmlHitStatusAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsBulkUpdateAmlHitStatusParams\n{\n HitUpdates = new SessionsBulkUpdateAmlHitStatusParamsHitUpdates[]\n {\n new()\n {\n HitId = \"hit_7c1e9a40b2d35f86e0a4c912\",\n ReviewStatus = \"Confirmed Match\",\n },\n new()\n {\n HitId = \"hit_3b8f20d6a91c4e75f0b2d6a8\",\n ReviewStatus = \"False Positive\",\n },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/update-poa-data/": { "patch": { "summary": "Обновить данные подтверждения адреса, извлечённые из документа POA в сессии верификации", "description": "Скорректируйте поля, извлечённые из документа пользователя для подтверждения адреса — счёта за коммунальные услуги, выписки из банка или другого подтверждения адреса — после завершения верификации: орган выдачи, даты, напечатанное имя, сам адрес и банковские реквизиты. Каждое поле в теле запроса опционально: записываются только отправленные ключи, всё остальное остаётся без изменений (семантика `PATCH`).\n\nСессия должна принадлежать вашему приложению и находиться в статусе `Approved`, `Declined`, `In Review` или `Kyc Expired`. Сессии в любом другом состоянии (например, всё ещё `In Progress`) возвращают `404` с сообщением `\"No Session matches the given query.\"` — в отличие от `\"Not found.\"`, возвращаемого для неизвестного или удалённого `sessionId`. Сессия также должна содержать запись POA: сессии, в сценарии которых ни разу не выполнялся шаг подтверждения адреса, возвращают `404` (`\"The session does not have a POA.\"`). Для графовых сценариев с несколькими шагами POA укажите конкретный шаг с помощью `node_id` (параметр запроса или поле тела); если он опущен, обновляется последняя запись POA.\n\n`extra_fields` объединяется по ключам: девять известных ключей (`bank_iban`, `additional_names`, …) записываются в выделенные столбцы POA, любой другой ключ сохраняется как пользовательское дополнительное поле, а `null` / `\"\"` удаляет ключ. `poa_parsed_address` принимает только семь задокументированных ключей и пересчитывает `formatted_address` / `poa_formatted_address` после каждого редактирования. Если произвольный текст `poa_address` изменяется, сервер может также выполнить повторное геокодирование и обновить структурированный адрес (пропускается для сессий в песочнице).\n\nВ отличие от варианта этого endpoint для KYC, [webhook](/ru/integration/webhooks) `data.updated` (триггер `manual_review`) срабатывает только тогда, когда хотя бы одно сохранённое значение **действительно изменилось** — повторная отправка идентичных значений не выполняет никаких действий. При изменении значений запись об активности `POA_DATA_UPDATED`, фиксирующая изменённые поля с предыдущими и новыми значениями, добавляется в `reviews` сессии и отображается в [Get Decision](#get-/v3/session/-sessionId-/decision/) и на шкале активности в консоли. Статус и решение сессии **не** пересматриваются — используйте [Update Status](#patch-/v3/session/-sessionId-/update-status/), чтобы изменить результат.\n\nПринимает API-ключ или token пользователя консоли; в любом случае учётные данные должны иметь разрешение `write:sessions`. Ошибки аутентификации и разрешений возвращают `403` — этот API никогда не отвечает `401`. Обратите внимание, что поиск сессии выполняется до проверки учётных данных, поэтому неизвестный `sessionId` вернёт `404` даже при отсутствии учётных данных. У этого endpoint есть выделенный лимит запросов: 10 запросов в минуту на API-ключ (недействительные запросы также учитываются); также применяется общий бюджет на запись в размере 300 запросов в минуту.\n\nПустое JSON-тело `{}` не выполняет никаких действий: оно отвечает `200`, возвращая текущую запись POA без отправки webhook (`has_changes` остаётся false).", "operationId": "patch_v3_session_update_poa_data", "x-didit-sdk": { "resource": "sessions", "method": "update_poa_data", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID сессии Проверки пользователей (KYC), прикреплённую запись подтверждения адреса (POA) которой вы исправляете.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "node_id", "in": "query", "required": false, "description": "Узел графа сценария, запись POA которого нужно обновить методом PATCH, для графовых сценариев с несколькими шагами подтверждения адреса (также принимается в поле `node_id` тела запроса). Если не указано, обновляется последняя запись POA в сессии. Если для указанного узла POA отсутствует, вызов возвращает `404` (`\"The session does not have a POA for node ''.\"`).", "schema": { "type": "string", "example": "feature_poa" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Все поля необязательны — передавайте только то, что хотите изменить.", "properties": { "issuing_state": { "type": "string", "nullable": true, "description": "Страна, выдавшая документ POA, ISO 3166-1 alpha-3. Нечувствительно к регистру (приводится к верхнему регистру); недействительные коды возвращают `400`.", "example": "ESP" }, "document_type": { "type": "string", "enum": [ "UTILITY_BILL", "BANK_STATEMENT", "GOVERNMENT_ISSUED_DOCUMENT", "OTHER_POA_DOCUMENT", "UNKNOWN" ], "description": "Категория документа POA. Значения указываются в верхнем регистре — варианты в нижнем регистре, такие как `utility_bill`, возвращают `400`.", "example": "UTILITY_BILL" }, "document_language": { "type": "string", "maxLength": 50, "nullable": true, "description": "Язык документа, обычно код ISO 639-1 (например, `es`). Свободный текст — валидация кода языка не выполняется.", "example": "es" }, "issuer": { "type": "string", "maxLength": 255, "nullable": true, "description": "Организация, выдавшая документ (коммунальная компания, банк, государственное учреждение).", "example": "Energy Provider S.A." }, "issue_date": { "type": "string", "format": "date", "nullable": true, "description": "Дата выдачи документа подтверждения адреса (POA) в формате `YYYY-MM-DD`. Любой другой формат возвращает `400`.", "example": "2026-04-12" }, "poa_address": { "type": "string", "nullable": true, "description": "Адрес в виде произвольного текста, как он напечатан на документе. При изменении этого значения (только для сессий вне песочницы) и если структурированный адрес всё ещё отсутствует или неполон, сервер повторно геокодирует его в фоновом режиме того же запроса и может перезаписать `poa_parsed_address` / `poa_formatted_address` результатом геокодера. Повторное геокодирование также требует наличия `issuing_state` в записи POA.", "example": "Avda de Madrid 34, 28013 Madrid" }, "name_on_document": { "type": "string", "maxLength": 255, "nullable": true, "description": "Имя получателя, как оно указано на документе.", "example": "Carmen Espanola" }, "extra_fields": { "type": "object", "additionalProperties": true, "nullable": true, "description": "Специфичные для документа дополнительные поля, объединяемые по ключам. Девять ключей соответствуют отдельным столбцам подтверждения адреса (POA): `bank_account_number`, `bank_iban`, `bank_sort_code`, `bank_routing_number`, `bank_swift_bic`, `bank_branch_name`, `bank_branch_address`, `document_phone_number` и `additional_names` (должен быть списком строк или `null`, иначе `400`). Любой другой ключ сохраняется как кастомное дополнительное поле. Семантика для каждого ключа: значение задаёт ключ; `null` или `\"\"` удаляет его. Должен быть JSON-объектом, иначе `400`." }, "poa_parsed_address": { "type": "object", "nullable": true, "description": "Структурированный адрес. Допускаются только следующие вложенные ключи: `address_type`, `city`, `region`, `street_1`, `street_2`, `postal_code`, `country` — любой другой ключ приведет к возврату `400`. Семантика ключей: переданное значение устанавливает значение ключа, `null` удаляет его. Поле `formatted_address` (и `poa_formatted_address` на верхнем уровне) пересчитывается на стороне сервера путем объединения `street_1`, `street_2`, `city`, `region`, `postal_code` и `country` — задать его напрямую невозможно.", "properties": { "address_type": { "type": "string", "nullable": true, "description": "Классификация адреса в свободной форме (например, `home`)." }, "city": { "type": "string", "nullable": true, "example": "Madrid" }, "region": { "type": "string", "nullable": true, "description": "Штат / провинция / автономное сообщество." }, "street_1": { "type": "string", "nullable": true, "example": "Avda de Madrid 34" }, "street_2": { "type": "string", "nullable": true }, "postal_code": { "type": "string", "nullable": true, "example": "28013" }, "country": { "type": "string", "nullable": true, "description": "Двухбуквенный код страны ISO 3166-1 alpha-2. Входные данные в нижнем регистре приводятся к верхнему регистру; трехбуквенные коды (alpha-3) отклоняются с ошибкой `400`.", "example": "ES" } } } } }, "examples": { "Correct issuer and address": { "summary": "Исправить классификацию документа, орган выдачи и структурированный адрес", "value": { "issuing_state": "ESP", "document_type": "BANK_STATEMENT", "issuer": "Banco Example S.A.", "issue_date": "2026-05-02", "name_on_document": "Carmen Espanola", "poa_address": "Avda de Madrid 34, 28013 Madrid", "extra_fields": { "bank_iban": "ES9121000418450200051332", "additional_names": [ "Carmen E. Espanola" ] }, "poa_parsed_address": { "street_1": "Avda de Madrid 34", "city": "Madrid", "postal_code": "28013", "country": "ES" } } }, "Remove a banking detail": { "summary": "Удалить один ключ дополнительного поля, сохранив остальные", "value": { "extra_fields": { "bank_iban": null } } } } } } }, "responses": { "200": { "description": "Данные подтверждения адреса (POA) обновлены. Возвращает **полную текущую запись POA** (каждое обновляемое поле с его сохранённым значением, а также полный объект `extra_fields`, `poa_parsed_address` и `poa_formatted_address`), а не только отправленные вами поля. webhook `data.updated` срабатывает только тогда, когда хотя бы одно значение действительно изменилось.", "content": { "application/json": { "schema": { "type": "object", "properties": { "issuing_state": { "type": "string", "nullable": true, "description": "Страна, выдавшая документ POA, ISO 3166-1 alpha-3. Нечувствительно к регистру (приводится к верхнему регистру); недействительные коды возвращают `400`.", "example": "ESP" }, "document_type": { "type": "string", "enum": [ "UTILITY_BILL", "BANK_STATEMENT", "GOVERNMENT_ISSUED_DOCUMENT", "OTHER_POA_DOCUMENT", "UNKNOWN" ], "description": "Категория документа POA. Значения указываются в верхнем регистре — варианты в нижнем регистре, такие как `utility_bill`, возвращают `400`.", "example": "UTILITY_BILL" }, "document_language": { "type": "string", "maxLength": 50, "nullable": true, "description": "Язык документа, обычно код ISO 639-1 (например, `es`). Свободный текст — валидация кода языка не выполняется.", "example": "es" }, "issuer": { "type": "string", "maxLength": 255, "nullable": true, "description": "Организация, выдавшая документ (коммунальная компания, банк, государственное учреждение).", "example": "Energy Provider S.A." }, "issue_date": { "type": "string", "format": "date", "nullable": true, "description": "Дата выдачи документа подтверждения адреса (POA) в формате `YYYY-MM-DD`. Любой другой формат возвращает `400`.", "example": "2026-04-12" }, "poa_address": { "type": "string", "nullable": true, "description": "Адрес в виде произвольного текста, как он напечатан на документе. При изменении этого значения (только для сессий вне песочницы) и если структурированный адрес всё ещё отсутствует или неполон, сервер повторно геокодирует его в фоновом режиме того же запроса и может перезаписать `poa_parsed_address` / `poa_formatted_address` результатом геокодера.", "example": "Avda de Madrid 34, 28013 Madrid" }, "name_on_document": { "type": "string", "maxLength": 255, "nullable": true, "description": "Имя получателя, как оно указано на документе.", "example": "Carmen Espanola" }, "extra_fields": { "type": "object", "additionalProperties": true, "nullable": true, "description": "Всегда присутствует в ответе: девять известных ключей (со значением `null` для полей, которым не задано значение, `additional_names` по умолчанию `[]`) плюс любые ранее сохранённые пользовательские ключи." }, "poa_parsed_address": { "type": "object", "nullable": true, "description": "Текущий структурированный адрес или `null`, если он отсутствует. Включает пересчитанный `formatted_address` наряду с семью редактируемыми ключами. Возвращается в сохранённом виде — после геокодирования на стороне сервера он может содержать служебные ключи (например, `raw_results`) наряду с редактируемыми ключами.", "properties": { "address_type": { "type": "string", "nullable": true, "description": "Классификация адреса в свободной форме (например, `home`)." }, "city": { "type": "string", "nullable": true, "example": "Madrid" }, "region": { "type": "string", "nullable": true, "description": "Штат / провинция / автономное сообщество." }, "street_1": { "type": "string", "nullable": true, "example": "Avda de Madrid 34" }, "street_2": { "type": "string", "nullable": true }, "postal_code": { "type": "string", "nullable": true, "example": "28013" }, "country": { "type": "string", "nullable": true, "description": "Двухбуквенный код страны ISO 3166-1 alpha-2. Входные данные в нижнем регистре приводятся к верхнему регистру; трехбуквенные коды (alpha-3) отклоняются с ошибкой `400`.", "example": "ES" }, "formatted_address": { "type": "string", "nullable": true, "description": "Объединённое, понятное человеку представление структурированного адреса. Пересчитывается на стороне сервера после каждого изменения `poa_parsed_address`.", "example": "Avda de Madrid 34, Madrid, 28013, ES" } } }, "poa_formatted_address": { "type": "string", "nullable": true, "description": "Копия пересчитанного `formatted_address` верхнего уровня, синхронизируемая при изменении структурированного адреса.", "example": "Avda de Madrid 34, Madrid, 28013, ES" } } }, "examples": { "Updated POA": { "summary": "Полная запись POA после исправления", "value": { "issuing_state": "ESP", "document_type": "BANK_STATEMENT", "document_language": "es", "issuer": "Banco Example S.A.", "issue_date": "2026-05-02", "poa_address": "Avda de Madrid 34, 28013 Madrid", "name_on_document": "Carmen Espanola", "extra_fields": { "bank_account_number": null, "bank_iban": "ES9121000418450200051332", "bank_sort_code": null, "bank_routing_number": null, "bank_swift_bic": null, "bank_branch_name": null, "bank_branch_address": null, "document_phone_number": null, "additional_names": [ "Carmen E. Espanola" ] }, "poa_parsed_address": { "city": "Madrid", "street_1": "Avda de Madrid 34", "postal_code": "28013", "country": "ES", "formatted_address": "Avda de Madrid 34, Madrid, 28013, ES" }, "poa_formatted_address": "Avda de Madrid 34, Madrid, 28013, ES" } } } } } }, "400": { "description": "Ошибка валидации. Ошибки полей возвращаются в виде `{\"\": [\"\"]}`; ошибки во вложенных ключах `poa_parsed_address` / `extra_fields` используют объектное значение: `{\"extra_fields\": {\"\": \"\"}}`.", "content": { "application/json": { "examples": { "Invalid document type": { "summary": "Значения enum указываются в верхнем регистре — варианты в нижнем регистре отклоняются", "value": { "document_type": [ "\"utility_bill\" is not a valid choice." ] } }, "Invalid issuing state": { "summary": "issuing_state не соответствует стандарту ISO 3166-1 alpha-3", "value": { "issuing_state": [ "Invalid ISO 3166-1 alpha-3 country code for issuing_state." ] } }, "additional_names not a list": { "summary": "additional_names принимает список строк или null", "value": { "extra_fields": { "additional_names": "Must be a list or null." } } }, "Unsupported poa_parsed_address key": { "summary": "Разрешены только семь задокументированных ключей", "value": { "poa_parsed_address": { "zipcode": "Unsupported key. Allowed keys: address_type, city, region, street_1, street_2, postal_code, country" } } }, "Bad date format": { "summary": "Даты должны быть в формате YYYY-MM-DD", "value": { "issue_date": [ "Date has wrong format. Use one of these formats instead: YYYY-MM-DD." ] } } } } } }, "403": { "description": "Отсутствуют учетные данные или недостаточно разрешений. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Отсутствует или недействителен x-api-key", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "В учётных данных отсутствует разрешение write:sessions", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Неизвестная сессия, сессия в нередактируемом состоянии или отсутствие записи POA для обновления. Для каждого кейса предусмотрено отдельное сообщение в `detail` (см. примеры). Поиск неизвестной сессии выполняется до проверки учетных данных.", "content": { "application/json": { "examples": { "Unknown session": { "summary": "Сессия с этим ID отсутствует в вашем приложении (или была удалена)", "value": { "detail": "Not found." } }, "Wrong session state": { "summary": "Сессия существует, но её статус отличается от Approved / Declined / In Review / Kyc Expired", "value": { "detail": "No Session matches the given query." } }, "No POA record": { "summary": "В сценарии не выполнялся шаг Подтверждение адреса", "value": { "detail": "The session does not have a POA." } }, "No POA for node": { "summary": "node_id указан, но POA для него отсутствует", "value": { "detail": "The session does not have a POA for node 'feature_missing'." } } } } } }, "429": { "description": "Превышен выделенный лимит запросов — 10 обновлений данных POA в минуту на один API-ключ (отклонённые запросы учитываются в лимите). Общий лимит на запись 300 запросов/мин также может сработать со своим сообщением. Проверьте заголовок `Retry-After` и заголовки ответа `X-RateLimit-*` перед повторной попыткой.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Лимит обновлений POA исчерпан", "value": { "detail": "Session POA data update rate limit exceeded. You can make up to 10 requests per minute." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/update-poa-data/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"issuing_state\": \"ESP\",\n \"document_type\": \"BANK_STATEMENT\",\n \"issuer\": \"Banco Example S.A.\",\n \"issue_date\": \"2026-05-02\",\n \"name_on_document\": \"Carmen Espanola\",\n \"poa_address\": \"Avda de Madrid 34, 28013 Madrid\",\n \"extra_fields\": {\n \"bank_iban\": \"ES9121000418450200051332\"\n },\n \"poa_parsed_address\": {\n \"city\": \"Madrid\",\n \"postal_code\": \"28013\",\n \"country\": \"ES\"\n }\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_poa_data(\n \"11111111-2222-3333-4444-555555555555\",\n issuing_state=\"ESP\",\n document_type=\"BANK_STATEMENT\",\n issuer=\"Banco Example S.A.\",\n issue_date=\"2026-05-02\",\n poa_address=\"Avda de Madrid 34, 28013 Madrid\",\n name_on_document=\"Carmen Espanola\",\n extra_fields={\"bank_iban\": \"ES9121000418450200051332\", \"additional_names\": [\"Carmen E. Espanola\"]},\n poa_parsed_address={\n \"city\": \"Madrid\",\n \"street_1\": \"Avda de Madrid 34\",\n \"postal_code\": \"28013\",\n \"country\": \"ES\",\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updatePoaData(\"11111111-2222-3333-4444-555555555555\", {\n issuing_state: \"ESP\",\n document_type: \"BANK_STATEMENT\",\n issuer: \"Banco Example S.A.\",\n issue_date: \"2026-05-02\",\n poa_address: \"Avda de Madrid 34, 28013 Madrid\",\n name_on_document: \"Carmen Espanola\",\n extra_fields: { bank_iban: \"ES9121000418450200051332\", additional_names: [\"Carmen E. Espanola\"] },\n poa_parsed_address: {\n city: \"Madrid\",\n street_1: \"Avda de Madrid 34\",\n postal_code: \"28013\",\n country: \"ES\",\n },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdatePOAData(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsUpdatePOADataParams{\n\tIssuingState: didit.String(\"ESP\"),\n\tDocumentType: didit.Some(didit.SessionsUpdatePOADataParamsDocumentType(\"BANK_STATEMENT\")),\n\tIssuer: didit.String(\"Banco Example S.A.\"),\n\tIssueDate: didit.String(\"2026-05-02\"),\n\tPOAAddress: didit.String(\"Avda de Madrid 34, 28013 Madrid\"),\n\tNameOnDocument: didit.String(\"Carmen Espanola\"),\n\tExtraFields: didit.Some(map[string]any{\"bank_iban\": \"ES9121000418450200051332\", \"additional_names\": []any{\"Carmen E. Espanola\"}}),\n\tPOAParsedAddress: didit.Some(didit.SessionsUpdatePOADataParamsPOAParsedAddress{\n\t\tCity: didit.String(\"Madrid\"),\n\t\tStreet1: didit.String(\"Avda de Madrid 34\"),\n\t\tPostalCode: didit.String(\"28013\"),\n\t\tCountry: didit.String(\"ES\"),\n\t}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.LocalDate;\nimport java.util.List;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.SessionsUpdatePoaDataParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updatePoaData(\"11111111-2222-3333-4444-555555555555\", SessionsUpdatePoaDataParams.builder()\n .issuingState(\"ESP\")\n .documentType(SessionsUpdatePoaDataParams.DocumentType.of(\"BANK_STATEMENT\"))\n .issuer(\"Banco Example S.A.\")\n .issueDate(LocalDate.parse(\"2026-05-02\"))\n .poaAddress(\"Avda de Madrid 34, 28013 Madrid\")\n .nameOnDocument(\"Carmen Espanola\")\n .extraFields(Map.of(\"bank_iban\", \"ES9121000418450200051332\", \"additional_names\", List.of(\"Carmen E. Espanola\")))\n .poaParsedAddress(SessionsUpdatePoaDataParams.PoaParsedAddress.builder()\n .city(\"Madrid\")\n .street1(\"Avda de Madrid 34\")\n .postalCode(\"28013\")\n .country(\"ES\")\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updatePoaData('11111111-2222-3333-4444-555555555555', [\n 'issuing_state' => 'ESP',\n 'document_type' => 'BANK_STATEMENT',\n 'issuer' => 'Banco Example S.A.',\n 'issue_date' => '2026-05-02',\n 'poa_address' => 'Avda de Madrid 34, 28013 Madrid',\n 'name_on_document' => 'Carmen Espanola',\n 'extra_fields' => ['bank_iban' => 'ES9121000418450200051332', 'additional_names' => ['Carmen E. Espanola']],\n 'poa_parsed_address' => [\n 'city' => 'Madrid',\n 'street_1' => 'Avda de Madrid 34',\n 'postal_code' => '28013',\n 'country' => 'ES',\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_poa_data(\n \"11111111-2222-3333-4444-555555555555\",\n issuing_state: \"ESP\",\n document_type: \"BANK_STATEMENT\",\n issuer: \"Banco Example S.A.\",\n issue_date: \"2026-05-02\",\n poa_address: \"Avda de Madrid 34, 28013 Madrid\",\n name_on_document: \"Carmen Espanola\",\n extra_fields: { bank_iban: \"ES9121000418450200051332\", additional_names: [\"Carmen E. Espanola\"] },\n poa_parsed_address: {\n city: \"Madrid\",\n street_1: \"Avda de Madrid 34\",\n postal_code: \"28013\",\n country: \"ES\",\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdatePoaDataAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsUpdatePoaDataParams\n{\n IssuingState = \"ESP\",\n DocumentType = new SessionsUpdatePoaDataParamsDocumentType(\"BANK_STATEMENT\"),\n Issuer = \"Banco Example S.A.\",\n IssueDate = \"2026-05-02\",\n PoaAddress = \"Avda de Madrid 34, 28013 Madrid\",\n NameOnDocument = \"Carmen Espanola\",\n ExtraFields = new Dictionary { [\"bank_iban\"] = \"ES9121000418450200051332\", [\"additional_names\"] = new object[] { \"Carmen E. Espanola\" } },\n PoaParsedAddress = new SessionsUpdatePoaDataParamsPoaParsedAddress\n {\n City = \"Madrid\",\n Street1 = \"Avda de Madrid 34\",\n PostalCode = \"28013\",\n Country = \"ES\",\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/kyb/{companyUuid}/update-data/": { "patch": { "summary": "Обновить данные компании, извлечённые из реестра, в сессии верификации бизнеса (KYB)", "description": "Исправляет извлечённые из реестра данные компании в сессии Верификации бизнеса (KYB) — название компании, регистрационный номер, адреса, статус, контактные данные — идентифицируемые по `companyUuid`. Обычно endpoint вызывают комплаенс-аналитики для исправления ошибок распознавания реестра или ваш бэк-офис для синхронизации скорректированных данных компании. Все поля в теле запроса опциональны (семантика `PATCH`); пустое тело JSON (`{}`) является холостой операцией (no-op), которая просто возвращает текущую запись компании.\n\nИзменения записываются одновременно в два места: поля с канонической колонкой компании (название, регистрационный номер, страна, дата регистрации, налоговый номер, тип, статусы, поля капитала (`registered_capital`, `registered_capital_amount`, `registered_capital_currency`), альтернативные названия, вид деятельности, веб-сайт, электронная почта, телефон, LEI, местоположение и `legal_address` → `registered_address`) обновляют эту колонку, и **каждый** переданный ключ также объединяется со снимком `registry_data` (даты в виде строк ISO), чтобы представление «извлечено из реестра» отражало исправление. Поля без колонки — `region`, `registration_date`, `dissolution_date`, `control_scheme` — попадают только в `registry_data`. Поле `user_provided_data` (то, что конечный пользователь подтвердил в размещённом сценарии) никогда не затрагивается, а метка `last_console_edit_at` проставляется при каждом непустом PATCH-запросе.\n\nВ отличие от endpoints обновления KYC/POA, здесь **нет ограничения по статусу сессии**: компанию можно редактировать в любой момент жизненного цикла бизнес-сессии. Компания должна принадлежать сессии, указанной в пути (в противном случае возвращается `404` с `\"KYB company does not belong to the given session.\"`), и вашему приложению. Каждый непустой PATCH вызывает [webhook](/ru/integration/webhooks) `data.updated` для бизнес-сессии (триггер `console_registry_edit`) — даже если переданные значения совпадают с сохранёнными. Статус и решение сессии **не** пересматриваются, а запись о проверке/аудите не создаётся.\n\nПринимает API-ключ или токен пользователя консоли; в любом случае учётные данные должны иметь разрешение `write:businesses`. Ошибки аутентификации и разрешений возвращают `403` — этот API никогда не возвращает `401`. Обратите внимание, что поиск сессии выполняется до проверки учётных данных, поэтому неизвестный `sessionId` возвращает `404` даже при отсутствии учётных данных. Применяется общий лимит на запись в размере 300 запросов в минуту на API-ключ.\n\nДля сессий Проверки пользователей аналогом KYC является `PATCH /v3/session/{sessionId}/update-data/`; чтобы изменить само решение по сессии, используйте `PATCH /v3/session/{sessionId}/update-status/`.", "operationId": "patch_v3_session_kyb_company_update_data", "x-didit-sdk": { "resource": "sessions", "method": "update_kyb_company_data", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID родительской сессии Верификации бизнеса (KYB).", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "companyUuid", "in": "path", "required": true, "description": "UUID обновляемой записи компании (`registry_checks[].company.uuid` в решении по бизнес-сессии). Должен принадлежать сессии, указанной в `sessionId`.", "schema": { "type": "string", "format": "uuid", "example": "88888888-9999-aaaa-bbbb-cccccccccccc" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Все поля опциональны — отправляйте только то, что хотите изменить. Переданные поля обновляют канонические столбцы компании (где применимо) и объединяются со снимком `registry_data`.", "properties": { "company_name": { "type": "string", "maxLength": 255, "description": "Юридическое наименование компании. Записывается в каноническую колонку и снимок реестра.", "example": "Docs Probe Corp" }, "registration_number": { "type": "string", "maxLength": 100, "description": "Официальный регистрационный номер в реестре компаний.", "example": "DPC-001" }, "country_code": { "type": "string", "maxLength": 2, "description": "Страна инкорпорации, ISO 3166-1 alpha-2. Нечувствительно к регистру (`us` сохраняется как `US`). Коды alpha-3 не проходят ограничение в 2 символа и возвращают `400`.", "example": "US" }, "region": { "type": "string", "maxLength": 10, "nullable": true, "description": "Тег подразделения / региона, если он есть в реестре (например, штат США). Сохраняется только в снимке реестра — не имеет канонической колонки." }, "incorporation_date": { "type": "string", "format": "date", "description": "Дата регистрации в формате `YYYY-MM-DD`. Поле необязательное, как и все остальные, поскольку запрос `PATCH` изменяет данные частично. Любой другой формат даты возвращает `400`.", "example": "2015-04-12" }, "registration_date": { "type": "string", "format": "date", "nullable": true, "description": "Дата регистрации, если реестр отличает её от даты инкорпорации. Сохраняется только в снапшоте реестра." }, "dissolution_date": { "type": "string", "format": "date", "nullable": true, "description": "Дата ликвидации для компаний, которые больше не действуют. Сохраняется только в снимке реестра." }, "tax_number": { "type": "string", "maxLength": 100, "description": "Налоговый номер." }, "legal_address": { "type": "string", "description": "Юридический / зарегистрированный адрес. На стороне сервера является псевдонимом канонической колонки `registered_address` — в ответе возвращается как `registered_address`, тогда как снимок реестра сохраняет переданный вами ключ `legal_address`.", "example": "1 Example Plaza, Wilmington, DE 19801" }, "company_type": { "type": "string", "maxLength": 100, "description": "Тип юридического лица (например, `Limited Liability Company`, `PLC`, `GmbH`).", "example": "Limited Liability Company" }, "registry_status": { "type": "string", "enum": [ "active", "dissolved", "deregistered", "see full details", "authorised", "appointed representative", "unauthorised", "inactive", "no longer authorised", "closed", "struck off" ], "nullable": true, "description": "Статус компании по данным реестра. В нижнем регистре, некоторые значения содержат пробелы (например, `struck off`, `no longer authorised`). Любое другое значение возвращает `400`.", "example": "active" }, "verification_status": { "type": "string", "enum": [ "verified", "failed", "unknown" ], "nullable": true, "description": "Результат верификации по реестру. Любое другое значение возвращает `400`.", "example": "verified" }, "alternative_names": { "type": "string", "description": "Коммерческие обозначения, прежние юридические наименования, наименования DBA (произвольный текст)." }, "nature_of_business": { "type": "string", "description": "Краткое описание деятельности компании.", "example": "Software development" }, "registered_capital": { "type": "string", "maxLength": 100, "description": "Уставный капитал в понятном человеку формате (например, `USD 50000`). Используйте `registered_capital_amount` + `registered_capital_currency` для структурированных значений или это поле для произвольного текста.", "example": "USD 50000" }, "registered_capital_amount": { "type": "number", "format": "double", "nullable": true, "description": "Числовая сумма уставного капитала (до 20 цифр, 2 знака после запятой). Задаёт колонку `registered_capital_amount` и дублируется в `registry_data` как десятичная строка; в ответе возвращается как десятичная строка (например, `\"1500000.50\"`)." }, "registered_capital_currency": { "type": "string", "maxLength": 3, "nullable": true, "description": "Код валюты ISO 4217 для `registered_capital_amount`. Регистронезависимый (`usd` сохраняется как `USD`); значения, длина которых отличается от 3 букв, возвращают `400` с сообщением об ошибке ISO 4217. Задаёт каноническую колонку `registered_capital_currency` и дублируется в `registry_data`.", "example": "USD" }, "website": { "type": "string", "maxLength": 500, "description": "Веб-сайт компании. Принимаются «голые» домены, которые нормализуются префиксом `https://` (`docsprobe.example.com` сохраняется как `https://docsprobe.example.com`); значения, не прошедшие валидацию URL, возвращают `400`.", "example": "https://docsprobe.example.com" }, "email": { "type": "string", "format": "email", "description": "Контактный email, зарегистрированный в реестре.", "example": "legal@docsprobe.example.com" }, "phone": { "type": "string", "maxLength": 50, "description": "Контактный телефон. Должен содержать `+`, цифры, пробелы, дефисы, точки или круглые скобки, всего от 7 до 15 цифр — иначе возвращается `400`.", "example": "+1 302 555 0143" }, "legal_entity_identifier": { "type": "string", "maxLength": 50, "description": "LEI, если он есть у компании." }, "location_of_registration": { "type": "string", "maxLength": 255, "description": "Город / подразделение реестра, в котором зарегистрирована запись." }, "vat_number": { "type": "string", "maxLength": 64, "description": "Номер плательщика НДС в ЕС. Объединяется только со снимком `registry_data` — его изменение здесь не запускает повторно проверку НДС и налогового номера, поэтому `vat_validation_status` и другие результирующие поля `vat_*` остаются без изменений." }, "control_scheme": { "type": "string", "description": "Схема контроля / управления, если реестр её раскрывает. Сохраняется только в снимке реестра." } } }, "examples": { "Correct registry data": { "summary": "Исправить поля компании, извлечённые из реестра", "value": { "company_name": "Docs Probe Corp", "registration_number": "DPC-001", "country_code": "US", "incorporation_date": "2015-04-12", "company_type": "Limited Liability Company", "legal_address": "1 Example Plaza, Wilmington, DE 19801", "registry_status": "active", "verification_status": "verified", "website": "docsprobe.example.com", "email": "legal@docsprobe.example.com", "phone": "+1 302 555 0143", "registered_capital": "USD 50000", "nature_of_business": "Software development" } }, "Single field": { "summary": "Записываются только отправленные вами ключи", "value": { "registry_status": "dissolved" } }, "No-op": { "summary": "Пустое тело запроса возвращает текущую запись без вызова webhook", "value": {} } } } } }, "responses": { "200": { "description": "Данные компании обновлены (или возвращены без изменений при пустом теле). Возвращает полную запись компании KYB — в том же формате, что и `registry_checks[].company` в решении по бизнес-сессии. Обратите внимание, что `legal_address` возвращается как `registered_address`. `registered_capital_amount`/`registered_capital_currency` заполняют свои канонические столбцы и дублируются в `registry_data`.", "content": { "application/json": { "schema": { "type": "object", "description": "Полная запись компании KYB — той же структуры, что и объект `company` внутри `registry_checks[]` в решении по бизнес-сессии.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Идентификатор записи компании (параметр пути `companyUuid`)." }, "node_id": { "type": "string", "nullable": true, "description": "Узел графа сценария, которому принадлежит эта запись компании, если сценарий основан на графе." }, "status": { "type": "string", "description": "Статус жизненного цикла функции проверки по реестру (например, `Not Finished`, `Approved`, `Declined`, `In Review`)." }, "registry_status": { "type": "string", "nullable": true, "description": "Статус компании по данным реестра (например, `active`, `dissolved`, `struck off`)." }, "data_resolved": { "type": "boolean", "description": "`true`, если данные компании заполнены полностью — всегда `true` для компаний, введённых вручную; для компаний, полученных из реестра, `true`, как только завершился запрос к реестру." }, "company_name": { "type": "string", "nullable": true }, "registration_number": { "type": "string", "nullable": true }, "country_code": { "type": "string", "nullable": true, "description": "Код страны инкорпорации по стандарту ISO 3166-1 alpha-2." }, "region": { "type": "string", "nullable": true }, "company_type": { "type": "string", "nullable": true }, "incorporation_date": { "type": "string", "format": "date", "nullable": true }, "registered_address": { "type": "string", "nullable": true, "description": "Канонический юридический адрес — обновляется при отправке `legal_address`." }, "tax_number": { "type": "string", "nullable": true }, "risk_level": { "type": "string", "nullable": true }, "verification_status": { "type": "string", "nullable": true, "description": "`verified`, `failed` или `unknown`." }, "is_from_registry": { "type": "boolean", "description": "`true`, если данные компании были предварительно заполнены из поиска по реестру, а не введены вручную." }, "fetch_status": { "type": "string", "nullable": true, "description": "Жизненный цикл получения данных из реестра для компаний, найденных в реестре (`pending` / `resolved`); `null` для записей, добавленных вручную." }, "alternative_names": { "type": "string", "nullable": true, "description": "Альтернативные, торговые, прежние или наименования компании на языке оригинала в виде текста, если они указаны." }, "nature_of_business": { "type": "string", "nullable": true }, "registered_capital": { "type": "string", "nullable": true }, "registered_capital_amount": { "type": "string", "nullable": true, "description": "Каноническая колонка. Возвращается в виде десятичной строки (например, `\"2750000.00\"`)." }, "registered_capital_currency": { "type": "string", "nullable": true, "description": "Каноническая колонка. Задаётся сценарием реестра либо редактированием через панель управления/API через данный endpoint." }, "website": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "legal_entity_identifier": { "type": "string", "nullable": true }, "location_of_registration": { "type": "string", "nullable": true }, "vat_number": { "type": "string", "nullable": true, "description": "Номер плательщика НДС в ЕС, если он был собран на размещённом шаге реестра или изменён впоследствии." }, "vat_validation_status": { "type": "string", "enum": [ "valid", "invalid", "format_valid", "invalid_format", "could_not_validate", "not_applicable" ], "description": "Результат валидации номера плательщика НДС (VAT) или, при его отсутствии, `tax_number` при отправке в реестр. `valid` / `invalid`: определяется официальным реестром страны (EU VIES, Норвегия, Швейцария, Бразилия, Колумбия, Коста-Рика, Эквадор, Парагвай; Польша также по внутреннему реестру НДС). `format_valid` / `invalid_format`: определяется правилами формата и контрольных цифр страны, если реестр недоступен для запроса. `could_not_validate`: реестр был недоступен. `not_applicable`: номер отсутствует, в стране нет реестра или правил либо это сессия в песочнице." }, "vat_validated_number": { "type": "string", "nullable": true, "description": "Номер, который был проверен, в том виде, в каком он известен источнику (например, номер VAT, полученный из французского SIREN или нидерландского RSIN). `null`, если проверка не выполнялась." }, "vat_validation_source": { "type": "string", "nullable": true, "enum": [ "eu_vies", "pl_vat_white_list", "no_brreg", "ch_uid_register", "br_receita_federal", "co_rues", "cr_hacienda", "ec_sri", "py_dnit", "format_rules", null ], "description": "Источник, определивший `vat_validation_status`: официальный реестр или `format_rules`. `null`, если проверка не проводилась." }, "vat_validated_name": { "type": "string", "nullable": true, "description": "Имя, зарегистрированное в источнике, подтвердившем номер, если источник его раскрывает. Указывается только со статусом `valid`." }, "vat_validated_address": { "type": "string", "nullable": true, "description": "Адрес, зарегистрированный в источнике, выполнившем проверку номера, если он раскрывает его. Заполняется, только когда статус равен `valid`." }, "vat_checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Временная метка проверки. `null`, если проверка не запускалась." }, "financial_summary": { "type": "object", "nullable": true, "additionalProperties": true }, "officers": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Директора / должностные лица, привязанные к компании, включая прогресс KYC по каждому лицу." }, "beneficial_owners": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Бенефициарные владельцы, привязанные к компании, включая прогресс KYC по каждому человеку." }, "addresses": { "type": "array", "nullable": true, "items": { "type": "object", "additionalProperties": true }, "description": "Детали адреса из реестра, если они были возвращены реестром." }, "industries": { "type": "array", "nullable": true, "items": { "type": "object", "additionalProperties": true }, "description": "Отраслевая классификация по данным реестра, если доступна." }, "accounts": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Даты подачи документов в реестр, если доступны. Для годовой отчётности и общих собраний используются last_annual_return_date и last_agm_date; они отличаются от финансовой отчётности." }, "registry_data": { "$ref": "#/components/schemas/KYBRegistryData" }, "user_provided_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Что конечный пользователь ввёл на размещённом шаге подтверждения данных в реестре. Никогда не изменяется этим endpoint." }, "confirmed_by_user_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда конечный пользователь подтвердил данные компании в хостируемом сценарии." }, "last_console_edit_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Проставляется при каждом успешном непустом PATCH-запросе, чтобы интерфейсы могли отображать контекст «отредактировано оператором»." }, "is_editable": { "type": "boolean", "description": "`true`, пока конечный пользователь всё ещё может редактировать полученные из реестра данные в размещённом сценарии (получены из реестра и ещё не подтверждены)." } } }, "examples": { "Updated company": { "summary": "Полная запись компании после исправления", "value": { "uuid": "6b9479f5-6769-46c8-baf1-df63bbbc5f8c", "node_id": null, "status": "Not Finished", "registry_status": "active", "data_resolved": true, "company_name": "Docs Probe Corp", "registration_number": "DPC-001", "country_code": "US", "region": null, "company_type": "Limited Liability Company", "incorporation_date": "2015-04-12", "registered_address": "1 Example Plaza, Wilmington, DE 19801", "tax_number": null, "risk_level": null, "verification_status": "verified", "is_from_registry": false, "fetch_status": null, "alternative_names": null, "nature_of_business": "Software development", "registered_capital": "USD 50000", "registered_capital_amount": null, "registered_capital_currency": "USD", "website": "https://docsprobe.example.com", "email": "legal@docsprobe.example.com", "phone": "+1 302 555 0143", "legal_entity_identifier": null, "location_of_registration": null, "financial_summary": null, "officers": [], "beneficial_owners": [], "addresses": null, "industries": null, "accounts": null, "registry_data": { "company_name": "Docs Probe Corp", "registration_number": "DPC-001", "country_code": "US", "incorporation_date": "2015-04-12", "legal_address": "1 Example Plaza, Wilmington, DE 19801", "company_type": "Limited Liability Company", "registry_status": "active", "verification_status": "verified", "nature_of_business": "Software development", "registered_capital": "USD 50000", "registered_capital_currency": "USD", "website": "https://docsprobe.example.com", "email": "legal@docsprobe.example.com", "phone": "+1 302 555 0143" }, "user_provided_data": null, "confirmed_by_user_at": null, "last_console_edit_at": "2026-06-12T00:02:34.276061Z", "is_editable": false } } } } } }, "400": { "description": "Ошибка валидации. Ошибки полей возвращаются в виде `{\"\": [\"\"]}`. Проверка максимальной длины выполняется до проверки формата, поэтому при `country_code: \"USA\"` возвращается сообщение об ограничении в 2 символа, а не сообщение о стандарте ISO.", "content": { "application/json": { "examples": { "Alpha-3 country code": { "summary": "country_code должен быть в формате alpha-2 — проверка длины срабатывает первой", "value": { "country_code": [ "Ensure this field has no more than 2 characters." ] } }, "Non-alphabetic country code": { "summary": "2 символа, но не буквы", "value": { "country_code": [ "country_code must be a 2-letter ISO 3166-1 alpha-2 code." ] } }, "Invalid currency": { "summary": "3 символа, но не код ISO 4217", "value": { "registered_capital_currency": [ "Currency must be a 3-letter ISO 4217 code (e.g. USD, EUR, GBP)." ] } }, "Invalid phone": { "summary": "Номер телефона не проходит проверку формата или количества цифр", "value": { "phone": [ "Invalid phone number format." ] } }, "Invalid registry status": { "summary": "registry_status отсутствует в enum", "value": { "registry_status": [ "\"liquidated\" is not a valid choice." ] } }, "Invalid email": { "summary": "Некорректный адрес электронной почты", "value": { "email": [ "Enter a valid email address." ] } }, "Invalid website": { "summary": "Значение не проходит валидацию URL даже после нормализации с https://", "value": { "website": [ "Enter a valid URL." ] } }, "Bad date format": { "summary": "Даты должны быть в формате YYYY-MM-DD", "value": { "incorporation_date": [ "Date has wrong format. Use one of these formats instead: YYYY-MM-DD." ] } } } } } }, "403": { "description": "Отсутствуют учетные данные или недостаточно разрешений. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Отсутствует или недействителен x-api-key", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "В учётных данных отсутствует разрешение write:businesses", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Неизвестная сессия, неизвестная компания или компания, принадлежащая к другой сессии. Для каждого кейса предусмотрено отдельное сообщение в `detail` (см. примеры). Поиск неизвестной сессии выполняется до проверки учетных данных.", "content": { "application/json": { "examples": { "Unknown session": { "summary": "Сессия с этим ID отсутствует в вашем приложении (или была удалена)", "value": { "detail": "Not found." } }, "Unknown company": { "summary": "В вашем приложении нет компании с таким UUID", "value": { "detail": "No KYBCompany matches the given query." } }, "Company / session mismatch": { "summary": "companyUuid существует, но принадлежит другой сессии", "value": { "detail": "KYB company does not belong to the given session." } } } } } }, "429": { "description": "Превышен общий лимит запросов на запись (300 запросов POST/PATCH/DELETE в минуту на один API-ключ). Проверьте заголовок `Retry-After` и заголовки ответа `X-RateLimit-*` перед повторной попыткой.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Исчерпан бюджет на запись", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH \\\n https://verification.didit.me/v3/session/33333333-4444-5555-6666-777777777777/kyb/88888888-9999-aaaa-bbbb-cccccccccccc/update-data/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"company_name\": \"Docs Probe Corp\",\n \"registration_number\": \"DPC-001\",\n \"country_code\": \"US\",\n \"incorporation_date\": \"2015-04-12\",\n \"company_type\": \"Limited Liability Company\",\n \"legal_address\": \"1 Example Plaza, Wilmington, DE 19801\",\n \"registry_status\": \"active\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_kyb_company_data(\n \"33333333-4444-5555-6666-777777777777\",\n \"88888888-9999-aaaa-bbbb-cccccccccccc\",\n company_name=\"Docs Probe Corp\",\n registration_number=\"DPC-001\",\n country_code=\"US\",\n incorporation_date=\"2015-04-12\",\n legal_address=\"1 Example Plaza, Wilmington, DE 19801\",\n company_type=\"Limited Liability Company\",\n registry_status=\"active\",\n verification_status=\"verified\",\n nature_of_business=\"Software development\",\n registered_capital=\"USD 50000\",\n website=\"docsprobe.example.com\",\n email=\"legal@docsprobe.example.com\",\n phone=\"+1 302 555 0143\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updateKybCompanyData(\n \"33333333-4444-5555-6666-777777777777\",\n \"88888888-9999-aaaa-bbbb-cccccccccccc\",\n {\n company_name: \"Docs Probe Corp\",\n registration_number: \"DPC-001\",\n country_code: \"US\",\n incorporation_date: \"2015-04-12\",\n legal_address: \"1 Example Plaza, Wilmington, DE 19801\",\n company_type: \"Limited Liability Company\",\n registry_status: \"active\",\n verification_status: \"verified\",\n nature_of_business: \"Software development\",\n registered_capital: \"USD 50000\",\n website: \"docsprobe.example.com\",\n email: \"legal@docsprobe.example.com\",\n phone: \"+1 302 555 0143\",\n },\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateKYBCompanyData(ctx, \"33333333-4444-5555-6666-777777777777\", \"88888888-9999-aaaa-bbbb-cccccccccccc\", didit.SessionsUpdateKYBCompanyDataParams{\n\tCompanyName: didit.String(\"Docs Probe Corp\"),\n\tRegistrationNumber: didit.String(\"DPC-001\"),\n\tCountryCode: didit.String(\"US\"),\n\tIncorporationDate: didit.String(\"2015-04-12\"),\n\tLegalAddress: didit.String(\"1 Example Plaza, Wilmington, DE 19801\"),\n\tCompanyType: didit.String(\"Limited Liability Company\"),\n\tRegistryStatus: didit.Some(didit.SessionsUpdateKYBCompanyDataParamsRegistryStatus(\"active\")),\n\tVerificationStatus: didit.Some(didit.SessionsUpdateKYBCompanyDataParamsVerificationStatus(\"verified\")),\n\tNatureOfBusiness: didit.String(\"Software development\"),\n\tRegisteredCapital: didit.String(\"USD 50000\"),\n\tWebsite: didit.String(\"docsprobe.example.com\"),\n\tEmail: didit.String(\"legal@docsprobe.example.com\"),\n\tPhone: didit.String(\"+1 302 555 0143\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.LocalDate;\nimport me.didit.Didit;\nimport me.didit.types.SessionsUpdateKybCompanyDataParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updateKybCompanyData(\"33333333-4444-5555-6666-777777777777\", \"88888888-9999-aaaa-bbbb-cccccccccccc\", SessionsUpdateKybCompanyDataParams.builder()\n .companyName(\"Docs Probe Corp\")\n .registrationNumber(\"DPC-001\")\n .countryCode(\"US\")\n .incorporationDate(LocalDate.parse(\"2015-04-12\"))\n .legalAddress(\"1 Example Plaza, Wilmington, DE 19801\")\n .companyType(\"Limited Liability Company\")\n .registryStatus(SessionsUpdateKybCompanyDataParams.RegistryStatus.of(\"active\"))\n .verificationStatus(SessionsUpdateKybCompanyDataParams.VerificationStatus.of(\"verified\"))\n .natureOfBusiness(\"Software development\")\n .registeredCapital(\"USD 50000\")\n .website(\"docsprobe.example.com\")\n .email(\"legal@docsprobe.example.com\")\n .phone(\"+1 302 555 0143\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updateKybCompanyData('33333333-4444-5555-6666-777777777777', '88888888-9999-aaaa-bbbb-cccccccccccc', [\n 'company_name' => 'Docs Probe Corp',\n 'registration_number' => 'DPC-001',\n 'country_code' => 'US',\n 'incorporation_date' => '2015-04-12',\n 'legal_address' => '1 Example Plaza, Wilmington, DE 19801',\n 'company_type' => 'Limited Liability Company',\n 'registry_status' => 'active',\n 'verification_status' => 'verified',\n 'nature_of_business' => 'Software development',\n 'registered_capital' => 'USD 50000',\n 'website' => 'docsprobe.example.com',\n 'email' => 'legal@docsprobe.example.com',\n 'phone' => '+1 302 555 0143',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_kyb_company_data(\n \"33333333-4444-5555-6666-777777777777\",\n \"88888888-9999-aaaa-bbbb-cccccccccccc\",\n company_name: \"Docs Probe Corp\",\n registration_number: \"DPC-001\",\n country_code: \"US\",\n incorporation_date: \"2015-04-12\",\n legal_address: \"1 Example Plaza, Wilmington, DE 19801\",\n company_type: \"Limited Liability Company\",\n registry_status: \"active\",\n verification_status: \"verified\",\n nature_of_business: \"Software development\",\n registered_capital: \"USD 50000\",\n website: \"docsprobe.example.com\",\n email: \"legal@docsprobe.example.com\",\n phone: \"+1 302 555 0143\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdateKybCompanyDataAsync(\"33333333-4444-5555-6666-777777777777\", \"88888888-9999-aaaa-bbbb-cccccccccccc\", new SessionsUpdateKybCompanyDataParams\n{\n CompanyName = \"Docs Probe Corp\",\n RegistrationNumber = \"DPC-001\",\n CountryCode = \"US\",\n IncorporationDate = \"2015-04-12\",\n LegalAddress = \"1 Example Plaza, Wilmington, DE 19801\",\n CompanyType = \"Limited Liability Company\",\n RegistryStatus = new SessionsUpdateKybCompanyDataParamsRegistryStatus(\"active\"),\n VerificationStatus = new SessionsUpdateKybCompanyDataParamsVerificationStatus(\"verified\"),\n NatureOfBusiness = \"Software development\",\n RegisteredCapital = \"USD 50000\",\n Website = \"docsprobe.example.com\",\n Email = \"legal@docsprobe.example.com\",\n Phone = \"+1 302 555 0143\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/kyb/parties/{partyUuid}/": { "patch": { "summary": "Пропустить участника из списка ключевых лиц (или снова сделать его обязательным) в сессии Верификации бизнеса (KYB)", "description": "Исключить сторону из блока «Ключевые лица» из верификации или вернуть её на проверку. Это аварийный выход для оператора в ситуации, когда сторона не может завершить собственную проверку, чаще всего из-за того, что индивидуальная KYC-сессия, выданная UBO или директору, была удалена, что замораживает статус этой дочерней сессии и оставляет KYB в состоянии `Awaiting User` без возможности дальнейшего движения.\n\nУстановка `is_skipped: true` исключает сторону из агрегации ключевых лиц и сразу же пересчитывает проверку `KYBKeyPeopleCheck` вместе со статусом родительской сессии, благодаря чему сессия компании может быть завершена, а затем одобрена или отклонена. Передача `is_skipped: false` возвращает сторону на проверку, и система снова переходит в режим ожидания её завершения.\n\nВ отличие от пропуска со стороны заявителя на размещённом экране ключевых лиц, этот endpoint **не** зависит от настройки роли `allow_skip`: этот флаг ограничивает действия заявителя, а не возможность ручной корректировки аналитиком. Поле `requires_verification` намеренно остаётся нетронутым, поэтому скорректированная сторона отображается со значениями `requires_verification: true` **и** `is_skipped: true`, сохраняя в записи исходные требования правил.\n\nСторона должна принадлежать сессии в пути (иначе возвращается `404` с текстом `\"Party does not belong to the given session.\"`), а также вашему приложению. Запрос PATCH, фактически изменяющий флаг, отправляет [webhook](/ru/integration/webhooks) `data.updated` по сессии компании с триггером `console_key_people_skip`; запрос PATCH, устанавливающий текущее значение флага, не выполняет действий и возвращает данные стороны без изменений.\n\nПринимает API-ключ или токен пользователя консоли; в обоих случаях для учётных данных требуется разрешение `write:businesses`.", "operationId": "patch_v3_session_kyb_party_update", "x-didit-sdk": { "resource": "sessions", "method": "update_kyb_party", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID родительской сессии Верификации бизнеса (KYB).", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "partyUuid", "in": "path", "required": true, "description": "UUID обновляемого участника в разделе «Ключевые лица» (`key_people_checks[].submitted.parties[].uuid` в решении по бизнес-сессии). Должен принадлежать сессии, указанной в `sessionId`.", "schema": { "type": "string", "format": "uuid", "example": "0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "is_skipped" ], "properties": { "is_skipped": { "type": "boolean", "description": "`true` освобождает сторону от проверки, позволяя завершить проверку ключевых лиц без неё; `false` возвращает её в область проверки.", "example": true } } } } } }, "responses": { "200": { "description": "Сторона обновлена (или возвращена без изменений, если флаг уже имел это значение). Возвращает сторону в том же формате, что и элемент `key_people_checks[].submitted.parties[]` в решении по сессии компании.", "content": { "application/json": { "schema": { "type": "object", "description": "Запись стороны ключевых лиц: имеет ту же структуру, что и элемент `key_people_checks[].submitted.parties[]` в решении по сессии компании.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Идентификатор стороны." }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Является ли сторона физическим лицом или компанией." }, "name": { "type": "string", "description": "Отображаемое имя стороны." }, "is_skipped": { "type": "boolean", "description": "Освобождена ли сторона от верификации." }, "requires_verification": { "type": "boolean", "description": "Требования, заданные правилами ролей и порогов. Не изменяется этим endpoint." }, "kyc_session_status": { "type": "string", "nullable": true, "description": "Статус связанной индивидуальной KYC-сессии, зафиксированный на момент удаления, если сессия была удалена." }, "kyc_session_url": { "type": "string", "nullable": true, "description": "Ссылка на связанную индивидуальную сессию KYC. `null`, если таковая отсутствует или была удалена." }, "kyc_session_deleted": { "type": "boolean", "description": "Связанная сессия KYC физического лица была удалена, поэтому она никогда не сможет завершиться." }, "kyb_sub_session_deleted": { "type": "boolean", "description": "Корпоративный аналог `kyc_session_deleted`." } } } } } }, "400": { "description": "Ошибка валидации в теле запроса. `is_skipped` является единственным полем, которое считывает этот endpoint, и оно обязательно. Ошибки полей возвращаются в виде `{\"\": [\"\"]}`. Валидация тела выполняется *после* поиска стороны, поэтому некорректный `is_skipped`, отправленный несуществующей стороне, возвращает `404`, а не `400`.", "content": { "application/json": { "examples": { "Missing is_skipped": { "summary": "Пустое тело запроса или тело, в котором пропущено поле `is_skipped`", "value": { "is_skipped": [ "This field is required." ] } }, "Non-boolean is_skipped": { "summary": "Значение не является булевым — `\"maybe\"`, `2`, `[]`. Булевы значения, а также `\"true\"`/`\"false\"`, `1`/`0` и `\"yes\"`/`\"no\"` принимаются", "value": { "is_skipped": [ "Must be a valid boolean." ] } }, "Null is_skipped": { "summary": "`is_skipped` присутствует, но равен `null`", "value": { "is_skipped": [ "This field may not be null." ] } } } } } }, "403": { "description": "Отсутствуют учетные данные или недостаточно разрешений. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Отсутствует или недействителен x-api-key", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "В учётных данных отсутствует разрешение write:businesses", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Неизвестная сторона или сторона, принадлежащая к другой сессии. Для каждого кейса предусмотрено отдельное сообщение в `detail` (см. примеры). Проверка учетных данных и разрешений выполняется до поиска стороны, поэтому неавторизованный вызов возвращает `403`, а не `404`. Отдельного поиска сессии нет: неизвестный `sessionId` в паре с вашей стороной вернет сообщение о несовпадении.", "content": { "application/json": { "examples": { "Unknown party": { "summary": "В вашем приложении нет стороны с таким UUID", "value": { "detail": "Not found." } }, "Party / session mismatch": { "summary": "partyUuid существует, но относится к другой сессии", "value": { "detail": "Party does not belong to the given session." } } } } } }, "429": { "description": "Превышен общий лимит запросов на запись (300 запросов POST/PATCH/DELETE в минуту на один API-ключ). Проверьте заголовок `Retry-After` и заголовки ответа `X-RateLimit-*` перед повторной попыткой.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Исчерпан бюджет на запись", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_kyb_party(\n \"33333333-4444-5555-6666-777777777777\",\n \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\",\n is_skipped=True,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updateKybParty(\n \"33333333-4444-5555-6666-777777777777\",\n \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\",\n {\n is_skipped: true,\n },\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateKYBParty(ctx, \"33333333-4444-5555-6666-777777777777\", \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\", didit.SessionsUpdateKYBPartyParams{\n\tIsSkipped: true,\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsUpdateKybPartyParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updateKybParty(\"33333333-4444-5555-6666-777777777777\", \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\", SessionsUpdateKybPartyParams.builder()\n .isSkipped(true)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updateKybParty('33333333-4444-5555-6666-777777777777', '0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41', [\n 'is_skipped' => true,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_kyb_party(\n \"33333333-4444-5555-6666-777777777777\",\n \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\",\n is_skipped: true\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdateKybPartyAsync(\"33333333-4444-5555-6666-777777777777\", \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\", new SessionsUpdateKybPartyParams\n{\n IsSkipped = true,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/travel-rule/settings/": { "get": { "summary": "Получить настройки Travel Rule", "description": "Получить настройки Travel Rule и профиль VASP для этого приложения. При первом чтении автоматически создаются отключённая строка настроек по умолчанию и пустой профиль.", "operationId": "getTravelRuleSettings", "x-didit-sdk": { "resource": "travel_rule", "method": "retrieve_settings", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/travel-rule/settings/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.retrieve_settings()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.retrieveSettings();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.RetrieveSettings(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().retrieveSettings();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->retrieveSettings();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.retrieve_settings\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.RetrieveSettingsAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Текущие настройки Travel Rule и профиль VASP.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleSettingsDetail" }, "examples": { "Disabled (default)": { "value": { "is_enabled": false, "jurisdiction": "EU", "name_matching_strictness": "DEFAULT", "confirmation_timeout_hours": 48, "timeout_outcome": "HOLD", "threshold_amount": "0.00", "inbound_auto_accept": true, "allow_self_declaration": true, "allow_screenshot_proof": true, "auto_wallet_verification": true, "vasp_attribution_enabled": true, "legal_name": "", "lei": "", "compliance_email": "", "is_discoverable": true, "counterparty_screening_enabled": false, "sunrise_policy": "", "sunrise_jurisdictions": [ "CO", "KH", "VN" ], "non_responsive_policy": "", "travel_address": "", "disabled_networks": [], "networks": { "gtr": { "rail": "GTR", "mode": "unavailable", "state": "didit_onboarding", "reason": "didit_membership_not_live", "platform_available": false, "connected": false, "participant": null, "vasps_reachable": 0, "routed_30d": 0 }, "trust": { "rail": "TRUST", "mode": "unavailable", "state": "unavailable", "reason": "own_membership_only", "platform_available": false, "connected": false, "participant": null, "vasps_reachable": 0, "routed_30d": 0 }, "verifyvasp": { "rail": "VERIFYVASP", "mode": "unavailable", "state": "didit_onboarding", "reason": "didit_membership_not_live", "platform_available": false, "connected": false, "participant": null, "vasps_reachable": 0, "routed_30d": 0 }, "sygna": { "rail": "SYGNA", "mode": "unavailable", "state": "didit_onboarding", "reason": "didit_membership_not_live", "platform_available": false, "connected": false, "participant": null, "vasps_reachable": 0, "routed_30d": 0 } }, "didit_network": { "listed": false, "missing": [ "travel_rule_off", "legal_name_missing", "compliance_email_missing" ], "compliance_email_confirmed": false } } } } } } } } }, "put": { "summary": "Обновить настройки Travel Rule", "description": "Создать или обновить настройки Travel Rule и профиль VASP для приложения. Частичное обновление: отправляйте только те поля, которые хотите изменить. Для установки `is_enabled: true` требуется непустое поле `legal_name` (уже сохранённое или переданное в том же запросе), иначе возвращается 400.", "operationId": "updateTravelRuleSettings", "x-didit-sdk": { "resource": "travel_rule", "method": "update_settings", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleSettingsUpdate" }, "example": { "is_enabled": true, "legal_name": "Origin CASP SL", "jurisdiction": "EU", "name_matching_strictness": "DEFAULT", "confirmation_timeout_hours": 48, "timeout_outcome": "HOLD", "is_discoverable": true } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PUT https://verification.didit.me/v3/travel-rule/settings/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"is_enabled\": true, \"legal_name\": \"Origin CASP SL\", \"jurisdiction\": \"EU\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.update_settings(\n is_enabled=True,\n legal_name=\"Origin CASP SL\",\n jurisdiction=\"EU\",\n name_matching_strictness=\"DEFAULT\",\n confirmation_timeout_hours=48,\n timeout_outcome=\"HOLD\",\n is_discoverable=True,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.updateSettings({\n is_enabled: true,\n legal_name: \"Origin CASP SL\",\n jurisdiction: \"EU\",\n name_matching_strictness: \"DEFAULT\",\n confirmation_timeout_hours: 48,\n timeout_outcome: \"HOLD\",\n is_discoverable: true,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.UpdateSettings(ctx, didit.TravelRuleSettingsUpdate{\n\tIsEnabled: didit.Bool(true),\n\tLegalName: didit.String(\"Origin CASP SL\"),\n\tJurisdiction: didit.String(\"EU\"),\n\tNameMatchingStrictness: didit.Some(didit.TravelRuleSettingsUpdateNameMatchingStrictness(\"DEFAULT\")),\n\tConfirmationTimeoutHours: didit.Int(48),\n\tTimeoutOutcome: didit.Some(didit.TravelRuleSettingsUpdateTimeoutOutcome(\"HOLD\")),\n\tIsDiscoverable: didit.Bool(true),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleSettingsUpdate;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().updateSettings(TravelRuleSettingsUpdate.builder()\n .isEnabled(true)\n .legalName(\"Origin CASP SL\")\n .jurisdiction(\"EU\")\n .nameMatchingStrictness(TravelRuleSettingsUpdate.NameMatchingStrictness.of(\"DEFAULT\"))\n .confirmationTimeoutHours(48L)\n .timeoutOutcome(TravelRuleSettingsUpdate.TimeoutOutcome.of(\"HOLD\"))\n .isDiscoverable(true)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->updateSettings([\n 'is_enabled' => true,\n 'legal_name' => 'Origin CASP SL',\n 'jurisdiction' => 'EU',\n 'name_matching_strictness' => 'DEFAULT',\n 'confirmation_timeout_hours' => 48,\n 'timeout_outcome' => 'HOLD',\n 'is_discoverable' => true,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.update_settings(\n is_enabled: true,\n legal_name: \"Origin CASP SL\",\n jurisdiction: \"EU\",\n name_matching_strictness: \"DEFAULT\",\n confirmation_timeout_hours: 48,\n timeout_outcome: \"HOLD\",\n is_discoverable: true\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.UpdateSettingsAsync(new TravelRuleSettingsUpdate\n{\n IsEnabled = true,\n LegalName = \"Origin CASP SL\",\n Jurisdiction = \"EU\",\n NameMatchingStrictness = new TravelRuleSettingsUpdateNameMatchingStrictness(\"DEFAULT\"),\n ConfirmationTimeoutHours = 48,\n TimeoutOutcome = new TravelRuleSettingsUpdateTimeoutOutcome(\"HOLD\"),\n IsDiscoverable = true,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Обновлённые настройки и профиль, в том же формате, что и в ответе GET.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleSettingsDetail" } } } }, "400": { "description": "Ошибка валидации, например, включение без legal_name, sunrise_policy или non_responsive_policy, отличные от HOLD, REJECT, PROCEED или пустой строки, неизвестное поле в `matching_rules` или выбор в `data_sharing_fields`, не позволяющий выполнить обязательства отправителя по регуляторному режиму вашей юрисдикции (ошибки распределены по типам сущностей под `data_sharing_fields`).", "content": { "application/json": { "schema": { "type": "object" }, "example": { "legal_name": [ "legal_name is required to enable travel rule." ] } } } } } } }, "/v3/travel-rule/settings/compliance-email/confirmation/": { "post": { "summary": "Отправьте электронное письмо с подтверждением комплаенса", "description": "Отправляет одноразовую ссылку для подтверждения на compliance_email вашего профиля VASP. Переход по ссылке и нажатие кнопки подтверждения подтверждают адрес, что необходимо сети Didit перед включением вашего профиля в список. Новый запрос заменяет предыдущую ссылку; ссылка перестаёт действовать при изменении адреса электронной почты для комплаенса. Одно письмо в минуту на один адрес.", "operationId": "sendTravelRuleComplianceEmailConfirmation", "x-didit-sdk": { "resource": "travel_rule", "method": "send_compliance_email_confirmation", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/settings/compliance-email/confirmation/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.send_compliance_email_confirmation()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.sendComplianceEmailConfirmation();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.SendComplianceEmailConfirmation(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().sendComplianceEmailConfirmation();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->sendComplianceEmailConfirmation();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.send_compliance_email_confirmation\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.SendComplianceEmailConfirmationAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "202": { "description": "Письмо с подтверждением было отправлено.", "content": { "application/json": { "schema": { "type": "object", "properties": { "sent_to": { "type": "string", "format": "email" } } }, "example": { "sent_to": "compliance@your-vasp.example" } } } }, "400": { "description": "Email комплаенса не задан или уже подтвержден.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "examples": { "No compliance email": { "value": { "compliance_email": [ "Set a compliance email before confirming it." ] } }, "Already confirmed": { "value": { "compliance_email": [ "This compliance email is already confirmed." ] } } } } } }, "429": { "description": "Подтверждение было отправлено на этот адрес менее минуты назад." }, "503": { "description": "Не удалось отправить электронное письмо. Никаких изменений не произошло; повторите попытку через некоторое время." } } } }, "/v3/travel-rule/wallet-addresses/": { "get": { "summary": "Получить список записей адресной книги кошельков", "description": "Адресная книга кошельков Travel Rule вашего приложения с пагинацией, сначала новые.", "operationId": "listTravelRuleWalletAddresses", "x-didit-sdk": { "resource": "travel_rule.wallet_addresses", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/travel-rule/wallet-addresses/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.travel_rule.wallet_addresses.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.travelRule.walletAddresses.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.TravelRule.WalletAddresses.ListAutoPaging(ctx, didit.TravelRuleWalletAddressesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.travelRule().walletAddresses().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "travelRule->walletAddresses->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.travel_rule.wallet_addresses.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.TravelRule.WalletAddresses.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Записи адресной книги кошельков с пагинацией.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/WalletAddressEntry" } } } } } } } } }, "post": { "summary": "Зарегистрировать адрес кошелька", "description": "Добавьте запись в адресную книгу кошельков Travel Rule, чтобы входящие переводы по маршруту INTERNAL-rail могли сопоставляться с ней.", "operationId": "createTravelRuleWalletAddress", "x-didit-sdk": { "resource": "travel_rule.wallet_addresses", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletAddressEntryCreate" }, "example": { "address": "0xBeneficiaryWallet01", "chain": "ETH", "holder_name": "Ana Diaz", "holder_vendor_data": "user-042", "self_declared": true } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/wallet-addresses/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"address\": \"0xBeneficiaryWallet01\", \"chain\": \"ETH\", \"holder_name\": \"Ana Diaz\", \"self_declared\": true}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.wallet_addresses.create(\n address=\"0xBeneficiaryWallet01\",\n chain=\"ETH\",\n holder_vendor_data=\"user-042\",\n holder_name=\"Ana Diaz\",\n self_declared=True,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.walletAddresses.create({\n address: \"0xBeneficiaryWallet01\",\n chain: \"ETH\",\n holder_vendor_data: \"user-042\",\n holder_name: \"Ana Diaz\",\n self_declared: true,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.WalletAddresses.Create(ctx, didit.WalletAddressEntryCreate{\n\tAddress: \"0xBeneficiaryWallet01\",\n\tChain: didit.String(\"ETH\"),\n\tHolderVendorData: didit.String(\"user-042\"),\n\tHolderName: didit.String(\"Ana Diaz\"),\n\tSelfDeclared: didit.Bool(true),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.WalletAddressEntryCreate;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().walletAddresses().create(WalletAddressEntryCreate.builder()\n .address(\"0xBeneficiaryWallet01\")\n .chain(\"ETH\")\n .holderVendorData(\"user-042\")\n .holderName(\"Ana Diaz\")\n .selfDeclared(true)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->walletAddresses->create([\n 'address' => '0xBeneficiaryWallet01',\n 'chain' => 'ETH',\n 'holder_vendor_data' => 'user-042',\n 'holder_name' => 'Ana Diaz',\n 'self_declared' => true,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.wallet_addresses.create(\n address: \"0xBeneficiaryWallet01\",\n chain: \"ETH\",\n holder_vendor_data: \"user-042\",\n holder_name: \"Ana Diaz\",\n self_declared: true\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.WalletAddresses.CreateAsync(new WalletAddressEntryCreate\n{\n Address = \"0xBeneficiaryWallet01\",\n Chain = \"ETH\",\n HolderVendorData = \"user-042\",\n HolderName = \"Ana Diaz\",\n SelfDeclared = true,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Созданная запись.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletAddressEntry" } } } }, "400": { "description": "Дублирующийся кошелёк (адрес, блокчейн и memo) для этого приложения, memo или X-address, которые блокчейн не может содержать, отсутствующий `address`, недействительный `travel_address`, `self_declared: true` при отключённом `allow_self_declaration`, либо `self_declared: true` при значении `FULL` для `ownership_validation_mode`.", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Duplicate entry": { "value": { "address": [ "A wallet address entry with this address and chain already exists." ] } }, "Invalid travel address": { "value": { "travel_address": [ "Invalid travel address." ] } }, "Self-declaration disabled": { "value": { "self_declared": [ "Self-declared ownership is disabled for this application." ] } } } } } } } } }, "/v3/travel-rule/wallet-addresses/{entry_uuid}/": { "patch": { "summary": "Обновить метаданные владельца адреса кошелька", "description": "Частичное обновление holder_name, holder_vendor_data, entity_type и travel_address. Установка travel_address привязывает адрес маршрутизации TRP к записи; недействительные значения отклоняются с ошибкой 400. В ответе возвращаются только эти четыре поля.", "operationId": "updateTravelRuleWalletAddress", "x-didit-sdk": { "resource": "travel_rule.wallet_addresses", "method": "update", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "entry_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletAddressEntryUpdate" }, "example": { "holder_name": "Ana Updated", "travel_address": "ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH https://verification.didit.me/v3/travel-rule/wallet-addresses/{entry_uuid}/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"holder_name\": \"Ana Updated\", \"travel_address\": \"ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.wallet_addresses.update(\n \"11111111-2222-3333-4444-555555555555\",\n holder_name=\"Ana Updated\",\n travel_address=\"ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.walletAddresses.update(\"11111111-2222-3333-4444-555555555555\", {\n holder_name: \"Ana Updated\",\n travel_address: \"ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.WalletAddresses.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.WalletAddressEntryUpdateParam{\n\tHolderName: didit.String(\"Ana Updated\"),\n\tTravelAddress: didit.String(\"ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.WalletAddressEntryUpdate;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().walletAddresses().update(\"11111111-2222-3333-4444-555555555555\", WalletAddressEntryUpdate.builder()\n .holderName(\"Ana Updated\")\n .travelAddress(\"ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->walletAddresses->update('11111111-2222-3333-4444-555555555555', [\n 'holder_name' => 'Ana Updated',\n 'travel_address' => 'ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.wallet_addresses.update(\n \"11111111-2222-3333-4444-555555555555\",\n holder_name: \"Ana Updated\",\n travel_address: \"ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.WalletAddresses.UpdateAsync(\"11111111-2222-3333-4444-555555555555\", new WalletAddressEntryUpdate\n{\n HolderName = \"Ana Updated\",\n TravelAddress = \"ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Обновлённые поля.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletAddressEntryUpdate" } } } }, "400": { "description": "`travel_address` не является допустимым Travel Address.", "content": { "application/json": { "examples": { "Invalid travel address": { "value": { "travel_address": [ "Invalid travel address." ] } } } } } }, "404": { "description": "Неизвестная или удалённая запись." } } }, "delete": { "summary": "Удалить адрес кошелька", "description": "Удаляет запись вместе с подтверждениями владения и сохраненными ими скриншотами. Она немедленно перестает сопоставляться с новыми переводами, а адрес освобождается для повторной регистрации. Переводы, в которых кошелек уже использовался, сохраняют собственную запись о нем и считываются без изменений. Удаление необратимо.", "operationId": "deleteTravelRuleWalletAddress", "x-didit-sdk": { "resource": "travel_rule.wallet_addresses", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "entry_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE https://verification.didit.me/v3/travel-rule/wallet-addresses/{entry_uuid}/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.travel_rule.wallet_addresses.delete(\n \"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.travelRule.walletAddresses.delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.TravelRule.WalletAddresses.Delete(ctx, \"11111111-2222-3333-4444-555555555555\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.travelRule().walletAddresses().delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "php", "label": "PHP", "source": "travelRule->walletAddresses->delete('11111111-2222-3333-4444-555555555555');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.travel_rule.wallet_addresses.delete(\"11111111-2222-3333-4444-555555555555\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.TravelRule.WalletAddresses.DeleteAsync(\"11111111-2222-3333-4444-555555555555\");" } ], "responses": { "204": { "description": "Удалено." }, "404": { "description": "Неизвестная или уже удалённая запись." }, "503": { "description": "`wallet_address_deletion_incomplete`: не удалось удалить сохранённый файл, поэтому удаление остановилось до его завершения. Запись в адресной книге сохранилась; повторите тот же запрос, чтобы завершить удаление.", "content": { "application/json": { "example": { "detail": "A stored file could not be deleted, so the deletion stopped before it finished. Try again.", "code": "wallet_address_deletion_incomplete" } } } } } } }, "/v3/travel-rule/vasps/": { "get": { "summary": "Поиск по справочнику VASP", "description": "Поиск по каталогу VASP с пагинацией и сортировкой по названию: общие записи каталога, которые Didit формирует на основе временного реестра MiCA от ESMA, публичного каталога TRISA, глобального реестра LEI и собственной модерации, а также участников сети Didit. Каждая строка содержит маршруты, доступные вашему приложению на сегодняшний день. Профиль вашего собственного приложения никогда не отображается в списке. Строки также содержат общую оценку надлежащей проверки (due diligence) и собственное решение вашего приложения, скрининг юридических лиц и анкеты.", "operationId": "listTravelRuleVasps", "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string", "maxLength": 255 }, "description": "Фрагмент имени или псевдонима (без учёта регистра), точный LEI или домен (example.com или URL на нём). Участники сети Didit сопоставляются по юридическому наименованию, LEI или домену адреса электронной почты комплаенс-отдела." }, { "name": "network", "in": "query", "schema": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA", "TRISA" ] }, "description": "Только записи справочника, которые в данный момент указаны в каталоге участников сети." }, { "name": "jurisdiction", "in": "query", "schema": { "type": "string" }, "description": "Двухбуквенный (alpha-2) или трехбуквенный (alpha-3) код страны по стандарту ISO 3166. Для любых других значений возвращается 400." }, { "name": "reachable", "in": "query", "schema": { "type": "boolean" }, "description": "true: только VASP, до которых у вашего приложения есть доступный маршрут (включая участников сети Didit). false: только записи справочника, недоступные в настоящее время." }, { "name": "kind", "in": "query", "schema": { "type": "string", "enum": [ "directory", "didit" ] }, "description": "Только записи справочника или только участники сети Didit." }, { "name": "risk", "in": "query", "schema": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "description": "Только записи справочника, у которых risk_level относится к этому диапазону. Участники сети Didit, для которых скоринг не проводится, никогда не соответствуют этому условию." }, { "name": "responsiveness", "in": "query", "schema": { "type": "string", "enum": [ "RESPONSIVE", "UNRESPONSIVE", "UNKNOWN" ] }, "description": "Только записи справочника, у которых responsiveness.status равен этому значению. Участники сети Didit никогда не соответствуют этому условию." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/travel-rule/vasps/?search=counterparty&reachable=true' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.travel_rule.list_vasps():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.travelRule.listVasps()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.TravelRule.ListVASPsAutoPaging(ctx, didit.TravelRuleListVASPsParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.travelRule().listVasps()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "travelRule->listVasps() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.travel_rule.list_vasps.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.TravelRule.ListVaspsAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Результаты каталога VASP с пагинацией, отсортированные по названию.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/VaspDirectoryEntry" } } } } } } }, "400": { "description": "Недопустимый фильтр: в теле ответа указано каждое поле, например неизвестная сеть, код страны, диапазон риска или статус отзывчивости.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "example": { "jurisdiction": [ "Use an ISO 3166 alpha-2 or alpha-3 country code." ], "network": [ "\"SWIFT\" is not a valid choice." ] } } } } }, "x-didit-sdk": { "resource": "travel_rule", "method": "list_vasps", "auth": "api_key", "server": true } } }, "/v3/travel-rule/vasps/{vasp_id}/": { "get": { "summary": "Получить запись каталога VASP", "description": "Одна запись справочника или участник сети Didit по идентификатору, возвращённому поиском, с теми же полями и маршрутами, доступными вашему приложению.", "operationId": "getTravelRuleVasp", "x-didit-sdk": { "resource": "travel_rule", "method": "retrieve_vasp", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "vasp_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "id строки из GET /v3/travel-rule/vasps/." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/travel-rule/vasps/{vasp_id}/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.retrieve_vasp(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.retrieveVasp(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.RetrieveVASP(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().retrieveVasp(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->retrieveVasp('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.retrieve_vasp(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.RetrieveVaspAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Запись.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaspDirectoryEntry" } } } }, "404": { "description": "Ни одна запись или зарегистрированный участник сети Didit не имеет такого id.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry has this id." } } } } } } }, "/v3/travel-rule/vasps/{vasp_id}/decision/": { "get": { "summary": "Получить ваше решение по VASP", "description": "Решение вашего приложения по контрагенту (записи в каталоге или участнику сети Didit): одобрено, ограничено или заблокировано. Сущность бренда без собственного решения следует решению бренда, указанному в inherited_from. Доступно только вашему приложению.", "operationId": "getTravelRuleVaspDecision", "x-didit-sdk": { "resource": "travel_rule", "method": "retrieve_vasp_decision", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "vasp_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "id строки из GET /v3/travel-rule/vasps/: запись справочника или участник сети Didit." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/travel-rule/vasps/{vasp_id}/decision/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.retrieve_vasp_decision(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.retrieveVaspDecision(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.RetrieveVASPDecision(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().retrieveVaspDecision(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->retrieveVaspDecision('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.retrieve_vasp_decision(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.RetrieveVaspDecisionAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Применимое решение или null.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyDecisionResponse" }, "examples": { "Own decision": { "value": { "decision": { "decision": "APPROVED", "reason": "Licensed in DE, questionnaire reviewed", "decided_by": "", "updated_at": "2026-10-14T10:05:00Z", "inherited_from": null } } }, "Inherited from the brand": { "value": { "decision": { "decision": "BLOCKED", "reason": "Group refused after review", "decided_by": "", "updated_at": "2026-10-14T10:05:00Z", "inherited_from": { "id": "5e4d3c2b-1a0f-4e9d-8c7b-6a5f4e3d2c1b", "name": "Example Group" } } } }, "No decision": { "value": { "decision": null } } } } } }, "404": { "description": "Ни одна запись справочника или зарегистрированный участник сети Didit не имеет такого id. Ваш собственный профиль VASP никогда не является вашим контрагентом.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry or Didit network member has this id." } } } } } }, "put": { "summary": "Установить ваше решение по VASP", "description": "Принять или изменить решение вашего приложения по контрагенту: APPROVED, RESTRICTED или BLOCKED, с необязательным указанием причины. Это никогда не меняет общую запись в справочнике и действует только через правила ваших транзакций (counterparty_dd_status). Решение по бренду также распространяется на каждое из его юридических лиц, не имеющее собственного решения.", "operationId": "updateTravelRuleVaspDecision", "x-didit-sdk": { "resource": "travel_rule", "method": "update_vasp_decision", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "vasp_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "id строки из GET /v3/travel-rule/vasps/: запись справочника или участник сети Didit." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyDecisionRequest" }, "example": { "decision": "BLOCKED", "reason": "Unlicensed in its home jurisdiction" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PUT https://verification.didit.me/v3/travel-rule/vasps/{vasp_id}/decision/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"decision\": \"BLOCKED\", \"reason\": \"Unlicensed in its home jurisdiction\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.update_vasp_decision(\n \"11111111-2222-3333-4444-555555555555\",\n decision=\"BLOCKED\",\n reason=\"Unlicensed in its home jurisdiction\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.updateVaspDecision(\"11111111-2222-3333-4444-555555555555\", {\n decision: \"BLOCKED\",\n reason: \"Unlicensed in its home jurisdiction\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.UpdateVASPDecision(ctx, \"11111111-2222-3333-4444-555555555555\", didit.TravelRuleCounterpartyDecisionRequest{\n\tDecision: \"BLOCKED\",\n\tReason: didit.String(\"Unlicensed in its home jurisdiction\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleCounterpartyDecisionRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().updateVaspDecision(\"11111111-2222-3333-4444-555555555555\", TravelRuleCounterpartyDecisionRequest.builder()\n .decision(TravelRuleCounterpartyDecisionRequest.Decision.of(\"BLOCKED\"))\n .reason(\"Unlicensed in its home jurisdiction\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->updateVaspDecision('11111111-2222-3333-4444-555555555555', [\n 'decision' => 'BLOCKED',\n 'reason' => 'Unlicensed in its home jurisdiction',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.update_vasp_decision(\n \"11111111-2222-3333-4444-555555555555\",\n decision: \"BLOCKED\",\n reason: \"Unlicensed in its home jurisdiction\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.UpdateVaspDecisionAsync(\"11111111-2222-3333-4444-555555555555\", new TravelRuleCounterpartyDecisionRequest\n{\n Decision = \"BLOCKED\",\n Reason = \"Unlicensed in its home jurisdiction\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Решение в том виде, в котором оно применяется в данный момент.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyDecisionResponse" }, "example": { "decision": { "decision": "BLOCKED", "reason": "Unlicensed in its home jurisdiction", "decided_by": "", "updated_at": "2026-10-14T10:05:00Z", "inherited_from": null } } } } }, "400": { "description": "Решение отсутствует или не входит в число APPROVED, RESTRICTED или BLOCKED, либо причина длиннее 255 символов.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "example": { "decision": [ "\"MAYBE\" is not a valid choice." ] } } } }, "404": { "description": "Ни одна запись справочника или зарегистрированный участник сети Didit не имеет такого id. Ваш собственный профиль VASP никогда не является вашим контрагентом.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry or Didit network member has this id." } } } } } }, "delete": { "summary": "Сбросить ваше решение по VASP", "description": "Сбросить собственное решение вашего приложения по контрагенту. Ответ содержит решение, которое применяется после этого: null или, для сущности бренда, решение бренда, которому эта сущность снова следует.", "operationId": "clearTravelRuleVaspDecision", "x-didit-sdk": { "resource": "travel_rule", "method": "clear_vasp_decision", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "vasp_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "id строки из GET /v3/travel-rule/vasps/: запись справочника или участник сети Didit." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE https://verification.didit.me/v3/travel-rule/vasps/{vasp_id}/decision/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.clear_vasp_decision(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.clearVaspDecision(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.ClearVASPDecision(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().clearVaspDecision(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->clearVaspDecision('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.clear_vasp_decision(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.ClearVaspDecisionAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Решение сброшено; тело ответа содержит решение, которое применяется сейчас.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyDecisionResponse" }, "example": { "decision": null } } } }, "404": { "description": "Ни один контрагент не имеет такого id, либо у вашего приложения нет собственного решения по нему (решение, унаследованное только от бренда, нельзя сбросить здесь: сбросьте решение бренда).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Unknown id": { "value": { "detail": "No directory entry or Didit network member has this id." } }, "No decision of its own": { "value": { "detail": "This application has no decision of its own on this counterparty." } } } } } } } } }, "/v3/travel-rule/vasps/{vasp_id}/screening/": { "get": { "summary": "Получить скрининг сущности VASP", "description": "Включён ли скрининг контрагентов для вашего приложения, сколько один скрининг стоит вашей организации, как долго результат остаётся актуальным, а также ваш последний скрининг контрагента по санкционным спискам и негативным публикациям в СМИ. Чтение этих данных бесплатно.", "operationId": "getTravelRuleVaspScreening", "x-didit-sdk": { "resource": "travel_rule", "method": "retrieve_vasp_screening", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "vasp_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "id строки из GET /v3/travel-rule/vasps/: запись справочника или участник сети Didit." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/travel-rule/vasps/{vasp_id}/screening/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.retrieve_vasp_screening(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.retrieveVaspScreening(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.RetrieveVASPScreening(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().retrieveVaspScreening(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->retrieveVaspScreening('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.retrieve_vasp_screening(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.RetrieveVaspScreeningAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Ваша настройка скрининга, её цена и ваш последний скрининг.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyScreeningStatus" }, "example": { "enabled": true, "price": "0.20", "fresh_days": 30, "screening": { "id": "7a1d2c3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d", "status": "Approved", "total_hits": 0, "score": null, "screened_at": "2026-10-14T09:58:00Z", "fresh": true, "flagged": false } } } } }, "403": { "description": "В договоре вашей организации не настроен тариф для скрининга контрагентов.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No contract rate is configured for this usage type." } } } }, "404": { "description": "Ни одна запись справочника или зарегистрированный участник сети Didit не имеет такого id. Ваш собственный профиль VASP никогда не является вашим контрагентом.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry or Didit network member has this id." } } } } } }, "post": { "summary": "Провести скрининг VASP", "description": "Выполните скрининг сущности контрагента по санкционным спискам и негативным публикациям в СМИ для вашего приложения. Требуется предварительное включение: параметр counterparty_screening_enabled должен быть включён в ваших настройках Travel Rule. Каждый новый скрининг тарифицируется по цене AML-скрининга компаний для вашей организации; если скрининг был проведён менее 30 дней назад, вместо этого возвращается его результат (200, не тарифицируется), если не передан параметр refresh: true. Для одного приложения одновременно выполняется только один скрининг контрагента. Результат виден только вашему приложению. Приложения в песочнице никогда не проходят скрининг.", "operationId": "screenTravelRuleVasp", "x-didit-sdk": { "resource": "travel_rule", "method": "screen_vasp", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "vasp_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "id строки из GET /v3/travel-rule/vasps/: запись справочника или участник сети Didit." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyScreeningRequest" }, "example": { "refresh": false } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/vasps/{vasp_id}/screening/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"refresh\": false}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.screen_vasp(\n \"11111111-2222-3333-4444-555555555555\",\n refresh=False,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.screenVasp(\"11111111-2222-3333-4444-555555555555\", {\n refresh: false,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.ScreenVASP(ctx, \"11111111-2222-3333-4444-555555555555\", didit.TravelRuleCounterpartyScreeningRequest{\n\tRefresh: didit.Bool(false),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleCounterpartyScreeningRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().screenVasp(\"11111111-2222-3333-4444-555555555555\", TravelRuleCounterpartyScreeningRequest.builder()\n .refresh(false)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->screenVasp('11111111-2222-3333-4444-555555555555', [\n 'refresh' => false,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.screen_vasp(\n \"11111111-2222-3333-4444-555555555555\",\n refresh: false\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.ScreenVaspAsync(\"11111111-2222-3333-4444-555555555555\", new TravelRuleCounterpartyScreeningRequest\n{\n Refresh = false,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Свежий скрининг уже существовал и был возвращён. Плата не списывалась.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyScreeningResult" }, "example": { "outcome": "reused", "screening": { "id": "7a1d2c3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d", "status": "Approved", "total_hits": 0, "score": null, "screened_at": "2026-10-14T09:58:00Z", "fresh": true, "flagged": false } } } } }, "201": { "description": "Новый скрининг был выполнен и оплачен.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyScreeningResult" }, "example": { "outcome": "screened", "screening": { "id": "7a1d2c3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d", "status": "In Review", "total_hits": 2, "score": 85.0, "screened_at": "2026-10-14T09:58:00Z", "fresh": true, "flagged": true } } } } }, "400": { "description": "Тело запроса недействительно, или у контрагента нет имени для проверки.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "example": { "detail": [ "This counterparty has no name to screen." ] } } } }, "403": { "description": "Баланс вашей организации недостаточен для покрытия скрининга (код insufficient_credits; ничего не выполнялось и средства не списывались) или в вашем договоре не настроен для него тариф.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string" } } }, "example": { "detail": "You don't have enough credits to perform this request. Please top up at https://business.didit.me", "code": "insufficient_credits" } } } }, "404": { "description": "Ни одна запись справочника или зарегистрированный участник сети Didit не имеет такого id. Ваш собственный профиль VASP никогда не является вашим контрагентом.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry or Didit network member has this id." } } } }, "409": { "description": "Ничего не было запущено и плата не взималась: скрининг контрагентов отключён для вашего приложения, приложение находится в песочнице, либо скрининг этого контрагента уже выполняется.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Screening off": { "value": { "detail": "Counterparty screening is turned off. Enable it in the Travel Rule settings first." } }, "Sandbox application": { "value": { "detail": "Counterparty screening does not run for sandbox applications." } }, "Already running": { "value": { "detail": "A screening of this counterparty is already running. Try again in a moment." } } } } } }, "502": { "description": "Скрининг не удалось завершить. Списаний не произошло; повторите попытку через некоторое время.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "The screening provider did not answer. Try again in a moment." } } } } } } }, "/v3/travel-rule/vasps/{vasp_id}/questionnaires/": { "get": { "summary": "Получить список анкет комплексной проверки с VASP", "description": "Каждая анкета по комплексной проверке, отправленная вашим приложением контрагенту, начиная с самых новых, с её статусом и, после заполнения, ответами. Доступно только вашему приложению.", "operationId": "listTravelRuleVaspQuestionnaires", "x-didit-sdk": { "resource": "travel_rule", "method": "list_vasp_questionnaires", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "vasp_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "id строки из GET /v3/travel-rule/vasps/: запись справочника или участник сети Didit." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/travel-rule/vasps/{vasp_id}/questionnaires/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.list_vasp_questionnaires(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.listVaspQuestionnaires(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.ListVASPQuestionnaires(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().listVaspQuestionnaires(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->listVaspQuestionnaires('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.list_vasp_questionnaires(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.ListVaspQuestionnairesAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Ваши анкеты с этим контрагентом.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyQuestionnaireList" }, "example": { "questionnaires": [ { "id": "3f9e8d7c-6b5a-4c3d-9e2f-1a0b9c8d7e6f", "status": "SENT", "form_version": "1", "sent_to": "travelrule@counterparty.example", "sent_at": "2026-10-14T10:00:00Z", "expires_at": "2026-11-13T10:00:00Z", "answered_at": null, "valid_until": null, "current": false, "answers": {} }, { "id": "8b7a6c5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d", "status": "ANSWERED", "form_version": "1", "sent_to": "travelrule@counterparty.example", "sent_at": "2026-09-02T08:00:00Z", "expires_at": "2026-10-02T08:00:00Z", "answered_at": "2026-09-04T15:20:00Z", "valid_until": "2027-09-04T15:20:00Z", "current": true, "answers": { "legal_name": "Example Counterparty VASP, incorporated in the example jurisdiction.", "licensing": "Crypto-asset service provider authorised under MiCA by its national regulator, licence active.", "jurisdictions": "EU and EEA. We do not serve the United States.", "aml_program": "Written AML/CFT policy, annual independent review, last completed in March 2026.", "compliance_officer": "Head of Compliance, reachable at compliance@counterparty.example.", "sanctions_screening": "Customers at onboarding and daily; counterparties on every transfer.", "transaction_monitoring": "Rule-based monitoring with analyst review; suspicious activity reports filed with the FIU.", "travel_rule": "TRP and email; we answer requests within one business day.", "custody": "Segregated customer wallets held with a qualified custodian, insured.", "ownership": "No shareholder holds 25 percent or more; parent company Example Holding Group.", "record_keeping": "Five-year record-keeping for Travel Rule and transaction data, as our regulator requires.", "data_protection": "Encrypted at rest and in transit, stored in the EU." } } ] } } } }, "404": { "description": "Ни одна запись справочника или зарегистрированный участник сети Didit не имеет такого id. Ваш собственный профиль VASP никогда не является вашим контрагентом.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry or Didit network member has this id." } } } } } }, "post": { "summary": "Отправить анкету комплексной проверки в VASP", "description": "Отправляет стандартную анкету должной осмотрительности Didit по электронной почте на зарегистрированный адрес комплаенс-службы контрагента с одноразовой ссылкой для ответа. У контрагента есть 30 дней, чтобы ответить на все вопросы; ответы остаются актуальными в течение 365 дней. Новая отправка заменяет ранее отправленную неотвеченную анкету тому же контрагенту, чья ссылка перестаёт действовать. Одно письмо в минуту на один адрес.", "operationId": "sendTravelRuleVaspQuestionnaire", "x-didit-sdk": { "resource": "travel_rule", "method": "send_vasp_questionnaire", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "vasp_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "id строки из GET /v3/travel-rule/vasps/: запись справочника или участник сети Didit." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyQuestionnaireRequest" }, "example": { "sent_to": "travelrule@counterparty.example" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/vasps/{vasp_id}/questionnaires/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"sent_to\": \"travelrule@counterparty.example\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.send_vasp_questionnaire(\n \"11111111-2222-3333-4444-555555555555\",\n sent_to=\"travelrule@counterparty.example\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.sendVaspQuestionnaire(\"11111111-2222-3333-4444-555555555555\", {\n sent_to: \"travelrule@counterparty.example\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.SendVASPQuestionnaire(ctx, \"11111111-2222-3333-4444-555555555555\", didit.TravelRuleCounterpartyQuestionnaireRequest{\n\tSentTo: didit.String(\"travelrule@counterparty.example\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleCounterpartyQuestionnaireRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().sendVaspQuestionnaire(\"11111111-2222-3333-4444-555555555555\", TravelRuleCounterpartyQuestionnaireRequest.builder()\n .sentTo(\"travelrule@counterparty.example\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->sendVaspQuestionnaire('11111111-2222-3333-4444-555555555555', [\n 'sent_to' => 'travelrule@counterparty.example',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.send_vasp_questionnaire(\n \"11111111-2222-3333-4444-555555555555\",\n sent_to: \"travelrule@counterparty.example\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.SendVaspQuestionnaireAsync(\"11111111-2222-3333-4444-555555555555\", new TravelRuleCounterpartyQuestionnaireRequest\n{\n SentTo = \"travelrule@counterparty.example\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "202": { "description": "Анкета была отправлена по электронной почте.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyQuestionnaire" }, "example": { "id": "3f9e8d7c-6b5a-4c3d-9e2f-1a0b9c8d7e6f", "status": "SENT", "form_version": "1", "sent_to": "travelrule@counterparty.example", "sent_at": "2026-10-14T10:00:00Z", "expires_at": "2026-11-13T10:00:00Z", "answered_at": null, "valid_until": null, "current": false, "answers": {} } } } }, "400": { "description": "sent_to не является допустимым адресом электронной почты, не является зарегистрированным комплаенс-адресом контрагента или у контрагента нет зарегистрированного комплаенс-адреса.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "examples": { "Not on record": { "value": { "sent_to": [ "Send the questionnaire to a compliance address on record for this counterparty." ] } }, "No address": { "value": { "sent_to": [ "No compliance address is on record for this counterparty. Add a contact for it first." ] } } } } } }, "404": { "description": "Ни одна запись справочника или зарегистрированный участник сети Didit не имеет такого id. Ваш собственный профиль VASP никогда не является вашим контрагентом.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry or Didit network member has this id." } } } }, "429": { "description": "Анкета была отправлена на этот адрес менее минуты назад." }, "503": { "description": "Не удалось отправить письмо, анкета не была создана. Повторите попытку через некоторое время." } } } }, "/v3/transactions/{transaction_id}/travel-rule/": { "patch": { "summary": "Завершить, отменить, повторно отправить или обновить кошелёк отправителя для перевода Travel Rule", "description": "Укажите `payment_txn_id`, чтобы передать ончейн-хеш и перевести исходящий перевод из COMPLETED в FINISHED (его аналог по каналу INTERNAL также переходит в FINISHED), `{\"action\": \"cancel\"}`, чтобы отменить перевод в нетерминальном статусе, или `{\"action\": \"resend\"}` чтобы повторно маршрутизировать исходящий перевод, зависший в статусах COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE или NOT_ENOUGH_COUNTERPARTY_DATA (сначала дополните данные контрагента, например добавьте travel_address в запись кошелька назначения). resend применяется только к исходящим переводам. `{\"action\": \"update_compliance_email\", \"compliance_email\": \"desk@example.com\"}` заменяет email комплаенса для исходящего перевода в одном из этих трёх статусов (решение проблемы `reason: email_undeliverable`): статус не меняется, и следующий `resend` отправит запрос на этот адрес. Повторная отправка ставится в очередь, а не выполняется внутри запроса: в ответе перевод снова отображается в статусе AWAITING_COUNTERPARTY с записью `resend queued` в таймлайне и поставленной в очередь `delivery`, а информация о том, куда он был направлен, приходит в виде webhook `travel_rule.status.updated`. Если перевод отправлен через GTR, VerifyVASP или Sygna Bridge, сеть получает информацию об ончейн-хеше или отмене после ответа; выполняются повторные попытки; `delivery` показывает текущее состояние этого сообщения. `{\"action\": \"update_originator_wallet\", \"wallet_address\": \"...\"}` фиксирует кошелёк, с которого фактически ушли средства при исходящем переводе, например адрес, с которого был отправлен вывод UTXO, а не основной заявленный вами кошелёк. Это изменяет только запись: контрагенту повторно ничего не отправляется, и статус сохраняется. Отправитель становится `chain_details.originator` с `source: updated`, изменение добавляется в `timeline` с предыдущим и новым кошельками, а аналог перевода по каналу INTERNAL обновляется аналогичным образом. `{\"action\": \"beneficiary_vasp\", \"beneficiary_vasp\": \"\"}` позволяет вручную указать контрагента, если обнаружение не удалось, для исходящего перевода в статусе COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE или NOT_ENOUGH_COUNTERPARTY_DATA: перевод маршрутизируется к этому VASP и отправляется повторно.", "operationId": "patchTravelRuleTransfer", "x-didit-sdk": { "resource": "transactions.travel_rule", "method": "update_transfer", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "description": "Стабильный UUID транзакции Didit, которой принадлежит перевод.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleTransferPatchRequest" }, "examples": { "Finish": { "value": { "payment_txn_id": "0xchainhash" } }, "Cancel": { "value": { "action": "cancel" } }, "Resend": { "value": { "action": "resend" } }, "Update compliance email": { "value": { "action": "update_compliance_email", "compliance_email": "desk@example.com" } }, "Update originator wallet": { "value": { "action": "update_originator_wallet", "wallet_address": "bc1qOriginatorInputAddress01" } }, "Name the counterparty": { "value": { "action": "beneficiary_vasp", "beneficiary_vasp": "9f1c2b34-5d6e-4f70-8a91-b2c3d4e5f607" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH https://verification.didit.me/v3/transactions/{transaction_id}/travel-rule/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"payment_txn_id\": \"0xchainhash\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.travel_rule.update_transfer(\n \"11111111-2222-3333-4444-555555555555\",\n payment_txn_id=\"0xchainhash\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.travelRule.updateTransfer(\"11111111-2222-3333-4444-555555555555\", {\n payment_txn_id: \"0xchainhash\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.TravelRule.UpdateTransfer(ctx, \"11111111-2222-3333-4444-555555555555\", didit.TravelRuleTransferPatchRequest{\n\tPaymentTxnID: didit.String(\"0xchainhash\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleTransferPatchRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().travelRule().updateTransfer(\"11111111-2222-3333-4444-555555555555\", TravelRuleTransferPatchRequest.builder()\n .paymentTxnId(\"0xchainhash\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->travelRule->updateTransfer('11111111-2222-3333-4444-555555555555', [\n 'payment_txn_id' => '0xchainhash',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.travel_rule.update_transfer(\n \"11111111-2222-3333-4444-555555555555\",\n payment_txn_id: \"0xchainhash\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.TravelRule.UpdateTransferAsync(\"11111111-2222-3333-4444-555555555555\", new TravelRuleTransferPatchRequest\n{\n PaymentTxnId = \"0xchainhash\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Обновлённый перевод. После `update_compliance_email` его статус остаётся неизменным и сохраняет `reason: email_undeliverable` до следующего `resend`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleTransferDetail" } } } }, "400": { "description": "Не указаны ни payment_txn_id, ни поддерживаемое действие, отсутствует `compliance_email` или значение не является адресом электронной почты для `update_compliance_email`, либо для `update_originator_wallet` не указан wallet_address, кошелёк или memo не поддерживаются блокчейном перевода, кошелёк не входит во входы UTXO перевода, либо отсутствует `beneficiary_vasp` или он не является действительным идентификатором VASP из справочника.", "content": { "application/json": { "examples": { "No action": { "value": { "detail": [ "Provide payment_txn_id, action=cancel, action=resend, action=beneficiary_vasp, action=update_originator_wallet or action=update_compliance_email." ] } }, "Invalid compliance email": { "value": { "compliance_email": [ "Enter a valid email address." ] } } } } } }, "404": { "description": "Неизвестная транзакция, у транзакции отсутствует перевод Travel Rule, либо (действие `beneficiary_vasp`) запись с таким id отсутствует в справочнике." }, "409": { "description": "Перевод находится в состоянии, не допускающем эту операцию (например, не имеет статуса COMPLETED или не является исходящим для finish, уже находится в терминальном статусе для cancel или не является исходящим переводом в статусе, допускающем повторную отправку, для resend). `update_compliance_email` возвращает `409` для входящего перевода и для исходящего вне статусов COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE и NOT_ENOUGH_COUNTERPARTY_DATA. `update_originator_wallet` возвращает `409` для входящего, отмененного перевода или перевода с истекшим сроком. `beneficiary_vasp` возвращает `409`, если только перевод не является исходящим и не находится в статусе COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE или NOT_ENOUGH_COUNTERPARTY_DATA.", "content": { "application/json": { "examples": { "Cancel from a terminal status": { "value": { "detail": "Transfer is already in a terminal state." } }, "Resend not allowed": { "value": { "detail": "Transfer cannot be resent from its current state." } }, "Finish not allowed": { "value": { "detail": "Transfer must be an outbound transfer in COMPLETED status to finish." } }, "Compliance email cannot change": { "value": { "detail": "The compliance email of this transfer cannot change from its current state." } } } } } } } } }, "/v3/transactions/{transaction_id}/travel-rule/ownership/": { "post": { "summary": "Подтвердить или опровергнуть владение кошельком", "description": "Разрешить перевод, ожидающий подтверждения владения кошельком: вызывайте этот метод со своей стороны перевода, когда он находится в статусе UNCONFIRMED_OWNERSHIP, или когда это входящий перевод в статусе ON_HOLD. Подтверждение помечает соответствующую запись в адресной книге кошельков как проверенную на владение (для входящего перевода в ON_HOLD без записи Didit создаёт её из beneficiary_data.wallet_address) и запускает сопоставление имени получателя на обеих сторонах перевода; отклонение отклоняет обе стороны. Входящий перевод, депозит по которому уже зачислен, переходит в FINISHED при успешном сопоставлении. Если кошелёк контрагента был заявлен как некастодиальный (counterparty.payment_method.method_type: unhosted_wallet), подтверждение фиксирует, что клиент проверил, кто контролирует этот кошелёк, и завершает перевод (COMPLETED) в обоих направлениях, либо переводит в FINISHED для входящего депозита, ончейн-хеш которого уже известен. Проверяемый кошелёк принадлежит контрагенту: это адрес назначения исходящего вывода или источник (кошелёк отправителя) входящего депозита. Если его ещё нет в вашей адресной книге кошельков, Didit добавляет его как проверенный на владение под именем контрагента; если в книге уже есть эта запись под другим именем владельца, перевод переходит в COUNTERPARTY_MISMATCHED_DATA. Для входящего перевода TRP в статусе UNCONFIRMED_OWNERSHIP, ON_HOLD или COUNTERPARTY_MISMATCHED_DATA Didit отправляет ваше решение инициирующему VASP: одобрение возвращает платёжный адрес (wallet_address или адрес совпавшей записи) и переводит перевод в COMPLETED, а отклонение отклоняет его. Этот же вызов выносит решение по входящему переводу, отправленному контрагентом GTR или Sygna Bridge, который ожидает вашей проверки (`UNCONFIRMED_OWNERSHIP`, `ON_HOLD` или `COUNTERPARTY_MISMATCHED_DATA`): `confirmed: true` одобряет его (передайте `wallet_address`, если в переводе он не указан), а `confirmed: false` отклоняет его, после чего сети отправляется ответ с повторными попытками. VerifyVASP получает ответ в момент запроса, поэтому перевод VerifyVASP, требующий вашей проверки, отклоняется сразу и не может быть разрешён позже.", "operationId": "confirmTravelRuleOwnership", "x-didit-sdk": { "resource": "transactions.travel_rule", "method": "confirm_ownership", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "description": "Стабильный UUID транзакции Didit, которую ваше приложение хранит для этого перевода: транзакция на стороне получателя при переводе по каналу INTERNAL или транзакция, созданная вами (исходящая или входящая), если кошелёк контрагента был заявлен как некастодиальный.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleOwnershipConfirmRequest" }, "example": { "confirmed": true } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/transactions/{transaction_id}/travel-rule/ownership/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"confirmed\": true}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.travel_rule.confirm_ownership(\n \"11111111-2222-3333-4444-555555555555\",\n confirmed=True,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.travelRule.confirmOwnership(\"11111111-2222-3333-4444-555555555555\", {\n confirmed: true,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.TravelRule.ConfirmOwnership(ctx, \"11111111-2222-3333-4444-555555555555\", didit.TravelRuleOwnershipConfirmRequest{\n\tConfirmed: true,\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleOwnershipConfirmRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().travelRule().confirmOwnership(\"11111111-2222-3333-4444-555555555555\", TravelRuleOwnershipConfirmRequest.builder()\n .confirmed(true)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->travelRule->confirmOwnership('11111111-2222-3333-4444-555555555555', [\n 'confirmed' => true,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.travel_rule.confirm_ownership(\n \"11111111-2222-3333-4444-555555555555\",\n confirmed: true\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.TravelRule.ConfirmOwnershipAsync(\"11111111-2222-3333-4444-555555555555\", new TravelRuleOwnershipConfirmRequest\n{\n Confirmed = true,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Обновлённый перевод. Для входящего перевода originator_data/beneficiary_data контрагента остаются маскированными (`data_masked: true`) до тех пор, пока не будет подтверждена структура владения, затем `data_unmasked` фиксирует, когда, почему и кем.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleTransferDetail" } } } }, "409": { "description": "Перевод не ожидает подтверждения владения, ни одна запись в адресной книге кошельков не соответствует кошельку контрагента, внутренний (INTERNAL) перевод от другого клиента Didit требует подтверждения контроля (подписанного сообщения или тестового депозита) перед подтверждением либо по сетевому переводу уже был дан ответ через соответствующую сеть (перевод VerifyVASP или перевод GTR/Sygna Bridge, по которому вы или Didit уже приняли решение).", "content": { "application/json": { "examples": { "Not awaiting confirmation": { "value": { "detail": "Transfer is not awaiting ownership confirmation." } }, "No matching address book entry": { "value": { "detail": "wallet address entry no longer available" } } } } } }, "400": { "description": "Ошибка валидации: отсутствует confirmed, входящее подтверждение TRP не содержит wallet_address и резервного адреса, либо передано `confirmed: true` для заявленного перевода на некастодиальный кошелёк, в котором не указан кошелёк контрагента и не был передан `wallet_address`.", "content": { "application/json": { "examples": { "No payment address": { "value": { "wallet_address": [ "wallet_address is required to approve." ] } } } } } }, "404": { "description": "Неизвестная транзакция, либо у транзакции отсутствует перевод Travel Rule." }, "502": { "description": "Только для входящих переводов TRP: Didit не удалось доставить ваше решение исходному VASP, поэтому статус перевода не меняется.", "content": { "application/json": { "examples": { "Callback not delivered": { "value": { "detail": "Counterparty inquiry-resolution callback could not be delivered." } } } } } } } } }, "/v3/transactions/{transaction_id}/travel-rule/messages/": { "get": { "summary": "Получить список сообщений Travel Rule", "description": "Сообщения и запросы документов, которыми обменялись с VASP-контрагентом по поводу этого перевода.", "operationId": "listTravelRuleMessages", "x-didit-sdk": { "resource": "transactions.travel_rule", "method": "list_messages", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "description": "Стабильный UUID транзакции Didit, которой принадлежит перевод.", "schema": { "type": "string", "format": "uuid" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/transactions/{transaction_id}/travel-rule/messages/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.travel_rule.list_messages(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.travelRule.listMessages(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.TravelRule.ListMessages(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().travelRule().listMessages(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->travelRule->listMessages('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.transactions.travel_rule.list_messages(\"11111111-2222-3333-4444-555555555555\").each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.TravelRule.ListMessagesAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Сообщения, начиная со старых.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleMessage" } } } } }, "404": { "description": "Неизвестная транзакция или token, либо по транзакции отсутствует перевод Travel Rule." } } }, "post": { "summary": "Отправить сообщение Travel Rule или запрос документов", "description": "Отправляет сообщение или запрос документов контрагенту VASP. Работает для переводов типа INTERNAL (другой клиент Didit видит его на своей стороне пары) и переводов EMAIL (контрагенту отправляется электронное письмо, и он отвечает на портале получения). Перевод через TRP, GTR, TRUST, VerifyVASP или Sygna не содержит сообщений, поскольку в этих протоколах они не предусмотрены. Лимиты: 100 сообщений на перевод, 5000 символов в теле сообщения, 10 запрашиваемых документов, 5 файлов по 10 МБ каждый.", "operationId": "createTravelRuleMessage", "x-didit-sdk": { "resource": "transactions.travel_rule", "method": "create_message", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "description": "Стабильный UUID транзакции Didit, которой принадлежит перевод.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleMessageCreateRequest" }, "example": { "kind": "DOCUMENT_REQUEST", "body": "Please confirm the date of birth of the beneficiary.", "requested_documents": [ "Proof of address" ] } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TravelRuleMessageCreateRequest" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/transactions/{transaction_id}/travel-rule/messages/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"kind\": \"DOCUMENT_REQUEST\", \"body\": \"Please confirm the date of birth of the beneficiary.\", \"requested_documents\": [\"Proof of address\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.travel_rule.create_message(\n \"11111111-2222-3333-4444-555555555555\",\n kind=\"DOCUMENT_REQUEST\",\n body=\"Please confirm the date of birth of the beneficiary.\",\n requested_documents=[\"Proof of address\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.travelRule.createMessage(\"11111111-2222-3333-4444-555555555555\", {\n kind: \"DOCUMENT_REQUEST\",\n body: \"Please confirm the date of birth of the beneficiary.\",\n requested_documents: [\"Proof of address\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.TravelRule.CreateMessage(ctx, \"11111111-2222-3333-4444-555555555555\", didit.TravelRuleMessageCreateRequest{\n\tKind: didit.Some(didit.TravelRuleMessageCreateRequestKind(\"DOCUMENT_REQUEST\")),\n\tBody: didit.String(\"Please confirm the date of birth of the beneficiary.\"),\n\tRequestedDocuments: didit.Some([]string{\"Proof of address\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.TravelRuleMessageCreateRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().travelRule().createMessage(\"11111111-2222-3333-4444-555555555555\", TravelRuleMessageCreateRequest.builder()\n .kind(TravelRuleMessageCreateRequest.Kind.of(\"DOCUMENT_REQUEST\"))\n .body(\"Please confirm the date of birth of the beneficiary.\")\n .requestedDocuments(List.of(\"Proof of address\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->travelRule->createMessage('11111111-2222-3333-4444-555555555555', [\n 'kind' => 'DOCUMENT_REQUEST',\n 'body' => 'Please confirm the date of birth of the beneficiary.',\n 'requested_documents' => ['Proof of address'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.travel_rule.create_message(\n \"11111111-2222-3333-4444-555555555555\",\n kind: \"DOCUMENT_REQUEST\",\n body: \"Please confirm the date of birth of the beneficiary.\",\n requested_documents: [\"Proof of address\"]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.TravelRule.CreateMessageAsync(\"11111111-2222-3333-4444-555555555555\", new TravelRuleMessageCreateRequest\n{\n Kind = new TravelRuleMessageCreateRequestKind(\"DOCUMENT_REQUEST\"),\n Body = \"Please confirm the date of birth of the beneficiary.\",\n RequestedDocuments = new string[] { \"Proof of address\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Сохранённое сообщение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleMessage" } } } }, "400": { "description": "Недопустимое тело запроса, неподдерживаемый тип или размер файла, более 100 сообщений в переводе или `reply_to`, не являющийся сообщением этого перевода.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "requested_documents": [ "Name at least one document the counterparty should send." ] } } } }, "404": { "description": "Неизвестная транзакция или token, либо по транзакции отсутствует перевод Travel Rule." }, "409": { "description": "Сообщение не может быть доставлено контрагенту. В `detail` указана причина: перевод выполняется через сетевой протокол (TRP, GTR, TRUST, VerifyVASP или Sygna), у него еще нет контрагента, данные перевода INTERNAL не совпали с владельцем кошелька, поэтому получателю ничего не поступило, либо ссылка для получения перевода EMAIL истекла или перевод закрыт.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } } } }, "/v3/travel-rule/pickup/{token}/": { "get": { "summary": "Получить информацию о получении по email-каналу", "description": "Публичный, не требует аутентификации. Позволяет VASP контрагента, не являющемуся Didit, просмотреть ожидающий обмен по ссылке для получения из email. Аутентификацией выступает сам token.", "operationId": "getTravelRulePickup", "x-didit-sdk": { "resource": "travel_rule", "method": "retrieve_pickup", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contact", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Значение `?contact=` ссылки, контакт, которому была отправлена ссылка. Возвращается без изменений в поле `contact`; валидация не выполняется." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl https://verification.didit.me/v3/travel-rule/pickup/{token}/" } ], "responses": { "200": { "description": "Предпросмотр продолжения сессии.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRulePickupInfo" }, "example": { "reference": "33333333-4444-5555-6666-777777777777", "requested_at": "2026-07-05T10:00:00Z", "originator_vasp_name": "Origin CASP SL", "originator_vasp_lei": "529900EXAMPLEORIG001", "recipient_vasp_name": "Example Counterparty VASP", "language": "es", "amount": "0.250000000000000000", "currency": "ETH", "fiat_amount": "", "fiat_currency": "", "chain": "ETH", "beneficiary_wallet": "0xede2d7e4f5b097e6391ab6bbcf2f47a53f4778cb", "status": "AWAITING_COUNTERPARTY", "ivms_version": "ivms101.2023", "deadline_at": "2026-07-07T10:00:00Z", "reminders_sent": 0, "contact": "", "decline_reasons": [ "data_mismatch", "not_our_customer", "wallet_not_hosted", "sanctions", "risk_appetite", "jurisdiction", "insufficient_data", "other" ], "join_invitation": { "eligible": false, "url": "" }, "originator_data": { "name": "Jane Doe", "wallet_address": "0x77ccff0cc624a53cd8b8d8703ced826710211ec7" }, "beneficiary_data": { "name": "Ana Diaz", "wallet_address": "0xede2d7e4f5b097e6391ab6bbcf2f47a53f4778cb" }, "ivms_request": { "originator": { "originatorPersons": [ { "naturalPerson": { "name": { "nameIdentifier": [ { "primaryIdentifier": "Doe", "secondaryIdentifier": "Jane", "nameIdentifierType": "LEGL" } ] } } } ], "accountNumber": [ "0x77ccff0cc624a53cd8b8d8703ced826710211ec7" ] }, "beneficiary": { "beneficiaryPersons": [ { "naturalPerson": { "name": { "nameIdentifier": [ { "primaryIdentifier": "Diaz", "secondaryIdentifier": "Ana", "nameIdentifierType": "LEGL" } ] } } } ], "accountNumber": [ "0xede2d7e4f5b097e6391ab6bbcf2f47a53f4778cb" ] } }, "data_masked": false } } } }, "404": { "description": "Неизвестный token." }, "410": { "description": "Окно закрыто: контрагент уже ответил, перевод вышел из статуса AWAITING_COUNTERPARTY или истёк срок." } } } }, "/v3/travel-rule/pickup/{token}/respond/": { "post": { "summary": "Ответить на получение через email-канал", "description": "Публичный, без аутентификации. Принимает или отклоняет обмен по ссылке получения из электронного письма. При принятии beneficiary_name проверяется на соответствие политике name_matching_strictness отправителя.", "operationId": "respondTravelRulePickup", "x-didit-sdk": { "resource": "travel_rule", "method": "respond_pickup", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contact", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Значение `?contact=` ссылки. Используется, когда тело запроса не содержит `contact`." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRulePickupRespondRequest" }, "example": { "decision": "accept", "beneficiary_name": "Carlos Ruiz" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/pickup/{token}/respond/ \\\n -H 'Content-Type: application/json' \\\n -d '{\"decision\": \"accept\", \"beneficiary_name\": \"Carlos Ruiz\"}'" } ], "responses": { "200": { "description": "Итоговый статус обмена: COMPLETED или COUNTERPARTY_MISMATCHED_DATA после принятия, COUNTERPARTY_VASP_GENERAL_DECLINE после отклонения (также дублирует `decline_reason`).", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "decline_reason": { "type": "string", "description": "Присутствует после отклонения." } } }, "examples": { "accepted": { "value": { "status": "COMPLETED" } }, "declined": { "value": { "status": "COUNTERPARTY_VASP_GENERAL_DECLINE", "decline_reason": "not_our_customer" } } } } } }, "400": { "description": "Поле недействительно: например, отсутствует `decision` или оно не равно `accept` или `decline`, отсутствует `decline_detail` при отклонении с `decline_reason: other`, `ivms_response` не является объектом IVMS 101 или превышает 16384 символа, либо `contact` в теле запроса не является UUID (`{\"contact\": [\"Must be a valid UUID.\"]}`).", "content": { "application/json": { "example": { "decline_detail": [ "Say what the reason is when you choose another reason." ] } } } }, "404": { "description": "Неизвестный token." }, "410": { "description": "Окно закрыто: контрагент уже ответил, перевод вышел из статуса AWAITING_COUNTERPARTY или истёк срок." } } } }, "/v3/travel-rule/pickup/{token}/messages/": { "get": { "summary": "Получить список сообщений для получения", "description": "Публичный, не требует аутентификации. Сообщения перевода по каналу EMAIL в том виде, в каком их видит VASP контрагента: отправленное клиентом имеет статус `INBOUND` и подписано именем VASP клиента. Аутентификацией выступает token.", "operationId": "listTravelRulePickupMessages", "x-didit-sdk": { "resource": "travel_rule", "method": "list_pickup_messages", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl https://verification.didit.me/v3/travel-rule/pickup/{token}/messages/" } ], "responses": { "200": { "description": "Сообщения со стороны контрагента, начиная со старых.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleMessage" } } } } }, "404": { "description": "Неизвестный token." }, "410": { "description": "Срок действия ссылки для получения истек или перевод закрыт." } } }, "post": { "summary": "Ответить на портале получения", "description": "Публичный, не требует аутентификации. VASP контрагента отправляет ответ в рамках перевода по каналу EMAIL. Структура тела совпадает с сообщениями транзакции; вложения должны быть в формате PDF, PNG, JPEG или WebP. Аутентификацией выступает token.", "operationId": "createTravelRulePickupMessage", "x-didit-sdk": { "resource": "travel_rule", "method": "create_pickup_message", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleMessageCreateRequest" }, "example": { "kind": "MESSAGE", "body": "Attached is the proof of address of the wallet holder." } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TravelRuleMessageCreateRequest" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/pickup/{token}/messages/ \\\n -H 'Content-Type: application/json' \\\n -d '{\"kind\": \"MESSAGE\", \"body\": \"Attached is the proof of address of the wallet holder.\"}'" } ], "responses": { "201": { "description": "Сохранённое сообщение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleMessage" } } } }, "400": { "description": "Недопустимое тело запроса, неподдерживаемый тип или размер файла, более 100 сообщений в переводе или `reply_to`, не являющийся сообщением этого перевода.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "requested_documents": [ "Name at least one document the counterparty should send." ] } } } }, "404": { "description": "Неизвестный token." }, "410": { "description": "Срок действия ссылки для получения истек или перевод закрыт." } } } }, "/v3/travel-rule/inbound/": { "post": { "summary": "Зарегистрировать входящий перевод после депозита (sunrise)", "description": "Зарегистрировать данные Travel Rule для криптовалютного депозита, который уже был проведён ончейн до совершения какого-либо обмена. Создаёт входящую транзакцию travelRule (или повторно использует невостребованный депозит) и сопоставляет перевод с вашей адресной книгой кошельков. Для вновь созданной транзакции Didit сначала отправляет webhook transaction.created, а затем webhook travel_rule.status.updated.", "operationId": "registerTravelRuleInbound", "x-didit-sdk": { "resource": "travel_rule", "method": "register_inbound", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleInboundRequest" }, "example": { "chain": "ETH", "txid": "0xdeposit-hash", "wallet_address": "0xYourDepositWallet", "amount": "500.00", "currency": "USDC", "originator_data": { "name": "Origin CASP SL" }, "beneficiary_data": { "name": "Ana Diaz" }, "originating_vasp": { "name": "Origin CASP SL", "lei": "", "travel_address": "ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/inbound/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"chain\":\"ETH\",\"txid\":\"0xdeposit-hash\",\"wallet_address\":\"0xYourDepositWallet\",\"amount\":\"500.00\",\"currency\":\"USDC\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.register_inbound(\n chain=\"ETH\",\n txid=\"0xdeposit-hash\",\n wallet_address=\"0xYourDepositWallet\",\n amount=\"500.00\",\n currency=\"USDC\",\n originator_data={\"name\": \"Origin CASP SL\"},\n beneficiary_data={\"name\": \"Ana Diaz\"},\n originating_vasp={\n \"name\": \"Origin CASP SL\",\n \"lei\": \"\",\n \"travel_address\": \"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\",\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.registerInbound({\n chain: \"ETH\",\n txid: \"0xdeposit-hash\",\n wallet_address: \"0xYourDepositWallet\",\n amount: \"500.00\",\n currency: \"USDC\",\n originator_data: { name: \"Origin CASP SL\" },\n beneficiary_data: { name: \"Ana Diaz\" },\n originating_vasp: {\n name: \"Origin CASP SL\",\n lei: \"\",\n travel_address: \"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\",\n },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.RegisterInbound(ctx, didit.TravelRuleInboundRequest{\n\tChain: \"ETH\",\n\tTxid: \"0xdeposit-hash\",\n\tWalletAddress: \"0xYourDepositWallet\",\n\tAmount: \"500.00\",\n\tCurrency: \"USDC\",\n\tOriginatorData: didit.Some(map[string]any{\"name\": \"Origin CASP SL\"}),\n\tBeneficiaryData: didit.Some(map[string]any{\"name\": \"Ana Diaz\"}),\n\tOriginatingVASP: didit.Some(didit.TravelRuleInboundRequestOriginatingVASP{\n\t\tName: didit.String(\"Origin CASP SL\"),\n\t\tLei: didit.String(\"\"),\n\t\tTravelAddress: didit.String(\"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\"),\n\t}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.TravelRuleInboundRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().registerInbound(TravelRuleInboundRequest.builder()\n .chain(\"ETH\")\n .txid(\"0xdeposit-hash\")\n .walletAddress(\"0xYourDepositWallet\")\n .amount(\"500.00\")\n .currency(\"USDC\")\n .originatorData(Map.of(\"name\", \"Origin CASP SL\"))\n .beneficiaryData(Map.of(\"name\", \"Ana Diaz\"))\n .originatingVasp(TravelRuleInboundRequest.OriginatingVasp.builder()\n .name(\"Origin CASP SL\")\n .lei(\"\")\n .travelAddress(\"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\")\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->registerInbound([\n 'chain' => 'ETH',\n 'txid' => '0xdeposit-hash',\n 'wallet_address' => '0xYourDepositWallet',\n 'amount' => '500.00',\n 'currency' => 'USDC',\n 'originator_data' => ['name' => 'Origin CASP SL'],\n 'beneficiary_data' => ['name' => 'Ana Diaz'],\n 'originating_vasp' => [\n 'name' => 'Origin CASP SL',\n 'lei' => '',\n 'travel_address' => 'ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC',\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.register_inbound(\n chain: \"ETH\",\n txid: \"0xdeposit-hash\",\n wallet_address: \"0xYourDepositWallet\",\n amount: \"500.00\",\n currency: \"USDC\",\n originator_data: { name: \"Origin CASP SL\" },\n beneficiary_data: { name: \"Ana Diaz\" },\n originating_vasp: {\n name: \"Origin CASP SL\",\n lei: \"\",\n travel_address: \"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\",\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.RegisterInboundAsync(new TravelRuleInboundRequest\n{\n Chain = \"ETH\",\n Txid = \"0xdeposit-hash\",\n WalletAddress = \"0xYourDepositWallet\",\n Amount = \"500.00\",\n Currency = \"USDC\",\n OriginatorData = new Dictionary { [\"name\"] = \"Origin CASP SL\" },\n BeneficiaryData = new Dictionary { [\"name\"] = \"Ana Diaz\" },\n OriginatingVasp = new TravelRuleInboundRequestOriginatingVasp\n {\n Name = \"Origin CASP SL\",\n Lei = \"\",\n TravelAddress = \"ta9JbXbsBSuS5ozArJRFVgvBHMVnDGUnrPPChSZYQsuZTn3kPrJXUQ7RSLUEJ5KjyPvr8C9sAxmPtZfGsQVKCi4n8ShxP9BkbDdbtjtA9aumNybAZ1BxC\",\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Перевод для этого txid и wallet_address уже был зарегистрирован; существующий перевод возвращён без изменений (created равно false).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleInboundResponse" } } } }, "201": { "description": "Новый перевод Travel Rule был зарегистрирован для новой входящей транзакции или существующего невостребованного депозита (created равно true).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleInboundResponse" } } } }, "400": { "description": "Обязательное поле (`chain`, `txid`, `wallet_address`, `amount`, `currency`) отсутствует, `originating_vasp.lei` не является корректным LEI, `originating_vasp.travel_address` не является корректным Travel Address, указан memo, X-address или `utxo`, который сеть не поддерживает, либо `originator_data` / `beneficiary_data` не является объектом.", "content": { "application/json": { "examples": { "Missing field": { "value": { "txid": [ "This field is required." ] } }, "Invalid LEI": { "value": { "originating_vasp": { "lei": [ "Invalid LEI: expected 20 alphanumeric characters (ISO 17442)." ] } } } } } } } } } }, "/v3/travel-rule/test-vasp/inbound/": { "post": { "summary": "Инициировать входящий перевод от тестового VASP Didit (песочница)", "description": "Только для приложений в песочнице. Didit Test VASP отправляет вашему приложению входящий перевод Travel Rule, чтобы вы могли протестировать принимающую сторону биржи от начала до конца перед выходом в продакшн. Перевод регистрируется, и решение по нему принимается по той же логике, которую реальный входящий перевод из сети применяет к вашей адресной книге кошельков, поэтому входящие сообщения, решение и процесс подтверждения владения кошельком работают так же, как и в продакшене. За пределы Didit ничего не уходит. Приложение в продакшн-среде получит ошибку 400. Отправьте тот же `reference` повторно, чтобы получить перевод, зарегистрированный первым вызовом, вместо создания второго.", "operationId": "triggerTravelRuleTestVaspInbound", "x-didit-sdk": { "resource": "transactions.travel_rule", "method": "trigger_test_vasp_inbound", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleTestVaspInboundRequest" }, "example": { "beneficiary_wallet_address": "0xYourSandboxWallet", "scenario": "accept", "amount": "1", "reference": "demo-001" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/test-vasp/inbound/ \\\n -H 'x-api-key: YOUR_SANDBOX_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"beneficiary_wallet_address\":\"0xYourSandboxWallet\",\"scenario\":\"accept\",\"reference\":\"demo-001\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.travel_rule.trigger_test_vasp_inbound(\n beneficiary_wallet_address=\"0xYourSandboxWallet\",\n scenario=\"accept\",\n amount=\"1\",\n reference=\"demo-001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.travelRule.triggerTestVaspInbound({\n beneficiary_wallet_address: \"0xYourSandboxWallet\",\n scenario: \"accept\",\n amount: \"1\",\n reference: \"demo-001\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.TravelRule.TriggerTestVASPInbound(ctx, didit.TravelRuleTestVASPInboundRequest{\n\tBeneficiaryWalletAddress: \"0xYourSandboxWallet\",\n\tScenario: didit.Some(didit.TravelRuleTestVASPInboundRequestScenario(\"accept\")),\n\tAmount: didit.String(\"1\"),\n\tReference: didit.String(\"demo-001\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleTestVaspInboundRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().travelRule().triggerTestVaspInbound(TravelRuleTestVaspInboundRequest.builder()\n .beneficiaryWalletAddress(\"0xYourSandboxWallet\")\n .scenario(TravelRuleTestVaspInboundRequest.Scenario.of(\"accept\"))\n .amount(\"1\")\n .reference(\"demo-001\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->travelRule->triggerTestVaspInbound([\n 'beneficiary_wallet_address' => '0xYourSandboxWallet',\n 'scenario' => 'accept',\n 'amount' => '1',\n 'reference' => 'demo-001',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.travel_rule.trigger_test_vasp_inbound(\n beneficiary_wallet_address: \"0xYourSandboxWallet\",\n scenario: \"accept\",\n amount: \"1\",\n reference: \"demo-001\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.TravelRule.TriggerTestVaspInboundAsync(new TravelRuleTestVaspInboundRequest\n{\n BeneficiaryWalletAddress = \"0xYourSandboxWallet\",\n Scenario = new TravelRuleTestVaspInboundRequestScenario(\"accept\"),\n Amount = \"1\",\n Reference = \"demo-001\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Входящий перевод был проведен и по нему принято решение. Повторный запрос с тем же `reference` возвращает то же тело ответа.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleTestVaspInboundResponse" } } } }, "400": { "description": "Недопустимое тело запроса, неизвестный или неподдерживаемый `scenario`, либо приложение является продакшн-приложением.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Перевод не удалось провести, например, потому что Travel Rule не включен для приложения.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } } } }, "/v3/travel-rule/widget-session/": { "post": { "summary": "Выпустить сессию виджета подтверждения владения кошельком", "description": "Сгенерировать URL/token размещённого виджета подтверждения владения кошельком. Направьте клиента по возвращённому URL, чтобы подтвердить контроль над кошельком (подписание сообщения, тест Сатоши, скриншот или самодекларация). В этом релизе виджет доступен только в веб-версии: открывайте URL в системном браузере или кастомной вкладке, но ни в коем случае не внутри веб-представления мобильного SDK.", "operationId": "createTravelRuleWidgetSession", "x-didit-sdk": { "resource": "travel_rule", "method": "create_widget_session", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetSessionCreate" }, "example": { "wallet_address": "0xd3b62acb76fb27a7f8961ec40fa11746b113aca9", "chain": "ETH", "holder_name": "Jane Doe", "vendor_data": "user-042", "transaction_id": "99999999-aaaa-bbbb-cccc-dddddddddddd", "expires_in_minutes": 60 } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/widget-session/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"wallet_address\":\"0xd3b62acb76fb27a7f8961ec40fa11746b113aca9\",\"chain\":\"ETH\",\"holder_name\":\"Jane Doe\",\"transaction_id\":\"99999999-aaaa-bbbb-cccc-dddddddddddd\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.create_widget_session(\n wallet_address=\"0xd3b62acb76fb27a7f8961ec40fa11746b113aca9\",\n chain=\"ETH\",\n holder_name=\"Jane Doe\",\n vendor_data=\"user-042\",\n transaction_id=\"99999999-aaaa-bbbb-cccc-dddddddddddd\",\n expires_in_minutes=60,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.createWidgetSession({\n wallet_address: \"0xd3b62acb76fb27a7f8961ec40fa11746b113aca9\",\n chain: \"ETH\",\n holder_name: \"Jane Doe\",\n vendor_data: \"user-042\",\n transaction_id: \"99999999-aaaa-bbbb-cccc-dddddddddddd\",\n expires_in_minutes: 60,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.CreateWidgetSession(ctx, didit.TravelRuleWidgetSessionCreate{\n\tWalletAddress: didit.String(\"0xd3b62acb76fb27a7f8961ec40fa11746b113aca9\"),\n\tChain: didit.String(\"ETH\"),\n\tHolderName: didit.String(\"Jane Doe\"),\n\tVendorData: didit.String(\"user-042\"),\n\tTransactionID: didit.String(\"99999999-aaaa-bbbb-cccc-dddddddddddd\"),\n\tExpiresInMinutes: didit.Int(60),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleWidgetSessionCreate;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().createWidgetSession(TravelRuleWidgetSessionCreate.builder()\n .walletAddress(\"0xd3b62acb76fb27a7f8961ec40fa11746b113aca9\")\n .chain(\"ETH\")\n .holderName(\"Jane Doe\")\n .vendorData(\"user-042\")\n .transactionId(\"99999999-aaaa-bbbb-cccc-dddddddddddd\")\n .expiresInMinutes(60L)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->createWidgetSession([\n 'wallet_address' => '0xd3b62acb76fb27a7f8961ec40fa11746b113aca9',\n 'chain' => 'ETH',\n 'holder_name' => 'Jane Doe',\n 'vendor_data' => 'user-042',\n 'transaction_id' => '99999999-aaaa-bbbb-cccc-dddddddddddd',\n 'expires_in_minutes' => 60,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.create_widget_session(\n wallet_address: \"0xd3b62acb76fb27a7f8961ec40fa11746b113aca9\",\n chain: \"ETH\",\n holder_name: \"Jane Doe\",\n vendor_data: \"user-042\",\n transaction_id: \"99999999-aaaa-bbbb-cccc-dddddddddddd\",\n expires_in_minutes: 60\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.CreateWidgetSessionAsync(new TravelRuleWidgetSessionCreate\n{\n WalletAddress = \"0xd3b62acb76fb27a7f8961ec40fa11746b113aca9\",\n Chain = \"ETH\",\n HolderName = \"Jane Doe\",\n VendorData = \"user-042\",\n TransactionId = \"99999999-aaaa-bbbb-cccc-dddddddddddd\",\n ExpiresInMinutes = 60,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Сгенерированная сессия виджета.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetSessionResponse" } } } }, "400": { "description": "Недопустимое тело запроса: `callback_url` не является абсолютным URL-адресом http(s), значение `expires_in_minutes` вне диапазона от 5 до 10080, `transaction_id` не является UUID или длина поля превышает лимит.", "content": { "application/json": { "examples": { "Invalid callback_url": { "value": { "callback_url": [ "callback_url must be an absolute http(s) URL." ] } } } } } }, "404": { "description": "`transaction_id` не указывает на перевод по Travel Rule в этом приложении." } } } }, "/v3/travel-rule/widget/{token}/": { "get": { "summary": "Получить контекст виджета владения кошельком", "description": "Публичный endpoint на чтение с доступом по токену сессии виджета - API-ключ не требуется. Возвращает контекст виджета и статус каждого подтверждения, что позволяет опрашивать его для отслеживания завершения; completed_at заполняется, как только подтверждение становится проверенным. Подтверждение SATOSHI_TEST может оставаться в статусе PENDING, пока его депозит виден ончейн, но еще не подтвержден - фоновая задача автоматически перепроверяет его и завершает после подтверждения депозита, поэтому никаких действий со стороны клиента во время ожидания не требуется. Каждое подтверждение содержит поля, необходимые для его метода: deposit_address, expected_amount и собственный expires_at для SATOSHI_TEST; challenge для MESSAGE_SIGNING. Если сессия связана с переводом, рекомендуется использовать webhook travel_rule.status.updated вместо опроса.", "operationId": "getTravelRuleWidgetContext", "x-didit-sdk": { "resource": "travel_rule", "method": "retrieve_widget_context", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "description": "Непрозрачный токен сессии, возвращённый при создании сессии виджета.", "schema": { "type": "string" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl https://verification.didit.me/v3/travel-rule/widget/{token}/" } ], "responses": { "200": { "description": "Контекст виджета и статусы подтверждений.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetContext" } } } }, "404": { "description": "Неизвестный token." }, "410": { "description": "Срок действия сессии истек до ее завершения." } } } }, "/v3/travel-rule/widget/{token}/vasps/": { "get": { "summary": "Поиск VASP через виджет кошелька", "description": "Публичный endpoint на чтение с доступом по токену сессии виджета, API-ключ не требуется: селектор VASP для виджета конечного пользователя. Тот же поиск и те же фильтры, что и в GET /v3/travel-rule/vasps/ для приложения виджета; возвращает только информацию о том, кем является каждый VASP и доступен ли он.", "operationId": "listTravelRuleWidgetVasps", "x-didit-sdk": { "resource": "travel_rule", "method": "list_widget_vasps", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "description": "Непрозрачный токен сессии, возвращённый при создании сессии виджета.", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string", "maxLength": 255 }, "description": "Фрагмент имени или псевдонима (без учёта регистра), точный LEI или домен (example.com или URL на нём). Участники сети Didit сопоставляются по юридическому наименованию, LEI или домену адреса электронной почты комплаенс-отдела." }, { "name": "network", "in": "query", "schema": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA", "TRISA" ] }, "description": "Только записи справочника, которые в данный момент указаны в каталоге участников сети." }, { "name": "jurisdiction", "in": "query", "schema": { "type": "string" }, "description": "Двухбуквенный (alpha-2) или трехбуквенный (alpha-3) код страны по стандарту ISO 3166. Для любых других значений возвращается 400." }, { "name": "reachable", "in": "query", "schema": { "type": "boolean" }, "description": "true: только VASP, до которых у вашего приложения есть доступный маршрут (включая участников сети Didit). false: только записи справочника, недоступные в настоящее время." }, { "name": "kind", "in": "query", "schema": { "type": "string", "enum": [ "directory", "didit" ] }, "description": "Только записи справочника или только участники сети Didit." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl 'https://verification.didit.me/v3/travel-rule/widget/{token}/vasps/?search=counterparty'" } ], "responses": { "200": { "description": "Результаты с пагинацией, отсортированные по названию.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/VaspDirectoryWidgetEntry" } } } } } } }, "400": { "description": "Недопустимый фильтр: в теле запроса указано каждое поле, например неизвестная сеть или код страны.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "example": { "jurisdiction": [ "Use an ISO 3166 alpha-2 or alpha-3 country code." ], "network": [ "\"SWIFT\" is not a valid choice." ] } } } }, "404": { "description": "Неизвестный token." }, "410": { "description": "Срок действия сессии истек." } } }, "post": { "summary": "Выбрать VASP контрагента в виджете кошелька", "description": "Публичный endpoint на запись с доступом по токену сессии виджета, API-ключ не требуется: конечный пользователь выбрал VASP назначения, который не удалось определить автоматически. Принимается только для исходящего перевода в статусах COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE или NOT_ENOUGH_COUNTERPARTY_DATA. Перевод маршрутизируется выбранному VASP и отправляется повторно; автоматическое определение никогда не перезаписывает этот выбор.", "operationId": "selectTravelRuleWidgetVasp", "x-didit-sdk": { "resource": "travel_rule", "method": "select_widget_vasp", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "description": "Непрозрачный токен сессии, возвращённый при создании сессии виджета.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "vasp" ], "properties": { "vasp": { "type": "string", "format": "uuid", "description": "`id` VASP из `GET /v3/travel-rule/widget/{token}/vasps/`." } } }, "example": { "vasp": "9f1c2b34-5d6e-4f70-8a91-b2c3d4e5f607" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/widget/{token}/vasps/ \\\n -H 'Content-Type: application/json' \\\n -d '{\"vasp\": \"9f1c2b34-5d6e-4f70-8a91-b2c3d4e5f607\"}'" } ], "responses": { "200": { "description": "Выбор зафиксирован, и перевод отправляется повторно.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "transfer_status": { "type": "string", "description": "Статус перевода после выбора." }, "counterparty_vasp": { "type": "string", "description": "Название VASP, выбранного конечным пользователем." } } }, "example": { "detail": "Counterparty VASP selected; the transfer is being resent.", "transfer_status": "AWAITING_COUNTERPARTY", "counterparty_vasp": "Northwind Exchange" } } } }, "400": { "description": "`vasp` отсутствует, либо ни одна действующая запись в каталоге не имеет такого id.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "example": { "vasp": [ "No directory entry has this id." ] } } } }, "404": { "description": "Неизвестный token." }, "409": { "description": "Сессия виджета не связана с переводом Travel Rule, либо перевод не является исходящим в статусе, допускающем контрагента." }, "410": { "description": "Срок действия сессии истек." } } } }, "/v3/organization/{organization_id}/application/{application_id}/vendor-users/toggle-ongoing-monitoring/": { "patch": { "summary": "Переключить постоянный AML-мониторинг для пользователей", "description": "Включает или отключает постоянный AML-мониторинг на уровне пользователя. Для каждого пользователя сохраняется ровно один отслеживаемый AML-скрининг; для пользователей без какого-либо AML-скрининга (например, импортированных пользователей) сначала создается и проводится скрининг, который тарифицируется как обычный AML-скрининг. Укажите estimate_only, чтобы предварительно просмотреть количество и затраты без записи изменений. Пакеты из 20 или менее элементов обрабатываются синхронно (200, COMPLETED); пакеты большего размера возвращают 202 и выполняются асинхронно.", "operationId": "toggle_vendor_users_ongoing_monitoring", "x-didit-sdk": { "resource": "users", "method": "set_ongoing_monitoring", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Users" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringToggleRequest" }, "example": { "is_enabled": true, "didit_internal_id_list": [ "5b9a0000-0000-4000-8000-00000000f00d" ] } } } }, "responses": { "200": { "description": "Предварительная оценка (при estimate_only) или завершённая задача для небольших пакетов, обработанных инлайн.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringToggleResult" } } } }, "202": { "description": "Более крупные пакеты обрабатываются асинхронно; опрашивайте endpoint задачи, используя полученный job_id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "403": { "description": "Отсутствует привилегия write:sessions или недостаточно баланса для включения (предварительный расчет включен в тело ошибки)." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.users.set_ongoing_monitoring(\n is_enabled=True,\n didit_internal_id_list=[\"5b9a0000-0000-4000-8000-00000000f00d\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.users.setOngoingMonitoring({\n is_enabled: true,\n didit_internal_id_list: [\"5b9a0000-0000-4000-8000-00000000f00d\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Users.SetOngoingMonitoring(ctx, didit.OngoingMonitoringToggleRequest{\n\tIsEnabled: true,\n\tDiditInternalIDList: didit.Some([]string{\"5b9a0000-0000-4000-8000-00000000f00d\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.OngoingMonitoringToggleRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.users().setOngoingMonitoring(OngoingMonitoringToggleRequest.builder()\n .isEnabled(true)\n .diditInternalIdList(List.of(\"5b9a0000-0000-4000-8000-00000000f00d\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "users->setOngoingMonitoring([\n 'is_enabled' => true,\n 'didit_internal_id_list' => ['5b9a0000-0000-4000-8000-00000000f00d'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.users.set_ongoing_monitoring(\n is_enabled: true,\n didit_internal_id_list: [\"5b9a0000-0000-4000-8000-00000000f00d\"]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Users.SetOngoingMonitoringAsync(new OngoingMonitoringToggleRequest\n{\n IsEnabled = true,\n DiditInternalIdList = new string[] { \"5b9a0000-0000-4000-8000-00000000f00d\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/vendor-users/toggle-ongoing-monitoring/{job_id}/": { "get": { "summary": "Получить задачу постоянного AML-мониторинга", "description": "Прогресс и счётчики по результатам задачи переключения мониторинга. Опрашивайте раз в пару секунд, пока статус остаётся PENDING или PROCESSING.", "operationId": "get_vendor_users_ongoing_monitoring_job", "x-didit-sdk": { "resource": "users", "method": "retrieve_ongoing_monitoring_job", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Users" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID задачи мониторинга, возвращенный endpoint переключения." } ], "responses": { "200": { "description": "Задание.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "404": { "description": "Неизвестная задача для этого приложения." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.users.retrieve_ongoing_monitoring_job(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.users.retrieveOngoingMonitoringJob(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Users.RetrieveOngoingMonitoringJob(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.users().retrieveOngoingMonitoringJob(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "users->retrieveOngoingMonitoringJob('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.users.retrieve_ongoing_monitoring_job(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Users.RetrieveOngoingMonitoringJobAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/vendor-businesses/toggle-ongoing-monitoring/": { "patch": { "summary": "Переключить постоянный AML-мониторинг для компаний", "description": "Эквивалент пользовательского переключателя на уровне компании: один отслеживаемый AML-скрининг на компанию, при этом компании без какого-либо AML-скрининга проверяются первыми (юридическое лицо). Тот же контракт estimate_only, быстрого синхронного выполнения и асинхронной задачи.", "operationId": "toggle_vendor_businesses_ongoing_monitoring", "x-didit-sdk": { "resource": "businesses", "method": "set_ongoing_monitoring", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Businesses" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringToggleRequest" }, "example": { "is_enabled": true, "didit_internal_id_list": [ "b0000000-0000-4000-8000-0000000000b1" ] } } } }, "responses": { "200": { "description": "Предварительная оценка (при estimate_only) или завершённая задача для небольших пакетов, обработанных инлайн.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringToggleResult" } } } }, "202": { "description": "Более крупные пакеты обрабатываются асинхронно; опрашивайте endpoint задачи, используя полученный job_id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "403": { "description": "Отсутствует привилегия write:sessions или недостаточно баланса для включения (предварительный расчет включен в тело ошибки)." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.businesses.set_ongoing_monitoring(\n is_enabled=True,\n didit_internal_id_list=[\"b0000000-0000-4000-8000-0000000000b1\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.businesses.setOngoingMonitoring({\n is_enabled: true,\n didit_internal_id_list: [\"b0000000-0000-4000-8000-0000000000b1\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.SetOngoingMonitoring(ctx, didit.OngoingMonitoringToggleRequest{\n\tIsEnabled: true,\n\tDiditInternalIDList: didit.Some([]string{\"b0000000-0000-4000-8000-0000000000b1\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.OngoingMonitoringToggleRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.businesses().setOngoingMonitoring(OngoingMonitoringToggleRequest.builder()\n .isEnabled(true)\n .diditInternalIdList(List.of(\"b0000000-0000-4000-8000-0000000000b1\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->setOngoingMonitoring([\n 'is_enabled' => true,\n 'didit_internal_id_list' => ['b0000000-0000-4000-8000-0000000000b1'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.businesses.set_ongoing_monitoring(\n is_enabled: true,\n didit_internal_id_list: [\"b0000000-0000-4000-8000-0000000000b1\"]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.SetOngoingMonitoringAsync(new OngoingMonitoringToggleRequest\n{\n IsEnabled = true,\n DiditInternalIdList = new string[] { \"b0000000-0000-4000-8000-0000000000b1\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/vendor-businesses/toggle-ongoing-monitoring/{job_id}/": { "get": { "summary": "Получить задачу постоянного AML-мониторинга", "description": "Прогресс и счётчики по результатам задачи переключения мониторинга. Опрашивайте раз в пару секунд, пока статус остаётся PENDING или PROCESSING.", "operationId": "get_vendor_businesses_ongoing_monitoring_job", "x-didit-sdk": { "resource": "businesses", "method": "retrieve_ongoing_monitoring_job", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Businesses" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID задачи мониторинга, возвращенный endpoint переключения." } ], "responses": { "200": { "description": "Задание.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "404": { "description": "Неизвестная задача для этого приложения." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.businesses.retrieve_ongoing_monitoring_job(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.businesses.retrieveOngoingMonitoringJob(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.RetrieveOngoingMonitoringJob(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.businesses().retrieveOngoingMonitoringJob(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->retrieveOngoingMonitoringJob('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.businesses.retrieve_ongoing_monitoring_job(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.RetrieveOngoingMonitoringJobAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/businesses/toggle-ongoing-monitoring/": { "patch": { "summary": "Переключить постоянный AML-мониторинг для бизнес-сессий", "description": "Переключатель на уровне сессии для верификаций KYB, доступный по номеру сессии. Для сессий без AML-скрининга он создаётся и прикрепляется к самой сессии. Тот же контракт с estimate_only, быстрым синхронным путём и асинхронными задачами, что и у endpoint'ов на уровне пользователя. Заменяет устаревшее синхронное поведение, при котором сессии без AML-скрининга пропускались.", "operationId": "toggle_business_sessions_ongoing_monitoring", "x-didit-sdk": { "resource": "businesses", "method": "set_session_ongoing_monitoring", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Businesses" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "is_enabled" ], "properties": { "is_enabled": { "type": "boolean", "description": "true для включения мониторинга, false для его отключения." }, "estimate_only": { "type": "boolean", "default": false, "description": "Если true, возвращает предварительную оценку стоимости и не выполняет операций записи." }, "update_all": { "type": "boolean", "default": false, "description": "Применить ко всем сущностям приложения (с учётом параметров filter_*, если они переданы)." }, "filter_search": { "type": "string" }, "filter_status": { "type": "array", "items": { "type": "string" } }, "filter_country": { "type": "string" }, "filter_date_from": { "type": "string", "format": "date" }, "filter_date_to": { "type": "string", "format": "date" }, "session_numbers": { "type": "array", "items": { "type": "string" }, "description": "Номера сессий компаний для переключения. Обязательно, если update_all (или устаревший псевдоним toggle_all) не равен true." }, "toggle_all": { "type": "boolean", "default": false, "description": "Устаревший псевдоним update_all." }, "filter_workflow_id": { "type": "string" } } }, "example": { "is_enabled": true, "session_numbers": [ "1001", "1002" ] } } } }, "responses": { "200": { "description": "Предварительная оценка (при estimate_only) или завершённая задача для небольших пакетов, обработанных инлайн.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringToggleResult" } } } }, "202": { "description": "Более крупные пакеты обрабатываются асинхронно; опрашивайте endpoint задачи, используя полученный job_id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "403": { "description": "Отсутствует привилегия write:sessions или недостаточно баланса для включения (предварительный расчет включен в тело ошибки)." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.businesses.set_session_ongoing_monitoring(\n is_enabled=True,\n session_numbers=[\"1001\", \"1002\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.businesses.setSessionOngoingMonitoring({\n is_enabled: true,\n session_numbers: [\"1001\", \"1002\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.SetSessionOngoingMonitoring(ctx, didit.BusinessesSetSessionOngoingMonitoringParams{\n\tIsEnabled: true,\n\tSessionNumbers: didit.Some([]string{\"1001\", \"1002\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.BusinessesSetSessionOngoingMonitoringParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.businesses().setSessionOngoingMonitoring(BusinessesSetSessionOngoingMonitoringParams.builder()\n .isEnabled(true)\n .sessionNumbers(List.of(\"1001\", \"1002\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->setSessionOngoingMonitoring([\n 'is_enabled' => true,\n 'session_numbers' => ['1001', '1002'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.businesses.set_session_ongoing_monitoring(\n is_enabled: true,\n session_numbers: [\"1001\", \"1002\"]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.SetSessionOngoingMonitoringAsync(new BusinessesSetSessionOngoingMonitoringParams\n{\n IsEnabled = true,\n SessionNumbers = new string[] { \"1001\", \"1002\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/businesses/toggle-ongoing-monitoring/{job_id}/": { "get": { "summary": "Получить задачу постоянного AML-мониторинга", "description": "Прогресс и счётчики по результатам задачи переключения мониторинга. Опрашивайте раз в пару секунд, пока статус остаётся PENDING или PROCESSING.", "operationId": "get_business_sessions_ongoing_monitoring_job", "x-didit-sdk": { "resource": "businesses", "method": "retrieve_session_ongoing_monitoring_job", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Businesses" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID задачи мониторинга, возвращенный endpoint переключения." } ], "responses": { "200": { "description": "Задание.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "404": { "description": "Неизвестная задача для этого приложения." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.businesses.retrieve_session_ongoing_monitoring_job(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.businesses.retrieveSessionOngoingMonitoringJob(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.RetrieveSessionOngoingMonitoringJob(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.businesses().retrieveSessionOngoingMonitoringJob(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->retrieveSessionOngoingMonitoringJob('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.businesses.retrieve_session_ongoing_monitoring_job(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.RetrieveSessionOngoingMonitoringJobAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/": { "get": { "summary": "Получить список кейсов", "description": "Получить список кейсов для приложения, сначала новые. Поддерживает фильтрацию, поиск и сортировку; см. параметры запроса. С пагинацией через `limit`/`offset`.", "operationId": "list_cases", "x-didit-sdk": { "resource": "cases", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Размер страницы. По умолчанию 50." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Смещение первой записи, начиная с нуля." }, { "name": "status__in", "in": "query", "schema": { "type": "string" }, "description": "Разделённый запятыми список статусов для включения, например OPEN,AWAITING_USER." }, { "name": "priority", "in": "query", "schema": { "type": "string" }, "description": "Разделённый запятыми список приоритетов для включения." }, { "name": "source__in", "in": "query", "schema": { "type": "string" }, "description": "Разделённый запятыми список источников для включения." }, { "name": "blueprint", "in": "query", "schema": { "type": "string", "format": "uuid" }, "description": "Фильтровать по кейсам в этом blueprint." }, { "name": "assigned_to", "in": "query", "schema": { "type": "string", "format": "uuid" }, "description": "Фильтровать по кейсам, назначенным этому пользователю." }, { "name": "unassigned", "in": "query", "schema": { "type": "boolean" }, "description": "true для неназначенных кейсов, false для назначенных кейсов." }, { "name": "tag", "in": "query", "schema": { "type": "string" }, "description": "Фильтровать по кейсам с этим точным тегом." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Поиск совпадений по title, case_number, tag, имени/UUID/внешнему ID субъекта, UUID связанной сессии или UUID связанной транзакции." }, { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Нижняя граница даты создания (включительно)." }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Верхняя граница даты создания (включительно)." }, { "name": "due_before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Верхняя граница due_at." }, { "name": "overdue", "in": "query", "schema": { "type": "boolean" }, "description": "true для возврата только просроченных кейсов со статусом open/awaiting-user." }, { "name": "ordering", "in": "query", "schema": { "type": "string", "enum": [ "created_at", "-created_at", "due_at", "-due_at" ], "default": "-created_at" }, "description": "Порядок сортировки. При сортировке по due_at значения null помещаются в конец." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/?status__in=OPEN,AWAITING_USER&ordering=-due_at' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.ListAutoPaging(ctx, didit.CasesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Список кейсов с пагинацией.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Количество совпадающих строк. Точное значение до 100, с ограничением 100 выше этого порога для повышения производительности. Чтобы определить последнюю страницу, ориентируйтесь на значение `next`, равное null." }, "next": { "type": "string", "nullable": true, "description": "Абсолютный URL следующей страницы или null." }, "previous": { "type": "string", "nullable": true, "description": "Абсолютный URL предыдущей страницы или null." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseListItem" } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Создать кейс", "description": "Создайте кейс, привязанный ровно к одному субъекту (пользователю или компании), напрямую либо определив субъект по прикреплённой ссылке на сессию или транзакцию. Для кейсов, созданных через API, источник всегда имеет значение `MANUAL`.", "operationId": "create_case", "x-didit-sdk": { "resource": "cases", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "title" ], "properties": { "title": { "type": "string", "maxLength": 255 }, "blueprint": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID CaseBlueprint. Опустите, чтобы не использовать шаблон." }, "priority": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ], "default": "MEDIUM" }, "due_at": { "type": "string", "format": "date-time", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" } }, "subject": { "type": "object", "description": "Обязательно, если не передан links; ровно один субъект кейса.", "properties": { "type": { "type": "string", "enum": [ "user", "business" ] }, "uuid": { "type": "string", "format": "uuid" } } }, "links": { "type": "array", "description": "Сессии/бизнес-сессии/транзакции для прикрепления при создании, например [{\"entity_type\": \"transaction\", \"entity_uuid\": \"...\"}]. Если субъект не указан, он определяется по владельцу первой привязки.", "items": { "type": "object" } }, "assigned_to": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID пользователя для немедленного назначения." }, "review_duplicates": { "type": "boolean", "default": false, "description": "Повторно проверять существующие расследования перед созданием кейса. Если указано true, для субъекта с существующими кейсами требуется непустой separate_incident_reason. Консоль всегда включает эту защиту. Если опустить этот параметр, сохраняется текущее поведение API." }, "separate_incident_reason": { "type": "string", "maxLength": 1000 }, "source_context": { "$ref": "#/components/schemas/CaseDuplicateCaseFraudSourceContextRequest" } } }, "example": { "title": "Manual - Jane Doe", "blueprint": "b1de0000-0000-4000-8000-000000000002", "priority": "HIGH", "subject": { "type": "user", "uuid": "5b9a0000-0000-4000-8000-00000000f00d" }, "tags": [ "review" ] } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"title\": \"Manual - Jane Doe\", \"blueprint\": \"b1de0000-0000-4000-8000-000000000002\", \"priority\": \"HIGH\", \"subject\": {\"type\": \"user\", \"uuid\": \"5b9a0000-0000-4000-8000-00000000f00d\"}, \"tags\": [\"review\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.create(\n title=\"Manual - Jane Doe\",\n blueprint=\"b1de0000-0000-4000-8000-000000000002\",\n priority=\"HIGH\",\n tags=[\"review\"],\n subject={\n \"type\": \"user\",\n \"uuid\": \"5b9a0000-0000-4000-8000-00000000f00d\",\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.create({\n title: \"Manual - Jane Doe\",\n blueprint: \"b1de0000-0000-4000-8000-000000000002\",\n priority: \"HIGH\",\n tags: [\"review\"],\n subject: {\n type: \"user\",\n uuid: \"5b9a0000-0000-4000-8000-00000000f00d\",\n },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Create(ctx, didit.CasesCreateParams{\n\tTitle: \"Manual - Jane Doe\",\n\tBlueprint: didit.String(\"b1de0000-0000-4000-8000-000000000002\"),\n\tPriority: didit.Some(didit.CasesCreateParamsPriority(\"HIGH\")),\n\tTags: didit.Some([]string{\"review\"}),\n\tSubject: didit.Some(didit.CasesCreateParamsSubject{\n\t\tType: didit.Some(didit.CasesCreateParamsSubjectType(\"user\")),\n\t\tUUID: didit.String(\"5b9a0000-0000-4000-8000-00000000f00d\"),\n\t}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CasesCreateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().create(CasesCreateParams.builder()\n .title(\"Manual - Jane Doe\")\n .blueprint(\"b1de0000-0000-4000-8000-000000000002\")\n .priority(CasesCreateParams.Priority.of(\"HIGH\"))\n .tags(List.of(\"review\"))\n .subject(CasesCreateParams.Subject.builder()\n .type(CasesCreateParams.Subject.Type.of(\"user\"))\n .uuid(\"5b9a0000-0000-4000-8000-00000000f00d\")\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->create([\n 'title' => 'Manual - Jane Doe',\n 'blueprint' => 'b1de0000-0000-4000-8000-000000000002',\n 'priority' => 'HIGH',\n 'tags' => ['review'],\n 'subject' => [\n 'type' => 'user',\n 'uuid' => '5b9a0000-0000-4000-8000-00000000f00d',\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.create(\n title: \"Manual - Jane Doe\",\n blueprint: \"b1de0000-0000-4000-8000-000000000002\",\n priority: \"HIGH\",\n tags: [\"review\"],\n subject: {\n type: \"user\",\n uuid: \"5b9a0000-0000-4000-8000-00000000f00d\",\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.CreateAsync(new CasesCreateParams\n{\n Title = \"Manual - Jane Doe\",\n Blueprint = \"b1de0000-0000-4000-8000-000000000002\",\n Priority = new CasesCreateParamsPriority(\"HIGH\"),\n Tags = new string[] { \"review\" },\n Subject = new CasesCreateParamsSubject\n {\n Type = new CasesCreateParamsSubjectType(\"user\"),\n Uuid = \"5b9a0000-0000-4000-8000-00000000f00d\",\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Кейс создан.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "400": { "description": "Не указаны ни subject, ни links, либо субъект/blueprint/ответственный не найден.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Проверка на дубликаты включена, и был найден существующий кейс без причины отдельного инцидента. Кейс не был создан." } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/": { "get": { "summary": "Получить кейс", "description": "Получите кейс с его субъектом, шаблоном, примечаниями, событиями, ссылками и чеклистом.", "operationId": "get_case", "x-didit-sdk": { "resource": "cases", "method": "retrieve", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID кейса." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.retrieve(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.retrieve(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Retrieve(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().retrieve(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->retrieve('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.retrieve(\"c1a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RetrieveAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Детали кейса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "404": { "description": "Кейс (или вложенный ресурс) не найден в этом приложении.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Обновить кейс", "description": "Обновить заголовок, приоритет, срок исполнения, теги или назначенную команду проверяющих для кейса. Передавайте только те поля, которые хотите изменить; пропущенные поля сохранят свои значения. Поле `tags` полностью заменяет текущий список тегов. В поле `team` передаётся UUID активной команды проверяющих данного приложения (получите список с помощью `GET .../cases/teams/`) или null для отвязки команды. Требуется API-ключ с полным доступом либо право `write:cases` для участника консоли; ключ с ограниченным доступом вернёт 403. При наличии изменений фиксируются события PRIORITY_CHANGED, DUE_DATE_CHANGED, TAG_ADDED, TAG_REMOVED и TEAM_CHANGED; изменение заголовка сохраняется без создания события на таймлайне. Возвращает обновлённый кейс.", "operationId": "update_case", "x-didit-sdk": { "resource": "cases", "method": "update", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID кейса." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 255, "description": "Новый заголовок кейса." }, "priority": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "due_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Новый крайний срок. Передайте null, чтобы очистить его." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Полный список тегов. Он заменяет текущие теги." }, "team": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID команды проверки, ведущей кейс. Это должна быть активная команда данного приложения. Передайте null, чтобы убрать команду." } } }, "examples": { "Change priority and deadline": { "value": { "priority": "HIGH", "due_at": "2026-11-01T00:00:00Z" } }, "Move the case to a team": { "value": { "team": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "Clear the team": { "value": { "team": null } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"priority\": \"HIGH\", \"due_at\": \"2026-08-01T00:00:00Z\"}'" }, { "lang": "curl", "label": "curl (change team)", "source": "curl -X PATCH 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"team\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.update(\n \"c1a5e000-0000-4000-8000-000000000001\",\n priority=\"HIGH\",\n due_at=\"2026-11-01T00:00:00Z\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.update(\"c1a5e000-0000-4000-8000-000000000001\", {\n priority: \"HIGH\",\n due_at: \"2026-11-01T00:00:00Z\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Update(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesUpdateParams{\n\tPriority: didit.Some(didit.CasesUpdateParamsPriority(\"HIGH\")),\n\tDueAt: didit.Time(time.Date(2026, 11, 1, 0, 0, 0, 0, time.UTC)),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.OffsetDateTime;\nimport me.didit.Didit;\nimport me.didit.types.CasesUpdateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().update(\"c1a5e000-0000-4000-8000-000000000001\", CasesUpdateParams.builder()\n .priority(CasesUpdateParams.Priority.of(\"HIGH\"))\n .dueAt(OffsetDateTime.parse(\"2026-11-01T00:00:00Z\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->update('c1a5e000-0000-4000-8000-000000000001', [\n 'priority' => 'HIGH',\n 'due_at' => '2026-11-01T00:00:00Z',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.update(\n \"c1a5e000-0000-4000-8000-000000000001\",\n priority: \"HIGH\",\n due_at: \"2026-11-01T00:00:00Z\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.UpdateAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesUpdateParams\n{\n Priority = new CasesUpdateParamsPriority(\"HIGH\"),\n DueAt = DateTimeOffset.Parse(\"2026-11-01T00:00:00Z\"),\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Обновлённый кейс.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "400": { "description": "Поле не прошло валидацию. В теле ответа ключами служат имена полей. Значение `team` отклоняется, если оно не является активной командой проверки этого приложения.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "examples": { "Team not active in this application": { "value": { "team": [ "Choose an active team of this application." ] } }, "Invalid priority": { "value": { "priority": [ "\"URGENT\" is not a valid choice." ] } } } } } }, "403": { "description": "API-ключ принадлежит другому приложению или имеет ограниченный доступ: для endpoint’ов раздела Cases требуется ключ с полным доступом. Для токена участника консоли требуется `write:cases`.", "content": { "application/json": { "examples": { "Restricted API Key": { "summary": "API-ключ с ограниченным доступом", "value": { "detail": "This API key has no access to this endpoint." } }, "Missing Privilege": { "summary": "Участник Console без write:cases или ключ другого приложения", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Кейс не найден в этом приложении.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No Case matches the given query." } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "summary": "Удалить кейс", "description": "Удалить кейс навсегда. Черновики регуляторных отчетов удаляются вместе с ним. Связанные верификации, люди, компании и транзакции не удаляются. Endpoint для отмены удаления отсутствует.\n\nЕсли кейс содержит финализированный регуляторный отчет, весь запрос отклоняется с кодом `409`, и ничего не удаляется. В теле ответа используется `code: in_filed_report`, а также указывается каждый отчет с полями `uuid`, `report_number`, `report_type` и `case_uuid`. Удалите эти отчеты, затем повторите запрос.", "operationId": "delete_case", "x-didit-sdk": { "resource": "cases", "method": "delete", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID кейса." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nclient.cases.delete(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nawait didit.cases.delete(\"c1a5e000-0000-4000-8000-000000000001\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nif err := client.Cases.Delete(ctx, \"c1a5e000-0000-4000-8000-000000000001\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.cases().delete(\"c1a5e000-0000-4000-8000-000000000001\");" }, { "lang": "php", "label": "PHP", "source": "cases->delete('c1a5e000-0000-4000-8000-000000000001');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.delete(\"c1a5e000-0000-4000-8000-000000000001\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait client.Cases.DeleteAsync(\"c1a5e000-0000-4000-8000-000000000001\");" } ], "responses": { "204": { "description": "Кейс удалён." }, "403": { "description": "Ключ не может удалять кейсы. Требуется ключ с полным доступом и разрешением `write:cases`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "404": { "description": "Кейс не существует в этом приложении или уже был удалён.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "409": { "description": "У кейса есть окончательно сформированный регуляторный отчёт. Ничего не удалено.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InFiledReportError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/assign/": { "post": { "summary": "Назначить или снять назначение кейса", "description": "Назначить кейс пользователю или снять назначение, передав assignee_user_id: null. Параметры assignee_email/assignee_name автоматически создают запись User, если исполнитель ещё не существует.", "operationId": "assign_case", "x-didit-sdk": { "resource": "cases", "method": "assign", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID кейса." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "assignee_user_id" ], "properties": { "assignee_user_id": { "type": "string", "format": "uuid", "nullable": true, "description": "null для снятия назначения." }, "assignee_email": { "type": "string", "format": "email", "nullable": true }, "assignee_name": { "type": "string", "nullable": true } } }, "example": { "assignee_user_id": "9a000000-0000-4000-8000-0000000000aa" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/assign/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"assignee_user_id\": \"9a000000-0000-4000-8000-0000000000aa\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.assign(\n \"c1a5e000-0000-4000-8000-000000000001\",\n assignee_user_id=\"9a000000-0000-4000-8000-0000000000aa\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.assign(\"c1a5e000-0000-4000-8000-000000000001\", {\n assignee_user_id: \"9a000000-0000-4000-8000-0000000000aa\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Assign(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesAssignParams{\n\tAssigneeUserID: didit.String(\"9a000000-0000-4000-8000-0000000000aa\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesAssignParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().assign(\"c1a5e000-0000-4000-8000-000000000001\", CasesAssignParams.builder()\n .assigneeUserId(\"9a000000-0000-4000-8000-0000000000aa\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->assign('c1a5e000-0000-4000-8000-000000000001', [\n 'assignee_user_id' => '9a000000-0000-4000-8000-0000000000aa',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.assign(\n \"c1a5e000-0000-4000-8000-000000000001\",\n assignee_user_id: \"9a000000-0000-4000-8000-0000000000aa\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.AssignAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesAssignParams\n{\n AssigneeUserId = \"9a000000-0000-4000-8000-0000000000aa\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Кейс назначен/назначение отменено.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/resolve/": { "post": { "summary": "Разрешить кейс", "description": "Завершите кейс одним из пяти решений: FALSE_POSITIVE (проблема не обнаружена), VALID_THREAT (проблема подтверждена), INCONCLUSIVE, REQUIREMENTS_NOT_MET или REQUIREMENTS_SATISFIED. Блокируется с ошибкой 400, если чеклист шаблона не является необязательным и пункты остаются незавершенными, или если шаблон требует примечание к решению, но оно не указано. Когда в шаблоне кейса настроен шаг проверки «четырех глаз» (four_eyes_checker_blueprint), решение переводится в отложенное состояние (case.pending_resolution), и кейс переходит к шаблону проверяющего вместо немедленного завершения; другой сотрудник должен вызвать approve или reject-approval. Отправляйте решение по принципу «четырех глаз» от имени участника консоли: у решения, отправленного через API-ключ, нет зафиксированного инициатора, поэтому approve и reject-approval вернут 403 для любого вызывающего. В шаблоне с принципом «четырех глаз» вы можете указать участника, который должен утвердить решение, с помощью `checker`: тогда только этот участник сможет утвердить или отклонить решение, а в поле `checker` ответа будет указано его имя. Без параметра `checker` решение ожидает в очереди шаблона проверяющего. Отправка `checker` для шаблона без шага проверки возвращает 400.", "operationId": "resolve_case", "x-didit-sdk": { "resource": "cases", "method": "resolve", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID кейса." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "resolution" ], "properties": { "resolution": { "type": "string", "enum": [ "FALSE_POSITIVE", "VALID_THREAT", "INCONCLUSIVE", "REQUIREMENTS_NOT_MET", "REQUIREMENTS_SATISFIED" ] }, "note": { "type": "string", "nullable": true, "description": "Обязательно, когда blueprint задаёт require_resolution_note." }, "checker": { "type": "string", "format": "uuid", "nullable": true, "description": "Только для схем «принципа четырёх глаз». UUID пользователя-участника, который должен утвердить это решение (тот же id, что и `assigned_to.uuid` в кейсе, или `members[].user_id` в команде проверки). Участник должен иметь доступ к кейсам этого приложения и не может быть офицером, отправляющим решение. Опустите это поле или передайте null, чтобы оставить решение в очереди проверяющих." } } }, "examples": { "Resolve": { "value": { "resolution": "FALSE_POSITIVE", "note": "Confirmed legitimate activity after reviewing documents." } }, "Four-eyes blueprint with a named checker": { "value": { "resolution": "VALID_THREAT", "note": "Document tampering confirmed.", "checker": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/resolve/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"resolution\": \"FALSE_POSITIVE\", \"note\": \"Confirmed legitimate activity after reviewing documents.\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.resolve(\n \"c1a5e000-0000-4000-8000-000000000001\",\n resolution=\"FALSE_POSITIVE\",\n note=\"Confirmed legitimate activity after reviewing documents.\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.resolve(\"c1a5e000-0000-4000-8000-000000000001\", {\n resolution: \"FALSE_POSITIVE\",\n note: \"Confirmed legitimate activity after reviewing documents.\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Resolve(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesResolveParams{\n\tResolution: \"FALSE_POSITIVE\",\n\tNote: didit.String(\"Confirmed legitimate activity after reviewing documents.\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesResolveParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().resolve(\"c1a5e000-0000-4000-8000-000000000001\", CasesResolveParams.builder()\n .resolution(CasesResolveParams.Resolution.of(\"FALSE_POSITIVE\"))\n .note(\"Confirmed legitimate activity after reviewing documents.\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->resolve('c1a5e000-0000-4000-8000-000000000001', [\n 'resolution' => 'FALSE_POSITIVE',\n 'note' => 'Confirmed legitimate activity after reviewing documents.',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.resolve(\n \"c1a5e000-0000-4000-8000-000000000001\",\n resolution: \"FALSE_POSITIVE\",\n note: \"Confirmed legitimate activity after reviewing documents.\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.ResolveAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesResolveParams\n{\n Resolution = \"FALSE_POSITIVE\",\n Note = \"Confirmed legitimate activity after reviewing documents.\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Завершен или переведен в отложенное состояние для утверждения по принципу «четырех глаз».", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "400": { "description": "Резолюция была отклонена. Ошибки, не связанные с конкретными полями, возвращаются в виде списка строк: незаполненный чек-лист, отсутствие обязательного примечания или `checker`, которого не удалось проверить либо который не является активным проверяющим с доступом к кейсам этого приложения. Ошибки `checker` возвращаются с привязкой к полю: указанный участник является офицером, отправляющим резолюцию, либо в схеме кейса отсутствует шаг проверяющего.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } ] }, "examples": { "Incomplete checklist": { "value": [ "Case has incomplete checklist items: Verify source of funds" ] }, "Resolution note required": { "value": [ "A resolution note is required to resolve this case." ] }, "Reviewer access could not be verified": { "value": [ "Reviewer access could not be verified. Try again." ] }, "Checker is not an active reviewer": { "value": [ "Choose an active reviewer with case access to this application." ] }, "Checker is the submitting officer": { "value": { "checker": [ "The officer who submitted the resolution cannot be its checker." ] } }, "Policy has no checker step": { "value": { "checker": [ "This review policy has no checker step, so the case resolves directly." ] } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/reopen/": { "post": { "summary": "Повторно открыть кейс", "description": "Перевести кейс в статусе awaiting_user или решённый кейс обратно в открытый статус, очистив resolution, resolution_notes, resolved_at и resolved_by_email.", "operationId": "reopen_case", "x-didit-sdk": { "resource": "cases", "method": "reopen", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID кейса." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/reopen/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.reopen(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.reopen(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Reopen(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().reopen(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->reopen('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.reopen(\"c1a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.ReopenAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Повторно открыть кейс.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/request-info/": { "post": { "summary": "Запрос информации (ожидание пользователя)", "description": "Перевести открытый кейс в статус awaiting_user на время сбора дополнительной информации от верифицированного пользователя. Завершается с ошибкой 400, если текущее решение ожидает одобрения по принципу четырёх глаз.", "operationId": "request_case_info", "x-didit-sdk": { "resource": "cases", "method": "request_info", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID кейса." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/request-info/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.request_info(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.requestInfo(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RequestInfo(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().requestInfo(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->requestInfo('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.request_info(\"c1a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RequestInfoAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Запрос информации (ожидание пользователя).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/escalate/": { "post": { "summary": "Эскалировать кейс", "description": "Переместить кейс в escalation_blueprint, настроенный для его шаблона. Требует, чтобы в текущем шаблоне был включён escalation_enabled и задан escalation_blueprint, иначе возвращается 400.", "operationId": "escalate_case", "x-didit-sdk": { "resource": "cases", "method": "escalate", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID кейса." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/escalate/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.escalate(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.escalate(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Escalate(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().escalate(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->escalate('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.escalate(\"c1a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.EscalateAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Эскалировать кейс.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/transfer/": { "post": { "summary": "Передать кейс", "description": "Переместить кейс в другой активный шаблон того же приложения. Требует, чтобы в текущем шаблоне был включён transfer_enabled, иначе возвращается 400.", "operationId": "transfer_case", "x-didit-sdk": { "resource": "cases", "method": "transfer", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID кейса." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "target_blueprint" ], "properties": { "target_blueprint": { "type": "string", "format": "uuid" } } }, "example": { "target_blueprint": "b1de0000-0000-4000-8000-000000000002" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/transfer/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"target_blueprint\": \"b1de0000-0000-4000-8000-000000000002\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.transfer(\n \"c1a5e000-0000-4000-8000-000000000001\",\n target_blueprint=\"b1de0000-0000-4000-8000-000000000002\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.transfer(\"c1a5e000-0000-4000-8000-000000000001\", {\n target_blueprint: \"b1de0000-0000-4000-8000-000000000002\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Transfer(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesTransferParams{\n\tTargetBlueprint: \"b1de0000-0000-4000-8000-000000000002\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesTransferParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().transfer(\"c1a5e000-0000-4000-8000-000000000001\", CasesTransferParams.builder()\n .targetBlueprint(\"b1de0000-0000-4000-8000-000000000002\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->transfer('c1a5e000-0000-4000-8000-000000000001', [\n 'target_blueprint' => 'b1de0000-0000-4000-8000-000000000002',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.transfer(\n \"c1a5e000-0000-4000-8000-000000000001\",\n target_blueprint: \"b1de0000-0000-4000-8000-000000000002\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.TransferAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesTransferParams\n{\n TargetBlueprint = \"b1de0000-0000-4000-8000-000000000002\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Кейс перенесён.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/approve/": { "post": { "summary": "Одобрить подготовленное решение (принцип четырёх глаз)", "description": "Применяет решение, подготовленное с помощью resolve в рамках шаблона «принципа четырёх глаз». Вызывающий сотрудник должен отличаться от того, кто отправил решение, иначе возвращается 403. Если в решении указан проверяющий (`checker` кейса), только этот участник может его одобрить: любой другой вызывающий субъект, включая API-ключ, получает 403.", "operationId": "approve_case_resolution", "x-didit-sdk": { "resource": "cases", "method": "approve_resolution", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID кейса." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/approve/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.approve_resolution(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.approveResolution(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.ApproveResolution(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().approveResolution(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->approveResolution('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.approve_resolution(\"c1a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.ApproveResolutionAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Решение применено.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "409": { "description": "У кейса нет резолюции, ожидающей утверждения.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "403": { "description": "Вызывающая сторона не может утвердить это решение: она его отправила, у кейса нет записанного создателя, либо в решении указан другой проверяющий. API-ключ всегда получает этот статус 403, если указан проверяющий.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Caller submitted the resolution": { "value": { "detail": "The officer who submitted the resolution cannot approve it." } }, "No recorded maker": { "value": { "detail": "Case has no recorded maker for this pending resolution; approve is not permitted." } }, "Caller is not the named checker": { "value": { "detail": "Only the named checker can approve this resolution." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/reject-approval/": { "post": { "summary": "Отклонить подготовленное решение (4-eyes)", "description": "Отклонить решение, подготовленное на этапе resolve, и вернуть кейс к его шаблону maker. Вызывающим должен быть другой сотрудник, отличный от отправившего его, иначе возвращается 403. Если в решении указан проверяющий (`checker` кейса), только этот участник может отклонить его: любой другой вызывающий, включая API-ключ, получит 403.", "operationId": "reject_case_resolution", "x-didit-sdk": { "resource": "cases", "method": "reject_resolution", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID кейса." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string", "nullable": true } } }, "example": { "notes": "Needs a clearer rationale before this can be approved." } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/reject-approval/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"notes\": \"Needs a clearer rationale before this can be approved.\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.reject_resolution(\n \"c1a5e000-0000-4000-8000-000000000001\",\n notes=\"Needs a clearer rationale before this can be approved.\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.rejectResolution(\"c1a5e000-0000-4000-8000-000000000001\", {\n notes: \"Needs a clearer rationale before this can be approved.\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RejectResolution(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesRejectResolutionParams{\n\tNotes: didit.String(\"Needs a clearer rationale before this can be approved.\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesRejectResolutionParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().rejectResolution(\"c1a5e000-0000-4000-8000-000000000001\", CasesRejectResolutionParams.builder()\n .notes(\"Needs a clearer rationale before this can be approved.\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->rejectResolution('c1a5e000-0000-4000-8000-000000000001', [\n 'notes' => 'Needs a clearer rationale before this can be approved.',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.reject_resolution(\n \"c1a5e000-0000-4000-8000-000000000001\",\n notes: \"Needs a clearer rationale before this can be approved.\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RejectResolutionAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesRejectResolutionParams\n{\n Notes = \"Needs a clearer rationale before this can be approved.\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Решение отклонено, кейс возвращён к шаблону инициатора.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "409": { "description": "У кейса нет резолюции, ожидающей утверждения.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "403": { "description": "Вызывающая сторона не может отклонить это решение: она его отправила, у кейса нет записанного создателя, либо в решении указан другой проверяющий. API-ключ всегда получает этот статус 403, если указан проверяющий.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Caller submitted the resolution": { "value": { "detail": "The officer who submitted the resolution cannot reject it." } }, "No recorded maker": { "value": { "detail": "Case has no recorded maker for this pending resolution; reject is not permitted." } }, "Caller is not the named checker": { "value": { "detail": "Only the named checker can reject this resolution." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/entity-actions/": { "post": { "operationId": "apply_case_entity_action", "x-didit-sdk": { "resource": "cases", "method": "apply_entity_action", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CaseActionCaseEntityActionRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CaseActionCaseEntityActionRequest" }, "example": { "client_reference": "e1a00000-0000-4000-8000-000000000001", "action": "add_tags", "tags": [ "source-of-funds-reviewed" ] } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CaseActionCaseEntityActionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseActionCaseEntityActionResult" } } }, "description": "" }, "409": { "description": "Ссылка относится к payload другого действия." } }, "security": [ { "ApiKeyAuth": [] } ], "description": "Применяет одно явное действие к субъекту кейса. Передайте уникальный client_reference, чтобы получить квитанцию действия и обеспечить идемпотентность повторных попыток. Повторное использование этого идентификатора с другим payload возвращает 409. При использовании reference проверяйте receipt.status, даже если HTTP-статус равен 200: значение FAILED означает, что действие не было применено. Повторная отправка неудавшегося запроса не выполняет его заново, если retry не равен true. Если client_reference не указан, возвращается устаревший формат ответа.", "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.apply_entity_action(\n \"11111111-2222-3333-4444-555555555555\",\n client_reference=\"e1a00000-0000-4000-8000-000000000001\",\n action=\"add_tags\",\n tags=[\"source-of-funds-reviewed\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.applyEntityAction(\"11111111-2222-3333-4444-555555555555\", {\n client_reference: \"e1a00000-0000-4000-8000-000000000001\",\n action: \"add_tags\",\n tags: [\"source-of-funds-reviewed\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.ApplyEntityAction(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CaseActionCaseEntityActionRequest{\n\tClientReference: didit.String(\"e1a00000-0000-4000-8000-000000000001\"),\n\tAction: didit.CaseActionActionEnum(\"add_tags\"),\n\tTags: didit.Some([]string{\"source-of-funds-reviewed\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CaseActionActionEnum;\nimport me.didit.types.CaseActionCaseEntityActionRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().applyEntityAction(\"11111111-2222-3333-4444-555555555555\", CaseActionCaseEntityActionRequest.builder()\n .clientReference(\"e1a00000-0000-4000-8000-000000000001\")\n .action(CaseActionActionEnum.of(\"add_tags\"))\n .tags(List.of(\"source-of-funds-reviewed\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->applyEntityAction('11111111-2222-3333-4444-555555555555', [\n 'client_reference' => 'e1a00000-0000-4000-8000-000000000001',\n 'action' => 'add_tags',\n 'tags' => ['source-of-funds-reviewed'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.apply_entity_action(\n \"11111111-2222-3333-4444-555555555555\",\n client_reference: \"e1a00000-0000-4000-8000-000000000001\",\n action: \"add_tags\",\n tags: [\"source-of-funds-reviewed\"]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.ApplyEntityActionAsync(\"11111111-2222-3333-4444-555555555555\", new CaseActionCaseEntityActionRequest\n{\n ClientReference = \"e1a00000-0000-4000-8000-000000000001\",\n Action = \"add_tags\",\n Tags = new string[] { \"source-of-funds-reviewed\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/print/": { "get": { "summary": "Печать кейса (PDF)", "description": "Сформировать кейс целиком (сводка, субъект, состояние чеклиста, заметки, прикреплённые сессии/транзакции, события, список отчётов FIU) в виде PDF и вернуть предварительно подписанный URL для скачивания.", "operationId": "print_case", "x-didit-sdk": { "resource": "cases", "method": "print", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID кейса." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/print/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.print(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.print(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Print(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().print(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->print('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.print(\"c1a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.PrintAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Предварительно подписанный URL PDF.", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/notes/": { "get": { "operationId": "list_case_notes", "x-didit-sdk": { "resource": "cases.notes", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "name": "ordering", "required": false, "in": "query", "description": "Какое поле использовать для сортировки результатов.", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Количество возвращаемых результатов на страницу.", "schema": { "type": "integer" } }, { "name": "offset", "required": false, "in": "query", "description": "Начальный индекс, с которого возвращаются результаты.", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseCollaborationPaginatedCaseNoteList" } } }, "description": "" }, "403": { "description": "У вызывающей стороны отсутствует необходимое разрешение для работы с кейсами." }, "404": { "description": "Кейс или заметка недоступны для этой вызывающей стороны." } }, "tags": [ "Case Management" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.notes.list(\n \"11111111-2222-3333-4444-555555555555\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.notes.list(\"11111111-2222-3333-4444-555555555555\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.Notes.ListAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CasesNotesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().notes().list(\"11111111-2222-3333-4444-555555555555\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->notes->list('11111111-2222-3333-4444-555555555555') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.notes.list(\"11111111-2222-3333-4444-555555555555\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.Notes.ListAsync(\"11111111-2222-3333-4444-555555555555\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] }, "post": { "operationId": "create_case_note", "x-didit-sdk": { "resource": "cases.notes", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CaseCollaborationCaseNoteCreateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CaseCollaborationCaseNoteCreateRequest" }, "example": { "comment": "Proof of address matches the ID document." } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CaseCollaborationCaseNoteCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseCollaborationCaseNote" } } }, "description": "" }, "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseCollaborationCaseNote" } } }, "description": "" }, "403": { "description": "У вызывающей стороны отсутствует необходимое разрешение для работы с кейсами." }, "404": { "description": "Кейс или заметка недоступны для этой вызывающей стороны." }, "409": { "description": "Этот клиентский идентификатор уже использовался для другой заметки или для заметки, которая была удалена." } }, "tags": [ "Case Management" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Добавить заметку в кейс. Необязательный client_reference позволяет при повторной попытке без изменений вернуть ту же заметку без дублирования записей активности или оповещений. reply_to должен указывать на действующую заметку в этом кейсе. Ответ включает ограниченный фрагмент родительской заметки без копирования этого фрагмента в сохранённый ответ.", "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.notes.create(\n \"11111111-2222-3333-4444-555555555555\",\n comment=\"Proof of address matches the ID document.\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.notes.create(\"11111111-2222-3333-4444-555555555555\", {\n comment: \"Proof of address matches the ID document.\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Notes.Create(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CaseCollaborationCaseNoteCreateRequest{\n\tComment: \"Proof of address matches the ID document.\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CaseCollaborationCaseNoteCreateRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().notes().create(\"11111111-2222-3333-4444-555555555555\", CaseCollaborationCaseNoteCreateRequest.builder()\n .comment(\"Proof of address matches the ID document.\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->notes->create('11111111-2222-3333-4444-555555555555', [\n 'comment' => 'Proof of address matches the ID document.',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.notes.create(\n \"11111111-2222-3333-4444-555555555555\",\n comment: \"Proof of address matches the ID document.\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Notes.CreateAsync(\"11111111-2222-3333-4444-555555555555\", new CaseCollaborationCaseNoteCreateRequest\n{\n Comment = \"Proof of address matches the ID document.\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/notes/{note_uuid}/": { "patch": { "operationId": "root_partial_update", "x-didit-sdk": { "resource": "cases.notes", "method": "update", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "note_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CaseCollaborationPatchedCaseNoteUpdateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CaseCollaborationPatchedCaseNoteUpdateRequest" }, "example": { "is_pinned": true } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CaseCollaborationPatchedCaseNoteUpdateRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseCollaborationCaseNote" } } }, "description": "" }, "403": { "description": "У вызывающей стороны отсутствует необходимое разрешение для работы с кейсами." }, "404": { "description": "Кейс или заметка недоступны для этой вызывающей стороны." } }, "tags": [ "Case Management" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Закрепить или открепить существующую заметку. Закрепленные заметки отображаются первыми. Изменения закрепления фиксируются в истории активности кейса и не меняют доказательства или решения источника.", "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.notes.update(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n is_pinned=True,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.notes.update(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n {\n is_pinned: true,\n },\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Notes.Update(ctx, \"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\", didit.CaseCollaborationPatchedCaseNoteUpdateRequest{\n\tIsPinned: didit.Bool(true),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CaseCollaborationPatchedCaseNoteUpdateRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().notes().update(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\", CaseCollaborationPatchedCaseNoteUpdateRequest.builder()\n .isPinned(true)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->notes->update('11111111-2222-3333-4444-555555555555', '11111111-2222-3333-4444-555555555555', [\n 'is_pinned' => true,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.notes.update(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n is_pinned: true\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Notes.UpdateAsync(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\", new CaseCollaborationPatchedCaseNoteUpdateRequest\n{\n IsPinned = true,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "delete": { "operationId": "delete_case_note", "x-didit-sdk": { "resource": "cases.notes", "method": "delete", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "note_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "responses": { "204": { "description": "Заметка удалена навсегда. Ответы остаются без цитаты удаленной родительской заметки. Вложения удаляются, если они больше не используются в других заметках." }, "403": { "description": "У вызывающей стороны отсутствует необходимое разрешение для работы с кейсами." }, "404": { "description": "Кейс или заметка недоступны для этой вызывающей стороны." } }, "tags": [ "Case Management" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nclient.cases.notes.delete(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nawait didit.cases.notes.delete(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nif err := client.Cases.Notes.Delete(ctx, \"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.cases().notes().delete(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");" }, { "lang": "php", "label": "PHP", "source": "cases->notes->delete('11111111-2222-3333-4444-555555555555', '11111111-2222-3333-4444-555555555555');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.notes.delete(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait client.Cases.Notes.DeleteAsync(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/notes/presign/": { "post": { "summary": "Загрузить вложение заметки", "description": "Загрузить файл (JPEG, PNG, WebP, PDF, обычный текст или CSV; максимум 5 МБ) для прикрепления к заметке. Возвращает s3_key, который передаётся в массиве attachments заметки.", "operationId": "upload_case_note_attachment", "x-didit-sdk": { "resource": "cases.notes", "method": "create_attachment_upload", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID кейса." } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/notes/presign/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'file=@evidence.pdf'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.notes.create_attachment_upload(\n \"c1a5e000-0000-4000-8000-000000000001\",\n file=open(\"document.pdf\", \"rb\"),\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.notes.createAttachmentUpload(\"c1a5e000-0000-4000-8000-000000000001\", {\n file: await fileFromPath(\"document.pdf\"),\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Notes.CreateAttachmentUpload(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesNotesCreateAttachmentUploadParams{\n\tFile: didit.FileFromPath(\"document.pdf\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\nimport me.didit.types.CasesNotesCreateAttachmentUploadParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().notes().createAttachmentUpload(\"c1a5e000-0000-4000-8000-000000000001\", CasesNotesCreateAttachmentUploadParams.builder()\n .file(Path.of(\"document.pdf\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->notes->createAttachmentUpload('c1a5e000-0000-4000-8000-000000000001', [\n 'file' => File::fromPath('document.pdf'),\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.notes.create_attachment_upload(\n \"c1a5e000-0000-4000-8000-000000000001\",\n file: Pathname(\"document.pdf\")\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Notes.CreateAttachmentUploadAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesNotesCreateAttachmentUploadParams\n{\n File = FileUpload.FromPath(\"document.pdf\"),\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Файл загружен.", "content": { "application/json": { "schema": { "type": "object", "properties": { "s3_key": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "filename": { "type": "string" }, "file_size": { "type": "integer" } } } } } }, "400": { "description": "Файл отсутствует, неподдерживаемый тип содержимого или размер файла превышает 5 MB.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "get": { "summary": "Получить URL вложения заметки", "description": "Сгенерировать свежий предварительно подписанный URL для скачивания вложения, уже сохранённого в одной из заметок кейса.", "operationId": "get_case_note_attachment_url", "x-didit-sdk": { "resource": "cases.notes", "method": "retrieve_attachment_url", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID кейса." }, { "name": "s3_key", "in": "query", "schema": { "type": "string" }, "description": "Параметр s3_key вложения, возвращённый при загрузке или указанный в заметке.", "required": true } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/notes/presign/?s3_key=case-notes/c1a5e000-0000-4000-8000-000000000001/evidence.pdf' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.notes.retrieve_attachment_url(\n \"c1a5e000-0000-4000-8000-000000000001\",\n s3_key=\"your-s3-key\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.notes.retrieveAttachmentUrl(\"c1a5e000-0000-4000-8000-000000000001\", {\n s3_key: \"your-s3-key\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Notes.RetrieveAttachmentURL(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesNotesRetrieveAttachmentURLParams{\n\tS3Key: \"your-s3-key\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesNotesRetrieveAttachmentUrlParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().notes().retrieveAttachmentUrl(\"c1a5e000-0000-4000-8000-000000000001\", CasesNotesRetrieveAttachmentUrlParams.builder()\n .s3Key(\"your-s3-key\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->notes->retrieveAttachmentUrl('c1a5e000-0000-4000-8000-000000000001', [\n 's3_key' => 'your-s3-key',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.notes.retrieve_attachment_url(\n \"c1a5e000-0000-4000-8000-000000000001\",\n s3_key: \"your-s3-key\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Notes.RetrieveAttachmentUrlAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesNotesRetrieveAttachmentUrlParams\n{\n S3Key = \"your-s3-key\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Предварительно подписанный URL.", "content": { "application/json": { "schema": { "type": "object", "properties": { "s3_key": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "filename": { "type": "string" } } } } } }, "404": { "description": "s3_key отсутствует или не принадлежит этому кейсу.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/links/": { "get": { "summary": "Получить список связей кейса", "description": "Получить список сессий, бизнес-сессий и транзакций, прикреплённых к кейсу.", "operationId": "list_case_links", "x-didit-sdk": { "resource": "cases.links", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID кейса." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/links/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.links.list(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.links.list(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Links.List(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().links().list(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->links->list('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.links.list(\"c1a5e000-0000-4000-8000-000000000001\").each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Links.ListAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Ссылки кейса.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CaseLink" } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Добавить ссылку на кейс", "description": "Прикрепить сессию, бизнес-сессию или транзакцию к кейсу. Отклоняется с кодом 400, если сущность относится к субъекту, отличному от субъекта кейса.", "operationId": "create_case_link", "x-didit-sdk": { "resource": "cases.links", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID кейса." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "entity_type", "entity_uuid" ], "properties": { "entity_type": { "type": "string", "enum": [ "session", "business_session", "transaction" ] }, "entity_uuid": { "type": "string", "format": "uuid" } } }, "example": { "entity_type": "transaction", "entity_uuid": "77000000-0000-4000-8000-000000000077" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/links/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"entity_type\": \"transaction\", \"entity_uuid\": \"77000000-0000-4000-8000-000000000077\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.links.create(\n \"c1a5e000-0000-4000-8000-000000000001\",\n entity_type=\"transaction\",\n entity_uuid=\"77000000-0000-4000-8000-000000000077\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.links.create(\"c1a5e000-0000-4000-8000-000000000001\", {\n entity_type: \"transaction\",\n entity_uuid: \"77000000-0000-4000-8000-000000000077\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Links.Create(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesLinksCreateParams{\n\tEntityType: \"transaction\",\n\tEntityUUID: \"77000000-0000-4000-8000-000000000077\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesLinksCreateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().links().create(\"c1a5e000-0000-4000-8000-000000000001\", CasesLinksCreateParams.builder()\n .entityType(CasesLinksCreateParams.EntityType.of(\"transaction\"))\n .entityUuid(\"77000000-0000-4000-8000-000000000077\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->links->create('c1a5e000-0000-4000-8000-000000000001', [\n 'entity_type' => 'transaction',\n 'entity_uuid' => '77000000-0000-4000-8000-000000000077',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.links.create(\n \"c1a5e000-0000-4000-8000-000000000001\",\n entity_type: \"transaction\",\n entity_uuid: \"77000000-0000-4000-8000-000000000077\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Links.CreateAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesLinksCreateParams\n{\n EntityType = \"transaction\",\n EntityUuid = \"77000000-0000-4000-8000-000000000077\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Ссылка создана.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseLink" } } } }, "400": { "description": "Сущность принадлежит профилю, отличному от субъекта кейса.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/links/{link_uuid}/": { "delete": { "summary": "Удалить связь с кейсом", "description": "Отвязать связанную сессию, сессию компании или транзакцию от кейса.", "operationId": "delete_case_link", "x-didit-sdk": { "resource": "cases.links", "method": "delete", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID кейса." }, { "name": "link_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "11000000-0000-4000-8000-000000000004" }, "description": "UUID ссылки." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/links/11000000-0000-4000-8000-000000000004/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nclient.cases.links.delete(\n \"c1a5e000-0000-4000-8000-000000000001\",\n \"11000000-0000-4000-8000-000000000004\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nawait didit.cases.links.delete(\n \"c1a5e000-0000-4000-8000-000000000001\",\n \"11000000-0000-4000-8000-000000000004\",\n);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nif err := client.Cases.Links.Delete(ctx, \"c1a5e000-0000-4000-8000-000000000001\", \"11000000-0000-4000-8000-000000000004\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.cases().links().delete(\"c1a5e000-0000-4000-8000-000000000001\", \"11000000-0000-4000-8000-000000000004\");" }, { "lang": "php", "label": "PHP", "source": "cases->links->delete('c1a5e000-0000-4000-8000-000000000001', '11000000-0000-4000-8000-000000000004');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.links.delete(\n \"c1a5e000-0000-4000-8000-000000000001\",\n \"11000000-0000-4000-8000-000000000004\"\n)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait client.Cases.Links.DeleteAsync(\"c1a5e000-0000-4000-8000-000000000001\", \"11000000-0000-4000-8000-000000000004\");" } ], "responses": { "204": { "description": "Ссылка удалена." } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/events/": { "get": { "summary": "Получить список событий кейса", "description": "Временная шкала аудита кейса только для чтения (создание, изменения статуса, назначение, решение, эскалация, передача, изменения тегов/приоритета/срока выполнения, действия с сущностями и многое другое).", "operationId": "list_case_events", "x-didit-sdk": { "resource": "cases", "method": "list_events", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID кейса." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Размер страницы." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Смещение, начиная с нуля." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/events/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.list_events(\n \"c1a5e000-0000-4000-8000-000000000001\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.listEvents(\"c1a5e000-0000-4000-8000-000000000001\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.ListEventsAutoPaging(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesListEventsParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().listEvents(\"c1a5e000-0000-4000-8000-000000000001\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->listEvents('c1a5e000-0000-4000-8000-000000000001') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.list_events(\"c1a5e000-0000-4000-8000-000000000001\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.ListEventsAsync(\"c1a5e000-0000-4000-8000-000000000001\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "События с пагинацией, сначала новые.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Количество совпадающих строк. Точное значение до 100, с ограничением 100 выше этого порога для повышения производительности. Чтобы определить последнюю страницу, ориентируйтесь на значение `next`, равное null." }, "next": { "type": "string", "nullable": true, "description": "Абсолютный URL следующей страницы или null." }, "previous": { "type": "string", "nullable": true, "description": "Абсолютный URL предыдущей страницы или null." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseEvent" } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/checklist/": { "get": { "summary": "Получить список пунктов чек-листа кейса", "description": "Получить упорядоченный список пунктов чек-листа кейса, скопированных из content_config.checklist.items шаблона при создании.", "operationId": "list_case_checklist", "x-didit-sdk": { "resource": "cases.checklist", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID кейса." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/checklist/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.checklist.list(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.checklist.list(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Checklist.List(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().checklist().list(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->checklist->list('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.checklist.list(\"c1a5e000-0000-4000-8000-000000000001\").each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Checklist.ListAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Элементы чек-листа.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CaseChecklistItem" } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/checklist/{item_uuid}/": { "patch": { "summary": "Переключить пункт чек-листа", "description": "Отметить пункт чек-листа как выполненный или невыполненный. Принятие решения заблокировано, пока хотя бы один пункт не выполнен, если только в схеме чек-лист не помечен как необязательный.", "operationId": "toggle_case_checklist_item", "x-didit-sdk": { "resource": "cases.checklist", "method": "toggle_item", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID кейса." }, { "name": "item_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c4ec0000-0000-4000-8000-000000000005" }, "description": "UUID элемента чек-листа." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "is_completed" ], "properties": { "is_completed": { "type": "boolean" } } }, "example": { "is_completed": true } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/checklist/c4ec0000-0000-4000-8000-000000000005/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"is_completed\": true}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.checklist.toggle_item(\n \"c1a5e000-0000-4000-8000-000000000001\",\n \"c4ec0000-0000-4000-8000-000000000005\",\n is_completed=True,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.checklist.toggleItem(\n \"c1a5e000-0000-4000-8000-000000000001\",\n \"c4ec0000-0000-4000-8000-000000000005\",\n {\n is_completed: true,\n },\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Checklist.ToggleItem(ctx, \"c1a5e000-0000-4000-8000-000000000001\", \"c4ec0000-0000-4000-8000-000000000005\", didit.CasesChecklistToggleItemParams{\n\tIsCompleted: true,\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesChecklistToggleItemParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().checklist().toggleItem(\"c1a5e000-0000-4000-8000-000000000001\", \"c4ec0000-0000-4000-8000-000000000005\", CasesChecklistToggleItemParams.builder()\n .isCompleted(true)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->checklist->toggleItem('c1a5e000-0000-4000-8000-000000000001', 'c4ec0000-0000-4000-8000-000000000005', [\n 'is_completed' => true,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.checklist.toggle_item(\n \"c1a5e000-0000-4000-8000-000000000001\",\n \"c4ec0000-0000-4000-8000-000000000005\",\n is_completed: true\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Checklist.ToggleItemAsync(\"c1a5e000-0000-4000-8000-000000000001\", \"c4ec0000-0000-4000-8000-000000000005\", new CasesChecklistToggleItemParams\n{\n IsCompleted = true,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Обновлённый пункт чеклиста.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseChecklistItem" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/aml/": { "get": { "summary": "Получить список AML-срабатываний для кейса", "description": "Получить список совпадений AML-скрининга для субъекта кейса. Формат совпадает с совпадениями, возвращаемыми POST /v3/aml/.", "operationId": "list_case_aml_hits", "x-didit-sdk": { "resource": "cases", "method": "list_aml_hits", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID кейса." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/aml/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.list_aml_hits(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.listAmlHits(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.ListAMLHits(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().listAmlHits(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->listAmlHits('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.list_aml_hits(\"c1a5e000-0000-4000-8000-000000000001\").each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.ListAmlHitsAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "AML-совпадения.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AMLScreening" } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/statistics/": { "get": { "summary": "Аналитика кейса", "description": "Агрегированная аналитика кейсов за диапазон дат (по умолчанию последние 30 дней; максимум 731 день). Графики, таблицы, итоговые значения, события назначения и текущее количество в очередях используют одни и те же фильтры на уровне приложения. Фильтры используют текущие значения кейса. Даты применяются к каждому событию метрики, поэтому более старые кейсы, назначенные или закрытые в течение этого периода, остаются включенными. Глубина очереди не зависит от диапазона дат. Некорректные фильтры возвращают 400; неизвестный шаблон или исполнитель возвращает пустой результат.", "operationId": "get_case_analytics", "x-didit-sdk": { "resource": "cases", "method": "retrieve_statistics", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Начало диапазона (включительно). По умолчанию: 30 дней назад." }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Конец диапазона (включительно). По умолчанию используется сегодняшний день." }, { "name": "blueprint", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Фильтр по UUID текущего blueprint." }, { "name": "assigned_to", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Фильтр по UUID текущего назначенного проверяющего пользователя." }, { "name": "priority", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "description": "Фильтр по текущему приоритету кейса." }, { "name": "source", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "MANUAL", "AML_SCREENING", "TRANSACTION_RULE", "WORKFLOW_BUILDER" ] }, "description": "Фильтр по источнику создания кейса." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "OPEN", "AWAITING_USER", "RESOLVED" ] }, "description": "Фильтр по текущему статусу кейса." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/statistics/?date_from=2026-06-01&date_to=2026-06-30' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.retrieve_statistics()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.retrieveStatistics();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RetrieveStatistics(ctx, didit.CasesRetrieveStatisticsParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().retrieveStatistics();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->retrieveStatistics();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.retrieve_statistics\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RetrieveStatisticsAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Payload аналитики.", "content": { "application/json": { "schema": { "type": "object", "properties": { "series": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "created": { "type": "integer" }, "reviewed": { "type": "integer" } } } }, "tables": { "type": "object", "properties": { "officer": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Значение измерения: email должностного лица, \"blueprint_name:uuid\", source или status. \"unassigned\"/\"none\" для отсутствующих измерений." }, "created": { "type": "integer" }, "assigned": { "type": "integer" }, "resolved": { "type": "integer" }, "threat_rate": { "type": "number", "format": "float" }, "false_positive_rate": { "type": "number", "format": "float" }, "unresolved": { "type": "integer" }, "reassignment_rate": { "type": "number", "format": "float" }, "escalation_rate": { "type": "number", "format": "float" }, "avg_assign_hours": { "type": "number", "format": "float" }, "avg_resolve_hours": { "type": "number", "format": "float" }, "avg_handling_hours": { "type": "number", "format": "float" } } } }, "blueprint": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Значение измерения: email должностного лица, \"blueprint_name:uuid\", source или status. \"unassigned\"/\"none\" для отсутствующих измерений." }, "created": { "type": "integer" }, "assigned": { "type": "integer" }, "resolved": { "type": "integer" }, "threat_rate": { "type": "number", "format": "float" }, "false_positive_rate": { "type": "number", "format": "float" }, "unresolved": { "type": "integer" }, "reassignment_rate": { "type": "number", "format": "float" }, "escalation_rate": { "type": "number", "format": "float" }, "avg_assign_hours": { "type": "number", "format": "float" }, "avg_resolve_hours": { "type": "number", "format": "float" }, "avg_handling_hours": { "type": "number", "format": "float" } } } }, "source": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Значение измерения: email должностного лица, \"blueprint_name:uuid\", source или status. \"unassigned\"/\"none\" для отсутствующих измерений." }, "created": { "type": "integer" }, "assigned": { "type": "integer" }, "resolved": { "type": "integer" }, "threat_rate": { "type": "number", "format": "float" }, "false_positive_rate": { "type": "number", "format": "float" }, "unresolved": { "type": "integer" }, "reassignment_rate": { "type": "number", "format": "float" }, "escalation_rate": { "type": "number", "format": "float" }, "avg_assign_hours": { "type": "number", "format": "float" }, "avg_resolve_hours": { "type": "number", "format": "float" }, "avg_handling_hours": { "type": "number", "format": "float" } } } }, "status": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Значение измерения: email должностного лица, \"blueprint_name:uuid\", source или status. \"unassigned\"/\"none\" для отсутствующих измерений." }, "created": { "type": "integer" }, "assigned": { "type": "integer" }, "resolved": { "type": "integer" }, "threat_rate": { "type": "number", "format": "float" }, "false_positive_rate": { "type": "number", "format": "float" }, "unresolved": { "type": "integer" }, "reassignment_rate": { "type": "number", "format": "float" }, "escalation_rate": { "type": "number", "format": "float" }, "avg_assign_hours": { "type": "number", "format": "float" }, "avg_resolve_hours": { "type": "number", "format": "float" }, "avg_handling_hours": { "type": "number", "format": "float" } } } } } }, "totals": { "type": "object", "properties": { "created": { "type": "integer" }, "assigned": { "type": "integer" }, "resolved": { "type": "integer" }, "threat_rate": { "type": "number", "format": "float" }, "false_positive_rate": { "type": "number", "format": "float" }, "unresolved": { "type": "integer" }, "reassignment_rate": { "type": "number", "format": "float" }, "escalation_rate": { "type": "number", "format": "float" }, "avg_assign_hours": { "type": "number", "format": "float" }, "avg_resolve_hours": { "type": "number", "format": "float" }, "avg_handling_hours": { "type": "number", "format": "float" } } }, "queue": { "type": "object", "description": "Снимок в реальном времени, без привязки к диапазону дат.", "properties": { "open": { "type": "integer" }, "overdue": { "type": "integer" } } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/bulk/status/": { "post": { "summary": "Массовое обновление статуса кейсов", "description": "Применить один и тот же переход статуса к нескольким кейсам за один вызов: OPEN открывает повторно, AWAITING_USER запрашивает данные, RESOLVED разрешает (требуется решение). Каждый кейс оценивается независимо; ошибки проверок (незаполненный чек-лист, отсутствие обязательной заметки) фиксируются по каждому кейсу без прерывания всей пачки.", "operationId": "bulk_update_case_status", "x-didit-sdk": { "resource": "cases", "method": "bulk_update_status", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "case_uuids", "status" ], "properties": { "case_uuids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1 }, "status": { "type": "string", "enum": [ "OPEN", "AWAITING_USER", "RESOLVED" ] }, "resolution": { "type": "string", "enum": [ "FALSE_POSITIVE", "VALID_THREAT", "INCONCLUSIVE", "REQUIREMENTS_NOT_MET", "REQUIREMENTS_SATISFIED" ], "description": "Обязательно, когда status имеет значение RESOLVED." }, "note": { "type": "string", "nullable": true } } }, "example": { "case_uuids": [ "c1a5e000-0000-4000-8000-000000000001" ], "status": "RESOLVED", "resolution": "FALSE_POSITIVE" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/bulk/status/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"case_uuids\": [\"c1a5e000-0000-4000-8000-000000000001\"], \"status\": \"RESOLVED\", \"resolution\": \"FALSE_POSITIVE\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.bulk_update_status(\n case_uuids=[\"c1a5e000-0000-4000-8000-000000000001\"],\n status=\"RESOLVED\",\n resolution=\"FALSE_POSITIVE\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.bulkUpdateStatus({\n case_uuids: [\"c1a5e000-0000-4000-8000-000000000001\"],\n status: \"RESOLVED\",\n resolution: \"FALSE_POSITIVE\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.BulkUpdateStatus(ctx, didit.CasesBulkUpdateStatusParams{\n\tCaseUUIDs: []string{\"c1a5e000-0000-4000-8000-000000000001\"},\n\tStatus: \"RESOLVED\",\n\tResolution: didit.Some(didit.CasesBulkUpdateStatusParamsResolution(\"FALSE_POSITIVE\")),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CasesBulkUpdateStatusParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().bulkUpdateStatus(CasesBulkUpdateStatusParams.builder()\n .caseUuids(List.of(\"c1a5e000-0000-4000-8000-000000000001\"))\n .status(CasesBulkUpdateStatusParams.Status.of(\"RESOLVED\"))\n .resolution(CasesBulkUpdateStatusParams.Resolution.of(\"FALSE_POSITIVE\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->bulkUpdateStatus([\n 'case_uuids' => ['c1a5e000-0000-4000-8000-000000000001'],\n 'status' => 'RESOLVED',\n 'resolution' => 'FALSE_POSITIVE',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.bulk_update_status(\n case_uuids: [\"c1a5e000-0000-4000-8000-000000000001\"],\n status: \"RESOLVED\",\n resolution: \"FALSE_POSITIVE\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.BulkUpdateStatusAsync(new CasesBulkUpdateStatusParams\n{\n CaseUuids = new string[] { \"c1a5e000-0000-4000-8000-000000000001\" },\n Status = \"RESOLVED\",\n Resolution = new CasesBulkUpdateStatusParamsResolution(\"FALSE_POSITIVE\"),\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Результаты по каждому кейсу.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBulkUpdateResult" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/bulk/assign/": { "post": { "summary": "Массовое назначение кейсов", "description": "Назначить (или снять назначение с помощью assignee_user_id: null) сразу несколько кейсов. Все кейсы должны относиться к одному и тому же плану; несоответствия фиксируются по каждому кейсу без прерывания всей пачки.", "operationId": "bulk_assign_cases", "x-didit-sdk": { "resource": "cases", "method": "bulk_assign", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "case_uuids", "assignee_user_id" ], "properties": { "case_uuids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1 }, "assignee_user_id": { "type": "string", "format": "uuid", "nullable": true }, "assignee_email": { "type": "string", "format": "email", "nullable": true }, "assignee_name": { "type": "string", "nullable": true } } }, "example": { "case_uuids": [ "c1a5e000-0000-4000-8000-000000000001" ], "assignee_user_id": "9a000000-0000-4000-8000-0000000000aa" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/bulk/assign/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"case_uuids\": [\"c1a5e000-0000-4000-8000-000000000001\"], \"assignee_user_id\": \"9a000000-0000-4000-8000-0000000000aa\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.bulk_assign(\n case_uuids=[\"c1a5e000-0000-4000-8000-000000000001\"],\n assignee_user_id=\"9a000000-0000-4000-8000-0000000000aa\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.bulkAssign({\n case_uuids: [\"c1a5e000-0000-4000-8000-000000000001\"],\n assignee_user_id: \"9a000000-0000-4000-8000-0000000000aa\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.BulkAssign(ctx, didit.CasesBulkAssignParams{\n\tCaseUUIDs: []string{\"c1a5e000-0000-4000-8000-000000000001\"},\n\tAssigneeUserID: didit.String(\"9a000000-0000-4000-8000-0000000000aa\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CasesBulkAssignParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().bulkAssign(CasesBulkAssignParams.builder()\n .caseUuids(List.of(\"c1a5e000-0000-4000-8000-000000000001\"))\n .assigneeUserId(\"9a000000-0000-4000-8000-0000000000aa\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->bulkAssign([\n 'case_uuids' => ['c1a5e000-0000-4000-8000-000000000001'],\n 'assignee_user_id' => '9a000000-0000-4000-8000-0000000000aa',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.bulk_assign(\n case_uuids: [\"c1a5e000-0000-4000-8000-000000000001\"],\n assignee_user_id: \"9a000000-0000-4000-8000-0000000000aa\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.BulkAssignAsync(new CasesBulkAssignParams\n{\n CaseUuids = new string[] { \"c1a5e000-0000-4000-8000-000000000001\" },\n AssigneeUserId = \"9a000000-0000-4000-8000-0000000000aa\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Результаты по каждому кейсу.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBulkUpdateResult" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/": { "get": { "summary": "Получить список блюпринтов", "description": "Получить список блюпринтов кейсов для приложения.", "operationId": "list_case_blueprints", "x-didit-sdk": { "resource": "cases.blueprints", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Blueprints" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Размер страницы." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Смещение, начиная с нуля." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/blueprints/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.blueprints.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.blueprints.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.Blueprints.ListAutoPaging(ctx, didit.CasesBlueprintsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().blueprints().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.blueprints.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.Blueprints.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Список шаблонов с пагинацией.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Количество подходящих строк, ограниченное 100 для повышения производительности." }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseBlueprintListItem" } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Создать блюпринт", "description": "Создайте шаблон кейса: общие настройки (назначение, эскалация, передача, принцип четырёх глаз) плюс content_config, шесть разделов, определяющих страницу кейса. Укажите publish=false, чтобы создать неопубликованный черновик; публикация создаёт его первую рабочую версию. Удаление черновика, который ни разу не был опубликован, удаляет его.", "operationId": "create_case_blueprint", "x-didit-sdk": { "resource": "cases.blueprints", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Blueprints" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "assignee_pool" ], "properties": { "name": { "type": "string", "maxLength": 24, "description": "Не более 24 символов, например «AML-расследование»." }, "description": { "type": "string", "nullable": true }, "assignee_pool": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "description": "Список UUID пользователей. Пустые массивы отклоняются с ошибкой \"Pick at least one assignee\"." }, "assignment_method": { "type": "string", "enum": [ "MANUAL", "AUTOMATIC" ], "default": "MANUAL" }, "max_active_cases": { "type": "integer", "nullable": true, "minimum": 1, "description": "Порог автоматического режима: «назначено менее N кейсов этого шаблона»." }, "escalation_enabled": { "type": "boolean", "default": false }, "escalation_blueprint": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID целевого шаблона. Не проверяется при сохранении, но действие эскалации завершается с ошибкой 400 до тех пор, пока не будут установлены escalation_enabled и escalation_blueprint." }, "transfer_enabled": { "type": "boolean", "default": false }, "four_eyes_checker_blueprint": { "type": "string", "format": "uuid", "nullable": true, "description": "Включение этой опции активирует проверку по принципу четырёх глаз (4-eyes): решения по этому шаблону помещаются в очередь шаблона проверяющего." }, "require_resolution_note": { "type": "boolean", "default": false }, "content_config": { "$ref": "#/components/schemas/CaseContentConfig" }, "is_active": { "type": "boolean", "default": true }, "default_deadline_hours": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 8760, "description": "Крайний срок по умолчанию для вновь открываемых кейсов. Крайние сроки существующих кейсов не изменяются." }, "publish": { "type": "boolean", "writeOnly": true, "default": true, "description": "Укажите false, чтобы сохранить черновик, который никогда не публиковался. Запись остаётся неактивной в версии 0 до тех пор, пока черновик не будет явно опубликован. Если опустить это поле, сохранится немедленное создание для существующих интеграций." } } }, "example": { "name": "AML investigation", "assignee_pool": [ "9a000000-0000-4000-8000-0000000000aa" ], "assignment_method": "AUTOMATIC", "max_active_cases": 15, "require_resolution_note": true, "content_config": { "aml_control": { "enabled": true, "financial": true, "identity": false } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/blueprints/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"name\": \"AML investigation\", \"assignee_pool\": [\"9a000000-0000-4000-8000-0000000000aa\"], \"assignment_method\": \"AUTOMATIC\", \"max_active_cases\": 15, \"require_resolution_note\": true, \"content_config\": {\"aml_control\": {\"enabled\": true, \"financial\": true, \"identity\": false}}}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.blueprints.create(\n name=\"AML investigation\",\n assignee_pool=[\"9a000000-0000-4000-8000-0000000000aa\"],\n assignment_method=\"AUTOMATIC\",\n max_active_cases=15,\n require_resolution_note=True,\n content_config={\n \"aml_control\": {\n \"enabled\": True,\n \"financial\": True,\n \"identity\": False,\n },\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.blueprints.create({\n name: \"AML investigation\",\n assignee_pool: [\"9a000000-0000-4000-8000-0000000000aa\"],\n assignment_method: \"AUTOMATIC\",\n max_active_cases: 15,\n require_resolution_note: true,\n content_config: {\n aml_control: {\n enabled: true,\n financial: true,\n identity: false,\n },\n },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Blueprints.Create(ctx, didit.CasesBlueprintsCreateParams{\n\tName: \"AML investigation\",\n\tAssigneePool: []string{\"9a000000-0000-4000-8000-0000000000aa\"},\n\tAssignmentMethod: didit.Some(didit.CasesBlueprintsCreateParamsAssignmentMethod(\"AUTOMATIC\")),\n\tMaxActiveCases: didit.Int(15),\n\tRequireResolutionNote: didit.Bool(true),\n\tContentConfig: didit.Some(didit.CaseContentConfigParam{\n\t\tAMLControl: didit.Some(didit.CaseContentConfigParamAMLControl{\n\t\t\tEnabled: didit.Bool(true),\n\t\t\tFinancial: didit.Bool(true),\n\t\t\tIdentity: didit.Bool(false),\n\t\t}),\n\t}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CaseContentConfig;\nimport me.didit.types.CasesBlueprintsCreateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().blueprints().create(CasesBlueprintsCreateParams.builder()\n .name(\"AML investigation\")\n .assigneePool(List.of(\"9a000000-0000-4000-8000-0000000000aa\"))\n .assignmentMethod(CasesBlueprintsCreateParams.AssignmentMethod.of(\"AUTOMATIC\"))\n .maxActiveCases(15L)\n .requireResolutionNote(true)\n .contentConfig(CaseContentConfig.builder()\n .amlControl(CaseContentConfig.AmlControl.builder()\n .enabled(true)\n .financial(true)\n .identity(false)\n .build())\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->create([\n 'name' => 'AML investigation',\n 'assignee_pool' => ['9a000000-0000-4000-8000-0000000000aa'],\n 'assignment_method' => 'AUTOMATIC',\n 'max_active_cases' => 15,\n 'require_resolution_note' => true,\n 'content_config' => [\n 'aml_control' => [\n 'enabled' => true,\n 'financial' => true,\n 'identity' => false,\n ],\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.blueprints.create(\n name: \"AML investigation\",\n assignee_pool: [\"9a000000-0000-4000-8000-0000000000aa\"],\n assignment_method: \"AUTOMATIC\",\n max_active_cases: 15,\n require_resolution_note: true,\n content_config: {\n aml_control: {\n enabled: true,\n financial: true,\n identity: false,\n },\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Blueprints.CreateAsync(new CasesBlueprintsCreateParams\n{\n Name = \"AML investigation\",\n AssigneePool = new string[] { \"9a000000-0000-4000-8000-0000000000aa\" },\n AssignmentMethod = new CasesBlueprintsCreateParamsAssignmentMethod(\"AUTOMATIC\"),\n MaxActiveCases = 15,\n RequireResolutionNote = true,\n ContentConfig = new CaseContentConfig\n {\n AmlControl = new CaseContentConfigAmlControl\n {\n Enabled = true,\n Financial = true,\n Identity = false,\n },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Шаблон создан.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBlueprintDetail" } } } }, "400": { "description": "Имя длиннее 24 символов, пустой assignee_pool или связанный шаблон (эскалация/проверяющий) не найден.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/": { "get": { "summary": "Получить чертеж", "description": "Получите шаблон, включая подключенные к нему источники создания (конфигурация AML, правила транзакций, узлы сценария) и информацию о том, какие шаблоны эскалируют в него.", "operationId": "get_case_blueprint", "x-didit-sdk": { "resource": "cases.blueprints", "method": "retrieve", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Blueprints" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "blueprint_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "b1de0000-0000-4000-8000-000000000002" }, "description": "UUID шаблона." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/blueprints/b1de0000-0000-4000-8000-000000000002/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.blueprints.retrieve(\n \"b1de0000-0000-4000-8000-000000000002\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.blueprints.retrieve(\"b1de0000-0000-4000-8000-000000000002\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Blueprints.Retrieve(ctx, \"b1de0000-0000-4000-8000-000000000002\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().blueprints().retrieve(\"b1de0000-0000-4000-8000-000000000002\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->retrieve('b1de0000-0000-4000-8000-000000000002');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.blueprints.retrieve(\"b1de0000-0000-4000-8000-000000000002\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Blueprints.RetrieveAsync(\"b1de0000-0000-4000-8000-000000000002\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Сведения о шаблоне.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBlueprintDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Обновить чертёж", "description": "Частично обновить общие настройки или content_config blueprint.", "operationId": "update_case_blueprint", "x-didit-sdk": { "resource": "cases.blueprints", "method": "update", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Blueprints" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "blueprint_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "b1de0000-0000-4000-8000-000000000002" }, "description": "UUID шаблона." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 24, "description": "Не более 24 символов, например «AML-расследование»." }, "description": { "type": "string", "nullable": true }, "assignee_pool": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "description": "Список UUID пользователей. Пустые массивы отклоняются с ошибкой \"Pick at least one assignee\"." }, "assignment_method": { "type": "string", "enum": [ "MANUAL", "AUTOMATIC" ] }, "max_active_cases": { "type": "integer", "nullable": true, "minimum": 1, "description": "Порог автоматического режима: «назначено менее N кейсов этого шаблона»." }, "escalation_enabled": { "type": "boolean" }, "escalation_blueprint": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID целевого шаблона. Не проверяется при сохранении, но действие эскалации завершается с ошибкой 400 до тех пор, пока не будут установлены escalation_enabled и escalation_blueprint." }, "transfer_enabled": { "type": "boolean" }, "four_eyes_checker_blueprint": { "type": "string", "format": "uuid", "nullable": true, "description": "Включение этой опции активирует проверку по принципу четырёх глаз (4-eyes): решения по этому шаблону помещаются в очередь шаблона проверяющего." }, "require_resolution_note": { "type": "boolean" }, "content_config": { "$ref": "#/components/schemas/CaseContentConfig" }, "is_active": { "type": "boolean" }, "default_deadline_hours": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 8760, "description": "Крайний срок по умолчанию для вновь открываемых кейсов. Крайние сроки существующих кейсов не изменяются." }, "expected_version": { "type": "integer", "minimum": 1, "description": "Версия, открытая редактором. Устаревшая версия возвращает 409 без изменения политики проверки." } } }, "example": { "transfer_enabled": true } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/blueprints/b1de0000-0000-4000-8000-000000000002/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"transfer_enabled\": true}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.blueprints.update(\n \"b1de0000-0000-4000-8000-000000000002\",\n transfer_enabled=True,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.blueprints.update(\"b1de0000-0000-4000-8000-000000000002\", {\n transfer_enabled: true,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Blueprints.Update(ctx, \"b1de0000-0000-4000-8000-000000000002\", didit.CasesBlueprintsUpdateParams{\n\tTransferEnabled: didit.Bool(true),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesBlueprintsUpdateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().blueprints().update(\"b1de0000-0000-4000-8000-000000000002\", CasesBlueprintsUpdateParams.builder()\n .transferEnabled(true)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->update('b1de0000-0000-4000-8000-000000000002', [\n 'transfer_enabled' => true,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.blueprints.update(\n \"b1de0000-0000-4000-8000-000000000002\",\n transfer_enabled: true\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Blueprints.UpdateAsync(\"b1de0000-0000-4000-8000-000000000002\", new CasesBlueprintsUpdateParams\n{\n TransferEnabled = true,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Обновлённый шаблон сценария.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBlueprintDetail" } } } }, "409": { "description": "Политика проверки изменилась с момента expected_version. Ознакомьтесь с последней версией перед повторной попыткой." } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "summary": "Удалить схему", "description": "Удалить шаблон. Удаление всегда проходит успешно и не затрагивает кейсы шаблона: существующие кейсы сохраняют ссылку на свой шаблон, и его настройки продолжают применяться к ним. Удаленный шаблон больше не отображается в списках шаблонов и не может быть выбран в качестве цели перемещения; если шаблон создателя удален, пока решение ожидает утверждения по принципу четырех глаз, отклоненное решение оставляет кейс на шаблоне проверяющего.", "operationId": "delete_case_blueprint", "x-didit-sdk": { "resource": "cases.blueprints", "method": "delete", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Blueprints" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "blueprint_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "b1de0000-0000-4000-8000-000000000002" }, "description": "UUID шаблона." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/blueprints/b1de0000-0000-4000-8000-000000000002/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nclient.cases.blueprints.delete(\n \"b1de0000-0000-4000-8000-000000000002\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nawait didit.cases.blueprints.delete(\"b1de0000-0000-4000-8000-000000000002\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nif err := client.Cases.Blueprints.Delete(ctx, \"b1de0000-0000-4000-8000-000000000002\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.cases().blueprints().delete(\"b1de0000-0000-4000-8000-000000000002\");" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->delete('b1de0000-0000-4000-8000-000000000002');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.blueprints.delete(\"b1de0000-0000-4000-8000-000000000002\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait client.Cases.Blueprints.DeleteAsync(\"b1de0000-0000-4000-8000-000000000002\");" } ], "responses": { "204": { "description": "Шаблон удалён." } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/presets/": { "get": { "summary": "Получить список пресетов блюпринтов", "description": "Получить список четырёх встроенных пресетов (Screening hit, AML investigation, Suspicious activity, KYC review) с их content_config и статусом установки в этом приложении.", "operationId": "list_case_blueprint_presets", "x-didit-sdk": { "resource": "cases.blueprints", "method": "list_presets", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Blueprints" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/blueprints/presets/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.blueprints.list_presets()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.blueprints.listPresets();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Blueprints.ListPresets(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().blueprints().listPresets();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->listPresets();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.blueprints.list_presets\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Blueprints.ListPresetsAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Каталог пресетов.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "preset_key": { "type": "string", "enum": [ "screening_hit", "aml_investigation", "suspicious_activity", "kyc" ] }, "name": { "type": "string" }, "description": { "type": "string" }, "content_config": { "$ref": "#/components/schemas/CaseContentConfig" }, "installed": { "type": "boolean" } } } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/presets/install/": { "post": { "summary": "Установить пресеты шаблона", "description": "Скопировать один или несколько шаблонов настроек в приложение как редактируемые шаблоны. Идемпотентно для каждого preset_key; опустите preset_keys, чтобы установить все ещё не установленные шаблоны настроек.", "operationId": "install_case_blueprint_presets", "x-didit-sdk": { "resource": "cases.blueprints", "method": "install_presets", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Blueprints" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "preset_keys": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Подмножество из screening_hit, aml_investigation, suspicious_activity, kyc. Опустите, чтобы установить все." } } }, "example": { "preset_keys": [ "aml_investigation", "kyc" ] } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/blueprints/presets/install/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"preset_keys\": [\"aml_investigation\", \"kyc\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.blueprints.install_presets(\n preset_keys=[\"aml_investigation\", \"kyc\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.blueprints.installPresets({\n preset_keys: [\"aml_investigation\", \"kyc\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Blueprints.InstallPresets(ctx, didit.CasesBlueprintsInstallPresetsParams{\n\tPresetKeys: didit.Some([]string{\"aml_investigation\", \"kyc\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CasesBlueprintsInstallPresetsParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().blueprints().installPresets(CasesBlueprintsInstallPresetsParams.builder()\n .presetKeys(List.of(\"aml_investigation\", \"kyc\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->installPresets([\n 'preset_keys' => ['aml_investigation', 'kyc'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.blueprints.install_presets(preset_keys: [\"aml_investigation\", \"kyc\"])\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Blueprints.InstallPresetsAsync(new CasesBlueprintsInstallPresetsParams\n{\n PresetKeys = new string[] { \"aml_investigation\", \"kyc\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Один или несколько установленных пресетов.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBlueprintPresetInstallResult" } } } }, "200": { "description": "Нет новых пресетов для установки (все запрошенные пресеты уже существуют).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBlueprintPresetInstallResult" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/report-templates/": { "get": { "summary": "Получить список шаблонов отчётов", "description": "Получить список шаблонов отчётов FIU для приложения.", "operationId": "list_report_templates", "x-didit-sdk": { "resource": "report_templates", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Report Templates" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Размер страницы." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Смещение, начиная с нуля." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/report-templates/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.report_templates.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.reportTemplates.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.ReportTemplates.ListAutoPaging(ctx, didit.ReportTemplatesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.reportTemplates().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "reportTemplates->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.report_templates.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.ReportTemplates.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Шаблоны с пагинацией.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Количество подходящих строк, ограниченное 100 для повышения производительности." }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTemplateDetail" } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Создать шаблон отчёта", "description": "Создайте многоразовый шаблон заголовка goAML для конкретной юрисдикции и типа отчёта. Запрос отклоняется с кодом 400, если в field_config отсутствует хотя бы одно из обязательных полей уровня шаблона (rentity_id, submission_code, currency_code_local); некорректный шаблон нельзя сохранить или использовать для создания отчёта. Поля заголовка для конкретной отправки (action, submission_date, transactions) проверяются на этапе валидации или финализации отчёта.", "operationId": "create_report_template", "x-didit-sdk": { "resource": "report_templates", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Report Templates" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "jurisdiction", "report_type" ], "properties": { "name": { "type": "string" }, "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Двухбуквенный код страны ISO 3166-1 alpha-2, преобразуемый в верхний регистр при сохранении." }, "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ] }, "field_config": { "type": "object", "description": "Значения по умолчанию для заголовка goAML многократного использования. Обязательные поля на уровне шаблона: rentity_id, submission_code и currency_code_local (3 буквы). Необязательные: enabled_fields (какие опциональные блоки отчёта включать), а также значения по умолчанию для reporting_person, location, reason и action. Поля заголовка для конкретного отчёта (action, submission_date, transactions, jurisdiction) проверяются при валидации или финализации отчёта, а не в шаблоне." } } }, "example": { "name": "US SAR default", "jurisdiction": "US", "report_type": "SAR", "field_config": { "rentity_id": "FIU-US-00123", "submission_code": "E", "currency_code_local": "USD" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/report-templates/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"name\": \"US SAR default\", \"jurisdiction\": \"US\", \"report_type\": \"SAR\", \"field_config\": {\"rentity_id\": \"FIU-US-00123\", \"submission_code\": \"E\", \"currency_code_local\": \"USD\"}}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.report_templates.create(\n name=\"US SAR default\",\n jurisdiction=\"US\",\n report_type=\"SAR\",\n field_config={\"rentity_id\": \"FIU-US-00123\", \"submission_code\": \"E\", \"currency_code_local\": \"USD\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.reportTemplates.create({\n name: \"US SAR default\",\n jurisdiction: \"US\",\n report_type: \"SAR\",\n field_config: { rentity_id: \"FIU-US-00123\", submission_code: \"E\", currency_code_local: \"USD\" },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.ReportTemplates.Create(ctx, didit.ReportTemplatesCreateParams{\n\tName: \"US SAR default\",\n\tJurisdiction: \"US\",\n\tReportType: \"SAR\",\n\tFieldConfig: didit.Some(map[string]any{\"rentity_id\": \"FIU-US-00123\", \"submission_code\": \"E\", \"currency_code_local\": \"USD\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.ReportTemplatesCreateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.reportTemplates().create(ReportTemplatesCreateParams.builder()\n .name(\"US SAR default\")\n .jurisdiction(\"US\")\n .reportType(ReportTemplatesCreateParams.ReportType.of(\"SAR\"))\n .fieldConfig(Map.of(\"rentity_id\", \"FIU-US-00123\", \"submission_code\", \"E\", \"currency_code_local\", \"USD\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "reportTemplates->create([\n 'name' => 'US SAR default',\n 'jurisdiction' => 'US',\n 'report_type' => 'SAR',\n 'field_config' => ['rentity_id' => 'FIU-US-00123', 'submission_code' => 'E', 'currency_code_local' => 'USD'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.report_templates.create(\n name: \"US SAR default\",\n jurisdiction: \"US\",\n report_type: \"SAR\",\n field_config: { rentity_id: \"FIU-US-00123\", submission_code: \"E\", currency_code_local: \"USD\" }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.ReportTemplates.CreateAsync(new ReportTemplatesCreateParams\n{\n Name = \"US SAR default\",\n Jurisdiction = \"US\",\n ReportType = \"SAR\",\n FieldConfig = new Dictionary { [\"rentity_id\"] = \"FIU-US-00123\", [\"submission_code\"] = \"E\", [\"currency_code_local\"] = \"USD\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Шаблон создан.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTemplateDetail" } } } }, "400": { "description": "Нераспознанная юрисдикция, либо field_config не проходит валидацию обязательных полей.", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "string" } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/report-templates/{template_uuid}/": { "get": { "summary": "Получить шаблон отчёта", "description": "Получить шаблон отчёта.", "operationId": "get_report_template", "x-didit-sdk": { "resource": "report_templates", "method": "retrieve", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Report Templates" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "template_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "7ec00000-0000-4000-8000-000000000006" }, "description": "UUID шаблона отчёта." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/report-templates/7ec00000-0000-4000-8000-000000000006/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.report_templates.retrieve(\n \"7ec00000-0000-4000-8000-000000000006\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.reportTemplates.retrieve(\"7ec00000-0000-4000-8000-000000000006\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.ReportTemplates.Retrieve(ctx, \"7ec00000-0000-4000-8000-000000000006\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.reportTemplates().retrieve(\"7ec00000-0000-4000-8000-000000000006\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "reportTemplates->retrieve('7ec00000-0000-4000-8000-000000000006');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.report_templates.retrieve(\"7ec00000-0000-4000-8000-000000000006\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.ReportTemplates.RetrieveAsync(\"7ec00000-0000-4000-8000-000000000006\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Сведения о шаблоне.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTemplateDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Обновить шаблон отчёта", "description": "Частично обновить шаблон отчёта. Повторно валидирует обязательные поля goAML при сохранении.", "operationId": "update_report_template", "x-didit-sdk": { "resource": "report_templates", "method": "update", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Report Templates" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "template_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "7ec00000-0000-4000-8000-000000000006" }, "description": "UUID шаблона отчёта." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Двухбуквенный код страны ISO 3166-1 alpha-2, преобразуемый в верхний регистр при сохранении." }, "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ] }, "field_config": { "type": "object", "description": "Значения по умолчанию для заголовка goAML многократного использования. Обязательные поля на уровне шаблона: rentity_id, submission_code и currency_code_local (3 буквы). Необязательные: enabled_fields (какие опциональные блоки отчёта включать), а также значения по умолчанию для reporting_person, location, reason и action. Поля заголовка для конкретного отчёта (action, submission_date, transactions, jurisdiction) проверяются при валидации или финализации отчёта, а не в шаблоне." } } }, "example": { "field_config": { "rentity_id": "FIU-US-00124" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/report-templates/7ec00000-0000-4000-8000-000000000006/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"field_config\": {\"rentity_id\": \"FIU-US-00124\"}}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.report_templates.update(\n \"7ec00000-0000-4000-8000-000000000006\",\n field_config={\"rentity_id\": \"FIU-US-00124\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.reportTemplates.update(\"7ec00000-0000-4000-8000-000000000006\", {\n field_config: { rentity_id: \"FIU-US-00124\" },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.ReportTemplates.Update(ctx, \"7ec00000-0000-4000-8000-000000000006\", didit.ReportTemplatesUpdateParams{\n\tFieldConfig: didit.Some(map[string]any{\"rentity_id\": \"FIU-US-00124\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.ReportTemplatesUpdateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.reportTemplates().update(\"7ec00000-0000-4000-8000-000000000006\", ReportTemplatesUpdateParams.builder()\n .fieldConfig(Map.of(\"rentity_id\", \"FIU-US-00124\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "reportTemplates->update('7ec00000-0000-4000-8000-000000000006', [\n 'field_config' => ['rentity_id' => 'FIU-US-00124'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.report_templates.update(\n \"7ec00000-0000-4000-8000-000000000006\",\n field_config: { rentity_id: \"FIU-US-00124\" }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.ReportTemplates.UpdateAsync(\"7ec00000-0000-4000-8000-000000000006\", new ReportTemplatesUpdateParams\n{\n FieldConfig = new Dictionary { [\"rentity_id\"] = \"FIU-US-00124\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Обновлённый шаблон.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTemplateDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "summary": "Удалить шаблон отчёта", "description": "Удалить шаблон отчета. Это не влияет на отчеты, которые уже были созданы на его основе.", "operationId": "delete_report_template", "x-didit-sdk": { "resource": "report_templates", "method": "delete", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Report Templates" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "template_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "7ec00000-0000-4000-8000-000000000006" }, "description": "UUID шаблона отчёта." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/report-templates/7ec00000-0000-4000-8000-000000000006/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nclient.report_templates.delete(\n \"7ec00000-0000-4000-8000-000000000006\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nawait didit.reportTemplates.delete(\"7ec00000-0000-4000-8000-000000000006\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nif err := client.ReportTemplates.Delete(ctx, \"7ec00000-0000-4000-8000-000000000006\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.reportTemplates().delete(\"7ec00000-0000-4000-8000-000000000006\");" }, { "lang": "php", "label": "PHP", "source": "reportTemplates->delete('7ec00000-0000-4000-8000-000000000006');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.report_templates.delete(\"7ec00000-0000-4000-8000-000000000006\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait client.ReportTemplates.DeleteAsync(\"7ec00000-0000-4000-8000-000000000006\");" } ], "responses": { "204": { "description": "Шаблон удален." } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/": { "get": { "summary": "Получить список отчётов по кейсу", "description": "Получить список отчётов FIU, созданных для кейса.", "operationId": "list_case_regulatory_reports", "x-didit-sdk": { "resource": "cases.regulatory_reports", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Regulatory Reports" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID кейса." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Размер страницы." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Смещение, начиная с нуля." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/regulatory-reports/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.regulatory_reports.list(\n \"c1a5e000-0000-4000-8000-000000000001\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.regulatoryReports.list(\"c1a5e000-0000-4000-8000-000000000001\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.RegulatoryReports.ListAutoPaging(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesRegulatoryReportsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().regulatoryReports().list(\"c1a5e000-0000-4000-8000-000000000001\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->regulatoryReports->list('c1a5e000-0000-4000-8000-000000000001') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.regulatory_reports.list(\"c1a5e000-0000-4000-8000-000000000001\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.RegulatoryReports.ListAsync(\"c1a5e000-0000-4000-8000-000000000001\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Отчёты по кейсу с пагинацией.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportList" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Создать отчёт из кейса", "description": "Создайте черновик отчёта для подразделения финансовой разведки (FIU) по кейсу: статус DRAFT, автоматическое заполнение на основе опционального шаблона, субъекта кейса, связанных транзакций и описания. Выполните валидацию, затем финализируйте отчёт для формирования XML goAML и PDF.", "operationId": "create_case_regulatory_report", "x-didit-sdk": { "resource": "cases.regulatory_reports", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Regulatory Reports" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID кейса." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ], "description": "Обязательно, если не указан шаблон; в противном случае используется report_type из шаблона." }, "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Обязательно, если не указан шаблон." }, "template": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID шаблона отчёта; его field_config заполняет черновик до объединения с данными из кейса." }, "transactions": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true, "description": "Транзакции для прикрепления; по умолчанию прикрепляются связанные с кейсом транзакции." }, "rentity_id": { "type": "string", "nullable": true }, "rentity_branch": { "type": "string", "nullable": true }, "submission_code": { "type": "string", "enum": [ "E", "M" ], "default": "E" }, "entity_reference": { "type": "string", "nullable": true }, "fiu_ref_number": { "type": "string", "nullable": true }, "currency_code_local": { "type": "string", "minLength": 3, "maxLength": 3, "nullable": true }, "submission_date": { "type": "string", "format": "date-time", "nullable": true }, "reporting_person": { "type": "object" }, "location": { "type": "object" }, "reason": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "activity": { "type": "string", "nullable": true }, "narrative": { "type": "object", "properties": { "who": { "type": "string" }, "what": { "type": "string" }, "when": { "type": "string" }, "where": { "type": "string" }, "why": { "type": "string" }, "how": { "type": "string" } } }, "report_indicators": { "type": "array", "items": { "type": "string" } }, "included_fields": { "type": "array", "items": { "type": "string" } } } }, "example": { "template": "7ec00000-0000-4000-8000-000000000006" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/regulatory-reports/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"template\": \"7ec00000-0000-4000-8000-000000000006\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.regulatory_reports.create(\n \"c1a5e000-0000-4000-8000-000000000001\",\n template=\"7ec00000-0000-4000-8000-000000000006\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.regulatoryReports.create(\"c1a5e000-0000-4000-8000-000000000001\", {\n template: \"7ec00000-0000-4000-8000-000000000006\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RegulatoryReports.Create(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesRegulatoryReportsCreateParams{\n\tTemplate: didit.String(\"7ec00000-0000-4000-8000-000000000006\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesRegulatoryReportsCreateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().regulatoryReports().create(\"c1a5e000-0000-4000-8000-000000000001\", CasesRegulatoryReportsCreateParams.builder()\n .template(\"7ec00000-0000-4000-8000-000000000006\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->regulatoryReports->create('c1a5e000-0000-4000-8000-000000000001', [\n 'template' => '7ec00000-0000-4000-8000-000000000006',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.regulatory_reports.create(\n \"c1a5e000-0000-4000-8000-000000000001\",\n template: \"7ec00000-0000-4000-8000-000000000006\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RegulatoryReports.CreateAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesRegulatoryReportsCreateParams\n{\n Template = \"7ec00000-0000-4000-8000-000000000006\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Черновик отчёта создан.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportDetail" } } } }, "400": { "description": "Указанный шаблон не найден.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/": { "get": { "summary": "Получить список отчётов", "description": "Список отчётов FIU по всему приложению, с возможностью фильтрации по status, report_type или case.", "operationId": "list_regulatory_reports", "x-didit-sdk": { "resource": "regulatory_reports", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Regulatory Reports" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Размер страницы." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Смещение, начиная с нуля." }, { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "DRAFT", "VALIDATED", "FINALIZED" ] }, "description": "Фильтр по статусу." }, { "name": "report_type", "in": "query", "schema": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ] }, "description": "Фильтр по типу отчёта." }, { "name": "case", "in": "query", "schema": { "type": "string", "format": "uuid" }, "description": "Фильтровать по отчётам в этом кейсе." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.regulatory_reports.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.regulatoryReports.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.RegulatoryReports.ListAutoPaging(ctx, didit.RegulatoryReportsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.regulatoryReports().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "regulatoryReports->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.regulatory_reports.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.RegulatoryReports.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Отчёты по всему приложению с пагинацией.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportList" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Создать отдельный отчёт", "description": "Создайте черновик отчёта для подразделения финансовой разведки (FIU) со страницы «Отчёты»: кейс и шаблон обязательны (в отличие от создания внутри кейса, где шаблон можно опустить).", "operationId": "create_standalone_regulatory_report", "x-didit-sdk": { "resource": "regulatory_reports", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Regulatory Reports" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "case", "template" ], "properties": { "case": { "type": "string", "format": "uuid" }, "template": { "type": "string", "format": "uuid" }, "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ], "description": "Обязательно, если не указан шаблон; в противном случае используется report_type из шаблона." }, "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Обязательно, если не указан шаблон." }, "transactions": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true, "description": "Транзакции для прикрепления; по умолчанию прикрепляются связанные с кейсом транзакции." }, "rentity_id": { "type": "string", "nullable": true }, "rentity_branch": { "type": "string", "nullable": true }, "submission_code": { "type": "string", "enum": [ "E", "M" ], "default": "E" }, "entity_reference": { "type": "string", "nullable": true }, "fiu_ref_number": { "type": "string", "nullable": true }, "currency_code_local": { "type": "string", "minLength": 3, "maxLength": 3, "nullable": true }, "submission_date": { "type": "string", "format": "date-time", "nullable": true }, "reporting_person": { "type": "object" }, "location": { "type": "object" }, "reason": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "activity": { "type": "string", "nullable": true }, "narrative": { "type": "object", "properties": { "who": { "type": "string" }, "what": { "type": "string" }, "when": { "type": "string" }, "where": { "type": "string" }, "why": { "type": "string" }, "how": { "type": "string" } } }, "report_indicators": { "type": "array", "items": { "type": "string" } }, "included_fields": { "type": "array", "items": { "type": "string" } } } }, "example": { "case": "c1a5e000-0000-4000-8000-000000000001", "template": "7ec00000-0000-4000-8000-000000000006" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"case\": \"c1a5e000-0000-4000-8000-000000000001\", \"template\": \"7ec00000-0000-4000-8000-000000000006\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.regulatory_reports.create(\n case=\"c1a5e000-0000-4000-8000-000000000001\",\n template=\"7ec00000-0000-4000-8000-000000000006\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.regulatoryReports.create({\n case: \"c1a5e000-0000-4000-8000-000000000001\",\n template: \"7ec00000-0000-4000-8000-000000000006\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.RegulatoryReports.Create(ctx, didit.RegulatoryReportsCreateParams{\n\tCase: \"c1a5e000-0000-4000-8000-000000000001\",\n\tTemplate: \"7ec00000-0000-4000-8000-000000000006\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.RegulatoryReportsCreateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.regulatoryReports().create(RegulatoryReportsCreateParams.builder()\n .case_(\"c1a5e000-0000-4000-8000-000000000001\")\n .template(\"7ec00000-0000-4000-8000-000000000006\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "regulatoryReports->create([\n 'case' => 'c1a5e000-0000-4000-8000-000000000001',\n 'template' => '7ec00000-0000-4000-8000-000000000006',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.regulatory_reports.create(\n case: \"c1a5e000-0000-4000-8000-000000000001\",\n template: \"7ec00000-0000-4000-8000-000000000006\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.RegulatoryReports.CreateAsync(new RegulatoryReportsCreateParams\n{\n Case = \"c1a5e000-0000-4000-8000-000000000001\",\n Template = \"7ec00000-0000-4000-8000-000000000006\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Черновик отчёта создан.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportDetail" } } } }, "400": { "description": "Указанный шаблон не найден.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/": { "get": { "summary": "Получить отчёт", "description": "Получить регуляторный отчёт.", "operationId": "get_regulatory_report", "x-didit-sdk": { "resource": "regulatory_reports", "method": "retrieve", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Regulatory Reports" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID отчёта." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/5ec00000-0000-4000-8000-000000000007/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.regulatory_reports.retrieve(\n \"5ec00000-0000-4000-8000-000000000007\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.regulatoryReports.retrieve(\"5ec00000-0000-4000-8000-000000000007\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.RegulatoryReports.Retrieve(ctx, \"5ec00000-0000-4000-8000-000000000007\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.regulatoryReports().retrieve(\"5ec00000-0000-4000-8000-000000000007\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "regulatoryReports->retrieve('5ec00000-0000-4000-8000-000000000007');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.regulatory_reports.retrieve(\"5ec00000-0000-4000-8000-000000000007\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.RegulatoryReports.RetrieveAsync(\"5ec00000-0000-4000-8000-000000000007\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Детали отчёта.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Обновить отчёт", "description": "Редактировать поля черновика или проверенного отчёта. Финализированные отчёты редактировать нельзя (409).", "operationId": "update_regulatory_report", "x-didit-sdk": { "resource": "regulatory_reports", "method": "update", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Regulatory Reports" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID отчёта." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2 }, "rentity_id": { "type": "string", "nullable": true }, "rentity_branch": { "type": "string", "nullable": true }, "submission_code": { "type": "string", "enum": [ "E", "M" ], "default": "E" }, "entity_reference": { "type": "string", "nullable": true }, "fiu_ref_number": { "type": "string", "nullable": true }, "currency_code_local": { "type": "string", "minLength": 3, "maxLength": 3, "nullable": true }, "submission_date": { "type": "string", "format": "date-time", "nullable": true }, "reporting_person": { "type": "object" }, "location": { "type": "object" }, "reason": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "activity": { "type": "string", "nullable": true }, "narrative": { "type": "object", "properties": { "who": { "type": "string" }, "what": { "type": "string" }, "when": { "type": "string" }, "where": { "type": "string" }, "why": { "type": "string" }, "how": { "type": "string" } } }, "report_indicators": { "type": "array", "items": { "type": "string" } }, "included_fields": { "type": "array", "items": { "type": "string" } } } }, "example": { "rentity_id": "FIU-US-00123", "currency_code_local": "USD" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/5ec00000-0000-4000-8000-000000000007/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"rentity_id\": \"FIU-US-00123\", \"currency_code_local\": \"USD\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.regulatory_reports.update(\n \"5ec00000-0000-4000-8000-000000000007\",\n rentity_id=\"FIU-US-00123\",\n currency_code_local=\"USD\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.regulatoryReports.update(\"5ec00000-0000-4000-8000-000000000007\", {\n rentity_id: \"FIU-US-00123\",\n currency_code_local: \"USD\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.RegulatoryReports.Update(ctx, \"5ec00000-0000-4000-8000-000000000007\", didit.RegulatoryReportsUpdateParams{\n\tRentityID: didit.String(\"FIU-US-00123\"),\n\tCurrencyCodeLocal: didit.String(\"USD\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.RegulatoryReportsUpdateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.regulatoryReports().update(\"5ec00000-0000-4000-8000-000000000007\", RegulatoryReportsUpdateParams.builder()\n .rentityId(\"FIU-US-00123\")\n .currencyCodeLocal(\"USD\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "regulatoryReports->update('5ec00000-0000-4000-8000-000000000007', [\n 'rentity_id' => 'FIU-US-00123',\n 'currency_code_local' => 'USD',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.regulatory_reports.update(\n \"5ec00000-0000-4000-8000-000000000007\",\n rentity_id: \"FIU-US-00123\",\n currency_code_local: \"USD\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.RegulatoryReports.UpdateAsync(\"5ec00000-0000-4000-8000-000000000007\", new RegulatoryReportsUpdateParams\n{\n RentityId = \"FIU-US-00123\",\n CurrencyCodeLocal = \"USD\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Обновлённый отчёт.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportDetail" } } } }, "409": { "description": "Отчёт уже финализирован.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "summary": "Удалить отчёт", "description": "Удалить регуляторный отчет навсегда. Отчет, скопированное описание и причины, ссылки на транзакции, а также сгенерированные файлы goAML XML и PDF стираются, включая все сохраненные версии этих файлов. Отчет исчезает из списков, а URL для скачивания перестают работать. Другие записи, включая кейс, транзакции, людей и компании, не удаляются. Отмена действия невозможна.\n\nЧерновик или проверенный отчет можно удалить без тела запроса. Для удаления финализированного отчета требуется `confirm_delete: true` в теле запроса. Если отчет отсутствует, запрос возвращает `404`; если финализированный отчет отправлен без подтверждения, запрос возвращает `400`, и ничего не удаляется.", "operationId": "delete_regulatory_report", "x-didit-sdk": { "resource": "regulatory_reports", "method": "delete", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Regulatory Reports" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID отчёта." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl (draft report)", "source": "curl -X DELETE 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/5ec00000-0000-4000-8000-000000000007/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "curl", "label": "curl (finalized report)", "source": "curl -X DELETE 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/5ec00000-0000-4000-8000-000000000007/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"confirm_delete\": true}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nclient.regulatory_reports.delete(\n \"5ec00000-0000-4000-8000-000000000007\",\n confirm_delete=True,\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nawait didit.regulatoryReports.delete(\"5ec00000-0000-4000-8000-000000000007\", {\n confirm_delete: true,\n});" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.RegulatoryReportsDeleteParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.regulatoryReports().delete(\"5ec00000-0000-4000-8000-000000000007\", RegulatoryReportsDeleteParams.builder()\n .confirmDelete(true)\n .build());" }, { "lang": "php", "label": "PHP", "source": "regulatoryReports->delete('5ec00000-0000-4000-8000-000000000007', [\n 'confirm_delete' => true,\n]);" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.regulatory_reports.delete(\n \"5ec00000-0000-4000-8000-000000000007\",\n confirm_delete: true\n)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait client.RegulatoryReports.DeleteAsync(\"5ec00000-0000-4000-8000-000000000007\", new RegulatoryReportsDeleteParams\n{\n ConfirmDelete = true,\n});" } ], "responses": { "204": { "description": "Отчёт удалён вместе со сгенерированными файлами." }, "400": { "description": "Завершённый отчёт был отправлен без `confirm_delete: true`. Ничего не удалено.", "content": { "application/json": { "schema": { "type": "object", "properties": { "confirm_delete": { "type": "array", "items": { "type": "string" } } } }, "example": { "confirm_delete": [ "This field is required to delete a finalized report." ] } } } }, "403": { "description": "API-ключ не может удалять отчёты: endpoint требует `write:cases`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "404": { "description": "Отчёт не найден в этом приложении.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "409": { "description": "Отчёт уже удаляется. Повторите запрос, чтобы завершить удаление его файлов.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string" } } }, "example": { "detail": "This report is being deleted. Retry deleting it to finish erasing its files.", "code": "report_deletion_pending" } } } }, "503": { "description": "Файлы отчёта не удалось удалить прямо сейчас. Отчёт по-прежнему сохранён. Повторите запрос.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string" } } }, "example": { "detail": "The report files could not be erased. Please retry deleting the report.", "code": "report_storage_unavailable" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": false, "description": "Обязательно только для финализированного отчёта.", "content": { "application/json": { "schema": { "type": "object", "properties": { "confirm_delete": { "type": "boolean", "description": "Установите значение true, чтобы подтвердить безвозвратное удаление окончательного отчёта и созданных для него файлов." } }, "example": { "confirm_delete": true } }, "example": { "confirm_delete": true } } } } } }, "/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/validate/": { "post": { "summary": "Проверить отчёт", "description": "Проверяет отчёт на наличие обязательных полей заголовка goAML (ID отчитывающейся организации, код отправки, местная валюта, предпринятое действие, дата отправки), а также как минимум одной прикреплённой транзакции и 2-буквенного кода юрисдикции без генерации файлов. Также сохраняет результат в отчёте: обновляются validation_errors и validated_at, а статус неокончательного отчёта переходит в VALIDATED (при отсутствии ошибок) или возвращается в DRAFT (при наличии ошибок).", "operationId": "validate_regulatory_report", "x-didit-sdk": { "resource": "regulatory_reports", "method": "validate", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Regulatory Reports" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID отчёта." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/5ec00000-0000-4000-8000-000000000007/validate/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.regulatory_reports.validate(\n \"5ec00000-0000-4000-8000-000000000007\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.regulatoryReports.validate(\"5ec00000-0000-4000-8000-000000000007\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.RegulatoryReports.Validate(ctx, \"5ec00000-0000-4000-8000-000000000007\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.regulatoryReports().validate(\"5ec00000-0000-4000-8000-000000000007\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "regulatoryReports->validate('5ec00000-0000-4000-8000-000000000007');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.regulatory_reports.validate(\"5ec00000-0000-4000-8000-000000000007\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.RegulatoryReports.ValidateAsync(\"5ec00000-0000-4000-8000-000000000007\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Результат валидации.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "DRAFT", "VALIDATED", "FINALIZED" ] }, "is_valid": { "type": "boolean" }, "errors": { "type": "array", "description": "Пусто при валидности.", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } } } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/finalize/": { "post": { "summary": "Финализировать отчёт", "description": "Повторно выполнить валидацию, затем сформировать XML и PDF для goAML и загрузить оба файла в S3. Для отчётов SAR/STR/TFR это также переводит оповещения о транзакциях кейса из статуса Pending SAR в SAR filed.", "operationId": "finalize_regulatory_report", "x-didit-sdk": { "resource": "regulatory_reports", "method": "finalize", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Regulatory Reports" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID отчёта." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/5ec00000-0000-4000-8000-000000000007/finalize/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.regulatory_reports.finalize(\n \"5ec00000-0000-4000-8000-000000000007\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.regulatoryReports.finalize(\"5ec00000-0000-4000-8000-000000000007\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.RegulatoryReports.Finalize(ctx, \"5ec00000-0000-4000-8000-000000000007\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.regulatoryReports().finalize_(\"5ec00000-0000-4000-8000-000000000007\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "regulatoryReports->finalize('5ec00000-0000-4000-8000-000000000007');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.regulatory_reports.finalize(\"5ec00000-0000-4000-8000-000000000007\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.RegulatoryReports.FinalizeAsync(\"5ec00000-0000-4000-8000-000000000007\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Отчёт финализирован; xml_s3_key и pdf_s3_key заданы.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportDetail" } } } }, "400": { "description": "Отчёт не прошёл валидацию.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "409": { "description": "Отчёт не находится в состоянии, доступном для финализации.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/download-url/": { "get": { "summary": "Получить URL скачивания отчёта", "description": "Сгенерировать предварительно подписанный URL для goAML XML или PDF финализированного отчёта.", "operationId": "get_regulatory_report_download_url", "x-didit-sdk": { "resource": "regulatory_reports", "method": "retrieve_download_url", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Regulatory Reports" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID отчёта." }, { "name": "file", "in": "query", "schema": { "type": "string", "enum": [ "pdf", "xml" ], "default": "pdf" }, "description": "Какой файл скачать." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/5ec00000-0000-4000-8000-000000000007/download-url/?file=xml' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.regulatory_reports.retrieve_download_url(\n \"5ec00000-0000-4000-8000-000000000007\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.regulatoryReports.retrieveDownloadUrl(\"5ec00000-0000-4000-8000-000000000007\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.RegulatoryReports.RetrieveDownloadURL(ctx, \"5ec00000-0000-4000-8000-000000000007\", didit.RegulatoryReportsRetrieveDownloadURLParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.regulatoryReports().retrieveDownloadUrl(\"5ec00000-0000-4000-8000-000000000007\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "regulatoryReports->retrieveDownloadUrl('5ec00000-0000-4000-8000-000000000007');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.regulatory_reports.retrieve_download_url(\"5ec00000-0000-4000-8000-000000000007\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.RegulatoryReports.RetrieveDownloadUrlAsync(\"5ec00000-0000-4000-8000-000000000007\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Предварительно подписанный URL для скачивания.", "content": { "application/json": { "schema": { "type": "object", "properties": { "download_url": { "type": "string", "format": "uri" }, "file": { "type": "string", "enum": [ "pdf", "xml" ] } } } } } }, "409": { "description": "Отчёт ещё не финализирован.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "status": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/transactions/rules/": { "get": { "summary": "Получить список правил", "description": "Получить список правил мониторинга транзакций приложения: ваших собственных правил и установленных пресетов из библиотеки. Доступна фильтрация по источнику, категории, режиму, набору или текстовому поиску; сортировка с помощью `ordering` (run_count, approved_pct, reviewed_pct, declined_pct, latest_triggered_at, title, created_at, source, каждый с опциональным префиксом `-`).", "operationId": "listTransactionRules", "x-didit-sdk": { "resource": "transactions.rules", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "source", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "PRESET", "CUSTOM" ] }, "description": "PRESET или CUSTOM" }, { "name": "category", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Фильтр по категории правил" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ACTIVE", "DISABLED", "TEST" ] }, "description": "ACTIVE, DISABLED или TEST" }, { "name": "bundle", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Фильтровать пресеты по пакету" }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Поиск без учёта регистра по названию и описанию" }, { "name": "ordering", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Разделённые запятыми поля сортировки, по умолчанию source,-run_count" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Размер страницы" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Смещение страницы" } ], "responses": { "200": { "description": "Правила с пагинацией.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleDetail" } } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/transactions/rules/?source=CUSTOM&ordering=-run_count' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.transactions.rules.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.transactions.rules.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Transactions.Rules.ListAutoPaging(ctx, didit.TransactionsRulesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.transactions().rules().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "transactions->rules->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.transactions.rules.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Transactions.Rules.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] }, "post": { "summary": "Создать правило", "description": "Создать правило мониторинга транзакций типа CUSTOM. Названия уникальны для каждого приложения (дубликат -> 400). Действие `change_status`, направленное на `AWAITING_USER`, должно содержать `workflow_id`. Правила, созданные в режиме ACTIVE, сразу применяются к новым транзакциям; рекомендуемый порядок действий: создать в режиме TEST, провести бэктестинг, затем переключить режим на ACTIVE. Чтобы изменить библиотечное правило, создайте его копию: передайте определение библиотечного правила с параметрами `metadata.based_on` (его библиотечный ключ) и `metadata.based_on_rule_uuid`.", "operationId": "createTransactionRule", "x-didit-sdk": { "resource": "transactions.rules", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleCreateRequest" }, "example": { "title": "Structuring - inbound (custom)", "description": "20+ inbound EUR transfers, all under 10,000 EUR, 30 days", "category": "finance", "mode": "TEST", "evaluation_mode": "ALL", "scope": { "transaction_types": [ "finance" ], "directions": [ "INBOUND" ] }, "conditions": [ { "field": "currency", "operator": "eq", "value": "EUR" }, { "field": "amount", "operator": "lt", "value": 10000 } ], "aggregation": [ { "metric": "count", "operator": "gte", "value": 20, "window": "30d", "filters": { "direction": "INBOUND", "transaction_type": "finance", "subject_vendor_data": "__current__", "currency": "EUR" } }, { "metric": "max", "field": "amount", "operator": "lt", "value": 10000, "window": "30d", "filters": { "direction": "INBOUND", "transaction_type": "finance", "subject_vendor_data": "__current__", "currency": "EUR" } } ], "actions": [ { "type": "add_score", "value": 35 } ] } } } }, "responses": { "201": { "description": "Созданное правило.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleDetail" } } } }, "400": { "description": "Ошибка валидации: дублирующийся заголовок, неизвестный оператор/метрика, некорректный формат окна, недопустимое направление области действия или AWAITING_USER без workflow_id.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "title": [ "A rule with this name already exists." ] } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/transactions/rules/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"title\": \"Structuring - inbound (custom)\", \"description\": \"20+ inbound EUR transfers, all under 10,000 EUR, 30 days\", \"category\": \"finance\", \"mode\": \"TEST\", \"evaluation_mode\": \"ALL\", \"scope\": {\"transaction_types\": [\"finance\"], \"directions\": [\"INBOUND\"]}, \"conditions\": [{\"field\": \"currency\", \"operator\": \"eq\", \"value\": \"EUR\"}, {\"field\": \"amount\", \"operator\": \"lt\", \"value\": 10000}], \"aggregation\": [{\"metric\": \"count\", \"operator\": \"gte\", \"value\": 20, \"window\": \"30d\", \"filters\": {\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}}, {\"metric\": \"max\", \"field\": \"amount\", \"operator\": \"lt\", \"value\": 10000, \"window\": \"30d\", \"filters\": {\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}}], \"actions\": [{\"type\": \"add_score\", \"value\": 35}]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.rules.create(\n title=\"Structuring - inbound (custom)\",\n description=\"20+ inbound EUR transfers, all under 10,000 EUR, 30 days\",\n category=\"finance\",\n mode=\"TEST\",\n evaluation_mode=\"ALL\",\n scope={\n \"transaction_types\": [\"finance\"],\n \"directions\": [\"INBOUND\"],\n },\n conditions=[{\n \"field\": \"currency\",\n \"operator\": \"eq\",\n \"value\": \"EUR\",\n }, {\n \"field\": \"amount\",\n \"operator\": \"lt\",\n \"value\": 10000,\n }],\n aggregation=[{\n \"metric\": \"count\",\n \"operator\": \"gte\",\n \"value\": 20.0,\n \"window\": \"30d\",\n \"filters\": {\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"},\n }, {\n \"metric\": \"max\",\n \"field\": \"amount\",\n \"operator\": \"lt\",\n \"value\": 10000.0,\n \"window\": \"30d\",\n \"filters\": {\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"},\n }],\n actions=[{\n \"type\": \"add_score\",\n \"value\": 35,\n }],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.rules.create({\n title: \"Structuring - inbound (custom)\",\n description: \"20+ inbound EUR transfers, all under 10,000 EUR, 30 days\",\n category: \"finance\",\n mode: \"TEST\",\n evaluation_mode: \"ALL\",\n scope: {\n transaction_types: [\"finance\"],\n directions: [\"INBOUND\"],\n },\n conditions: [{\n field: \"currency\",\n operator: \"eq\",\n value: \"EUR\",\n }, {\n field: \"amount\",\n operator: \"lt\",\n value: 10000,\n }],\n aggregation: [{\n metric: \"count\",\n operator: \"gte\",\n value: 20.0,\n window: \"30d\",\n filters: { direction: \"INBOUND\", transaction_type: \"finance\", subject_vendor_data: \"__current__\", currency: \"EUR\" },\n }, {\n metric: \"max\",\n field: \"amount\",\n operator: \"lt\",\n value: 10000.0,\n window: \"30d\",\n filters: { direction: \"INBOUND\", transaction_type: \"finance\", subject_vendor_data: \"__current__\", currency: \"EUR\" },\n }],\n actions: [{\n type: \"add_score\",\n value: 35,\n }],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Rules.Create(ctx, didit.TransactionRuleCreateRequest{\n\tTitle: \"Structuring - inbound (custom)\",\n\tDescription: didit.String(\"20+ inbound EUR transfers, all under 10,000 EUR, 30 days\"),\n\tCategory: \"finance\",\n\tMode: \"TEST\",\n\tEvaluationMode: didit.Some(didit.TransactionRuleCreateRequestEvaluationMode(\"ALL\")),\n\tScope: didit.Some(didit.TransactionRuleScopeParam{\n\t\tTransactionTypes: didit.Some([]string{\"finance\"}),\n\t\tDirections: didit.Some([]didit.TransactionRuleScopeDirections{\"INBOUND\"}),\n\t}),\n\tConditions: didit.Some([]didit.TransactionRuleConditionParam{{\n\t\tField: \"currency\",\n\t\tOperator: \"eq\",\n\t\tValue: didit.Some[any](\"EUR\"),\n\t}, {\n\t\tField: \"amount\",\n\t\tOperator: \"lt\",\n\t\tValue: didit.Some[any](10000),\n\t}}),\n\tAggregation: didit.Some([]didit.TransactionRuleAggregationParam{{\n\t\tMetric: didit.Some(didit.TransactionRuleAggregationMetric(\"count\")),\n\t\tOperator: didit.Some(didit.TransactionRuleAggregationOperator(\"gte\")),\n\t\tValue: 20.0,\n\t\tWindow: didit.String(\"30d\"),\n\t\tFilters: didit.Some(map[string]any{\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}),\n\t}, {\n\t\tMetric: didit.Some(didit.TransactionRuleAggregationMetric(\"max\")),\n\t\tField: didit.String(\"amount\"),\n\t\tOperator: didit.Some(didit.TransactionRuleAggregationOperator(\"lt\")),\n\t\tValue: 10000.0,\n\t\tWindow: didit.String(\"30d\"),\n\t\tFilters: didit.Some(map[string]any{\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}),\n\t}}),\n\tActions: didit.Some([]didit.TransactionRuleActionParam{{\n\t\tType: \"add_score\",\n\t\tValue: didit.Some[any](35),\n\t}}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.TransactionRuleAction;\nimport me.didit.types.TransactionRuleActionAddScore;\nimport me.didit.types.TransactionRuleAggregation;\nimport me.didit.types.TransactionRuleCondition;\nimport me.didit.types.TransactionRuleCreateRequest;\nimport me.didit.types.TransactionRuleScope;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().rules().create(TransactionRuleCreateRequest.builder()\n .title(\"Structuring - inbound (custom)\")\n .description(\"20+ inbound EUR transfers, all under 10,000 EUR, 30 days\")\n .category(\"finance\")\n .mode(TransactionRuleCreateRequest.Mode.of(\"TEST\"))\n .evaluationMode(TransactionRuleCreateRequest.EvaluationMode.of(\"ALL\"))\n .scope(TransactionRuleScope.builder()\n .transactionTypes(List.of(\"finance\"))\n .directions(List.of(TransactionRuleScope.Directions.of(\"INBOUND\")))\n .build())\n .conditions(List.of(\n TransactionRuleCondition.builder()\n .field(\"currency\")\n .operator(TransactionRuleCondition.Operator.of(\"eq\"))\n .value(\"EUR\")\n .build(),\n TransactionRuleCondition.builder()\n .field(\"amount\")\n .operator(TransactionRuleCondition.Operator.of(\"lt\"))\n .value(10000)\n .build()))\n .aggregation(List.of(\n TransactionRuleAggregation.builder()\n .metric(TransactionRuleAggregation.Metric.of(\"count\"))\n .operator(TransactionRuleAggregation.Operator.of(\"gte\"))\n .value(20.0)\n .window(\"30d\")\n .filters(Map.of(\"direction\", \"INBOUND\", \"transaction_type\", \"finance\", \"subject_vendor_data\", \"__current__\", \"currency\", \"EUR\"))\n .build(),\n TransactionRuleAggregation.builder()\n .metric(TransactionRuleAggregation.Metric.of(\"max\"))\n .field(\"amount\")\n .operator(TransactionRuleAggregation.Operator.of(\"lt\"))\n .value(10000.0)\n .window(\"30d\")\n .filters(Map.of(\"direction\", \"INBOUND\", \"transaction_type\", \"finance\", \"subject_vendor_data\", \"__current__\", \"currency\", \"EUR\"))\n .build()))\n .actions(List.of(TransactionRuleAction.ofAddScore(TransactionRuleActionAddScore.builder()\n .type(TransactionRuleActionAddScore.Type.of(\"add_score\"))\n .value(35L)\n .build())))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->rules->create([\n 'title' => 'Structuring - inbound (custom)',\n 'description' => '20+ inbound EUR transfers, all under 10,000 EUR, 30 days',\n 'category' => 'finance',\n 'mode' => 'TEST',\n 'evaluation_mode' => 'ALL',\n 'scope' => [\n 'transaction_types' => ['finance'],\n 'directions' => ['INBOUND'],\n ],\n 'conditions' => [[\n 'field' => 'currency',\n 'operator' => 'eq',\n 'value' => 'EUR',\n ], [\n 'field' => 'amount',\n 'operator' => 'lt',\n 'value' => 10000,\n ]],\n 'aggregation' => [[\n 'metric' => 'count',\n 'operator' => 'gte',\n 'value' => 20.0,\n 'window' => '30d',\n 'filters' => ['direction' => 'INBOUND', 'transaction_type' => 'finance', 'subject_vendor_data' => '__current__', 'currency' => 'EUR'],\n ], [\n 'metric' => 'max',\n 'field' => 'amount',\n 'operator' => 'lt',\n 'value' => 10000.0,\n 'window' => '30d',\n 'filters' => ['direction' => 'INBOUND', 'transaction_type' => 'finance', 'subject_vendor_data' => '__current__', 'currency' => 'EUR'],\n ]],\n 'actions' => [[\n 'type' => 'add_score',\n 'value' => 35,\n ]],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.rules.create(\n title: \"Structuring - inbound (custom)\",\n description: \"20+ inbound EUR transfers, all under 10,000 EUR, 30 days\",\n category: \"finance\",\n mode: \"TEST\",\n evaluation_mode: \"ALL\",\n scope: {\n transaction_types: [\"finance\"],\n directions: [\"INBOUND\"],\n },\n conditions: [{\n field: \"currency\",\n operator: \"eq\",\n value: \"EUR\",\n }, {\n field: \"amount\",\n operator: \"lt\",\n value: 10000,\n }],\n aggregation: [{\n metric: \"count\",\n operator: \"gte\",\n value: 20.0,\n window: \"30d\",\n filters: { direction: \"INBOUND\", transaction_type: \"finance\", subject_vendor_data: \"__current__\", currency: \"EUR\" },\n }, {\n metric: \"max\",\n field: \"amount\",\n operator: \"lt\",\n value: 10000.0,\n window: \"30d\",\n filters: { direction: \"INBOUND\", transaction_type: \"finance\", subject_vendor_data: \"__current__\", currency: \"EUR\" },\n }],\n actions: [{\n type: \"add_score\",\n value: 35,\n }]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.Rules.CreateAsync(new TransactionRuleCreateRequest\n{\n Title = \"Structuring - inbound (custom)\",\n Description = \"20+ inbound EUR transfers, all under 10,000 EUR, 30 days\",\n Category = \"finance\",\n Mode = \"TEST\",\n EvaluationMode = new TransactionRuleCreateRequestEvaluationMode(\"ALL\"),\n Scope = new TransactionRuleScope\n {\n TransactionTypes = new string[] { \"finance\" },\n Directions = new TransactionRuleScopeDirections[] { \"INBOUND\" },\n },\n Conditions = new TransactionRuleCondition[]\n {\n new()\n {\n Field = \"currency\",\n Operator = \"eq\",\n Value = \"EUR\",\n },\n new()\n {\n Field = \"amount\",\n Operator = \"lt\",\n Value = 10000,\n },\n },\n Aggregation = new TransactionRuleAggregation[]\n {\n new()\n {\n Metric = new TransactionRuleAggregationMetric(\"count\"),\n Operator = new TransactionRuleAggregationOperator(\"gte\"),\n Value = 20.0,\n Window = \"30d\",\n Filters = new Dictionary { [\"direction\"] = \"INBOUND\", [\"transaction_type\"] = \"finance\", [\"subject_vendor_data\"] = \"__current__\", [\"currency\"] = \"EUR\" },\n },\n new()\n {\n Metric = new TransactionRuleAggregationMetric(\"max\"),\n Field = \"amount\",\n Operator = new TransactionRuleAggregationOperator(\"lt\"),\n Value = 10000.0,\n Window = \"30d\",\n Filters = new Dictionary { [\"direction\"] = \"INBOUND\", [\"transaction_type\"] = \"finance\", [\"subject_vendor_data\"] = \"__current__\", [\"currency\"] = \"EUR\" },\n },\n },\n Actions = new TransactionRuleAction[]\n {\n new()\n {\n Type = new TransactionRuleActionType(\"add_score\"),\n Value = 35,\n },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/transactions/rules/{rule_uuid}/": { "parameters": [ { "name": "rule_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID правила из вызова list или create." } ], "get": { "summary": "Получить правило", "description": "Получить одно правило с его полной конфигурацией и счетчиками выполнения.", "operationId": "getTransactionRule", "x-didit-sdk": { "resource": "transactions.rules", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Правило.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleDetail" } } } }, "404": { "description": "Такое правило отсутствует в этом приложении.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/transactions/rules/RULE_UUID/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.rules.retrieve(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.rules.retrieve(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Rules.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().rules().retrieve(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->rules->retrieve('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.rules.retrieve(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.Rules.RetrieveAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "patch": { "summary": "Обновить правило", "description": "Частично обновить правило. Пользовательские правила принимают любые поля конфигурации. Библиотечные правила (PRESET) принимают только `mode`: используйте его для активации, отключения или перевода предустановленного правила в режим TEST; любое другое поле возвращает 400, так как Didit поддерживает библиотечные правила и применяет их обновления автоматически. Чтобы изменить условия библиотечного правила, создайте пользовательскую копию с помощью `POST /v3/transactions/rules/`, используя определение библиотечного правила, а также `metadata.based_on` (ключ библиотеки) и `metadata.based_on_rule_uuid`, затем отключите библиотечное правило с помощью `mode: DISABLED`, чтобы по транзакции не создавалось повторное оповещение. Установленная копия скрытого библиотечного правила отключена: установка для `mode` любого значения, кроме `DISABLED`, возвращает 400 (\"This library rule cannot run yet: its conditions read data the rules engine cannot evaluate.\").", "operationId": "updateTransactionRule", "x-didit-sdk": { "resource": "transactions.rules", "method": "update", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleUpdateRequest" }, "example": { "mode": "ACTIVE" } } } }, "responses": { "200": { "description": "Обновлённое правило.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleDetail" } } } }, "400": { "description": "Ошибка валидации, поле, не относящееся к режиму, в библиотечном правиле или режим, отличный от DISABLED, в библиотечном правиле, для которого установлен статус withheld.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/transactions/rules/RULE_UUID/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"mode\": \"ACTIVE\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.rules.update(\n \"11111111-2222-3333-4444-555555555555\",\n mode=\"ACTIVE\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.rules.update(\"11111111-2222-3333-4444-555555555555\", {\n mode: \"ACTIVE\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Rules.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.TransactionRuleUpdateRequest{\n\tMode: didit.Some(didit.TransactionRuleUpdateRequestMode(\"ACTIVE\")),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TransactionRuleUpdateRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().rules().update(\"11111111-2222-3333-4444-555555555555\", TransactionRuleUpdateRequest.builder()\n .mode(TransactionRuleUpdateRequest.Mode.of(\"ACTIVE\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->rules->update('11111111-2222-3333-4444-555555555555', [\n 'mode' => 'ACTIVE',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.rules.update(\n \"11111111-2222-3333-4444-555555555555\",\n mode: \"ACTIVE\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.Rules.UpdateAsync(\"11111111-2222-3333-4444-555555555555\", new TransactionRuleUpdateRequest\n{\n Mode = new TransactionRuleUpdateRequestMode(\"ACTIVE\"),\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "delete": { "summary": "Удалить правило", "description": "Удалить правило CUSTOM. Удаление происходит мгновенно и навсегда: правило перестает оцениваться для новых транзакций и исчезает из списков, в то время как результаты прошлых проверок правила для уже оцененных транзакций сохраняются. Библиотечные правила нельзя удалить: вместо этого удалите их через endpoint установки (их всегда можно переустановить из библиотеки).", "operationId": "deleteTransactionRule", "x-didit-sdk": { "resource": "transactions.rules", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "204": { "description": "Удалено." }, "400": { "description": "Правило является пресетом из библиотеки: вместо этого удалите его.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "detail": "Library rules cannot be deleted. Uninstall them via the rules install endpoint instead." } } } }, "404": { "description": "Такое правило отсутствует в этом приложении.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/transactions/rules/RULE_UUID/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.transactions.rules.delete(\n \"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.transactions.rules.delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.Transactions.Rules.Delete(ctx, \"11111111-2222-3333-4444-555555555555\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.transactions().rules().delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "php", "label": "PHP", "source": "transactions->rules->delete('11111111-2222-3333-4444-555555555555');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.transactions.rules.delete(\"11111111-2222-3333-4444-555555555555\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.Transactions.Rules.DeleteAsync(\"11111111-2222-3333-4444-555555555555\");" } ] } }, "/v3/transactions/rules/backtest/": { "post": { "summary": "Конфигурация правила бэктеста", "description": "Оцените гипотетическую конфигурацию правила на ваших недавних транзакциях (начиная с самых последних, вплоть до лимита бэктеста) без создания правила и затрагивания каких-либо транзакций. Используйте это перед активацией правила, чтобы увидеть, как часто оно срабатывало бы и скольких субъектов затронуло бы.", "operationId": "backtestTransactionRules", "x-didit-sdk": { "resource": "transactions.rules", "method": "backtest", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleBacktestRequest" }, "example": { "conditions": [ { "field": "currency", "operator": "eq", "value": "EUR" }, { "field": "amount", "operator": "lt", "value": 10000 } ], "aggregation": [ { "metric": "count", "operator": "gte", "value": 20, "window": "30d", "filters": { "direction": "INBOUND", "transaction_type": "finance", "subject_vendor_data": "__current__", "currency": "EUR" } }, { "metric": "max", "field": "amount", "operator": "lt", "value": 10000, "window": "30d", "filters": { "direction": "INBOUND", "transaction_type": "finance", "subject_vendor_data": "__current__", "currency": "EUR" } } ], "evaluation_mode": "ALL", "scope": { "transaction_types": [ "finance" ], "directions": [ "INBOUND" ] }, "period_days": 90 } } } }, "responses": { "200": { "description": "Статистика бэктеста.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleBacktestResult" }, "example": { "evaluated": 4820, "matched": 12, "affected_entities": 4, "period_days": 90 } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/transactions/rules/backtest/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"conditions\": [{\"field\": \"currency\", \"operator\": \"eq\", \"value\": \"EUR\"}, {\"field\": \"amount\", \"operator\": \"lt\", \"value\": 10000}], \"aggregation\": [{\"metric\": \"count\", \"operator\": \"gte\", \"value\": 20, \"window\": \"30d\", \"filters\": {\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}}, {\"metric\": \"max\", \"field\": \"amount\", \"operator\": \"lt\", \"value\": 10000, \"window\": \"30d\", \"filters\": {\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}}], \"evaluation_mode\": \"ALL\", \"scope\": {\"transaction_types\": [\"finance\"], \"directions\": [\"INBOUND\"]}, \"period_days\": 90}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.rules.backtest(\n conditions=[{\n \"field\": \"currency\",\n \"operator\": \"eq\",\n \"value\": \"EUR\",\n }, {\n \"field\": \"amount\",\n \"operator\": \"lt\",\n \"value\": 10000,\n }],\n aggregation=[{\n \"metric\": \"count\",\n \"operator\": \"gte\",\n \"value\": 20.0,\n \"window\": \"30d\",\n \"filters\": {\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"},\n }, {\n \"metric\": \"max\",\n \"field\": \"amount\",\n \"operator\": \"lt\",\n \"value\": 10000.0,\n \"window\": \"30d\",\n \"filters\": {\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"},\n }],\n evaluation_mode=\"ALL\",\n scope={\n \"transaction_types\": [\"finance\"],\n \"directions\": [\"INBOUND\"],\n },\n period_days=90,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.rules.backtest({\n conditions: [{\n field: \"currency\",\n operator: \"eq\",\n value: \"EUR\",\n }, {\n field: \"amount\",\n operator: \"lt\",\n value: 10000,\n }],\n aggregation: [{\n metric: \"count\",\n operator: \"gte\",\n value: 20.0,\n window: \"30d\",\n filters: { direction: \"INBOUND\", transaction_type: \"finance\", subject_vendor_data: \"__current__\", currency: \"EUR\" },\n }, {\n metric: \"max\",\n field: \"amount\",\n operator: \"lt\",\n value: 10000.0,\n window: \"30d\",\n filters: { direction: \"INBOUND\", transaction_type: \"finance\", subject_vendor_data: \"__current__\", currency: \"EUR\" },\n }],\n evaluation_mode: \"ALL\",\n scope: {\n transaction_types: [\"finance\"],\n directions: [\"INBOUND\"],\n },\n period_days: 90,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Rules.Backtest(ctx, didit.TransactionRuleBacktestRequest{\n\tConditions: didit.Some([]didit.TransactionRuleConditionParam{{\n\t\tField: \"currency\",\n\t\tOperator: \"eq\",\n\t\tValue: didit.Some[any](\"EUR\"),\n\t}, {\n\t\tField: \"amount\",\n\t\tOperator: \"lt\",\n\t\tValue: didit.Some[any](10000),\n\t}}),\n\tAggregation: didit.Some([]didit.TransactionRuleAggregationParam{{\n\t\tMetric: didit.Some(didit.TransactionRuleAggregationMetric(\"count\")),\n\t\tOperator: didit.Some(didit.TransactionRuleAggregationOperator(\"gte\")),\n\t\tValue: 20.0,\n\t\tWindow: didit.String(\"30d\"),\n\t\tFilters: didit.Some(map[string]any{\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}),\n\t}, {\n\t\tMetric: didit.Some(didit.TransactionRuleAggregationMetric(\"max\")),\n\t\tField: didit.String(\"amount\"),\n\t\tOperator: didit.Some(didit.TransactionRuleAggregationOperator(\"lt\")),\n\t\tValue: 10000.0,\n\t\tWindow: didit.String(\"30d\"),\n\t\tFilters: didit.Some(map[string]any{\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}),\n\t}}),\n\tEvaluationMode: didit.Some(didit.TransactionRuleBacktestRequestEvaluationMode(\"ALL\")),\n\tScope: didit.Some(didit.TransactionRuleScopeParam{\n\t\tTransactionTypes: didit.Some([]string{\"finance\"}),\n\t\tDirections: didit.Some([]didit.TransactionRuleScopeDirections{\"INBOUND\"}),\n\t}),\n\tPeriodDays: didit.Int(90),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.TransactionRuleAggregation;\nimport me.didit.types.TransactionRuleBacktestRequest;\nimport me.didit.types.TransactionRuleCondition;\nimport me.didit.types.TransactionRuleScope;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().rules().backtest(TransactionRuleBacktestRequest.builder()\n .conditions(List.of(\n TransactionRuleCondition.builder()\n .field(\"currency\")\n .operator(TransactionRuleCondition.Operator.of(\"eq\"))\n .value(\"EUR\")\n .build(),\n TransactionRuleCondition.builder()\n .field(\"amount\")\n .operator(TransactionRuleCondition.Operator.of(\"lt\"))\n .value(10000)\n .build()))\n .aggregation(List.of(\n TransactionRuleAggregation.builder()\n .metric(TransactionRuleAggregation.Metric.of(\"count\"))\n .operator(TransactionRuleAggregation.Operator.of(\"gte\"))\n .value(20.0)\n .window(\"30d\")\n .filters(Map.of(\"direction\", \"INBOUND\", \"transaction_type\", \"finance\", \"subject_vendor_data\", \"__current__\", \"currency\", \"EUR\"))\n .build(),\n TransactionRuleAggregation.builder()\n .metric(TransactionRuleAggregation.Metric.of(\"max\"))\n .field(\"amount\")\n .operator(TransactionRuleAggregation.Operator.of(\"lt\"))\n .value(10000.0)\n .window(\"30d\")\n .filters(Map.of(\"direction\", \"INBOUND\", \"transaction_type\", \"finance\", \"subject_vendor_data\", \"__current__\", \"currency\", \"EUR\"))\n .build()))\n .evaluationMode(TransactionRuleBacktestRequest.EvaluationMode.of(\"ALL\"))\n .scope(TransactionRuleScope.builder()\n .transactionTypes(List.of(\"finance\"))\n .directions(List.of(TransactionRuleScope.Directions.of(\"INBOUND\")))\n .build())\n .periodDays(90L)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->rules->backtest([\n 'conditions' => [[\n 'field' => 'currency',\n 'operator' => 'eq',\n 'value' => 'EUR',\n ], [\n 'field' => 'amount',\n 'operator' => 'lt',\n 'value' => 10000,\n ]],\n 'aggregation' => [[\n 'metric' => 'count',\n 'operator' => 'gte',\n 'value' => 20.0,\n 'window' => '30d',\n 'filters' => ['direction' => 'INBOUND', 'transaction_type' => 'finance', 'subject_vendor_data' => '__current__', 'currency' => 'EUR'],\n ], [\n 'metric' => 'max',\n 'field' => 'amount',\n 'operator' => 'lt',\n 'value' => 10000.0,\n 'window' => '30d',\n 'filters' => ['direction' => 'INBOUND', 'transaction_type' => 'finance', 'subject_vendor_data' => '__current__', 'currency' => 'EUR'],\n ]],\n 'evaluation_mode' => 'ALL',\n 'scope' => [\n 'transaction_types' => ['finance'],\n 'directions' => ['INBOUND'],\n ],\n 'period_days' => 90,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.rules.backtest(\n conditions: [{\n field: \"currency\",\n operator: \"eq\",\n value: \"EUR\",\n }, {\n field: \"amount\",\n operator: \"lt\",\n value: 10000,\n }],\n aggregation: [{\n metric: \"count\",\n operator: \"gte\",\n value: 20.0,\n window: \"30d\",\n filters: { direction: \"INBOUND\", transaction_type: \"finance\", subject_vendor_data: \"__current__\", currency: \"EUR\" },\n }, {\n metric: \"max\",\n field: \"amount\",\n operator: \"lt\",\n value: 10000.0,\n window: \"30d\",\n filters: { direction: \"INBOUND\", transaction_type: \"finance\", subject_vendor_data: \"__current__\", currency: \"EUR\" },\n }],\n evaluation_mode: \"ALL\",\n scope: {\n transaction_types: [\"finance\"],\n directions: [\"INBOUND\"],\n },\n period_days: 90\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.Rules.BacktestAsync(new TransactionRuleBacktestRequest\n{\n Conditions = new TransactionRuleCondition[]\n {\n new()\n {\n Field = \"currency\",\n Operator = \"eq\",\n Value = \"EUR\",\n },\n new()\n {\n Field = \"amount\",\n Operator = \"lt\",\n Value = 10000,\n },\n },\n Aggregation = new TransactionRuleAggregation[]\n {\n new()\n {\n Metric = new TransactionRuleAggregationMetric(\"count\"),\n Operator = new TransactionRuleAggregationOperator(\"gte\"),\n Value = 20.0,\n Window = \"30d\",\n Filters = new Dictionary { [\"direction\"] = \"INBOUND\", [\"transaction_type\"] = \"finance\", [\"subject_vendor_data\"] = \"__current__\", [\"currency\"] = \"EUR\" },\n },\n new()\n {\n Metric = new TransactionRuleAggregationMetric(\"max\"),\n Field = \"amount\",\n Operator = new TransactionRuleAggregationOperator(\"lt\"),\n Value = 10000.0,\n Window = \"30d\",\n Filters = new Dictionary { [\"direction\"] = \"INBOUND\", [\"transaction_type\"] = \"finance\", [\"subject_vendor_data\"] = \"__current__\", [\"currency\"] = \"EUR\" },\n },\n },\n EvaluationMode = new TransactionRuleBacktestRequestEvaluationMode(\"ALL\"),\n Scope = new TransactionRuleScope\n {\n TransactionTypes = new string[] { \"finance\" },\n Directions = new TransactionRuleScopeDirections[] { \"INBOUND\" },\n },\n PeriodDays = 90,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/transactions/rules/library/": { "get": { "summary": "Получить библиотеку правил", "description": "Просмотр полной библиотеки предустановленных правил (150+ правил) с полной конфигурацией каждой записи и флагом `is_installed` для данного приложения. Фильтрация по пакету, категории или текстовому поиску. Правило библиотеки, условия которого используют данные, которые движок правил пока не может оценить, скрывается до тех пор, пока движок не сможет его выполнить. Скрытые правила не отображаются в списке.", "operationId": "listTransactionRuleLibrary", "x-didit-sdk": { "resource": "transactions.rules", "method": "list_library", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "bundle", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Фильтр по пакету, например finance, aml_ctf, crypto_monitoring, travel_rule" }, { "name": "category", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Фильтр по категории" }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Поиск без учёта регистра по названию и описанию" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Размер страницы" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Смещение страницы" } ], "responses": { "200": { "description": "Записи библиотеки с пагинацией.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleLibraryEntry" } } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/transactions/rules/library/?bundle=finance' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.transactions.rules.list_library():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.transactions.rules.listLibrary()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Transactions.Rules.ListLibraryAutoPaging(ctx, didit.TransactionsRulesListLibraryParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.transactions().rules().listLibrary()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "transactions->rules->listLibrary() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.transactions.rules.list_library.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Transactions.Rules.ListLibraryAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] } }, "/v3/transactions/rules/install/": { "post": { "summary": "Установить правила из библиотеки", "description": "Установите один или несколько пресетов в приложение по `library_keys` или целым `bundle`. Установленный пресет становится активным сразу, если мониторинг транзакций включён, и отключён в противном случае; уже установленные ключи пропускаются. Библиотечное правило, условия которого считывают данные, которые движок правил ещё не может оценить, откладывается до тех пор, пока оно не сможет выполняться. Запрос с указанием такого ключа в `library_keys` возвращает 400 и ничего не устанавливает («These library rules cannot run yet: their conditions read data the rules engine cannot evaluate.» с перечислением ключей), а установка `bundle` пропускает его. Отложенное правило восстанавливается автоматически, как только его условия можно будет оценить. Запись в `library_keys`, отсутствующая в библиотеке, пропускается, а не отклоняется.", "operationId": "installTransactionRuleLibrary", "x-didit-sdk": { "resource": "transactions.rules", "method": "install_library", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleInstallRequest" }, "example": { "library_keys": [ "structuring-inbound", "structuring-outbound" ] } } } }, "responses": { "200": { "description": "Что было установлено.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleInstallResult" }, "example": { "installed_library_keys": [ "structuring-inbound", "structuring-outbound" ], "installed_count": 2 } } } }, "400": { "description": "Не указаны ни library_keys, ни bundle, `library_keys` не является списком или элемент `library_keys` скрыт. Неизвестный элемент пропускается, и возвращается ответ 200 без него.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/transactions/rules/install/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"library_keys\": [\"structuring-inbound\", \"structuring-outbound\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.rules.install_library(\n library_keys=[\"structuring-inbound\", \"structuring-outbound\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.rules.installLibrary({\n library_keys: [\"structuring-inbound\", \"structuring-outbound\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Rules.InstallLibrary(ctx, didit.TransactionRuleInstallRequest{\n\tLibraryKeys: didit.Some([]string{\"structuring-inbound\", \"structuring-outbound\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.TransactionRuleInstallRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().rules().installLibrary(TransactionRuleInstallRequest.builder()\n .libraryKeys(List.of(\"structuring-inbound\", \"structuring-outbound\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->rules->installLibrary([\n 'library_keys' => ['structuring-inbound', 'structuring-outbound'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.rules.install_library(library_keys: [\"structuring-inbound\", \"structuring-outbound\"])\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.Rules.InstallLibraryAsync(new TransactionRuleInstallRequest\n{\n LibraryKeys = new string[] { \"structuring-inbound\", \"structuring-outbound\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "delete": { "summary": "Удалить правила библиотеки", "description": "Удалить установленные пресеты из приложения по `library_keys` или целый `bundle`. Удаленные пресеты немедленно прекращают оцениваться и могут быть переустановлены из библиотеки в любое время.", "operationId": "uninstallTransactionRuleLibrary", "x-didit-sdk": { "resource": "transactions.rules", "method": "uninstall_library", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleInstallRequest" }, "example": { "bundle": "responsible_gaming" } } } }, "responses": { "200": { "description": "Сколько пресетов было удалено.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleInstallResult" }, "example": { "uninstalled_count": 5 } } } }, "400": { "description": "Не указаны ни library_keys, ни bundle.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/transactions/rules/install/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"bundle\": \"responsible_gaming\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.rules.uninstall_library(\n bundle=\"responsible_gaming\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.rules.uninstallLibrary({\n bundle: \"responsible_gaming\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Rules.UninstallLibrary(ctx, didit.TransactionRuleInstallRequest{\n\tBundle: didit.String(\"responsible_gaming\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TransactionRuleInstallRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().rules().uninstallLibrary(TransactionRuleInstallRequest.builder()\n .bundle(\"responsible_gaming\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->rules->uninstallLibrary([\n 'bundle' => 'responsible_gaming',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.rules.uninstall_library(bundle: \"responsible_gaming\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.Rules.UninstallLibraryAsync(new TransactionRuleInstallRequest\n{\n Bundle = \"responsible_gaming\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/": { "get": { "summary": "Получить список сетей", "description": "Получить список мошеннических сетей, обнаруженных в организации этого приложения, по умолчанию сначала с наивысшим риском. По умолчанию отклонённые сети исключены; передайте статус, чтобы включить их. Приложения в песочнице никогда не содержат сетей: кластеризация полностью исключает данные песочницы. Каждый ответ содержит `sharing_mode` организации и информацию о том, применяются ли к ней межорганизационные сигналы (`cross_org_available`, `cross_org_unavailable_reason`). `kpis` агрегируют сети, соответствующие вашим фильтрам, а `counts` агрегируют все сети, видимые приложению; передайте `summary=false`, чтобы пропустить оба параметра, если вам нужна только страница. Требуется API-ключ с полным доступом или разрешение `list:networks` для участника консоли.", "operationId": "list_networks", "x-didit-sdk": { "resource": "networks", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "status", "in": "query", "schema": { "type": "string" }, "description": "Разделённый запятыми список статусов для включения: active,in_review,resolved,dismissed. Опустите, чтобы исключить dismissed." }, { "name": "scope", "in": "query", "schema": { "type": "string", "enum": [ "identity", "transactions" ] }, "description": "`transactions` оставляет сети, все участники которых являются сторонами транзакции; `identity` оставляет все остальные сети. Опустите для обеих. Это также сужает `counts.views` и `counts.facets`. Любое другое значение возвращает 400." }, { "name": "signal_type", "in": "query", "schema": { "type": "string" }, "description": "Разделённый запятыми список типов сигналов: ip_address,device,face,document_number,phone,email,address." }, { "name": "pattern_type", "in": "query", "schema": { "type": "string" }, "description": "Разделённый запятыми список типов шаблонов, например exact_same_device,same_email." }, { "name": "risk_band", "in": "query", "schema": { "type": "string" }, "description": "Разделённые запятыми диапазоны: low,medium,high." }, { "name": "min_size", "in": "query", "schema": { "type": "integer" }, "description": "Минимальное количество участников." }, { "name": "max_size", "in": "query", "schema": { "type": "integer" }, "description": "Максимальное количество участников." }, { "name": "assignee", "in": "query", "schema": { "type": "string" }, "description": "Разделённые запятыми ответственные лица: `unassigned`, email участников (без учёта регистра) или `me` для вызывающего участника консоли. Сеть совпадает с любым значением. Для `me` требуется token участника консоли: API-ключ вернёт ошибку 400 `{\"assignee\": [\"\\\"me\\\" needs a user token; an API key has no assignee identity.\"]}`." }, { "name": "priority", "in": "query", "schema": { "type": "string" }, "description": "Разделённые запятыми приоритеты: `low`, `medium`, `high` или `none` для сетей без приоритета. Любое другое значение возвращает 400 `{\"priority\": \"Unknown priority: .\"}`." }, { "name": "risk_min", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 100 }, "description": "Минимальная оценка риска, целое число от 0 до 100. Нецелое число возвращает 400 `{\"risk_min\": \"Use a whole number from 0 to 100.\"}`." }, { "name": "has_case", "in": "query", "schema": { "type": "boolean" }, "description": "`true` оставляет сети, по которым ваше приложение открыло кейс, а `false` оставляет остальные. Любое другое значение игнорируется." }, { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Нижняя граница для last_activity_at (дата или дата и время по стандарту ISO 8601)." }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Верхняя граница first_activity_at (дата или дата и время в формате ISO 8601)." }, { "name": "q", "in": "query", "schema": { "type": "string" }, "description": "Полнотекстовый поиск по названию сети, именам участников, network_id (N-0001) и точным токенам pattern_type." }, { "name": "ordering", "in": "query", "schema": { "type": "string" }, "description": "Одно из значений: risk_score, -risk_score, last_activity_at, -last_activity_at, first_activity_at, -first_activity_at, network_number, -network_number. По умолчанию: -risk_score,-last_activity_at." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 100, "minimum": 1, "maximum": 500 }, "description": "Размер страницы, 1–500. По умолчанию 100." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Смещение первой записи, начиная с нуля." }, { "name": "summary", "in": "query", "schema": { "type": "boolean", "default": true }, "description": "`false` возвращает только страницу и её `count`, без `kpis` и `counts`. По умолчанию `true`. Любое значение, кроме `true` или `false`, возвращает 400." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/?status=active,in_review&ordering=-risk_score' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.networks.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.networks.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Networks.ListAutoPaging(ctx, didit.NetworksListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.networks().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "networks->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.networks.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Networks.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Список сетей с пагинацией, с режимом общего доступа организации и доступностью между организациями, а также с `kpis` и `counts`, если не указано `summary=false`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "integer", "nullable": true, "description": "Смещение следующей страницы или null на последней странице." }, "previous": { "type": "integer", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkListItem" } }, "kpis": { "type": "object", "description": "Каждый ключ представляет собой {value, delta} по результатам, соответствующим текущим фильтрам. Опускается при `summary=false`.", "properties": { "active": { "type": "object" }, "in_review": { "type": "object" }, "applicants_involved": { "type": "object" }, "detected_this_period": { "type": "object" }, "false_positive_rate": { "type": "object" } } }, "counts": { "$ref": "#/components/schemas/NetworkListCounts" }, "sharing_mode": { "type": "string", "enum": [ "off", "private", "global" ], "description": "Режим межорганизационного обмена данными организации. Только `global` сравнивает сети между организациями; `private` и `off` оставляют их только в истории этой организации.", "example": "global" }, "cross_org_available": { "type": "boolean", "description": "Применяются ли сигналы между организациями к этой организации. Для них требуются как тариф Enterprise, так и режим общего доступа `global`.", "example": true }, "cross_org_unavailable_reason": { "type": "string", "enum": [ "plan", "sharing_mode" ], "nullable": true, "description": "Причина, по которой межорганизационные сигналы не применяются; проверяются в следующем порядке. `plan`: тариф организации не включает межорганизационную сеть защиты от мошенничества (требуется тариф Enterprise) независимо от режима обмена данными. `sharing_mode`: тариф включает её, но режим обмена установлен как `private` или `off`. Null, если `cross_org_available` равен `true`.", "example": null } }, "required": [ "count", "next", "previous", "results", "sharing_mode", "cross_org_available", "cross_org_unavailable_reason" ] } } } }, "400": { "description": "Недопустимое значение фильтра, сортировки, пагинации или параметра `summary`.", "content": { "application/json": { "examples": { "Invalid summary": { "summary": "Недопустимая сводка", "value": { "summary": [ "Must be \"true\" or \"false\"." ] } }, "Invalid scope": { "summary": "Недопустимая область действия (scope)", "value": { "scope": [ "Use identity or transactions." ] } }, "Unsupported ordering": { "summary": "Неподдерживаемый порядок сортировки", "value": [ "Unsupported ordering." ] } } } } }, "401": { "description": "Отсутствуют или недействительны учетные данные.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Присутствует при ошибках с кодом, например `networks_not_entitled`." } } }, "examples": { "Missing or invalid credentials": { "summary": "Отсутствуют или недействительны учетные данные", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "403": { "description": "API-ключ принадлежит другому приложению или имеет ограниченный доступ: для endpoint’ов раздела Networks требуется ключ с полным доступом. Для токена участника консоли требуется `list:networks`. Также возвращается с `code: networks_not_entitled`, если Networks не включен для организации.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Присутствует при ошибках с кодом, например `networks_not_entitled`." } } }, "examples": { "Networks not enabled": { "summary": "Сети не включены", "value": { "detail": "Networks is disabled for this organization. Contact Didit support if you believe this is an error.", "code": "networks_not_entitled" } }, "Restricted API key": { "summary": "Ограниченный API-ключ", "value": { "detail": "This API key has no access to this endpoint." } }, "No permission": { "summary": "Нет разрешения", "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/": { "get": { "summary": "Получить сеть", "description": "Получить полную информацию об одной сети: статистику, метки мошенничества и сигналы риска, а также `sharing_mode` организации и доступность между организациями, `tags` вашего приложения в сети, `outcomes` участников и оценки паттернов (`patterns`). Требуется API-ключ с полным доступом или разрешение `read:networks` для участника консоли.", "operationId": "get_network", "x-didit-sdk": { "resource": "networks", "method": "retrieve", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID сети." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/n3a5e000-0000-4000-8000-000000000001/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.networks.retrieve(\n \"n3a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.networks.retrieve(\"n3a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Networks.Retrieve(ctx, \"n3a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.networks().retrieve(\"n3a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "networks->retrieve('n3a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.networks.retrieve(\"n3a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Networks.RetrieveAsync(\"n3a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Сведения о сети.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkDetailResponse" }, "example": { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "network_id": "N-0042", "name": null, "status": "in_review", "risk": { "score": 82, "band": "high", "bar": 0.82 }, "pattern_types": [ "exact_same_device", "same_email" ], "signal_types": [ "device", "email" ], "member_counts": { "total": 3, "users": 3, "businesses": 0, "transaction_parties": 0 }, "member_status": { "approved": 1, "declined": 1, "in_review": 0, "not_completed": 1 }, "signal_coverage": { "device": { "signals": 1, "subjects": 3, "coverage": 1.0 }, "email": { "signals": 1, "subjects": 2, "coverage": 0.6667 } }, "first_activity_at": "2026-10-01T09:12:44Z", "last_activity_at": "2026-10-12T16:03:10Z", "stats": { "members": { "total": 3, "users": 3, "businesses": 0, "transaction_parties": 0 }, "member_status": { "approved": 1, "declined": 1, "in_review": 0, "not_completed": 1 }, "signals": { "total": 2, "by_type": { "device": { "signals": 1, "subjects": 3, "coverage": 1.0 }, "email": { "signals": 1, "subjects": 2, "coverage": 0.6667 } } } }, "fraud_tags": [], "risk_signals": { "residential_proxy_reuse": { "detected": false, "signal_count": 0, "max_subject_count": 0 }, "email_intelligence": { "enriched_signal_count": 1, "high_risk_count": 0, "social_profile_count": 0 }, "phone_intelligence": { "enriched_signal_count": 0, "high_risk_count": 0 } }, "reviewed_at": "2026-10-12T16:30:00Z", "reviewed_by": "reviewer@example.com", "review_reason": "Shared device across three new accounts.", "notes_count": 0, "sharing_mode": "global", "cross_org_available": true, "cross_org_unavailable_reason": null, "tags": [ { "uuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "name": "SUSPICIOUS", "color": "#6366F1", "source": "custom", "added_by": null, "added_at": "2026-10-13T08:15:00Z" } ], "outcomes": { "approved": 1, "declined": 1, "in_review": 0, "total": 3 }, "patterns": [ { "type": "background", "score": 0.8125, "members": 3, "reason": null, "computed_at": "2026-10-13T08:00:00Z" } ] } } } }, "404": { "description": "Сеть не найдена (или не видна этому приложению).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "401": { "description": "Отсутствуют или недействительны учетные данные.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Присутствует при ошибках с кодом, например `networks_not_entitled`." } } }, "examples": { "Missing or invalid credentials": { "summary": "Отсутствуют или недействительны учетные данные", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "403": { "description": "API-ключ принадлежит другому приложению или имеет ограниченный доступ: для endpoint’ов раздела Networks требуется ключ с полным доступом. Для токена участника консоли требуется `read:networks`. Также возвращается с `code: networks_not_entitled`, если Networks не включен для организации.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Присутствует при ошибках с кодом, например `networks_not_entitled`." } } }, "examples": { "Networks not enabled": { "summary": "Сети не включены", "value": { "detail": "Networks is disabled for this organization. Contact Didit support if you believe this is an error.", "code": "networks_not_entitled" } }, "Restricted API key": { "summary": "Ограниченный API-ключ", "value": { "detail": "This API key has no access to this endpoint." } }, "No permission": { "summary": "Нет разрешения", "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/graph/": { "get": { "summary": "Получить граф сети", "description": "Получить сеть в виде графа узлов субъектов (пользователи вендора, компании вендора, стороны транзакции) и узлов сигналов (общие значения устройств/IP/лиц/документов/телефонов/email/адресов, связывающие их) с рёбрами, отражающими отношения принадлежности.", "operationId": "get_network_graph", "x-didit-sdk": { "resource": "networks", "method": "retrieve_graph", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID сети." }, { "name": "depth", "in": "query", "schema": { "type": "string", "enum": [ "1", "2", "3", "all" ] }, "description": "Количество переходов от целевого субъекта для включения. По умолчанию включаются все (без ограничений)." }, { "name": "focus_kind", "in": "query", "schema": { "type": "string", "enum": [ "vendor_user", "vendor_business", "transaction_party" ] }, "description": "Тип субъекта, на котором центрируется граф. Должен передаваться вместе с focus_id; по умолчанию выбирается произвольный участник, если глубина ограничена и ни один параметр не передан." }, { "name": "focus_id", "in": "query", "schema": { "type": "string", "format": "uuid" }, "description": "UUID субъекта, на котором центрируется граф." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/n3a5e000-0000-4000-8000-000000000001/graph/?depth=2' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.networks.retrieve_graph(\n \"n3a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.networks.retrieveGraph(\"n3a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Networks.RetrieveGraph(ctx, \"n3a5e000-0000-4000-8000-000000000001\", didit.NetworksRetrieveGraphParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.networks().retrieveGraph(\"n3a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "networks->retrieveGraph('n3a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.networks.retrieve_graph(\"n3a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Networks.RetrieveGraphAsync(\"n3a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Граф сети.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkGraph" } } } }, "404": { "description": "Сеть не найдена (или не видна этому приложению).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/members/": { "get": { "summary": "Получить список участников сети", "description": "Получить список субъектов (пользователи вендора, компании вендора или стороны транзакции), входящих в эту сеть.", "operationId": "list_network_members", "x-didit-sdk": { "resource": "networks", "method": "list_members", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID сети." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/n3a5e000-0000-4000-8000-000000000001/members/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.networks.list_members(\n \"n3a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.networks.listMembers(\"n3a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Networks.ListMembers(ctx, \"n3a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.networks().listMembers(\"n3a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "networks->listMembers('n3a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.networks.list_members(\"n3a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Networks.ListMembersAsync(\"n3a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Участники сети. Без пагинации.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkMember" } } } } } } }, "404": { "description": "Сеть не найдена (или не видна этому приложению).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/signals/": { "get": { "summary": "Получить список сигналов сети", "description": "Получить список сигналов (общие значения устройства, IP-адреса, лица, номера документа, телефона, электронной почты или адреса), связывающих участников этой сети.", "operationId": "list_network_signals", "x-didit-sdk": { "resource": "networks", "method": "list_signals", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID сети." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/n3a5e000-0000-4000-8000-000000000001/signals/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.networks.list_signals(\n \"n3a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.networks.listSignals(\"n3a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Networks.ListSignals(ctx, \"n3a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.networks().listSignals(\"n3a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "networks->listSignals('n3a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.networks.list_signals(\"n3a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Networks.ListSignalsAsync(\"n3a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Сигналы сети. Без пагинации.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkSignal" } } } } } } }, "404": { "description": "Сеть не найдена (или не видна этому приложению).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/timeline/": { "get": { "summary": "Получить таймлайн сети", "description": "Без `contract`: собственные события сети (обнаружение, последнее наблюдение каждого сигнала и его проверка), сначала старые, без пагинации. `limit`, `cursor` и `event_type` игнорируются. С `contract=2`: типизированная временная шкала, сначала новые, с пагинацией по курсору. Добавляет действия аккаунтов-участников (попытки верификации, транзакции, входы в систему, отправленные вами через API событий, и сработавшие активные правила) и кейсы, открытые для сети. События `note_added` возвращаются только участникам консоли и никогда не возвращаются API-ключу. Требуется API-ключ с полным доступом или `read:networks` для участника консоли.", "operationId": "get_network_timeline", "x-didit-sdk": { "resource": "networks", "method": "retrieve_timeline", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID сети." }, { "name": "contract", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "2" ] }, "description": "`2` возвращает типизированную хронологию. Опустите его для хронологии по умолчанию. Любое другое значение возвращает 400." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 100 }, "description": "Только для типизированной ленты событий. Количество событий на странице, от 1 до 500. По умолчанию 100." }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Только для типизированной ленты событий. Значение `next_cursor` предыдущей страницы. Недействительный или пустой курсор возвращает 400." }, { "name": "event_type", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "maxItems": 20, "items": { "type": "string", "enum": [ "network_detected", "signal_observed", "network_active", "network_in_review", "network_resolved", "network_dismissed", "verification_attempt", "transaction", "login", "rule_hit", "case_linked", "note_added" ] } }, "description": "Только для типизированной ленты событий. Типы событий для сохранения; значения можно повторять или разделять запятыми, не более 20 значений. По умолчанию сохраняются все типы." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/n3a5e000-0000-4000-8000-000000000001/timeline/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "curl", "label": "curl (typed timeline)", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/3fa85f64-5717-4562-b3fc-2c963f66afa6/timeline/?contract=2&limit=50&event_type=verification_attempt,login' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.networks.retrieve_timeline(\n \"n3a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.networks.retrieveTimeline(\"n3a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Networks.RetrieveTimeline(ctx, \"n3a5e000-0000-4000-8000-000000000001\", didit.NetworksRetrieveTimelineParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.networks().retrieveTimeline(\"n3a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "networks->retrieveTimeline('n3a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.networks.retrieve_timeline(\"n3a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Networks.RetrieveTimelineAsync(\"n3a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Без `contract`: `{results}`, сначала старые, без пагинации. С `contract=2`: `{results, next_cursor}`, сначала новые.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/NetworkTimeline" }, { "$ref": "#/components/schemas/NetworkTimelinePage" } ] }, "examples": { "Default timeline": { "summary": "Без contract", "value": { "results": [ { "event_type": "network_detected", "occurred_at": "2026-10-01T09:12:44Z", "label": "Network detected", "metadata": { "network_id": "N-0042" } }, { "event_type": "signal_observed", "occurred_at": "2026-10-12T16:03:10Z", "label": "device observed", "metadata": { "signal_type": "device", "subject_count": 3, "is_hub": false } }, { "event_type": "network_in_review", "occurred_at": "2026-10-12T16:30:00Z", "label": "Network in_review", "metadata": { "reason": "Shared device across three new accounts." } } ] } }, "Typed timeline": { "summary": "С contract=2", "value": { "results": [ { "id": "monitoring_event:9b2f1c3e-4d5a-4b6c-8d7e-0f1a2b3c4d5e", "event_type": "login", "occurred_at": "2026-10-12T18:41:02Z", "ingested_at": "2026-10-12T18:41:03Z", "label": "Login", "metadata": {}, "account": { "node_id": "vendor_user:5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f", "node_type": "account", "uuid": "5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f", "vendor_data": "user-1042", "display_name": "Alex Example", "ownership": "owned", "route": { "kind": "user", "id": "5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f", "application_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" } }, "source_ref": { "kind": "monitoring_event", "id": "9b2f1c3e-4d5a-4b6c-8d7e-0f1a2b3c4d5e", "ownership": "owned" }, "verification_attempt": null, "transaction": null, "login": { "action": "auth.login", "succeeded": true, "status": "APPROVED", "ip": { "address": "203.0.113.24", "country_code": "ES", "city": "Madrid", "connection_type": null, "is_vpn_or_tor": false, "is_data_center": false }, "device": { "fingerprint": "fp_0a1b2c3d", "label": "Chrome · Android" }, "is_first_login": false, "is_new_device": true }, "rule_hit": null, "case_linked": null, "note_added": null }, { "id": "session:1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f", "event_type": "verification_attempt", "occurred_at": "2026-10-12T16:03:10Z", "ingested_at": "2026-10-12T16:03:10Z", "label": "Verification attempt 2 of 2", "metadata": {}, "account": { "node_id": "vendor_user:5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f", "node_type": "account", "uuid": "5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f", "vendor_data": "user-1042", "display_name": "Alex Example", "ownership": "owned", "route": { "kind": "user", "id": "5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f", "application_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" } }, "source_ref": { "kind": "session", "id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f", "ownership": "owned", "route": { "kind": "session", "id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f", "application_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" } }, "verification_attempt": { "session_id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f", "session_number": 1287, "attempt": 2, "attempt_count": 2, "status": "Approved", "status_changed_at": "2026-10-12T16:05:41Z", "decline_reasons": [] }, "transaction": null, "login": null, "rule_hit": null, "case_linked": null, "note_added": null }, { "id": "signal_observed:8d7c6b5a-4e3f-4a2b-9c1d-0e9f8a7b6c5d", "event_type": "signal_observed", "occurred_at": "2026-10-12T16:03:10Z", "ingested_at": "2026-10-01T09:12:44Z", "label": "device observed", "metadata": { "signal_type": "device", "subject_count": 3, "is_hub": false }, "account": null, "source_ref": null, "verification_attempt": null, "transaction": null, "login": null, "rule_hit": null, "case_linked": null, "note_added": null } ], "next_cursor": "eyJ0IjoiMjAyNi0xMC0xMlQxNjowMzoxMCswMDowMCIsImMiOiIyMDI2LTEwLTAxVDA5OjEyOjQ0KzAwOjAwIiwiciI6MSwidSI6IjhkN2M2YjVhLTRlM2YtNGEyYi05YzFkLTBlOWY4YTdiNmM1ZCJ9" } } } } } }, "400": { "description": "При наличии `contract`: недопустимое значение `contract`, `limit`, `cursor` или `event_type`.", "content": { "application/json": { "examples": { "Unsupported contract": { "summary": "Неподдерживаемый контракт", "value": { "contract": [ "\"3\" is not a valid choice." ] } }, "Invalid cursor": { "summary": "Недопустимый курсор", "value": { "cursor": [ "This cursor is not valid. Reload the feed." ] } }, "Limit too large": { "summary": "Лимит слишком велик", "value": { "limit": [ "Ensure this value is less than or equal to 500." ] } }, "Unknown event type": { "summary": "Неизвестный тип события", "value": { "event_type": { "0": [ "\"logout\" is not a valid choice." ] } } } } } } }, "401": { "description": "Отсутствуют или недействительны учетные данные.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Присутствует при ошибках с кодом, например `networks_not_entitled`." } } }, "examples": { "Missing or invalid credentials": { "summary": "Отсутствуют или недействительны учетные данные", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "403": { "description": "API-ключ принадлежит другому приложению или имеет ограниченный доступ: для endpoint’ов раздела Networks требуется ключ с полным доступом. Для токена участника консоли требуется `read:networks`. Также возвращается с `code: networks_not_entitled`, если Networks не включен для организации.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Присутствует при ошибках с кодом, например `networks_not_entitled`." } } }, "examples": { "Networks not enabled": { "summary": "Сети не включены", "value": { "detail": "Networks is disabled for this organization. Contact Didit support if you believe this is an error.", "code": "networks_not_entitled" } }, "Restricted API key": { "summary": "Ограниченный API-ключ", "value": { "detail": "This API key has no access to this endpoint." } }, "No permission": { "summary": "Нет разрешения", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Сеть не найдена (или не видна этому приложению).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/map/": { "get": { "summary": "Получить карту сети", "description": "Географические точки, в которых сходятся адреса и местоположения участников этой сети, полученные из сессий, бизнес-сессий и транзакций, лежащих в основе их членства.", "operationId": "get_network_map", "x-didit-sdk": { "resource": "networks", "method": "retrieve_map", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID сети." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/n3a5e000-0000-4000-8000-000000000001/map/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.networks.retrieve_map(\n \"n3a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.networks.retrieveMap(\"n3a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Networks.RetrieveMap(ctx, \"n3a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.networks().retrieveMap(\"n3a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "networks->retrieveMap('n3a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.networks.retrieve_map(\"n3a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Networks.RetrieveMapAsync(\"n3a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Карта сети.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkMap" } } } }, "404": { "description": "Сеть не найдена (или не видна этому приложению).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/sessions/{session_id}/networks/": { "get": { "summary": "Получить список сетей для сессии", "description": "Получить список сетей, к которым принадлежит пользователь поставщика из сессии. Определяется через пользователя, связанного с vendor_data сессии.", "operationId": "list_session_network_memberships", "x-didit-sdk": { "resource": "sessions", "method": "list_networks", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID сессии." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/sessions/aaaaaaaa-0000-4000-8000-000000000001/networks/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.sessions.list_networks(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.sessions.listNetworks(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.ListNetworks(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.sessions().listNetworks(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->listNetworks('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.sessions.list_networks(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.ListNetworksAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Сети, к которым относится эта сущность. Без пагинации.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "Сущность не найдена в этом приложении или не имеет связанного субъекта для поиска.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/business-sessions/{business_session_id}/networks/": { "get": { "summary": "Получить список сетей для сессии компании", "description": "Получить список сетей, к которым принадлежит компания поставщика из бизнес-сессии.", "operationId": "list_business_session_network_memberships", "x-didit-sdk": { "resource": "business_sessions", "method": "list_networks", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "business_session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID сессии компании." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/business-sessions/aaaaaaaa-0000-4000-8000-000000000002/networks/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.business_sessions.list_networks(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.businessSessions.listNetworks(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.BusinessSessions.ListNetworks(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.businessSessions().listNetworks(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businessSessions->listNetworks('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.business_sessions.list_networks(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.BusinessSessions.ListNetworksAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Сети, к которым относится эта сущность. Без пагинации.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "Сущность не найдена в этом приложении или не имеет связанного субъекта для поиска.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/users/{vendor_user_uuid}/networks/": { "get": { "summary": "Получить список сетей для пользователя", "description": "Получить список сетей, к которым принадлежит пользователь поставщика.", "operationId": "list_user_network_memberships", "x-didit-sdk": { "resource": "users", "method": "list_networks", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "vendor_user_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID пользователя вендора." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/users/aaaaaaaa-0000-4000-8000-000000000003/networks/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.users.list_networks(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.users.listNetworks(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Users.ListNetworks(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.users().listNetworks(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "users->listNetworks('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.users.list_networks(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Users.ListNetworksAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Сети, к которым относится эта сущность. Без пагинации.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "Сущность не найдена в этом приложении или не имеет связанного субъекта для поиска.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/businesses/{vendor_business_uuid}/networks/": { "get": { "summary": "Получить список сетей для компании", "description": "Получить список сетей, к которым принадлежит компания поставщика.", "operationId": "list_business_network_memberships", "x-didit-sdk": { "resource": "businesses", "method": "list_networks", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "vendor_business_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID компании вендора." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/businesses/aaaaaaaa-0000-4000-8000-000000000004/networks/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.businesses.list_networks(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.businesses.listNetworks(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.ListNetworks(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.businesses().listNetworks(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->listNetworks('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.businesses.list_networks(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.ListNetworksAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Сети, к которым относится эта сущность. Без пагинации.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "Сущность не найдена в этом приложении или не имеет связанного субъекта для поиска.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/transactions/{transaction_uuid}/networks/": { "get": { "summary": "Получить список сетей для транзакции", "description": "Получить список сетей, к которым принадлежит связанный субъект KYC/KYB транзакции (определяется через сессию или бизнес-сессию транзакции).", "operationId": "list_transaction_network_memberships", "x-didit-sdk": { "resource": "transactions", "method": "list_networks", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "transaction_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID транзакции." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/transactions/aaaaaaaa-0000-4000-8000-000000000005/networks/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.transactions.list_networks(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.transactions.listNetworks(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.ListNetworks(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.transactions().listNetworks(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->listNetworks('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.transactions.list_networks(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.ListNetworksAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Сети, к которым относится эта сущность. Без пагинации.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "Сущность не найдена в этом приложении или не имеет связанного субъекта для поиска.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/transactions/{transaction_uuid}/parties/{transaction_party_uuid}/networks/": { "get": { "summary": "Получить список сетей для стороны транзакции", "description": "Получить список сетей, к которым принадлежит участник транзакции (отправитель, получатель или контрагент), определённый напрямую через самого участника, а не через связанную сессию транзакции.", "operationId": "list_transaction_party_network_memberships", "x-didit-sdk": { "resource": "transactions", "method": "list_party_networks", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "transaction_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID транзакции." }, { "name": "transaction_party_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID стороны транзакции." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/transactions/aaaaaaaa-0000-4000-8000-000000000005/parties/bbbbbbbb-0000-4000-8000-000000000006/networks/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.transactions.list_party_networks(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.transactions.listPartyNetworks(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.ListPartyNetworks(ctx, \"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.transactions().listPartyNetworks(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->listPartyNetworks('11111111-2222-3333-4444-555555555555', '11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.transactions.list_party_networks(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.ListPartyNetworksAsync(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Сети, к которым относится эта сущность. Без пагинации.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "Сущность не найдена в этом приложении или не имеет связанного субъекта для поиска.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/biometric-templates/": { "get": { "summary": "Получить список сохранённых биометрических шаблонов", "description": "Приложение, давшее согласие на участие, сохраняет один отдельно управляемый биометрический шаблон лица без изображений, привязанный к Пользователю, при удалении сессии (см. `DELETE /v3/session/{sessionId}/delete/`). Шаблоны представляют собой биометрические данные с ограниченным `expires_at`; они никогда не содержат изображений, данных сессии или полей идентификации и очищаются при удалении Пользователя, удалении данных в целях конфиденциальности, истечении срока действия или явной очистке. Эти endpoint принимают только API-ключи приложений (`x-api-key`); токены пользователей Business Console отклоняются с кодом `403`.\n\nВозвращает разбитый на страницы список шаблонов, которыми в данный момент владеет приложение. Очищенные шаблоны в список не включаются.", "operationId": "list_biometric_templates", "x-didit-sdk": { "resource": "biometric_templates", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Biometric Templates" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "query", "name": "vendor_data", "required": false, "description": "Поиск подстроки без учёта регистра по текущему `vendor_data` пользователя-владельца.", "schema": { "type": "string" } }, { "in": "query", "name": "vendor_user_uuid", "required": false, "description": "Точное совпадение по пользователю-владельцу.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "status", "required": false, "description": "Статус жизненного цикла. Удалённые шаблоны никогда не возвращаются в списке.", "schema": { "type": "string", "enum": [ "pending", "active", "expired", "held_out_of_use", "purge_pending", "purge_failed" ] } }, { "in": "query", "name": "source_type", "required": false, "description": "Способ создания шаблона.", "schema": { "type": "string", "enum": [ "session_delete", "automatic_retention", "backfill" ] } }, { "in": "query", "name": "retained_from", "required": false, "description": "Шаблоны, сохраненные в указанное время или позже.", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "retained_to", "required": false, "description": "Шаблоны, сохраненные в указанное время или ранее. Не должно быть раньше `retained_from` (`400`).", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "ordering", "required": false, "description": "Порядок сортировки.", "schema": { "type": "string", "enum": [ "retained_at", "-retained_at", "expires_at", "-expires_at" ], "default": "-retained_at" } }, { "in": "query", "name": "limit", "required": false, "description": "Размер страницы.", "schema": { "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "description": "Смещение пагинации.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Шаблоны с пагинацией.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Идентификатор шаблона. Генерируется случайным образом; не выводится из удаленной сессии или ее лица." }, "vendor_user_uuid": { "type": "string", "format": "uuid", "description": "Пользователь-владелец." }, "vendor_data": { "type": "string", "nullable": true, "description": "Текущие `vendor_data` пользователя, вычисляемые при чтении шаблона (никогда не копируются)." }, "source_type": { "type": "string", "enum": [ "session_delete", "automatic_retention", "backfill" ], "description": "Способ создания шаблона: удаление сессии (через API или Console), окно автоматического хранения данных приложения или инициированное вами фоновое заполнение силами Didit." }, "provenance_reference": { "type": "string", "format": "uuid", "description": "Непрозрачная ссылка, связывающая шаблон с его журналом аудита. Она не является идентификатором удалённой сессии и не может быть сопоставлена с ним." }, "retention_policy": { "type": "string", "enum": [ "delete_with_session", "retain_until_user_deleted" ], "description": "Политика приложения на момент применения правил хранения данных." }, "retention_override": { "type": "boolean", "nullable": true, "description": "Значение `retain_face_embeddings`, отправленное при удалении, или `null`, если была применена политика." }, "retained_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time", "description": "Время истечения срока действия шаблона и его автоматического удаления. Задаётся всегда." }, "retained_by": { "type": "string", "nullable": true, "description": "Субъект, отдавший распоряжение: ID приложения для API-ключей, ID участника Console для действий в Console или идентификатор `service:` для автоматического хранения данных. Никогда не является адресом электронной почты." }, "retained_by_type": { "type": "string", "enum": [ "API_KEY", "CONSOLE_USER", "SYSTEM" ] }, "instruction_class": { "type": "string", "enum": [ "operational_session_delete", "privacy_erasure" ] }, "instruction_source": { "type": "string", "enum": [ "api", "console", "automatic_retention", "backfill", "privacy_erasure", "explicit_template_purge", "vendor_user_delete", "expiry", "reconciliation", "migration", "system" ] }, "instruction_id": { "type": "string", "description": "Параметр `instruction_id`, отправленный при удалении, или сгенерированный Didit id." }, "held_out_of_use": { "type": "boolean", "description": "`true` только во время действия юридического удержания. Удержанный шаблон исключается из всех сопоставлений." }, "status": { "type": "string", "enum": [ "pending", "active", "expired", "held_out_of_use", "purge_pending", "purge_failed", "purged" ], "description": "В сопоставлении участвуют только шаблоны со статусом `active`, которые не приостановлены, чей срок `expires_at` не истёк и чей пользователь всё ещё существует." }, "purged_at": { "type": "string", "format": "date-time", "nullable": true } } } } } }, "examples": { "One active template": { "value": { "count": 1, "next": null, "previous": null, "results": [ { "uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "vendor_user_uuid": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f", "vendor_data": "user-42", "source_type": "session_delete", "provenance_reference": "6b1e8d2f-4a3c-4f9e-8c7d-1a2b3c4d5e6f", "retention_policy": "retain_until_user_deleted", "retention_override": null, "retained_at": "2026-08-28T10:15:42.318402Z", "expires_at": "2027-08-28T10:15:42.318402Z", "retained_by": "3c9e2b1f-7d4a-4e8b-9c1d-5f6a7b8c9d0e", "retained_by_type": "API_KEY", "instruction_class": "operational_session_delete", "instruction_source": "api", "instruction_id": "post-approval-cleanup-2026-08", "held_out_of_use": false, "status": "active", "purged_at": null } ] } } } } } }, "400": { "description": "Недопустимое значение фильтра или `retained_to` раньше `retained_from`. Ошибки валидации с разбивкой по полям.", "content": { "application/json": { "examples": { "Bad range": { "value": { "retained_to": [ "Must be on or after retained_from." ] } } } } } }, "403": { "description": "Токен пользователя Console, либо данный API-ключ не разрешён. Эти endpoint принимают только API-ключи приложений.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/biometric-templates/?vendor_data=user-42&status=active' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.biometric_templates.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.biometricTemplates.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.BiometricTemplates.ListAutoPaging(ctx, didit.BiometricTemplatesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.biometricTemplates().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "biometricTemplates->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.biometric_templates.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.BiometricTemplates.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] } }, "/v3/biometric-templates/count/": { "get": { "summary": "Подсчитать сохранённые биометрические шаблоны", "description": "Приложение, давшее согласие на участие, сохраняет один отдельно управляемый биометрический шаблон лица без изображений, привязанный к Пользователю, при удалении сессии (см. `DELETE /v3/session/{sessionId}/delete/`). Шаблоны представляют собой биометрические данные с ограниченным сроком `expires_at`; они никогда не содержат изображений, данных сессии или полей идентификации и безвозвратно удаляются при удалении Пользователя, удалении данных в целях конфиденциальности, истечении срока действия или явной очистке. Эти endpoints принимают только API-ключи приложений (`x-api-key`); токены пользователей Business Console отклоняются с кодом `403`.\n\nВозвращает количество шаблонов, соответствующих тем же фильтрам, что и endpoint списка. Используйте его, чтобы проверить, какие шаблоны затронет фильтрованная массовая очистка с `delete_all: true`.", "operationId": "count_biometric_templates", "x-didit-sdk": { "resource": "biometric_templates", "method": "count", "auth": "api_key", "server": true }, "tags": [ "Biometric Templates" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "query", "name": "vendor_data", "required": false, "description": "Поиск подстроки без учёта регистра по текущему `vendor_data` пользователя-владельца.", "schema": { "type": "string" } }, { "in": "query", "name": "vendor_user_uuid", "required": false, "description": "Точное совпадение по пользователю-владельцу.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "status", "required": false, "description": "Статус жизненного цикла. Удалённые шаблоны никогда не возвращаются в списке.", "schema": { "type": "string", "enum": [ "pending", "active", "expired", "held_out_of_use", "purge_pending", "purge_failed" ] } }, { "in": "query", "name": "source_type", "required": false, "description": "Способ создания шаблона.", "schema": { "type": "string", "enum": [ "session_delete", "automatic_retention", "backfill" ] } }, { "in": "query", "name": "retained_from", "required": false, "description": "Шаблоны, сохраненные в указанное время или позже.", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "retained_to", "required": false, "description": "Шаблоны, сохраненные в указанное время или ранее. Не должно быть раньше `retained_from` (`400`).", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Количество.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0 } } }, "examples": { "Count": { "value": { "count": 128 } } } } } }, "400": { "description": "Недопустимое значение фильтра или `retained_to` раньше `retained_from`. Ошибки валидации с разбивкой по полям.", "content": { "application/json": { "examples": { "Bad range": { "value": { "retained_to": [ "Must be on or after retained_from." ] } } } } } }, "403": { "description": "Токен пользователя Console, либо данный API-ключ не разрешён. Эти endpoint принимают только API-ключи приложений.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/biometric-templates/count/?status=active' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.biometric_templates.count()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.biometricTemplates.count();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.BiometricTemplates.Count(ctx, didit.BiometricTemplatesCountParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.biometricTemplates().count();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "biometricTemplates->count();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.biometric_templates.count\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.BiometricTemplates.CountAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/biometric-templates/{template_uuid}/": { "get": { "summary": "Получить сохраненный биометрический шаблон", "description": "Приложение, давшее согласие на участие, сохраняет один отдельно управляемый биометрический шаблон лица без изображений, привязанный к Пользователю, при удалении сессии (см. `DELETE /v3/session/{sessionId}/delete/`). Шаблоны представляют собой биометрические данные с ограниченным сроком `expires_at`; они никогда не содержат изображений, данных сессии или полей идентификации и очищаются при удалении Пользователя, удалении данных в целях конфиденциальности, истечении срока действия или явной очистке. Эти endpoint принимают только API-ключи приложений (`x-api-key`); токены пользователей Business Console отклоняются с кодом `403`.\n\nВозвращает один шаблон. Ответ никогда не содержит изображения, вектора, идентификатора удалённой сессии или идентификационных данных.", "operationId": "get_biometric_template", "x-didit-sdk": { "resource": "biometric_templates", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Biometric Templates" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "template_uuid", "required": true, "description": "Идентификатор шаблона, возвращаемый в `biometric_template_uuid` endpoint'ами удаления сессии, `biometric_template_id` при совпадении в Поиске по лицу или endpoint'ом списка.", "schema": { "type": "string", "format": "uuid", "example": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b" } } ], "responses": { "200": { "description": "Шаблон.", "content": { "application/json": { "schema": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Идентификатор шаблона. Генерируется случайным образом; не выводится из удаленной сессии или ее лица." }, "vendor_user_uuid": { "type": "string", "format": "uuid", "description": "Пользователь-владелец." }, "vendor_data": { "type": "string", "nullable": true, "description": "Текущие `vendor_data` пользователя, вычисляемые при чтении шаблона (никогда не копируются)." }, "source_type": { "type": "string", "enum": [ "session_delete", "automatic_retention", "backfill" ], "description": "Способ создания шаблона: удаление сессии (через API или Console), окно автоматического хранения данных приложения или инициированное вами фоновое заполнение силами Didit." }, "provenance_reference": { "type": "string", "format": "uuid", "description": "Непрозрачная ссылка, связывающая шаблон с его журналом аудита. Она не является идентификатором удалённой сессии и не может быть сопоставлена с ним." }, "retention_policy": { "type": "string", "enum": [ "delete_with_session", "retain_until_user_deleted" ], "description": "Политика приложения на момент применения правил хранения данных." }, "retention_override": { "type": "boolean", "nullable": true, "description": "Значение `retain_face_embeddings`, отправленное при удалении, или `null`, если была применена политика." }, "retained_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time", "description": "Время истечения срока действия шаблона и его автоматического удаления. Задаётся всегда." }, "retained_by": { "type": "string", "nullable": true, "description": "Субъект, отдавший распоряжение: ID приложения для API-ключей, ID участника Console для действий в Console или идентификатор `service:` для автоматического хранения данных. Никогда не является адресом электронной почты." }, "retained_by_type": { "type": "string", "enum": [ "API_KEY", "CONSOLE_USER", "SYSTEM" ] }, "instruction_class": { "type": "string", "enum": [ "operational_session_delete", "privacy_erasure" ] }, "instruction_source": { "type": "string", "enum": [ "api", "console", "automatic_retention", "backfill", "privacy_erasure", "explicit_template_purge", "vendor_user_delete", "expiry", "reconciliation", "migration", "system" ] }, "instruction_id": { "type": "string", "description": "Параметр `instruction_id`, отправленный при удалении, или сгенерированный Didit id." }, "held_out_of_use": { "type": "boolean", "description": "`true` только во время действия юридического удержания. Удержанный шаблон исключается из всех сопоставлений." }, "status": { "type": "string", "enum": [ "pending", "active", "expired", "held_out_of_use", "purge_pending", "purge_failed", "purged" ], "description": "В сопоставлении участвуют только шаблоны со статусом `active`, которые не приостановлены, чей срок `expires_at` не истёк и чей пользователь всё ещё существует." }, "purged_at": { "type": "string", "format": "date-time", "nullable": true } } }, "examples": { "Active template": { "value": { "uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "vendor_user_uuid": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f", "vendor_data": "user-42", "source_type": "session_delete", "provenance_reference": "6b1e8d2f-4a3c-4f9e-8c7d-1a2b3c4d5e6f", "retention_policy": "retain_until_user_deleted", "retention_override": null, "retained_at": "2026-08-28T10:15:42.318402Z", "expires_at": "2027-08-28T10:15:42.318402Z", "retained_by": "3c9e2b1f-7d4a-4e8b-9c1d-5f6a7b8c9d0e", "retained_by_type": "API_KEY", "instruction_class": "operational_session_delete", "instruction_source": "api", "instruction_id": "post-approval-cleanup-2026-08", "held_out_of_use": false, "status": "active", "purged_at": null } } } } } }, "403": { "description": "Токен пользователя Console, либо данный API-ключ не разрешён. Эти endpoint принимают только API-ключи приложений.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Неизвестный шаблон, шаблон другого приложения или (при `GET`) удалённый шаблон.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Biometric template not found." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/biometric-templates/9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.biometric_templates.retrieve(\n \"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.biometricTemplates.retrieve(\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.BiometricTemplates.Retrieve(ctx, \"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.biometricTemplates().retrieve(\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "biometricTemplates->retrieve('9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.biometric_templates.retrieve(\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.BiometricTemplates.RetrieveAsync(\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "delete": { "summary": "Удалить сохранённый биометрический шаблон", "description": "Приложение, давшее согласие на участие, сохраняет один отдельно управляемый биометрический шаблон лица без изображений, привязанный к Пользователю, при удалении сессии (см. `DELETE /v3/session/{sessionId}/delete/`). Шаблоны представляют собой биометрические данные с ограниченным сроком `expires_at`; они никогда не содержат изображений, данных сессии или полей идентификации и очищаются при удалении Пользователя, удалении данных в целях конфиденциальности, истечении срока действия или явной очистке. Эти endpoint принимают только API-ключи приложений (`x-api-key`); токены пользователей Business Console отклоняются с кодом `403`.\n\nОчищает один шаблон: он исключается из всех видов сопоставления, а сохранённый шаблон удаляется. Действие необратимо и фиксируется в журнале аудита с указанием совершившего его субъекта.\n\n**Семантика повторных попыток:** Didit сначала удаляет сохранённый шаблон и только затем помечает его как очищенный. Если биометрическое хранилище недоступно, вызов возвращает `503`, шаблон переходит в `status: purge_failed` и уже исключён из сопоставления; повторите тот же вызов для завершения. Повторная очистка уже очищенного шаблона возвращает `already_purged`.\n\nШаблоны также очищаются с помощью `POST /v3/users/delete/` для соответствующего Пользователя, при любом удалении сессий этого Пользователя с `deletion_instruction: privacy_erasure`, а также автоматически при наступлении `expires_at`.", "operationId": "purge_biometric_template", "x-didit-sdk": { "resource": "biometric_templates", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Biometric Templates" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "template_uuid", "required": true, "description": "Идентификатор шаблона, возвращаемый в `biometric_template_uuid` endpoint'ами удаления сессии, `biometric_template_id` при совпадении в Поиске по лицу или endpoint'ом списка.", "schema": { "type": "string", "format": "uuid", "example": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b" } } ], "responses": { "200": { "description": "Результат удаления.", "content": { "application/json": { "schema": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "outcome": { "type": "string", "enum": [ "purged", "already_purged" ] } } }, "examples": { "Purged": { "value": { "uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "outcome": "purged" } }, "Already purged": { "value": { "uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "outcome": "already_purged" } } } } } }, "403": { "description": "Токен пользователя Console, либо данный API-ключ не разрешён. Эти endpoint принимают только API-ключи приложений.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Неизвестный шаблон, шаблон другого приложения или (при `GET`) удалённый шаблон.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Biometric template not found." } } } } } }, "503": { "description": "Хранилище биометрии было недоступно при сохранении или удалении биометрического шаблона. Ничего не удалено; повторите тот же запрос. Повторные попытки идемпотентны и сходятся к одному шаблону.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Retryable": { "value": { "detail": "The biometric-template operation could not finish because an external store is unavailable. The operation is retryable." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE https://verification.didit.me/v3/biometric-templates/9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.biometric_templates.delete(\n \"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.biometricTemplates.delete(\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.BiometricTemplates.Delete(ctx, \"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.biometricTemplates().delete(\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "biometricTemplates->delete('9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.biometric_templates.delete(\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.BiometricTemplates.DeleteAsync(\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/biometric-templates/delete/": { "post": { "summary": "Массовое удаление сохранённых биометрических шаблонов", "description": "Приложение, включившее эту функцию, сохраняет один отдельно управляемый биометрический шаблон лица без изображений, привязанный к Пользователю при удалении сессии (см. `DELETE /v3/session/{sessionId}/delete/`). Шаблоны представляют собой биометрические данные с ограниченным сроком действия `expires_at`; они никогда не содержат изображений, данных сессии или полей личности и безвозвратно удаляются при удалении Пользователя, стирании данных в целях конфиденциальности, истечении срока действия или явной очистке. Эти endpoint принимают только API-ключи приложения (`x-api-key`); пользовательские токены Business Console отклоняются с ошибкой `403`.\n\nОчищает множество шаблонов за один вызов, по явному списку идентификаторов или с флагом `delete_all: true`, при необходимости суженным теми же фильтрами, что и endpoint списка. Шаблоны очищаются по одному, и для каждого результата указывается `purged` или `already_purged`. Если хранилище биометрических данных недоступно, вызов возвращает `503` на первом сбойном шаблоне: шаблоны, очищенные ранее в запросе, остаются очищенными, сбойный переходит в `purge_failed` (уже исключён из сопоставления), а повторение запроса завершает операцию.\n\n**`delete_all: true` без фильтров очищает каждый биометрический шаблон в приложении, и это действие невозможно отменить.** Сначала вызовите endpoint подсчёта количества с теми же фильтрами.", "operationId": "bulk_purge_biometric_templates", "x-didit-sdk": { "resource": "biometric_templates", "method": "batch_delete", "auth": "api_key", "server": true }, "tags": [ "Biometric Templates" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "template_uuids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "description": "Шаблоны для безвозвратного удаления. Обязательно, если `delete_all` не равен `true`. Уже удаленные идентификаторы возвращаются как `already_purged`." }, "delete_all": { "type": "boolean", "default": false, "description": "Когда `true`, безвозвратно удаляет все шаблоны, соответствующие указанным ниже фильтрам (все шаблоны приложения, если фильтр не задан). Параметр `template_uuids` игнорируется. Действие необратимо." }, "vendor_data": { "type": "string", "description": "Только с `delete_all`: нечувствительное к регистру сопоставление по подстроке в `vendor_data` пользователя-владельца." }, "vendor_user_uuid": { "type": "string", "format": "uuid", "description": "Только с `delete_all`: точное совпадение по пользователю-владельцу." }, "status": { "type": "string", "enum": [ "pending", "active", "expired", "held_out_of_use", "purge_pending", "purge_failed" ], "description": "Только с `delete_all`." }, "source_type": { "type": "string", "enum": [ "session_delete", "automatic_retention", "backfill" ], "description": "Только с `delete_all`." }, "retained_from": { "type": "string", "format": "date-time", "description": "Только с `delete_all`." }, "retained_to": { "type": "string", "format": "date-time", "description": "Только с `delete_all`. Не должно быть раньше `retained_from`." } } }, "examples": { "By id": { "value": { "template_uuids": [ "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d" ] } }, "Every template of one User": { "value": { "delete_all": true, "vendor_user_uuid": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f" } }, "Every template in the application": { "value": { "delete_all": true } } } } } }, "responses": { "200": { "description": "Результаты очистки по шаблонам.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "outcome": { "type": "string", "enum": [ "purged", "already_purged" ] } } } } } }, "examples": { "Mixed": { "value": { "results": [ { "uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "outcome": "purged" }, { "uuid": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "outcome": "already_purged" } ] } } } } } }, "400": { "description": "Ошибка валидации — ничего не очищено.", "content": { "application/json": { "examples": { "Missing selector": { "value": { "template_uuids": [ "This field is required unless delete_all is true." ] } }, "Bad range": { "value": { "retained_to": [ "Must be on or after retained_from." ] } } } } } }, "403": { "description": "Токен пользователя Console, либо данный API-ключ не разрешён. Эти endpoint принимают только API-ключи приложений.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "503": { "description": "Хранилище биометрии было недоступно при сохранении или удалении биометрического шаблона. Ничего не удалено; повторите тот же запрос. Повторные попытки идемпотентны и сходятся к одному шаблону.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Retryable": { "value": { "detail": "The biometric-template operation could not finish because an external store is unavailable. The operation is retryable." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/biometric-templates/delete/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"delete_all\": true, \"vendor_user_uuid\": \"2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.biometric_templates.batch_delete(\n template_uuids=[\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\", \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.biometricTemplates.batchDelete({\n template_uuids: [\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\", \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.BiometricTemplates.BatchDelete(ctx, didit.BiometricTemplatesBatchDeleteParams{\n\tTemplateUUIDs: didit.Some([]string{\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\", \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.BiometricTemplatesBatchDeleteParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.biometricTemplates().batchDelete(BiometricTemplatesBatchDeleteParams.builder()\n .templateUuids(List.of(\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\", \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "biometricTemplates->batchDelete([\n 'template_uuids' => ['9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b', '1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.biometric_templates.batch_delete(template_uuids: [\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\", \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\"])\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.BiometricTemplates.BatchDeleteAsync(new BiometricTemplatesBatchDeleteParams\n{\n TemplateUuids = new string[] { \"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\", \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/kyb/shareholders/": { "post": { "summary": "Компания в реестре KYB с акционерами (отдельная)", "operationId": "post_v3_kyb_shareholders", "x-didit-sdk": { "resource": "kyb", "method": "list_shareholders", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [], "description": "Получить профиль Lite **плюс прямых акционеров** (физических и юридических лиц с их диапазонами владения) для одного кандидата, возвращённого `POST /v3/kyb/search/`.\n\n**Связка с поиском.** Передайте `kyb_response_id` кандидата в точности так, как он был возвращён поиском того же приложения. Выполняйте поиск на том уровне, который планируете приобрести (`tier` в `POST /v3/kyb/search/`), поскольку поиск выполняется по цепочке реестров, обслуживающей этот уровень, а пустой поиск Lite не является доказательством того, что компании нет в реестре. Если данные о структуре владения в этой стране находятся в другом реестре, Didit находит компанию там заново по регистрационному номеру без дополнительной платы.\n\n**Биллинг.** Оплата списывается по цене Shareholders для соответствующей страны: см. [Цены на реестры KYB](/ru/getting-started/kyb-registry-pricing). Если в реестре отсутствует запись об акционерах компании (или в стране вообще не предоставляются данные о структуре владения), вместо этого доставляется и тарифицируется профиль Lite: считывайте `registry_tier_delivered` и `registry_ownership_status`. Баланс проверяется на соответствие цене Shareholders перед любым вызовом к реестру (`403` при нехватке средств).\n\n**Доступность.** Только v3. Каждый вызов создаёт сессию компании (её идентификатором является `request_id`).\n\n**Отчёты в обработке.** Если отчёт всё ещё формируется или раздел со структурой владения ещё не получен из реестра, endpoint возвращает 202 Accepted, kyb_registry.fetch_status=pending, kyb_registry.registry_ownership_status=pending и registry_tier_delivered=null. Сохраните request_id и вызывайте GET /v3/session/{request_id}/decision/, пока значение registry_checks[0].company.fetch_status не будет определено. Didit формирует отчёт автоматически и списывает оплату за доставленный уровень, как только он будет готов. Не повторяйте покупку, пока она находится в ожидании; каждый новый POST создаёт отдельный запрос.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KYBRegistryCandidateRequest" }, "example": { "kyb_response_id": "69aeeb95febb0f1704042259", "vendor_data": "company-1234" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/kyb/shareholders/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"kyb_response_id\": \"69aeeb95febb0f1704042259\",\n \"vendor_data\": \"company-1234\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.kyb.list_shareholders(\n kyb_response_id=\"69aeeb95febb0f1704042259\",\n vendor_data=\"company-1234\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.kyb.listShareholders({\n kyb_response_id: \"69aeeb95febb0f1704042259\",\n vendor_data: \"company-1234\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.KYB.ListShareholders(ctx, didit.KYBRegistryCandidateRequest{\n\tKYBResponseID: \"69aeeb95febb0f1704042259\",\n\tVendorData: didit.String(\"company-1234\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.KYBRegistryCandidateRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.kyb().listShareholders(KYBRegistryCandidateRequest.builder()\n .kybResponseId(\"69aeeb95febb0f1704042259\")\n .vendorData(\"company-1234\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "kyb->listShareholders([\n 'kyb_response_id' => '69aeeb95febb0f1704042259',\n 'vendor_data' => 'company-1234',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.kyb.list_shareholders(\n kyb_response_id: \"69aeeb95febb0f1704042259\",\n vendor_data: \"company-1234\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Kyb.ListShareholdersAsync(new KYBRegistryCandidateRequest\n{\n KybResponseId = \"69aeeb95febb0f1704042259\",\n VendorData = \"company-1234\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Отчёт о компании возвращён и тарифицирован по предоставленному уровню. Отчёты о структуре владения, которые всё ещё подготавливаются, могут возвращать 202; сохраняйте request_id для получения сохранённого решения.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Идентификатор бизнес-сессии, созданной для этого запроса данных. Сохранённая запись (видимая в консоли) продолжает обновляться, если реестр завершит обработку после отправки ответа." }, "registry_tier_requested": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "description": "Уровень, который продает этот endpoint: `basic` (Lite) для select, `shareholders`, `ubo`." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo", null ], "description": "Уровень, фактически предоставленный и включенный в счёт. Ниже запрошенного, если реестры страны не содержат данных о структуре владения или в реестре нет записей о структуре владения для этой компании.", "nullable": true }, "kyb_registry": { "type": "object", "description": "Полный профиль компании из реестра.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Идентификатор Didit для этой записи компании." }, "node_id": { "type": "string", "example": "feature_kyb_registry" }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review" ], "description": "Оценка Didit по проверке в реестре (например, `In Review`, если компания не активна в реестре или данные о структуре владения не удалось определить)." }, "registry_status": { "type": "string", "nullable": true, "enum": [ "active", "dissolved", "deregistered", "see full details", "authorised", "appointed representative", "unauthorised", "inactive", "no longer authorised", "closed", "struck off", null ], "description": "Нормализованный статус компании согласно данным реестра." }, "data_resolved": { "type": "boolean", "description": "`true`, когда реестр вернул полный профиль. `false`, если реестр всё ещё обрабатывал запрос после опроса — сохранённая запись будет автоматически дополнена, как только реестр завершит обработку." }, "company_name": { "type": "string", "example": "Tesco PLC" }, "registration_number": { "type": "string", "nullable": true, "example": "00445790" }, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2.", "example": "GB" }, "region": { "type": "string", "nullable": true, "description": "Код подразделения, если реестр региональный (например, `CA` для `US-CA`); в противном случае пусто." }, "company_type": { "type": "string", "nullable": true, "example": "Public Limited Company" }, "incorporation_date": { "type": "string", "format": "date", "nullable": true, "example": "1947-11-27" }, "registered_address": { "type": "string", "nullable": true, "example": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA" }, "tax_number": { "type": "string", "nullable": true, "example": "GB412 8925 93" }, "risk_level": { "type": "string", "nullable": true, "description": "Уровень риска по данным реестра, если доступен." }, "verification_status": { "type": "string", "enum": [ "verified", "failed", "unknown" ], "nullable": true, "description": "Статус верификации между юрисдикциями: `verified`, когда статус в реестре подтверждает правовой статус (`active`), `failed`, когда реестр указывает, что компания ликвидирована или не действует (например, `dissolved`), в противном случае `unknown`. `null` для компании, полученной не из реестра, а также пока выбор остаётся в статусе `pending`." }, "is_from_registry": { "type": "boolean", "description": "Всегда `true` для этого endpoint — профиль был получен из официального реестра." }, "fetch_status": { "type": "string", "enum": [ "pending", "resolved" ], "description": "Жизненный цикл получения данных из реестра. Дублируется полем `data_resolved`." }, "alternative_names": { "type": "string", "nullable": true, "description": "Альтернативные, торговые, прежние или наименования компании на языке оригинала в виде текста, если они указаны." }, "nature_of_business": { "type": "string", "nullable": true, "description": "Описание деятельности или код классификации, если они указаны." }, "registered_capital": { "type": "string", "nullable": true }, "registered_capital_amount": { "type": "string", "nullable": true, "description": "Десятичная сумма в виде строки, если передана." }, "registered_capital_currency": { "type": "string", "nullable": true, "description": "Код ISO 4217, если указан." }, "website": { "type": "string", "nullable": true, "example": "https://www.tesco.com/" }, "email": { "type": "string", "nullable": true, "example": "customer.service@tesco.co.uk" }, "phone": { "type": "string", "nullable": true, "example": "03301231688" }, "legal_entity_identifier": { "type": "string", "nullable": true, "description": "LEI, если указан." }, "location_of_registration": { "type": "string", "nullable": true, "description": "Реестр или юрисдикция регистрации компании, если указаны." }, "vat_number": { "type": "string", "nullable": true, "description": "Номер плательщика НДС в ЕС, если он был собран на размещённом шаге реестра или изменён впоследствии. При выборе он обычно ещё не задан — проверка НДС и налогового номера выполняется, когда конечный пользователь отправляет шаг реестра в размещённом процессе." }, "vat_validation_status": { "type": "string", "enum": [ "valid", "invalid", "format_valid", "invalid_format", "could_not_validate", "not_applicable" ], "description": "Результат валидации номера плательщика НДС (VAT) или, при его отсутствии, `tax_number` при отправке в реестр. `valid` / `invalid`: определяется официальным реестром страны (EU VIES, Норвегия, Швейцария, Бразилия, Колумбия, Коста-Рика, Эквадор, Парагвай; Польша также по внутреннему реестру НДС). `format_valid` / `invalid_format`: определяется правилами формата и контрольных цифр страны, если реестр недоступен для запроса. `could_not_validate`: реестр был недоступен. `not_applicable`: номер отсутствует, в стране нет реестра или правил либо это сессия в песочнице." }, "vat_validated_number": { "type": "string", "nullable": true, "description": "Номер, который был проверен, в том виде, в каком он известен источнику (например, номер VAT, полученный из французского SIREN или нидерландского RSIN). `null`, если проверка не выполнялась." }, "vat_validation_source": { "type": "string", "nullable": true, "enum": [ "eu_vies", "pl_vat_white_list", "no_brreg", "ch_uid_register", "br_receita_federal", "co_rues", "cr_hacienda", "ec_sri", "py_dnit", "format_rules", null ], "description": "Источник, определивший `vat_validation_status`: официальный реестр или `format_rules`. `null`, если проверка не проводилась." }, "vat_validated_name": { "type": "string", "nullable": true, "description": "Имя, зарегистрированное в источнике, подтвердившем номер, если источник его раскрывает. Указывается только со статусом `valid`." }, "vat_validated_address": { "type": "string", "nullable": true, "description": "Адрес, зарегистрированный в источнике, выполнившем проверку номера, если он раскрывает его. Заполняется, только когда статус равен `valid`." }, "vat_checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Временная метка проверки. `null`, если проверка не запускалась." }, "financial_summary": { "type": "object", "nullable": true, "description": "Сведения об акциях и капитале по данным реестра (валюта, общее количество акций, классы акций), если доступны." }, "officers": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "example": "MELISSA BETHELL" }, "designation": { "type": "string", "nullable": true, "description": "Необработанное наименование должности из реестра (например, `Director`, `Secretary`)." }, "role": { "type": "string", "description": "Нормализованная роль, полученная из должности. Полный набор модели из 17 значений; парсинг реестра на этом endpoint обычно возвращает director, non_executive_director, secretary, chairman или company_officer.", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "company_officer", "settlor", "protector", "investor", "other" ] }, "nationality": { "type": "string", "nullable": true }, "is_active": { "type": "boolean", "description": "`false`, когда реестр отмечает назначение как завершённое из-за отставки." }, "kyc_status": { "type": "string", "nullable": true, "enum": [ "Approved", "Declined", "Pending", null ], "description": "Статус связанной KYC-сессии, если она была запущена для этого должностного лица. В противном случае `null`." }, "kyc_session_url": { "type": "string", "nullable": true, "description": "URL верификации связанной сессии KYC, если таковая существует." }, "first_name": { "type": "string", "nullable": true, "description": "Имя, если оно явно указано в реестре; не выводится из полного имени." }, "last_name": { "type": "string", "nullable": true, "description": "Фамилия, если она явно указана в реестре." }, "address": { "type": "string", "nullable": true, "description": "Адрес должностного лица, указанный в реестре." }, "appointment_date": { "type": "string", "nullable": true, "description": "Дата назначения должностного лица.", "format": "date" }, "termination_date": { "type": "string", "nullable": true, "description": "Дата окончания полномочий, если указана.", "format": "date" }, "date_of_birth": { "type": "string", "nullable": true, "description": "Полная дата рождения по данным реестра. Null, если известны только год или месяц рождения.", "format": "date" }, "date_of_birth_year": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 9999, "description": "Год рождения по данным реестра, в том числе когда полная дата недоступна." }, "date_of_birth_month": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 12, "description": "Месяц рождения по данным реестра. Null, если известен только год." } } }, "description": "Директора, секретари и другие должностные лица, извлечённые из реестра." }, "beneficial_owners": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Является ли владелец физическим или юридическим лицом." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Нормализованные роли (например, `ubo`, `shareholder`)." }, "ownership_min_shares": { "type": "string", "nullable": true, "description": "Нижняя граница диапазона владения, указанная в реестре (например, `25%`)." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Верхняя граница диапазона доли владения согласно реестру." }, "is_active": { "type": "boolean" }, "kyc_status": { "type": "string", "nullable": true, "enum": [ "Approved", "Declined", "Pending", null ] }, "kyc_session_url": { "type": "string", "nullable": true }, "effective_ownership_percent": { "type": "number", "nullable": true, "description": "Распознанный процент владения (верхняя граница, с переходом на нижнюю границу при отсутствии)." }, "company_name": { "type": "string", "nullable": true }, "registration_number": { "type": "string", "nullable": true }, "country_of_birth": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "designation": { "type": "string", "nullable": true }, "voting_min_shares": { "type": "string", "nullable": true }, "voting_max_shares": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "nullable": true, "description": "Полная дата рождения, если указана.", "format": "date" }, "appointment_date": { "type": "string", "nullable": true, "description": "Дата назначения, если указана.", "format": "date" }, "shareholding": { "$ref": "#/components/schemas/KYBRegistryShareholding" } } }, "description": "Бенефициарные владельцы / лица, осуществляющие значительный контроль, извлечённые из реестра. Может быть пустым, если реестр не раскрывает структуру владения." }, "addresses": { "type": "array", "nullable": true, "description": "Каждый адрес, указанный в реестре, в едином каноническом формате. Null, если реестр не указывает ни одного.", "items": { "$ref": "#/components/schemas/KYBRegistryAddress" } }, "industries": { "type": "array", "nullable": true, "description": "Виды деятельности, к которым реестр относит компанию, в единой канонической форме. Null, если ни один вид не указан.", "items": { "$ref": "#/components/schemas/KYBRegistryIndustry" } }, "accounts": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Даты подачи документов в реестр, если доступны. Для годовой отчётности и общих собраний используются last_annual_return_date и last_agm_date; они отличаются от финансовой отчётности." }, "registry_data": { "$ref": "#/components/schemas/KYBRegistryData" }, "user_provided_data": { "type": "object", "nullable": true, "description": "Всегда `null` на этом endpoint (используется в размещённом сценарии KYB, когда конечные пользователи редактируют данные из реестра)." }, "confirmed_by_user_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Всегда `null` на этом endpoint." }, "last_console_edit_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Задаётся, когда проверяющий из консоли позже редактирует запись." }, "is_editable": { "type": "boolean", "description": "Можно ли по-прежнему редактировать данные из реестра компаний в размещённом сценарии или консоли." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo", null ], "description": "То же, что и `registry_tier_delivered` верхнего уровня.", "nullable": true }, "registry_ownership_status": { "type": "string", "nullable": true, "enum": [ "not_requested", "delivered", "not_held", "unavailable", "pending", null ], "description": "`delivered`, когда данные о структуре владения получены; `not_held`, когда реестр структуры владения ответил и в нём нет этой компании (см. `registry_data.ownership_error`); `unavailable`, когда был запрошен уровень со структурой владения, но в реестре не было данных по этой компании или к нему не удалось обратиться (см. `registry_data.ownership_error`); `pending`, когда раздел структуры владения ещё не получен из реестра и Didit всё ещё формирует его; `not_requested` для уровня Lite." }, "ownership": { "$ref": "#/components/schemas/KYBRegistryOwnership" }, "registry_tier": { "type": "string", "nullable": true, "description": "Уровень реестра, запрошенный сценарием: `basic`, `shareholders` или `ubo`. Также указан в `ownership.tier_requested`." }, "registry_monitoring": { "type": "object", "nullable": true, "description": "Последний мониторинг реестра для компании или `null`, если он отсутствует.", "properties": { "uuid": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "unavailable_reason": { "type": "string", "nullable": true }, "enrolled_at": { "type": "string", "format": "date-time", "nullable": true }, "cancelled_at": { "type": "string", "format": "date-time", "nullable": true }, "last_bill_date": { "type": "string", "format": "date", "nullable": true }, "next_bill_date": { "type": "string", "format": "date", "nullable": true }, "last_event_at": { "type": "string", "format": "date-time", "nullable": true }, "events_count": { "type": "integer" }, "watched_fields": { "description": "Поля компании, отслеживаемые мониторингом." } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Эхо отправленных вами `vendor_data`." }, "metadata": { "type": "object", "nullable": true, "description": "Эхо-значение переданного вами `metadata`." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "Resolved company": { "summary": "Полный профиль из реестра (список должностных лиц сокращён для краткости)", "value": { "request_id": "9d4f2c7a-1b3e-4a5c-8d6f-0e9a8b7c6d5e", "kyb_registry": { "uuid": "f1e2d3c4-b5a6-4789-9c0d-1e2f3a4b5c6d", "node_id": "feature_kyb_registry", "status": "In Review", "registry_status": "active", "data_resolved": true, "company_name": "Tesco PLC", "registration_number": "00445790", "country_code": "GB", "region": "", "company_type": "Public Limited Company", "incorporation_date": "1947-11-27", "registered_address": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA", "tax_number": "GB412 8925 93", "risk_level": "low risk", "verification_status": "verified", "is_from_registry": true, "fetch_status": "resolved", "alternative_names": "TESCO STORES (HOLDINGS) PUBLIC LIMITED COMPANY", "nature_of_business": null, "registered_capital": null, "registered_capital_amount": null, "registered_capital_currency": null, "website": "https://www.tesco.com/", "email": "customer.service@tesco.co.uk", "phone": "03301231688", "legal_entity_identifier": null, "location_of_registration": null, "financial_summary": { "currency": "Pound (£)", "total_number_of_shares": "8174378721", "meta_detail": { "Class_Of_Share": "Ordinary" } }, "officers": [ { "uuid": "a1b2c3d4-e5f6-4789-9a0b-1c2d3e4f5a6b", "name": "CHRISTOPHER JON TAYLOR", "designation": "Secretary", "role": "secretary", "nationality": null, "is_active": true, "kyc_status": null, "kyc_session_url": null }, { "uuid": "b2c3d4e5-f6a7-4890-8b1c-2d3e4f5a6b7c", "name": "MELISSA BETHELL", "designation": "Director", "role": "director", "nationality": "British", "is_active": true, "kyc_status": null, "kyc_session_url": null } ], "beneficial_owners": [], "addresses": [ { "address": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA", "type": "legal_entity_registry_address", "description": "registered office address" } ], "industries": null, "accounts": { "last_account": "26 February 2025", "next_account": "26 February 2026", "due_by_date": "26 August 2026" }, "registry_data": {}, "user_provided_data": null, "confirmed_by_user_at": null, "last_console_edit_at": null, "is_editable": true }, "vendor_data": "company-1234", "metadata": null, "created_at": "2026-06-11T10:45:00.000000+00:00" } } } } } }, "400": { "description": "Ошибка валидации. Проблемы на уровне полей используют стандартную структуру DRF.", "content": { "application/json": { "examples": { "Missing kyb_response_id": { "summary": "Поле `kyb_response_id` обязательно", "value": { "kyb_response_id": [ "This field is required." ] } }, "save_api_request=false rejected": { "summary": "Выбранные значения всегда сохраняются", "value": { "save_api_request": [ "KYB registry select must be saved so billing and retrieval can be tracked." ] } } } } } }, "403": { "description": "В доступе отказано. Возвращается, если заголовок `x-api-key` отсутствует, а также если баланс вызывающей организации не покрывает вызов; неверный, отозванный или истекший ключ возвращает `401`. Отсутствующий ключ возвращает `403` с `{\"detail\": ...}`; неверный, отозванный или истекший ключ возвращает `401`. При нехватке кредитов возвращается `403` с `{\"error\": ...}` до начала любого скрининга или вызова провайдера.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Отсутствует заголовок `x-api-key`, либо ключ недействителен/отозван", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "Баланс организации недостаточен для совершения вызова", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Превышен лимит запросов. Endpoint'ы POST/PATCH/DELETE делят общий лимит в 300 запросов на запись в минуту на один API-ключ (для создания транзакций и отправки событий действует отдельный лимит в 600). Ответ содержит заголовки `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` и `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Более 300 запросов на запись в текущую минуту", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "202": { "description": "Отчёт принят и всё ещё обрабатывается. Когда отчёт всё ещё подготавливается, endpoint возвращает 202 Accepted, kyb_registry.fetch_status=pending и registry_tier_delivered=null. Сохраните request_id и опрашивайте GET /v3/session/{request_id}/decision/ до тех пор, пока registry_checks[0].company.fetch_status не перейдёт в финальный статус. Didit автоматически завершает подготовку отчёта и списывает плату за предоставленный уровень, как только он готов. Не повторяйте покупку, пока запрос находится в обработке; каждый новый POST создаёт отдельный запрос.", "content": { "application/json": { "schema": { "$ref": "#/paths/~1v3~1kyb~1shareholders~1/post/responses/200/content/application~1json/schema" }, "examples": { "Pending (registry still resolving)": { "summary": "Отчёт о структуре владения всё ещё формируется; получить сохранённое решение", "value": { "request_id": "9d4f2c7a-1b3e-4a5c-8d6f-0e9a8b7c6d5e", "kyb_registry": { "uuid": "7c0a4f7e-2b1d-4f6a-9c3e-8d5b2a1f0e9d", "node_id": "feature_kyb_registry", "status": "Not Finished", "registry_status": null, "data_resolved": false, "company_name": "Example Holdings Limited", "registration_number": "12345678", "country_code": "HK", "region": null, "company_type": null, "incorporation_date": null, "registered_address": null, "tax_number": null, "risk_level": null, "verification_status": null, "is_from_registry": true, "fetch_status": "pending", "alternative_names": null, "nature_of_business": null, "registered_capital": null, "registered_capital_amount": null, "registered_capital_currency": null, "website": null, "email": null, "phone": null, "legal_entity_identifier": null, "location_of_registration": null, "financial_summary": {}, "officers": [], "beneficial_owners": [], "addresses": null, "industries": null, "accounts": null, "registry_data": {}, "user_provided_data": null, "confirmed_by_user_at": null, "last_console_edit_at": null, "is_editable": true, "registry_tier_delivered": null, "registry_ownership_status": "pending" }, "vendor_data": "company-1234", "metadata": null, "created_at": "2026-06-11T10:45:00.000000+00:00", "registry_tier_delivered": null, "registry_tier_requested": "shareholders" } } } } } } } } }, "/v3/kyb/ubo/": { "post": { "summary": "Компания в реестре KYB с конечными бенефициарными владельцами (отдельная)", "operationId": "post_v3_kyb_ubo", "x-didit-sdk": { "resource": "kyb", "method": "list_ubos", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [], "description": "Получить профиль Lite, прямых акционеров **и конечных бенефициарных владельцев**, определённых через цепочку владения (`registry_data.ubo_resolution` содержит цепочку материнских компаний), для одного кандидата, возвращённого `POST /v3/kyb/search/`.\n\n**Связка с поиском.** Передайте `kyb_response_id` кандидата в точности так, как он был возвращён поиском того же приложения. Выполняйте поиск на том уровне, который планируете приобрести (`tier` в `POST /v3/kyb/search/`), поскольку поиск выполняется по цепочке реестров, обслуживающей этот уровень, а пустой поиск Lite не является доказательством того, что компании нет в реестре. Если данные о структуре владения в этой стране находятся в другом реестре, Didit находит компанию там заново по регистрационному номеру без дополнительной платы.\n\n**Биллинг.** Оплата списывается по цене UBO для соответствующей страны - см. [Цены на реестры KYB](/ru/getting-started/kyb-registry-pricing). Доставленный уровень является наивысшим из доступных для данной страны и реестра: Shareholders, если сформированный отчёт не указывает физическое лицо в качестве бенефициарного владельца, и Lite, если запись о структуре владения отсутствует вовсе; `registry_tier_delivered` указывает, за какой уровень списана оплата. Баланс проверяется на соответствие цене UBO перед любым вызовом к реестру (`403` при нехватке средств).\n\n**Доступность.** Только v3. Каждый вызов создаёт сессию компании (её идентификатором является `request_id`).\n\n**Отчёты в обработке.** Если отчёт всё ещё формируется или раздел со структурой владения ещё не получен из реестра, endpoint возвращает 202 Accepted, kyb_registry.fetch_status=pending, kyb_registry.registry_ownership_status=pending и registry_tier_delivered=null. Сохраните request_id и вызывайте GET /v3/session/{request_id}/decision/, пока registry_checks[0].company.fetch_status не разрешится. Didit формирует отчёт автоматически и списывает оплату за доставленный уровень, как только он будет готов. Не повторяйте покупку, пока она находится в ожидании; каждый новый POST создаёт отдельный запрос.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KYBRegistryCandidateRequest" }, "example": { "kyb_response_id": "69aeeb95febb0f1704042259", "vendor_data": "company-1234" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/kyb/ubo/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"kyb_response_id\": \"69aeeb95febb0f1704042259\",\n \"vendor_data\": \"company-1234\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.kyb.list_ubos(\n kyb_response_id=\"69aeeb95febb0f1704042259\",\n vendor_data=\"company-1234\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.kyb.listUbos({\n kyb_response_id: \"69aeeb95febb0f1704042259\",\n vendor_data: \"company-1234\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.KYB.ListUBOs(ctx, didit.KYBRegistryCandidateRequest{\n\tKYBResponseID: \"69aeeb95febb0f1704042259\",\n\tVendorData: didit.String(\"company-1234\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.KYBRegistryCandidateRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.kyb().listUbos(KYBRegistryCandidateRequest.builder()\n .kybResponseId(\"69aeeb95febb0f1704042259\")\n .vendorData(\"company-1234\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "kyb->listUbos([\n 'kyb_response_id' => '69aeeb95febb0f1704042259',\n 'vendor_data' => 'company-1234',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.kyb.list_ubos(\n kyb_response_id: \"69aeeb95febb0f1704042259\",\n vendor_data: \"company-1234\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Kyb.ListUbosAsync(new KYBRegistryCandidateRequest\n{\n KybResponseId = \"69aeeb95febb0f1704042259\",\n VendorData = \"company-1234\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Отчёт о компании возвращён и тарифицирован по предоставленному уровню. Отчёты о структуре владения, которые всё ещё подготавливаются, могут возвращать 202; сохраняйте request_id для получения сохранённого решения.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Идентификатор бизнес-сессии, созданной для этого запроса данных. Сохранённая запись (видимая в консоли) продолжает обновляться, если реестр завершит обработку после отправки ответа." }, "registry_tier_requested": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "description": "Уровень, который продает этот endpoint: `basic` (Lite) для select, `shareholders`, `ubo`." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo", null ], "description": "Уровень, фактически предоставленный и включенный в счёт. Ниже запрошенного, если реестры страны не содержат данных о структуре владения, если в реестре нет записей о структуре владения для этой компании, либо если итоговый отчёт по запросу `ubo` не содержит физических лиц в качестве бенефициарных владельцев.", "nullable": true }, "kyb_registry": { "type": "object", "description": "Полный профиль компании из реестра.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Идентификатор Didit для этой записи компании." }, "node_id": { "type": "string", "example": "feature_kyb_registry" }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review" ], "description": "Оценка Didit по проверке в реестре (например, `In Review`, если компания не активна в реестре или данные о структуре владения не удалось определить)." }, "registry_status": { "type": "string", "nullable": true, "enum": [ "active", "dissolved", "deregistered", "see full details", "authorised", "appointed representative", "unauthorised", "inactive", "no longer authorised", "closed", "struck off", null ], "description": "Нормализованный статус компании согласно данным реестра." }, "data_resolved": { "type": "boolean", "description": "`true`, когда реестр вернул полный профиль. `false`, если реестр всё ещё обрабатывал запрос после опроса — сохранённая запись будет автоматически дополнена, как только реестр завершит обработку." }, "company_name": { "type": "string", "example": "Tesco PLC" }, "registration_number": { "type": "string", "nullable": true, "example": "00445790" }, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2.", "example": "GB" }, "region": { "type": "string", "nullable": true, "description": "Код подразделения, если реестр региональный (например, `CA` для `US-CA`); в противном случае пусто." }, "company_type": { "type": "string", "nullable": true, "example": "Public Limited Company" }, "incorporation_date": { "type": "string", "format": "date", "nullable": true, "example": "1947-11-27" }, "registered_address": { "type": "string", "nullable": true, "example": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA" }, "tax_number": { "type": "string", "nullable": true, "example": "GB412 8925 93" }, "risk_level": { "type": "string", "nullable": true, "description": "Уровень риска по данным реестра, если доступен." }, "verification_status": { "type": "string", "enum": [ "verified", "failed", "unknown" ], "nullable": true, "description": "Статус верификации между юрисдикциями: `verified`, когда статус в реестре подтверждает правовой статус (`active`), `failed`, когда реестр указывает, что компания ликвидирована или не действует (например, `dissolved`), в противном случае `unknown`. `null` для компании, полученной не из реестра, а также пока выбор остаётся в статусе `pending`." }, "is_from_registry": { "type": "boolean", "description": "Всегда `true` для этого endpoint — профиль был получен из официального реестра." }, "fetch_status": { "type": "string", "enum": [ "pending", "resolved" ], "description": "Жизненный цикл получения данных из реестра. Дублируется полем `data_resolved`." }, "alternative_names": { "type": "string", "nullable": true, "description": "Альтернативные, торговые, прежние или наименования компании на языке оригинала в виде текста, если они указаны." }, "nature_of_business": { "type": "string", "nullable": true, "description": "Описание деятельности или код классификации, если они указаны." }, "registered_capital": { "type": "string", "nullable": true }, "registered_capital_amount": { "type": "string", "nullable": true, "description": "Десятичная сумма в виде строки, если передана." }, "registered_capital_currency": { "type": "string", "nullable": true, "description": "Код ISO 4217, если указан." }, "website": { "type": "string", "nullable": true, "example": "https://www.tesco.com/" }, "email": { "type": "string", "nullable": true, "example": "customer.service@tesco.co.uk" }, "phone": { "type": "string", "nullable": true, "example": "03301231688" }, "legal_entity_identifier": { "type": "string", "nullable": true, "description": "LEI, если указан." }, "location_of_registration": { "type": "string", "nullable": true, "description": "Реестр или юрисдикция регистрации компании, если указаны." }, "vat_number": { "type": "string", "nullable": true, "description": "Номер плательщика НДС в ЕС, если он был собран на размещённом шаге реестра или изменён впоследствии. При выборе он обычно ещё не задан — проверка НДС и налогового номера выполняется, когда конечный пользователь отправляет шаг реестра в размещённом процессе." }, "vat_validation_status": { "type": "string", "enum": [ "valid", "invalid", "format_valid", "invalid_format", "could_not_validate", "not_applicable" ], "description": "Результат валидации номера плательщика НДС (VAT) или, при его отсутствии, `tax_number` при отправке в реестр. `valid` / `invalid`: определяется официальным реестром страны (EU VIES, Норвегия, Швейцария, Бразилия, Колумбия, Коста-Рика, Эквадор, Парагвай; Польша также по внутреннему реестру НДС). `format_valid` / `invalid_format`: определяется правилами формата и контрольных цифр страны, если реестр недоступен для запроса. `could_not_validate`: реестр был недоступен. `not_applicable`: номер отсутствует, в стране нет реестра или правил либо это сессия в песочнице." }, "vat_validated_number": { "type": "string", "nullable": true, "description": "Номер, который был проверен, в том виде, в каком он известен источнику (например, номер VAT, полученный из французского SIREN или нидерландского RSIN). `null`, если проверка не выполнялась." }, "vat_validation_source": { "type": "string", "nullable": true, "enum": [ "eu_vies", "pl_vat_white_list", "no_brreg", "ch_uid_register", "br_receita_federal", "co_rues", "cr_hacienda", "ec_sri", "py_dnit", "format_rules", null ], "description": "Источник, определивший `vat_validation_status`: официальный реестр или `format_rules`. `null`, если проверка не проводилась." }, "vat_validated_name": { "type": "string", "nullable": true, "description": "Имя, зарегистрированное в источнике, подтвердившем номер, если источник его раскрывает. Указывается только со статусом `valid`." }, "vat_validated_address": { "type": "string", "nullable": true, "description": "Адрес, зарегистрированный в источнике, выполнившем проверку номера, если он раскрывает его. Заполняется, только когда статус равен `valid`." }, "vat_checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Временная метка проверки. `null`, если проверка не запускалась." }, "financial_summary": { "type": "object", "nullable": true, "description": "Сведения об акциях и капитале по данным реестра (валюта, общее количество акций, классы акций), если доступны." }, "officers": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "example": "MELISSA BETHELL" }, "designation": { "type": "string", "nullable": true, "description": "Необработанное наименование должности из реестра (например, `Director`, `Secretary`)." }, "role": { "type": "string", "description": "Нормализованная роль, полученная из должности. Полный набор модели из 17 значений; парсинг реестра на этом endpoint обычно возвращает director, non_executive_director, secretary, chairman или company_officer.", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "company_officer", "settlor", "protector", "investor", "other" ] }, "nationality": { "type": "string", "nullable": true }, "is_active": { "type": "boolean", "description": "`false`, когда реестр отмечает назначение как завершённое из-за отставки." }, "kyc_status": { "type": "string", "nullable": true, "enum": [ "Approved", "Declined", "Pending", null ], "description": "Статус связанной KYC-сессии, если она была запущена для этого должностного лица. В противном случае `null`." }, "kyc_session_url": { "type": "string", "nullable": true, "description": "URL верификации связанной сессии KYC, если таковая существует." }, "first_name": { "type": "string", "nullable": true, "description": "Имя, если оно явно указано в реестре; не выводится из полного имени." }, "last_name": { "type": "string", "nullable": true, "description": "Фамилия, если она явно указана в реестре." }, "address": { "type": "string", "nullable": true, "description": "Адрес должностного лица, указанный в реестре." }, "appointment_date": { "type": "string", "nullable": true, "description": "Дата назначения должностного лица.", "format": "date" }, "termination_date": { "type": "string", "nullable": true, "description": "Дата окончания полномочий, если указана.", "format": "date" }, "date_of_birth": { "type": "string", "nullable": true, "description": "Полная дата рождения по данным реестра. Null, если известны только год или месяц рождения.", "format": "date" }, "date_of_birth_year": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 9999, "description": "Год рождения по данным реестра, в том числе когда полная дата недоступна." }, "date_of_birth_month": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 12, "description": "Месяц рождения по данным реестра. Null, если известен только год." } } }, "description": "Директора, секретари и другие должностные лица, извлечённые из реестра." }, "beneficial_owners": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Является ли владелец физическим или юридическим лицом." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Нормализованные роли (например, `ubo`, `shareholder`)." }, "ownership_min_shares": { "type": "string", "nullable": true, "description": "Нижняя граница диапазона владения, указанная в реестре (например, `25%`)." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Верхняя граница диапазона доли владения согласно реестру." }, "is_active": { "type": "boolean" }, "kyc_status": { "type": "string", "nullable": true, "enum": [ "Approved", "Declined", "Pending", null ] }, "kyc_session_url": { "type": "string", "nullable": true }, "effective_ownership_percent": { "type": "number", "nullable": true, "description": "Распознанный процент владения (верхняя граница, с переходом на нижнюю границу при отсутствии)." }, "company_name": { "type": "string", "nullable": true }, "registration_number": { "type": "string", "nullable": true }, "country_of_birth": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "designation": { "type": "string", "nullable": true }, "voting_min_shares": { "type": "string", "nullable": true }, "voting_max_shares": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "nullable": true, "description": "Полная дата рождения, если указана.", "format": "date" }, "appointment_date": { "type": "string", "nullable": true, "description": "Дата назначения, если указана.", "format": "date" }, "shareholding": { "$ref": "#/components/schemas/KYBRegistryShareholding" } } }, "description": "Бенефициарные владельцы / лица, осуществляющие значительный контроль, извлечённые из реестра. Может быть пустым, если реестр не раскрывает структуру владения." }, "addresses": { "type": "array", "nullable": true, "description": "Каждый адрес, указанный в реестре, в едином каноническом формате. Null, если реестр не указывает ни одного.", "items": { "$ref": "#/components/schemas/KYBRegistryAddress" } }, "industries": { "type": "array", "nullable": true, "description": "Виды деятельности, к которым реестр относит компанию, в единой канонической форме. Null, если ни один вид не указан.", "items": { "$ref": "#/components/schemas/KYBRegistryIndustry" } }, "accounts": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Даты подачи документов в реестр, если доступны. Для годовой отчётности и общих собраний используются last_annual_return_date и last_agm_date; они отличаются от финансовой отчётности." }, "registry_data": { "$ref": "#/components/schemas/KYBRegistryData" }, "user_provided_data": { "type": "object", "nullable": true, "description": "Всегда `null` на этом endpoint (используется в размещённом сценарии KYB, когда конечные пользователи редактируют данные из реестра)." }, "confirmed_by_user_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Всегда `null` на этом endpoint." }, "last_console_edit_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Задаётся, когда проверяющий из консоли позже редактирует запись." }, "is_editable": { "type": "boolean", "description": "Можно ли по-прежнему редактировать данные из реестра компаний в размещённом сценарии или консоли." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo", null ], "description": "То же, что и `registry_tier_delivered` верхнего уровня.", "nullable": true }, "registry_ownership_status": { "type": "string", "nullable": true, "enum": [ "not_requested", "delivered", "not_held", "unavailable", "pending", null ], "description": "`delivered`, когда данные о структуре владения получены; `not_held`, когда реестр структуры владения ответил и в нём нет этой компании (см. `registry_data.ownership_error`); `unavailable`, когда был запрошен уровень со структурой владения, но в реестре не было данных по этой компании или к нему не удалось обратиться (см. `registry_data.ownership_error`); `pending`, когда раздел структуры владения ещё не получен из реестра и Didit всё ещё формирует его; `not_requested` для уровня Lite." }, "ownership": { "$ref": "#/components/schemas/KYBRegistryOwnership" }, "registry_tier": { "type": "string", "nullable": true, "description": "Уровень реестра, запрошенный сценарием: `basic`, `shareholders` или `ubo`. Также указан в `ownership.tier_requested`." }, "registry_monitoring": { "type": "object", "nullable": true, "description": "Последний мониторинг реестра для компании или `null`, если он отсутствует.", "properties": { "uuid": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "unavailable_reason": { "type": "string", "nullable": true }, "enrolled_at": { "type": "string", "format": "date-time", "nullable": true }, "cancelled_at": { "type": "string", "format": "date-time", "nullable": true }, "last_bill_date": { "type": "string", "format": "date", "nullable": true }, "next_bill_date": { "type": "string", "format": "date", "nullable": true }, "last_event_at": { "type": "string", "format": "date-time", "nullable": true }, "events_count": { "type": "integer" }, "watched_fields": { "description": "Поля компании, отслеживаемые мониторингом." } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Эхо отправленных вами `vendor_data`." }, "metadata": { "type": "object", "nullable": true, "description": "Эхо-значение переданного вами `metadata`." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "Resolved company": { "summary": "Полный профиль из реестра (список должностных лиц сокращён для краткости)", "value": { "request_id": "9d4f2c7a-1b3e-4a5c-8d6f-0e9a8b7c6d5e", "kyb_registry": { "uuid": "f1e2d3c4-b5a6-4789-9c0d-1e2f3a4b5c6d", "node_id": "feature_kyb_registry", "status": "In Review", "registry_status": "active", "data_resolved": true, "company_name": "Tesco PLC", "registration_number": "00445790", "country_code": "GB", "region": "", "company_type": "Public Limited Company", "incorporation_date": "1947-11-27", "registered_address": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA", "tax_number": "GB412 8925 93", "risk_level": "low risk", "verification_status": "verified", "is_from_registry": true, "fetch_status": "resolved", "alternative_names": "TESCO STORES (HOLDINGS) PUBLIC LIMITED COMPANY", "nature_of_business": null, "registered_capital": null, "registered_capital_amount": null, "registered_capital_currency": null, "website": "https://www.tesco.com/", "email": "customer.service@tesco.co.uk", "phone": "03301231688", "legal_entity_identifier": null, "location_of_registration": null, "financial_summary": { "currency": "Pound (£)", "total_number_of_shares": "8174378721", "meta_detail": { "Class_Of_Share": "Ordinary" } }, "officers": [ { "uuid": "a1b2c3d4-e5f6-4789-9a0b-1c2d3e4f5a6b", "name": "CHRISTOPHER JON TAYLOR", "designation": "Secretary", "role": "secretary", "nationality": null, "is_active": true, "kyc_status": null, "kyc_session_url": null }, { "uuid": "b2c3d4e5-f6a7-4890-8b1c-2d3e4f5a6b7c", "name": "MELISSA BETHELL", "designation": "Director", "role": "director", "nationality": "British", "is_active": true, "kyc_status": null, "kyc_session_url": null } ], "beneficial_owners": [], "addresses": [ { "address": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA", "type": "legal_entity_registry_address", "description": "registered office address" } ], "industries": null, "accounts": { "last_account": "26 February 2025", "next_account": "26 February 2026", "due_by_date": "26 August 2026" }, "registry_data": { "ubo_resolution": { "parent_chain": [], "subsidiaries": [], "unresolved": [] } }, "user_provided_data": null, "confirmed_by_user_at": null, "last_console_edit_at": null, "is_editable": true }, "vendor_data": "company-1234", "metadata": null, "created_at": "2026-06-11T10:45:00.000000+00:00" } } } } } }, "400": { "description": "Ошибка валидации. Проблемы на уровне полей используют стандартную структуру DRF.", "content": { "application/json": { "examples": { "Missing kyb_response_id": { "summary": "Поле `kyb_response_id` обязательно", "value": { "kyb_response_id": [ "This field is required." ] } }, "save_api_request=false rejected": { "summary": "Выбранные значения всегда сохраняются", "value": { "save_api_request": [ "KYB registry select must be saved so billing and retrieval can be tracked." ] } } } } } }, "403": { "description": "В доступе отказано. Возвращается, если заголовок `x-api-key` отсутствует, а также если баланс вызывающей организации не покрывает вызов; неверный, отозванный или истекший ключ возвращает `401`. Отсутствующий ключ возвращает `403` с `{\"detail\": ...}`; неверный, отозванный или истекший ключ возвращает `401`. При нехватке кредитов возвращается `403` с `{\"error\": ...}` до начала любого скрининга или вызова провайдера.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Отсутствует заголовок `x-api-key`, либо ключ недействителен/отозван", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "Баланс организации недостаточен для совершения вызова", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Превышен лимит запросов. Endpoint'ы POST/PATCH/DELETE делят общий лимит в 300 запросов на запись в минуту на один API-ключ (для создания транзакций и отправки событий действует отдельный лимит в 600). Ответ содержит заголовки `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` и `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Более 300 запросов на запись в текущую минуту", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "202": { "description": "Отчёт принят и всё ещё обрабатывается. Когда отчёт всё ещё подготавливается, endpoint возвращает 202 Accepted, kyb_registry.fetch_status=pending и registry_tier_delivered=null. Сохраните request_id и опрашивайте GET /v3/session/{request_id}/decision/ до тех пор, пока registry_checks[0].company.fetch_status не перейдёт в финальный статус. Didit автоматически завершает подготовку отчёта и списывает плату за предоставленный уровень, как только он готов. Не повторяйте покупку, пока запрос находится в обработке; каждый новый POST создаёт отдельный запрос.", "content": { "application/json": { "schema": { "$ref": "#/paths/~1v3~1kyb~1ubo~1/post/responses/200/content/application~1json/schema" }, "examples": { "Pending (registry still resolving)": { "summary": "Отчёт о структуре владения всё ещё формируется; получить сохранённое решение", "value": { "request_id": "9d4f2c7a-1b3e-4a5c-8d6f-0e9a8b7c6d5e", "kyb_registry": { "uuid": "7c0a4f7e-2b1d-4f6a-9c3e-8d5b2a1f0e9d", "node_id": "feature_kyb_registry", "status": "Not Finished", "registry_status": null, "data_resolved": false, "company_name": "Example Holdings Limited", "registration_number": "12345678", "country_code": "HK", "region": null, "company_type": null, "incorporation_date": null, "registered_address": null, "tax_number": null, "risk_level": null, "verification_status": null, "is_from_registry": true, "fetch_status": "pending", "alternative_names": null, "nature_of_business": null, "registered_capital": null, "registered_capital_amount": null, "registered_capital_currency": null, "website": null, "email": null, "phone": null, "legal_entity_identifier": null, "location_of_registration": null, "financial_summary": {}, "officers": [], "beneficial_owners": [], "addresses": null, "industries": null, "accounts": null, "registry_data": {}, "user_provided_data": null, "confirmed_by_user_at": null, "last_console_edit_at": null, "is_editable": true, "registry_tier_delivered": null, "registry_ownership_status": "pending" }, "vendor_data": "company-1234", "metadata": null, "created_at": "2026-06-11T10:45:00.000000+00:00", "registry_tier_delivered": null, "registry_tier_requested": "ubo" } } } } } } } } }, "/v3/id-verification/wallets/": { "get": { "operationId": "list_wallets", "x-didit-sdk": { "resource": "id_wallets", "method": "list", "auth": "api_key", "server": true }, "description": "Каждый кошелёк Digital ID с его стартовым endpoint, странами, обязательными полями и информацией о том, может ли данное приложение запустить его в этой среде прямо сейчас. Наличие в списке не означает, что кошелёк активен.", "summary": "Получить список кошельков Digital ID", "tags": [ "Digital ID wallets" ], "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletCatalogResponse" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiClientCredentialsForbiddenErrorMessage" } } }, "description": "Отсутствуют учетные данные (x-api-key или Authorization: Bearer)." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request GET \\\n --url https://verification.didit.me/v3/id-verification/wallets/ \\\n --header 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.list()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.list();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.List(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().list();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->list();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.list\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.ListAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/id-verification/wallets/verifications/{request_id}/": { "get": { "operationId": "get_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "retrieve_verification", "auth": "api_key", "server": true }, "description": "Статус и результат верификации кошелька: нормализованные данные личности и собственные атрибуты кошелька после подтверждения, код ошибки в случае отклонения, следующее действие во время ожидания. Для верификации с истёкшим expires_at принимается решение timeout.", "summary": "Получить верификацию кошелька", "parameters": [ { "in": "path", "name": "request_id", "schema": { "type": "string", "format": "uuid" }, "description": "request_id, возвращённый endpoint запуска.", "required": true } ], "tags": [ "Digital ID wallets" ], "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "ftn", "name": "Finnish Trust Network", "issuing_authority": "Finnish banks and mobile operators (FTN)" }, "country": "FIN", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiClientCredentialsForbiddenErrorMessage" } } }, "description": "Отсутствуют учетные данные (x-api-key или Authorization: Bearer)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка not_found: у этого приложения нет верификации кошелька с таким request_id." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request GET \\\n --url https://verification.didit.me/v3/id-verification/wallets/verifications/REQUEST_ID/ \\\n --header 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.retrieve_verification(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.retrieveVerification(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.RetrieveVerification(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().retrieveVerification(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->retrieveVerification('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.retrieve_verification(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.RetrieveVerificationAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/id-verification/wallets/verifications/{request_id}/poll/": { "post": { "operationId": "poll_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "poll_verification", "auth": "api_key", "server": true }, "description": "Smart-ID и Mobile-ID: запрашивает у провайдера, подтвердил ли пользователь запрос, отклонил его или истекло время ожидания, и проверяет подписанные идентификационные данные, если он подтвердил запрос. Кошельки с перенаправлением завершают процесс через браузер пользователя, поэтому для них этот запрос только считывает результат верификации. Возвращает объект верификации в его итоговом состоянии.", "summary": "Опросить статус верификации кошелька", "parameters": [ { "in": "path", "name": "request_id", "schema": { "type": "string", "format": "uuid" }, "description": "request_id, возвращённый endpoint запуска.", "required": true } ], "tags": [ "Digital ID wallets" ], "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "smart_id", "name": "Smart-ID", "issuing_authority": "SK ID Solutions" }, "country": "EST", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "in_app", "simulated": true, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "confirm_in_app", "verification_code": "1234", "poll_interval_seconds": 2 }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiClientCredentialsForbiddenErrorMessage" } } }, "description": "Отсутствуют учетные данные (x-api-key или Authorization: Bearer)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка not_found: у этого приложения нет верификации кошелька с таким request_id." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/verifications/REQUEST_ID/poll/ \\\n --header 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.poll_verification(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.pollVerification(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.PollVerification(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().pollVerification(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->pollVerification('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.poll_verification(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.PollVerificationAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/id-verification/wallets/verifications/{request_id}/cancel/": { "post": { "operationId": "cancel_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "cancel_verification", "auth": "api_key", "server": true }, "description": "Отозвать ожидающую верификацию: она отклонена как отменённая и никогда не тарифицируется. Верификация с принятым решением возвращается без изменений. Smart-ID и Mobile-ID: отмена, поступившая во время опроса при проверке входа, ждёт завершения этого опроса несколько секунд, затем отклоняет её или возвращает её верифицированной, если пользователь уже подтвердил. Верификацию, которую пользователь завершает прямо сейчас, нельзя отменить (409 verification_in_progress с Retry-After): повторите попытку через указанное количество секунд, чтобы узнать результат.", "summary": "Отменить верификацию кошелька", "parameters": [ { "in": "path", "name": "request_id", "schema": { "type": "string", "format": "uuid" }, "description": "request_id, возвращённый endpoint запуска.", "required": true } ], "tags": [ "Digital ID wallets" ], "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "ftn", "name": "Finnish Trust Network", "issuing_authority": "Finnish banks and mobile operators (FTN)" }, "country": "FIN", "status": "Declined", "outcome": "cancelled", "error": "cancelled_by_customer", "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": null, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiClientCredentialsForbiddenErrorMessage" } } }, "description": "Отсутствуют учетные данные (x-api-key или Authorization: Bearer)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка not_found: у этого приложения нет верификации кошелька с таким request_id." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка verification_in_progress: пользователь выполняет этот вход прямо сейчас. Заголовок Retry-After указывает, когда повторить запрос; повторный запрос возвращает вынесенное решение по верификации." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/verifications/REQUEST_ID/cancel/ \\\n --header 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.cancel_verification(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.cancelVerification(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.CancelVerification(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().cancelVerification(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->cancelVerification('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.cancel_verification(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.CancelVerificationAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/id-verification/wallets/mitid/": { "post": { "operationId": "start_mitid_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_mitid", "auth": "api_key", "server": true }, "description": "Запустить вход через MitID (Danish Agency for Digital Government; DNK) без какого-либо сценария. Тарифицируется один раз, только когда личность верифицирована. Ответ содержит next_action.type=redirect с URL для перенаправления браузера пользователя; пользователь возвращается на return_url с добавленными request_id и result. Считывайте результат с помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или из webhook, ни в коем случае не из URL. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая никогда не обращается к провайдеру.", "summary": "Запустить верификацию через MitID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiMitidWalletVerificationStartRequest" }, "example": { "country": "DNK", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiMitidWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiMitidWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "mitid", "name": "MitID", "issuing_authority": "Danish Agency for Digital Government" }, "country": "DNK", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/mitid/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"DNK\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_mitid(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"DNK\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startMitid({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"DNK\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartMitid(ctx, didit.IDWalletsStartMitidParams{\n\tBody: didit.DigitalIDWalletAPIMitidWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIMitidWalletVerificationStartCountryEnum(\"DNK\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiMitidWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiMitidWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startMitid(DigitalIdWalletApiMitidWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiMitidWalletVerificationStartCountryEnum.of(\"DNK\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startMitid([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'DNK',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_mitid(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"DNK\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartMitidAsync(new DigitalIdWalletApiMitidWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiMitidWalletVerificationStartCountryEnum(\"DNK\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "mitid" } }, "/v3/id-verification/wallets/bankid-se/": { "post": { "operationId": "start_bankid_se_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_bankid_se", "auth": "api_key", "server": true }, "description": "Запустить вход через BankID (SWE) (Finansiell ID-Teknik / банковский консорциум; SWE) без сценария. Тарифицируется один раз, только после успешной верификации личности. Ответ содержит next_action.type=redirect с URL, на который следует перенаправить браузер пользователя; пользователь возвращается на return_url с добавленными параметрами request_id и result. Считывайте результат с помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или из webhook, ни в коем случае не из URL. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая не обращается к провайдеру.", "summary": "Запустить верификацию через BankID (SWE)", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBankidSeWalletVerificationStartRequest" }, "example": { "country": "SWE", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBankidSeWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBankidSeWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "bankid_se", "name": "BankID", "issuing_authority": "Finansiell ID-Teknik / bank consortium" }, "country": "SWE", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/bankid-se/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"SWE\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_bankid_se(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"SWE\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startBankidSe({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"SWE\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartBankidSe(ctx, didit.IDWalletsStartBankidSeParams{\n\tBody: didit.DigitalIDWalletAPIBankidSeWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPICountryEe9enum(\"SWE\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiBankidSeWalletVerificationStartRequest;\nimport me.didit.types.DigitalIdWalletApiCountryEe9Enum;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startBankidSe(DigitalIdWalletApiBankidSeWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiCountryEe9Enum.of(\"SWE\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startBankidSe([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'SWE',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_bankid_se(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"SWE\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartBankidSeAsync(new DigitalIdWalletApiBankidSeWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiCountryEe9Enum(\"SWE\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "bankid_se" } }, "/v3/id-verification/wallets/bankid-no/": { "post": { "operationId": "start_bankid_no_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_bankid_no", "auth": "api_key", "server": true }, "description": "Запустить вход через BankID (NOR) (BankID BankAxept AS; NOR) без сценария. Тарифицируется один раз, только после успешной верификации личности. Ответ содержит next_action.type=redirect с URL, на который следует перенаправить браузер пользователя; пользователь возвращается на return_url с добавленными параметрами request_id и result. Считывайте результат с помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или из webhook, ни в коем случае не из URL. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая не обращается к провайдеру.", "summary": "Запустить верификацию через BankID (NOR)", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBankidNoWalletVerificationStartRequest" }, "example": { "country": "NOR", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBankidNoWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBankidNoWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "bankid_no", "name": "BankID", "issuing_authority": "BankID BankAxept AS" }, "country": "NOR", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/bankid-no/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"NOR\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_bankid_no(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"NOR\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startBankidNo({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"NOR\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartBankidNo(ctx, didit.IDWalletsStartBankidNoParams{\n\tBody: didit.DigitalIDWalletAPIBankidNoWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPICountryAfcEnum(\"NOR\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiBankidNoWalletVerificationStartRequest;\nimport me.didit.types.DigitalIdWalletApiCountryAfcEnum;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startBankidNo(DigitalIdWalletApiBankidNoWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiCountryAfcEnum.of(\"NOR\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startBankidNo([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'NOR',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_bankid_no(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"NOR\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartBankidNoAsync(new DigitalIdWalletApiBankidNoWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiCountryAfcEnum(\"NOR\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "bankid_no" } }, "/v3/id-verification/wallets/vipps/": { "post": { "operationId": "start_vipps_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_vipps", "auth": "api_key", "server": true }, "description": "Запустить вход через Vipps (Vipps MobilePay / BankID NO; NOR) без сценария. Тарифицируется один раз, только при успешной верификации личности. Ответ содержит next_action.type=redirect с URL, на который следует перенаправить браузер пользователя; пользователь возвращается на return_url с добавленными request_id и result. Получайте результат с помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или из webhook, но ни в коем случае не из URL. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая не обращается к провайдеру.", "summary": "Запустить верификацию через Vipps", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiVippsWalletVerificationStartRequest" }, "example": { "country": "NOR", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiVippsWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiVippsWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "vipps", "name": "Vipps", "issuing_authority": "Vipps MobilePay / BankID NO" }, "country": "NOR", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/vipps/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"NOR\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_vipps(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"NOR\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startVipps({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"NOR\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartVipps(ctx, didit.IDWalletsStartVippsParams{\n\tBody: didit.DigitalIDWalletAPIVippsWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPICountryAfcEnum(\"NOR\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiCountryAfcEnum;\nimport me.didit.types.DigitalIdWalletApiVippsWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startVipps(DigitalIdWalletApiVippsWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiCountryAfcEnum.of(\"NOR\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startVipps([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'NOR',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_vipps(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"NOR\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartVippsAsync(new DigitalIdWalletApiVippsWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiCountryAfcEnum(\"NOR\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "vipps" } }, "/v3/id-verification/wallets/buypass/": { "post": { "operationId": "start_buypass_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_buypass", "auth": "api_key", "server": true }, "description": "Запустить вход через Buypass ID (Buypass AS; NOR) без сценария. Тарифицируется один раз, только после успешной верификации личности. Ответ содержит next_action.type=redirect с URL, на который следует перенаправить браузер пользователя; пользователь возвращается на return_url с добавленными параметрами request_id и result. Считывайте результат с помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или из webhook, ни в коем случае не из URL. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая не обращается к провайдеру.", "summary": "Запустить верификацию через Buypass ID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBuypassWalletVerificationStartRequest" }, "example": { "country": "NOR", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBuypassWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBuypassWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "buypass", "name": "Buypass ID", "issuing_authority": "Buypass AS" }, "country": "NOR", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/buypass/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"NOR\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_buypass(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"NOR\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startBuypass({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"NOR\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartBuypass(ctx, didit.IDWalletsStartBuypassParams{\n\tBody: didit.DigitalIDWalletAPIBuypassWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPICountryAfcEnum(\"NOR\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiBuypassWalletVerificationStartRequest;\nimport me.didit.types.DigitalIdWalletApiCountryAfcEnum;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startBuypass(DigitalIdWalletApiBuypassWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiCountryAfcEnum.of(\"NOR\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startBuypass([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'NOR',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_buypass(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"NOR\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartBuypassAsync(new DigitalIdWalletApiBuypassWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiCountryAfcEnum(\"NOR\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "buypass" } }, "/v3/id-verification/wallets/itsme/": { "post": { "operationId": "start_itsme_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_itsme", "auth": "api_key", "server": true }, "description": "Запустить вход через itsme (Belgian Mobile ID; BEL, LUX, NLD) без сценария. Оплата взимается один раз, только когда личность верифицирована. Ответ содержит next_action.type=redirect с URL, на который нужно перенаправить браузер пользователя; пользователь возвращается на return_url с добавленными request_id и result. Считывайте результат с помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или из webhook, но никогда не из URL. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая никогда не обращается к провайдеру.", "summary": "Запустить верификацию itsme", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiItsmeWalletVerificationStartRequest" }, "example": { "country": "BEL", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiItsmeWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiItsmeWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "itsme", "name": "itsme", "issuing_authority": "Belgian Mobile ID" }, "country": "BEL", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/itsme/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"BEL\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_itsme(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"BEL\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startItsme({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"BEL\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartItsme(ctx, didit.IDWalletsStartItsmeParams{\n\tBody: didit.DigitalIDWalletAPIItsmeWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.DigitalIDWalletAPIItsmeWalletVerificationStartCountryEnum(\"BEL\"),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiItsmeWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiItsmeWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startItsme(DigitalIdWalletApiItsmeWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiItsmeWalletVerificationStartCountryEnum.of(\"BEL\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startItsme([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'BEL',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_itsme(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"BEL\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartItsmeAsync(new DigitalIdWalletApiItsmeWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = \"BEL\",\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "itsme" } }, "/v3/id-verification/wallets/idin/": { "post": { "operationId": "start_idin_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_idin", "auth": "api_key", "server": true }, "description": "Запустить вход через iDIN (банки Нидерландов (Currence iDIN); NLD) без сценария. Оплата взимается один раз, только когда личность верифицирована. Ответ содержит next_action.type=redirect с URL, на который нужно перенаправить браузер пользователя; пользователь возвращается на return_url с добавленными request_id и result. Считывайте результат с помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или из webhook, но никогда не из URL. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая никогда не обращается к провайдеру.", "summary": "Запустить верификацию iDIN", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiIdinWalletVerificationStartRequest" }, "example": { "country": "NLD", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiIdinWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiIdinWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "idin", "name": "iDIN", "issuing_authority": "Dutch banks (Currence iDIN)" }, "country": "NLD", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/idin/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"NLD\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_idin(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"NLD\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startIdin({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"NLD\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartIdin(ctx, didit.IDWalletsStartIdinParams{\n\tBody: didit.DigitalIDWalletAPIIdinWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIIdinWalletVerificationStartCountryEnum(\"NLD\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiIdinWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiIdinWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startIdin(DigitalIdWalletApiIdinWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiIdinWalletVerificationStartCountryEnum.of(\"NLD\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startIdin([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'NLD',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_idin(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"NLD\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartIdinAsync(new DigitalIdWalletApiIdinWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiIdinWalletVerificationStartCountryEnum(\"NLD\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "idin" } }, "/v3/id-verification/wallets/ftn/": { "post": { "operationId": "start_ftn_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_ftn", "auth": "api_key", "server": true }, "description": "Запустить вход через Finnish Trust Network (финские банки и мобильные операторы (FTN); FIN) без какого-либо сценария. Тарифицируется один раз, только после успешной верификации личности. Ответ содержит next_action.type=redirect с URL для перенаправления браузера пользователя; пользователь возвращается на return_url с добавленными request_id и result. Считывайте результат с помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или из webhook, но ни в коем случае не из URL. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая никогда не обращается к провайдеру.", "summary": "Запустить верификацию через Finnish Trust Network", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiFtnWalletVerificationStartRequest" }, "example": { "country": "FIN", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiFtnWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiFtnWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "ftn", "name": "Finnish Trust Network", "issuing_authority": "Finnish banks and mobile operators (FTN)" }, "country": "FIN", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/ftn/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"FIN\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_ftn(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"FIN\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startFtn({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"FIN\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartFtn(ctx, didit.IDWalletsStartFtnParams{\n\tBody: didit.DigitalIDWalletAPIFtnWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIFtnWalletVerificationStartCountryEnum(\"FIN\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiFtnWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiFtnWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startFtn(DigitalIdWalletApiFtnWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiFtnWalletVerificationStartCountryEnum.of(\"FIN\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startFtn([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'FIN',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_ftn(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"FIN\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartFtnAsync(new DigitalIdWalletApiFtnWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiFtnWalletVerificationStartCountryEnum(\"FIN\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "ftn" } }, "/v3/id-verification/wallets/personalausweis/": { "post": { "operationId": "start_personalausweis_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_personalausweis", "auth": "api_key", "server": true }, "description": "Запустить вход через Personalausweis (Bundesministerium des Innern (eID); DEU) без сценария. Тарифицируется один раз, только при успешной верификации личности. Ответ содержит next_action.type=redirect с URL, на который следует перенаправить браузер пользователя; пользователь возвращается на return_url с добавленными request_id и result. Получайте результат с помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или из webhook, но ни в коем случае не из URL. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая не обращается к провайдеру.", "summary": "Запустить верификацию через Personalausweis", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiPersonalausweisWalletVerificationStartRequest" }, "example": { "country": "DEU", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiPersonalausweisWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiPersonalausweisWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "personalausweis", "name": "Personalausweis", "issuing_authority": "Bundesministerium des Innern (eID)" }, "country": "DEU", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/personalausweis/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"DEU\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_personalausweis(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"DEU\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startPersonalausweis({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"DEU\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartPersonalausweis(ctx, didit.IDWalletsStartPersonalausweisParams{\n\tBody: didit.DigitalIDWalletAPIPersonalausweisWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIPersonalausweisWalletVerificationStartCountryEnum(\"DEU\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiPersonalausweisWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiPersonalausweisWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startPersonalausweis(DigitalIdWalletApiPersonalausweisWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiPersonalausweisWalletVerificationStartCountryEnum.of(\"DEU\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startPersonalausweis([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'DEU',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_personalausweis(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"DEU\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartPersonalausweisAsync(new DigitalIdWalletApiPersonalausweisWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiPersonalausweisWalletVerificationStartCountryEnum(\"DEU\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "personalausweis" } }, "/v3/id-verification/wallets/frejaid/": { "post": { "operationId": "start_frejaid_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_frejaid", "auth": "api_key", "server": true }, "description": "Запустить вход через Freja eID (Freja eID Group; SWE) без какого-либо сценария. Тарифицируется один раз, только после успешной верификации личности. В ответе возвращается next_action.type=redirect с URL для перенаправления браузера пользователя; пользователь возвращается на return_url с добавленными request_id и result. Считывайте результат с помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или из webhook, но ни в коем случае не из URL. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая никогда не обращается к провайдеру.", "summary": "Запустить верификацию через Freja eID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiFrejaidWalletVerificationStartRequest" }, "example": { "country": "SWE", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiFrejaidWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiFrejaidWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "frejaid", "name": "Freja eID", "issuing_authority": "Freja eID Group" }, "country": "SWE", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/frejaid/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"SWE\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_frejaid(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"SWE\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startFrejaid({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"SWE\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartFrejaid(ctx, didit.IDWalletsStartFrejaidParams{\n\tBody: didit.DigitalIDWalletAPIFrejaidWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPICountryEe9enum(\"SWE\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiCountryEe9Enum;\nimport me.didit.types.DigitalIdWalletApiFrejaidWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startFrejaid(DigitalIdWalletApiFrejaidWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiCountryEe9Enum.of(\"SWE\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startFrejaid([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'SWE',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_frejaid(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"SWE\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartFrejaidAsync(new DigitalIdWalletApiFrejaidWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiCountryEe9Enum(\"SWE\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "frejaid" } }, "/v3/id-verification/wallets/uae-pass/": { "post": { "operationId": "start_uae_pass_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_uae_pass", "auth": "api_key", "server": true }, "description": "Запустить вход через UAE PASS (UAE Digital Government Authority; ARE) без сценария. Тарифицируется один раз, только при успешной верификации личности. Ответ содержит next_action.type=redirect с URL, на который следует перенаправить браузер пользователя; пользователь возвращается на return_url с добавленными request_id и result. Получайте результат с помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или из webhook, но ни в коем случае не из URL. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая не обращается к провайдеру.", "summary": "Запустить верификацию через UAE PASS", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiUaePassWalletVerificationStartRequest" }, "example": { "country": "ARE", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiUaePassWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiUaePassWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "uae_pass", "name": "UAE PASS", "issuing_authority": "UAE Digital Government Authority" }, "country": "ARE", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/uae-pass/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"ARE\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_uae_pass(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"ARE\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startUaePass({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"ARE\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartUaePass(ctx, didit.IDWalletsStartUaePassParams{\n\tBody: didit.DigitalIDWalletAPIUaePassWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIUaePassWalletVerificationStartCountryEnum(\"ARE\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiUaePassWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startUaePass(DigitalIdWalletApiUaePassWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum.of(\"ARE\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startUaePass([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'ARE',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_uae_pass(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"ARE\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartUaePassAsync(new DigitalIdWalletApiUaePassWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum(\"ARE\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "uae_pass" } }, "/v3/id-verification/wallets/govbr/": { "post": { "operationId": "start_govbr_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_govbr", "auth": "api_key", "server": true }, "description": "Запустить вход через gov.br (Governo Federal do Brasil; BRA) без сценария. Тарифицируется один раз, только при успешной верификации личности. Ответ содержит next_action.type=redirect с URL, на который следует перенаправить браузер пользователя; пользователь возвращается на return_url с добавленными request_id и result. Получайте результат с помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или из webhook, но ни в коем случае не из URL. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая не обращается к провайдеру.", "summary": "Запустить верификацию gov.br", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiGovbrWalletVerificationStartRequest" }, "example": { "country": "BRA", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiGovbrWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiGovbrWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "govbr", "name": "gov.br", "issuing_authority": "Governo Federal do Brasil" }, "country": "BRA", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/govbr/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"BRA\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_govbr(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"BRA\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startGovbr({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"BRA\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartGovbr(ctx, didit.IDWalletsStartGovbrParams{\n\tBody: didit.DigitalIDWalletAPIGovbrWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIGovbrWalletVerificationStartCountryEnum(\"BRA\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiGovbrWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiGovbrWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startGovbr(DigitalIdWalletApiGovbrWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiGovbrWalletVerificationStartCountryEnum.of(\"BRA\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startGovbr([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'BRA',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_govbr(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"BRA\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartGovbrAsync(new DigitalIdWalletApiGovbrWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiGovbrWalletVerificationStartCountryEnum(\"BRA\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "govbr" } }, "/v3/id-verification/wallets/oneid/": { "post": { "operationId": "start_oneid_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_oneid", "auth": "api_key", "server": true }, "description": "Запустить вход через OneID (OneID (личность, верифицированная банком Великобритании); GBR) без сценария. Тарифицируется один раз, только при успешной верификации личности. Ответ содержит next_action.type=redirect с URL, на который следует перенаправить браузер пользователя; пользователь возвращается на return_url с добавленными request_id и result. Получайте результат с помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или из webhook, но ни в коем случае не из URL. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая не обращается к провайдеру.", "summary": "Запустить верификацию через OneID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiOneidWalletVerificationStartRequest" }, "example": { "country": "GBR", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiOneidWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiOneidWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "oneid", "name": "OneID", "issuing_authority": "OneID (UK bank-verified identity)" }, "country": "GBR", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/oneid/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"GBR\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_oneid(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"GBR\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startOneid({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"GBR\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartOneid(ctx, didit.IDWalletsStartOneidParams{\n\tBody: didit.DigitalIDWalletAPIOneidWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPICountry520enum(\"GBR\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiCountry520Enum;\nimport me.didit.types.DigitalIdWalletApiOneidWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startOneid(DigitalIdWalletApiOneidWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiCountry520Enum.of(\"GBR\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startOneid([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'GBR',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_oneid(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"GBR\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartOneidAsync(new DigitalIdWalletApiOneidWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiCountry520Enum(\"GBR\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "oneid" } }, "/v3/id-verification/wallets/govuk-wallet/": { "post": { "operationId": "start_govuk_wallet_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_govuk_wallet", "auth": "api_key", "server": true }, "description": "Запустить вход через GOV.UK Wallet (UK Government Digital Service; GBR) без какого-либо сценария. Тарифицируется один раз, только после успешной верификации личности. Ответ содержит next_action.type=redirect с URL для перенаправления браузера пользователя; пользователь возвращается на return_url с добавленными request_id и result. Считывайте результат с помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или из webhook, но ни в коем случае не из URL. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая никогда не обращается к провайдеру.", "summary": "Запустить верификацию через GOV.UK Wallet", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiGovukWalletWalletVerificationStartRequest" }, "example": { "country": "GBR", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiGovukWalletWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiGovukWalletWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "govuk_wallet", "name": "GOV.UK Wallet", "issuing_authority": "UK Government Digital Service" }, "country": "GBR", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/govuk-wallet/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"GBR\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_govuk_wallet(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"GBR\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startGovukWallet({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"GBR\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartGovukWallet(ctx, didit.IDWalletsStartGovukWalletParams{\n\tBody: didit.DigitalIDWalletAPIGovukWalletWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPICountry520enum(\"GBR\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiCountry520Enum;\nimport me.didit.types.DigitalIdWalletApiGovukWalletWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startGovukWallet(DigitalIdWalletApiGovukWalletWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiCountry520Enum.of(\"GBR\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startGovukWallet([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'GBR',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_govuk_wallet(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"GBR\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartGovukWalletAsync(new DigitalIdWalletApiGovukWalletWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiCountry520Enum(\"GBR\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "govuk_wallet" } }, "/v3/id-verification/wallets/smart-id/": { "post": { "operationId": "start_smart_id_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_smart_id", "auth": "api_key", "server": true }, "description": "Запустить вход через Smart-ID (SK ID Solutions; EST, LVA, LTU, BEL) без сценария. Тарифицируется один раз, только при успешной верификации личности. Ответ содержит next_action.type=confirm_in_app с кодом подтверждения для показа пользователю; пользователь подтверждает его и вводит свой PIN-код в приложении (никогда не собирайте PIN-код). Опрашивайте POST /v3/id-verification/wallets/verifications/{request_id}/poll/ каждые poll_interval_seconds или используйте webhook: Didit также выполняет опрос в фоновом режиме. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая никогда не обращается к провайдеру.", "summary": "Запустить верификацию через Smart-ID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiSmartIdWalletVerificationStartRequest" }, "example": { "country": "EST", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "personal_code": "00000000000" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiSmartIdWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiSmartIdWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "smart_id", "name": "Smart-ID", "issuing_authority": "SK ID Solutions" }, "country": "EST", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "in_app", "simulated": true, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "confirm_in_app", "verification_code": "1234", "poll_interval_seconds": 2 }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/smart-id/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"EST\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"personal_code\": \"00000000000\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_smart_id(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"EST\",\n personal_code=\"00000000000\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startSmartId({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"EST\",\n personal_code: \"00000000000\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartSmartID(ctx, didit.IDWalletsStartSmartIDParams{\n\tBody: didit.DigitalIDWalletAPISmartIDWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.DigitalIDWalletAPISmartIDWalletVerificationStartCountryEnum(\"EST\"),\n\t\tPersonalCode: \"00000000000\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiSmartIdWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiSmartIdWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startSmartId(DigitalIdWalletApiSmartIdWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiSmartIdWalletVerificationStartCountryEnum.of(\"EST\"))\n .personalCode(\"00000000000\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startSmartId([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'EST',\n 'personal_code' => '00000000000',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_smart_id(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"EST\",\n personal_code: \"00000000000\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartSmartIdAsync(new DigitalIdWalletApiSmartIdWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = \"EST\",\n PersonalCode = \"00000000000\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "smart_id" } }, "/v3/id-verification/wallets/mobile-id/": { "post": { "operationId": "start_mobile_id_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_mobile_id", "auth": "api_key", "server": true }, "description": "Запустить вход через Mobile-ID (SK ID Solutions совместно с национальными мобильными операторами; EST, LTU) без какого-либо сценария. Тарифицируется один раз, только когда личность верифицирована. Ответ содержит next_action.type=confirm_in_app с кодом подтверждения для показа пользователю; пользователь подтверждает его и вводит свой PIN-код в приложении (никогда не запрашивайте PIN самостоятельно). Опрашивайте POST /v3/id-verification/wallets/verifications/{request_id}/poll/ каждые poll_interval_seconds или полагайтесь на webhook: Didit также выполняет опрос в фоновом режиме. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая никогда не обращается к провайдеру.", "summary": "Запустить верификацию через Mobile-ID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiMobileIdWalletVerificationStartRequest" }, "example": { "country": "EST", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "personal_code": "00000000000", "phone_number": "+37200000000" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiMobileIdWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiMobileIdWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "mobile_id", "name": "Mobile-ID", "issuing_authority": "SK ID Solutions with the national mobile operators" }, "country": "EST", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "in_app", "simulated": true, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "confirm_in_app", "verification_code": "1234", "poll_interval_seconds": 2 }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/mobile-id/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"EST\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"personal_code\": \"00000000000\",\n \"phone_number\": \"+37200000000\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_mobile_id(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"EST\",\n personal_code=\"00000000000\",\n phone_number=\"+37200000000\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startMobileId({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"EST\",\n personal_code: \"00000000000\",\n phone_number: \"+37200000000\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartMobileID(ctx, didit.IDWalletsStartMobileIDParams{\n\tBody: didit.DigitalIDWalletAPIMobileIDWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.DigitalIDWalletAPIMobileIDWalletVerificationStartCountryEnum(\"EST\"),\n\t\tPersonalCode: \"00000000000\",\n\t\tPhoneNumber: \"+37200000000\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiMobileIdWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiMobileIdWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startMobileId(DigitalIdWalletApiMobileIdWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiMobileIdWalletVerificationStartCountryEnum.of(\"EST\"))\n .personalCode(\"00000000000\")\n .phoneNumber(\"+37200000000\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startMobileId([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'EST',\n 'personal_code' => '00000000000',\n 'phone_number' => '+37200000000',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_mobile_id(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"EST\",\n personal_code: \"00000000000\",\n phone_number: \"+37200000000\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartMobileIdAsync(new DigitalIdWalletApiMobileIdWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = \"EST\",\n PersonalCode = \"00000000000\",\n PhoneNumber = \"+37200000000\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "mobile_id" } }, "/v3/id-verification/wallets/idcard-ee/": { "post": { "operationId": "start_idcard_ee_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_idcard_ee", "auth": "api_key", "server": true }, "description": "Запустить вход через эстонскую ID-карту (Департамент полиции и пограничной охраны Эстонии; EST) без сценария. Тарифицируется один раз, только после успешной верификации личности. Ответ содержит next_action.type=redirect с URL, на который следует перенаправить браузер пользователя; пользователь возвращается на return_url с добавленными параметрами request_id и result. Считывайте результат с помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или из webhook, ни в коем случае не из URL. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая не обращается к провайдеру.", "summary": "Запустить верификацию через эстонскую ID-карту", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiIdcardEeWalletVerificationStartRequest" }, "example": { "country": "EST", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiIdcardEeWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiIdcardEeWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "idcard_ee", "name": "Estonian ID-card", "issuing_authority": "Police and Border Guard Board (Estonia)" }, "country": "EST", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/idcard-ee/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"EST\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_idcard_ee(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"EST\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startIdcardEe({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"EST\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartIdcardEe(ctx, didit.IDWalletsStartIdcardEeParams{\n\tBody: didit.DigitalIDWalletAPIIdcardEeWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIIdcardEeWalletVerificationStartCountryEnum(\"EST\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiIdcardEeWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiIdcardEeWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startIdcardEe(DigitalIdWalletApiIdcardEeWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiIdcardEeWalletVerificationStartCountryEnum.of(\"EST\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startIdcardEe([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'EST',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_idcard_ee(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"EST\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartIdcardEeAsync(new DigitalIdWalletApiIdcardEeWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiIdcardEeWalletVerificationStartCountryEnum(\"EST\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "idcard_ee" } }, "/v3/id-verification/wallets/eparaksts-mobile/": { "post": { "operationId": "start_eparaksts_mobile_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_eparaksts_mobile", "auth": "api_key", "server": true }, "description": "Запустить вход через eParaksts mobile (LVRTC (Latvian State Radio and Television Centre); LVA) без сценария. Тарифицируется один раз, только при успешной верификации личности. Ответ содержит next_action.type=redirect с URL, на который следует перенаправить браузер пользователя; пользователь возвращается на return_url с добавленными request_id и result. Получайте результат с помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или из webhook, но ни в коем случае не из URL. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая не обращается к провайдеру.", "summary": "Запустить мобильную верификацию eParaksts", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiEparakstsMobileWalletVerificationStartRequest" }, "example": { "country": "LVA", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiEparakstsMobileWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiEparakstsMobileWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "eparaksts_mobile", "name": "eParaksts mobile", "issuing_authority": "LVRTC (Latvian State Radio and Television Centre)" }, "country": "LVA", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/eparaksts-mobile/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"LVA\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_eparaksts_mobile(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"LVA\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startEparakstsMobile({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"LVA\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartEparakstsMobile(ctx, didit.IDWalletsStartEparakstsMobileParams{\n\tBody: didit.DigitalIDWalletAPIEparakstsMobileWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIEparakstsMobileWalletVerificationStartCountryEnum(\"LVA\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiEparakstsMobileWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiEparakstsMobileWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startEparakstsMobile(DigitalIdWalletApiEparakstsMobileWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiEparakstsMobileWalletVerificationStartCountryEnum.of(\"LVA\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startEparakstsMobile([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'LVA',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_eparaksts_mobile(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"LVA\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartEparakstsMobileAsync(new DigitalIdWalletApiEparakstsMobileWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiEparakstsMobileWalletVerificationStartCountryEnum(\"LVA\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "eparaksts_mobile" } }, "/v3/id-verification/wallets/bankid-cz/": { "post": { "operationId": "start_bankid_cz_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_bankid_cz", "auth": "api_key", "server": true }, "description": "Запустить вход через Bank iD (Bankovní identita, a.s.; CZE) без какого-либо сценария. Оплата взимается один раз, только после успешной верификации личности. Ответ содержит next_action.type=redirect с URL, на который следует перенаправить браузер пользователя; пользователь возвращается на return_url с добавленными параметрами request_id и result. Считывайте результат с помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или из webhook, ни в коем случае не из URL. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая никогда не обращается к провайдеру.", "summary": "Запустить верификацию через Bank iD", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBankidCzWalletVerificationStartRequest" }, "example": { "country": "CZE", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBankidCzWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiBankidCzWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "bankid_cz", "name": "Bank iD", "issuing_authority": "Bankovní identita, a.s." }, "country": "CZE", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/bankid-cz/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"CZE\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_bankid_cz(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"CZE\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startBankidCz({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"CZE\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartBankidCz(ctx, didit.IDWalletsStartBankidCzParams{\n\tBody: didit.DigitalIDWalletAPIBankidCzWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPICountryE2dEnum(\"CZE\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiBankidCzWalletVerificationStartRequest;\nimport me.didit.types.DigitalIdWalletApiCountryE2dEnum;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startBankidCz(DigitalIdWalletApiBankidCzWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiCountryE2dEnum.of(\"CZE\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startBankidCz([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'CZE',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_bankid_cz(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"CZE\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartBankidCzAsync(new DigitalIdWalletApiBankidCzWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiCountryE2dEnum(\"CZE\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "bankid_cz" } }, "/v3/id-verification/wallets/mojeid/": { "post": { "operationId": "start_mojeid_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_mojeid", "auth": "api_key", "server": true }, "description": "Запустить вход через MojeID (CZ.NIC; CZE) без сценария. Тарифицируется один раз, только при успешной верификации личности. Ответ содержит next_action.type=redirect с URL, на который следует перенаправить браузер пользователя; пользователь возвращается на return_url с добавленными request_id и result. Получайте результат с помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или из webhook, но ни в коем случае не из URL. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая не обращается к провайдеру.", "summary": "Запустить верификацию через MojeID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiMojeidWalletVerificationStartRequest" }, "example": { "country": "CZE", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiMojeidWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiMojeidWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "mojeid", "name": "MojeID", "issuing_authority": "CZ.NIC" }, "country": "CZE", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/mojeid/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"CZE\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_mojeid(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"CZE\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startMojeid({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"CZE\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartMojeid(ctx, didit.IDWalletsStartMojeidParams{\n\tBody: didit.DigitalIDWalletAPIMojeidWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPICountryE2dEnum(\"CZE\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiCountryE2dEnum;\nimport me.didit.types.DigitalIdWalletApiMojeidWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startMojeid(DigitalIdWalletApiMojeidWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiCountryE2dEnum.of(\"CZE\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startMojeid([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'CZE',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_mojeid(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"CZE\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartMojeidAsync(new DigitalIdWalletApiMojeidWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiCountryE2dEnum(\"CZE\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "mojeid" } }, "/v3/id-verification/wallets/diia/": { "post": { "operationId": "start_diia_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_diia", "auth": "api_key", "server": true }, "description": "Запустить вход через Diia (Министерство цифровой трансформации Украины; UKR) без сценария. Тарифицируется один раз, только после успешной верификации личности. Ответ содержит next_action.type=redirect с URL, на который следует перенаправить браузер пользователя; пользователь возвращается на return_url с добавленными параметрами request_id и result. Считывайте результат с помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или из webhook, ни в коем случае не из URL. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая не обращается к провайдеру.", "summary": "Запустить верификацию через Diia", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiDiiaWalletVerificationStartRequest" }, "example": { "country": "UKR", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiDiiaWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiDiiaWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "diia", "name": "Diia", "issuing_authority": "Ministry of Digital Transformation of Ukraine" }, "country": "UKR", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/diia/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"UKR\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_diia(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"UKR\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startDiia({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"UKR\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartDiia(ctx, didit.IDWalletsStartDiiaParams{\n\tBody: didit.DigitalIDWalletAPIDiiaWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIDiiaWalletVerificationStartCountryEnum(\"UKR\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiDiiaWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiDiiaWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startDiia(DigitalIdWalletApiDiiaWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiDiiaWalletVerificationStartCountryEnum.of(\"UKR\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startDiia([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'UKR',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_diia(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"UKR\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartDiiaAsync(new DigitalIdWalletApiDiiaWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiDiiaWalletVerificationStartCountryEnum(\"UKR\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "diia" } }, "/v3/id-verification/wallets/franceconnect/": { "post": { "operationId": "start_franceconnect_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_franceconnect", "auth": "api_key", "server": true }, "description": "Запустить вход через FranceConnect (DINUM (государство Франция); FRA) без какого-либо сценария. Тарифицируется один раз, только когда личность верифицирована. Ответ содержит next_action.type=redirect с URL для перенаправления браузера пользователя; пользователь возвращается на return_url с добавленными request_id и result. Считывайте результат с помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или из webhook, но ни в коем случае не из URL. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая никогда не обращается к провайдеру.", "summary": "Запустить верификацию через FranceConnect", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiFranceconnectWalletVerificationStartRequest" }, "example": { "country": "FRA", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiFranceconnectWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiFranceconnectWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "franceconnect", "name": "FranceConnect", "issuing_authority": "DINUM (French state)" }, "country": "FRA", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/franceconnect/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"FRA\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_franceconnect(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"FRA\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startFranceconnect({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"FRA\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartFranceconnect(ctx, didit.IDWalletsStartFranceconnectParams{\n\tBody: didit.DigitalIDWalletAPIFranceconnectWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIFranceconnectWalletVerificationStartCountryEnum(\"FRA\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiFranceconnectWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiFranceconnectWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startFranceconnect(DigitalIdWalletApiFranceconnectWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiFranceconnectWalletVerificationStartCountryEnum.of(\"FRA\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startFranceconnect([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'FRA',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_franceconnect(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"FRA\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartFranceconnectAsync(new DigitalIdWalletApiFranceconnectWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiFranceconnectWalletVerificationStartCountryEnum(\"FRA\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "franceconnect" } }, "/v3/id-verification/wallets/audkenni/": { "post": { "operationId": "start_audkenni_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_audkenni", "auth": "api_key", "server": true }, "description": "Запустить вход через Auðkenni (электронное удостоверение Исландии; ISL) без какого-либо сценария. Оплата взимается один раз, только после успешной верификации личности. Ответ содержит next_action.type=redirect с URL, на который следует перенаправить браузер пользователя; пользователь возвращается на return_url с добавленными параметрами request_id и result. Считывайте результат с помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или из webhook, ни в коем случае не из URL. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая никогда не обращается к провайдеру.", "summary": "Запустить верификацию через Auðkenni", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiAudkenniWalletVerificationStartRequest" }, "example": { "country": "ISL", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiAudkenniWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiAudkenniWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "audkenni", "name": "Auðkenni", "issuing_authority": "Auðkenni (Icelandic electronic ID)" }, "country": "ISL", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/audkenni/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"ISL\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_audkenni(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"ISL\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startAudkenni({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"ISL\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartAudkenni(ctx, didit.IDWalletsStartAudkenniParams{\n\tBody: didit.DigitalIDWalletAPIAudkenniWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIAudkenniWalletVerificationStartCountryEnum(\"ISL\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiAudkenniWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiAudkenniWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startAudkenni(DigitalIdWalletApiAudkenniWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiAudkenniWalletVerificationStartCountryEnum.of(\"ISL\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startAudkenni([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'ISL',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_audkenni(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"ISL\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartAudkenniAsync(new DigitalIdWalletApiAudkenniWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiAudkenniWalletVerificationStartCountryEnum(\"ISL\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "audkenni" } }, "/v3/id-verification/wallets/connectid/": { "post": { "operationId": "start_connectid_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_connectid", "auth": "api_key", "server": true }, "description": "Запустить вход через ConnectID (Australian Payments Plus; AUS) без сценария. Тарифицируется один раз, только после успешной верификации личности. Ответ содержит next_action.type=redirect с URL, на который следует перенаправить браузер пользователя; пользователь возвращается на return_url с добавленными параметрами request_id и result. Считывайте результат с помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или из webhook, ни в коем случае не из URL. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая не обращается к провайдеру.", "summary": "Запустить верификацию через ConnectID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiConnectidWalletVerificationStartRequest" }, "example": { "country": "AUS", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiConnectidWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiConnectidWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "connectid", "name": "ConnectID", "issuing_authority": "Australian Payments Plus" }, "country": "AUS", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/connectid/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"AUS\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_connectid(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"AUS\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startConnectid({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"AUS\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartConnectid(ctx, didit.IDWalletsStartConnectidParams{\n\tBody: didit.DigitalIDWalletAPIConnectidWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.Some(didit.DigitalIDWalletAPIConnectidWalletVerificationStartCountryEnum(\"AUS\")),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiConnectidWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiConnectidWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startConnectid(DigitalIdWalletApiConnectidWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiConnectidWalletVerificationStartCountryEnum.of(\"AUS\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startConnectid([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'AUS',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_connectid(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"AUS\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartConnectidAsync(new DigitalIdWalletApiConnectidWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = new DigitalIdWalletApiConnectidWalletVerificationStartCountryEnum(\"AUS\"),\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "connectid" } }, "/v3/id-verification/wallets/eudi/": { "post": { "operationId": "start_eudi_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_eudi", "auth": "api_key", "server": true }, "description": "Запустить вход через EUDI Wallet (государство-член ЕС пользователя; эмитент зависит от страны; AUT, BEL, BGR, HRV, CYP, CZE, DNK, EST, FIN, FRA, DEU, GRC, HUN, IRL, ITA, LVA, LTU, LUX, MLT, NLD, POL, PRT, ROU, SVK, SVN, ESP, SWE, ISL, LIE, NOR) без сценария. Тарифицируется один раз, только после успешной верификации личности. Ответ содержит next_action.type=redirect с URL, на который следует перенаправить браузер пользователя; пользователь возвращается на return_url с добавленными параметрами request_id и result. Считывайте результат с помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или из webhook, ни в коем случае не из URL. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая не обращается к провайдеру.", "summary": "Запустить верификацию через EUDI Wallet", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiEudiWalletVerificationStartRequest" }, "example": { "country": "AUT", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "return_url": "https://app.example.com/identity/complete" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiEudiWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiEudiWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "eudi", "name": "EUDI Wallet", "issuing_authority": "The user's own member state; the issuer differs per country" }, "country": "AUT", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "redirect", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "redirect", "url": "https://wallet.example.com/authorize" }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/eudi/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"AUT\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_eudi(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"AUT\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startEudi({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"AUT\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartEudi(ctx, didit.IDWalletsStartEudiParams{\n\tBody: didit.DigitalIDWalletAPIEudiWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.DigitalIDWalletAPIEudiWalletVerificationStartCountryEnum(\"AUT\"),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiEudiWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiEudiWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startEudi(DigitalIdWalletApiEudiWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiEudiWalletVerificationStartCountryEnum.of(\"AUT\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startEudi([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'AUT',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_eudi(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"AUT\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartEudiAsync(new DigitalIdWalletApiEudiWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = \"AUT\",\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "eudi" } }, "/v3/organization/{organization_id}/application/{application_id}/cases/teams/": { "get": { "summary": "Получить список команд проверки", "description": "Требуется разрешение `list:cases` для запрошенного приложения.", "operationId": "list_case_teams", "x-didit-sdk": { "resource": "cases.teams", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 1000000, "default": 0 } } ], "responses": { "200": { "description": "Успешно", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseReviewTeam" } }, "count": { "type": "integer", "description": "Количество совпадений, ограничено 100. Перейдите по ссылке next, чтобы продолжить дальше лимита." }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true } } } } } }, "400": { "description": "Недопустимые входные данные." }, "403": { "description": "Недостаточно прав." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.teams.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.teams.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.Teams.ListAutoPaging(ctx, didit.CasesTeamsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().teams().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->teams->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.teams.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.Teams.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] }, "post": { "summary": "Создать команду проверки", "description": "Требуется разрешение `write:cases` для запрошенного приложения.", "operationId": "create_case_teams", "x-didit-sdk": { "resource": "cases.teams", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." } ], "responses": { "201": { "description": "Успешно", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseReviewTeam" } } } }, "400": { "description": "Недопустимые входные данные." }, "403": { "description": "Недостаточно прав." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseReviewTeamCreate" }, "example": { "name": "AML analysts", "members": [ { "user_id": "9a000000-0000-4000-8000-0000000000aa", "capacity": 10 } ] } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.teams.create(\n name=\"AML analysts\",\n members=[{\n \"user_id\": \"9a000000-0000-4000-8000-0000000000aa\",\n \"capacity\": 10,\n }],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.teams.create({\n name: \"AML analysts\",\n members: [{\n user_id: \"9a000000-0000-4000-8000-0000000000aa\",\n capacity: 10,\n }],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Teams.Create(ctx, didit.CaseReviewTeamCreate{\n\tName: \"AML analysts\",\n\tMembers: []didit.CaseReviewTeamMemberParam{{\n\t\tUserID: \"9a000000-0000-4000-8000-0000000000aa\",\n\t\tCapacity: didit.Int(10),\n\t}},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CaseReviewTeamCreate;\nimport me.didit.types.CaseReviewTeamMember;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().teams().create(CaseReviewTeamCreate.builder()\n .name(\"AML analysts\")\n .members(List.of(CaseReviewTeamMember.builder()\n .userId(\"9a000000-0000-4000-8000-0000000000aa\")\n .capacity(10L)\n .build()))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->teams->create([\n 'name' => 'AML analysts',\n 'members' => [[\n 'user_id' => '9a000000-0000-4000-8000-0000000000aa',\n 'capacity' => 10,\n ]],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.teams.create(\n name: \"AML analysts\",\n members: [{\n user_id: \"9a000000-0000-4000-8000-0000000000aa\",\n capacity: 10,\n }]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Teams.CreateAsync(new CaseReviewTeamCreate\n{\n Name = \"AML analysts\",\n Members = new CaseReviewTeamMember[]\n {\n new()\n {\n UserId = \"9a000000-0000-4000-8000-0000000000aa\",\n Capacity = 10,\n },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/fraud/checks/{check_id}/": { "get": { "operationId": "root_retrieve", "x-didit-sdk": { "resource": "fraud_checks", "method": "retrieve", "auth": "api_key", "server": true }, "description": "Получить ранее созданную проверку по её `check_id`.", "summary": "Получить результат проверки на мошенничество", "parameters": [ { "in": "path", "name": "check_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudCheckResponse" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudClientCredentialsErrorMessage" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudClientCredentialsForbiddenErrorMessage" } } }, "description": "" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Fraud Check" ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.fraud_checks.retrieve(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.fraudChecks.retrieve(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.FraudChecks.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.fraudChecks().retrieve(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "fraudChecks->retrieve('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.fraud_checks.retrieve(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.FraudChecks.RetrieveAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/": { "get": { "operationId": "organization_application_cases_requests_list", "x-didit-sdk": { "resource": "cases.requests", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "name": "ordering", "required": false, "in": "query", "description": "Какое поле использовать для сортировки результатов.", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Количество возвращаемых результатов на страницу.", "schema": { "type": "integer" } }, { "name": "offset", "required": false, "in": "query", "description": "Начальный индекс, с которого возвращаются результаты.", "schema": { "type": "integer" } } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingPaginatedCaseRequestList" } } }, "description": "" }, "404": { "description": "Запрос или кейс недоступен для вызывающей стороны." }, "403": { "description": "У вызывающей стороны отсутствует необходимое разрешение для работы с кейсами." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.requests.list(\n \"11111111-2222-3333-4444-555555555555\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.requests.list(\"11111111-2222-3333-4444-555555555555\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.Requests.ListAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CasesRequestsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().requests().list(\"11111111-2222-3333-4444-555555555555\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->requests->list('11111111-2222-3333-4444-555555555555') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.requests.list(\"11111111-2222-3333-4444-555555555555\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.Requests.ListAsync(\"11111111-2222-3333-4444-555555555555\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] }, "post": { "operationId": "organization_application_cases_requests_create", "x-didit-sdk": { "resource": "cases.requests", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequestConfirmRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequestConfirmRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequestConfirmRequest" } } }, "required": true }, "responses": { "404": { "description": "Запрос или кейс недоступен для вызывающей стороны." }, "403": { "description": "У вызывающей стороны отсутствует необходимое разрешение для работы с кейсами." }, "400": { "description": "Недопустимые входные данные, неподдерживаемая цель, недоступный подтверждённый контакт или существующий неизменяемый ответ." }, "409": { "description": "Предварительный просмотр изменился или истек. Снова запросите предварительный просмотр перед подтверждением." }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequest" } } }, "description": "" } }, "security": [ { "ApiKeyAuth": [] } ], "description": "Подтвердите точный подписанный предварительный просмотр в течение 15 минут. Принимаются только фиксированные шаблоны и контакт субъекта кейса, подтверждённый через OTP. ID запроса обеспечивает идемпотентность повторных попыток. Доставка ставится в очередь; SENT, SIMULATED и UNKNOWN являются отдельными результатами. Запрос, требующий действий, переводит кейс в статус Ожидает пользователя. Обновление проверки оставляет его статус без изменений.", "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.requests.create(\n \"11111111-2222-3333-4444-555555555555\",\n contact_id=\"11111111-2222-3333-4444-555555555555\",\n purpose=\"identity_document\",\n request_id=\"11111111-2222-3333-4444-555555555555\",\n expires_at=\"2026-01-15T10:00:00Z\",\n preview_token=\"your-preview-token\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.requests.create(\"11111111-2222-3333-4444-555555555555\", {\n contact_id: \"11111111-2222-3333-4444-555555555555\",\n purpose: \"identity_document\",\n request_id: \"11111111-2222-3333-4444-555555555555\",\n expires_at: \"2026-01-15T10:00:00Z\",\n preview_token: \"your-preview-token\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Requests.Create(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CustomerMessagingCaseRequestConfirmRequest{\n\tContactID: \"11111111-2222-3333-4444-555555555555\",\n\tPurpose: didit.CustomerMessagingPurposeEnum(\"identity_document\"),\n\tRequestID: \"11111111-2222-3333-4444-555555555555\",\n\tExpiresAt: time.Date(2026, 1, 15, 10, 0, 0, 0, time.UTC),\n\tPreviewToken: \"your-preview-token\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.OffsetDateTime;\nimport me.didit.Didit;\nimport me.didit.types.CustomerMessagingCaseRequestConfirmRequest;\nimport me.didit.types.CustomerMessagingPurposeEnum;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().requests().create(\"11111111-2222-3333-4444-555555555555\", CustomerMessagingCaseRequestConfirmRequest.builder()\n .contactId(\"11111111-2222-3333-4444-555555555555\")\n .purpose(CustomerMessagingPurposeEnum.of(\"identity_document\"))\n .requestId(\"11111111-2222-3333-4444-555555555555\")\n .expiresAt(OffsetDateTime.parse(\"2026-01-15T10:00:00Z\"))\n .previewToken(\"your-preview-token\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->requests->create('11111111-2222-3333-4444-555555555555', [\n 'contact_id' => '11111111-2222-3333-4444-555555555555',\n 'purpose' => 'identity_document',\n 'request_id' => '11111111-2222-3333-4444-555555555555',\n 'expires_at' => '2026-01-15T10:00:00Z',\n 'preview_token' => 'your-preview-token',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.requests.create(\n \"11111111-2222-3333-4444-555555555555\",\n contact_id: \"11111111-2222-3333-4444-555555555555\",\n purpose: \"identity_document\",\n request_id: \"11111111-2222-3333-4444-555555555555\",\n expires_at: \"2026-01-15T10:00:00Z\",\n preview_token: \"your-preview-token\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Requests.CreateAsync(\"11111111-2222-3333-4444-555555555555\", new CustomerMessagingCaseRequestConfirmRequest\n{\n ContactId = \"11111111-2222-3333-4444-555555555555\",\n Purpose = \"identity_document\",\n RequestId = \"11111111-2222-3333-4444-555555555555\",\n ExpiresAt = DateTimeOffset.Parse(\"2026-01-15T10:00:00Z\"),\n PreviewToken = \"your-preview-token\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/fraud/checks/": { "post": { "operationId": "create_fraud_check", "x-didit-sdk": { "resource": "fraud_checks", "method": "create", "auth": "api_key", "server": true }, "description": "Отправьте один или несколько типизированных идентификаторов и получите нормализацию, актуальное обогащение, авторитетную валидацию при поддержке страны и типа идентификатора, независимые измерения риска и рекомендацию в одном ответе.\n\nЭти профили поддерживают проверку идентификаторов. Привязка личности на основе селфи (`biometric_identity`) требует версии профиля `2026-09-14.2` и бразильского CPF; она выполняется только с согласия пользователя и при наличии прав у вашей организации. Более ранние версии возвращают статус `not_available_in_profile_version`. Модули, выполнение которых невозможно, отмечаются как пропущенные с детерминированной причиной; источник, который не смог ответить, никогда не интерпретируется как несовпадение данных личности.", "summary": "Запустить проверку на мошенничество", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/FraudCheckRequestRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FraudCheckRequestRequest" }, "example": { "client_reference": "review-attempt-001", "subject": { "identifiers": [ { "type": "email", "value": "applicant@example.com" } ], "attributes": { "first_name": "Alex", "last_name": "Example" } }, "checks": { "include": [ "networks_same_org", "networks_cross_org", "email_risk" ] } } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/FraudCheckRequestRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudCheckResponse" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudClientCredentialsErrorMessage" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudClientCredentialsForbiddenErrorMessage" } } }, "description": "" }, "409": { "description": "Конфликт, возвращается без списания средств: `client_reference` уже использовался с другим телом запроса; проверка с таким же `client_reference` всё ещё выполняется (повторите попытку через количество секунд, указанное в `Retry-After`, с тем же референсом); либо верификация, к которой привязана эта проверка, была удалена до её завершения.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] }, "examples": { "different_body": { "summary": "Идентификатор повторно использован с другим телом запроса", "value": { "error": "client_reference has already been used with a different request body." } }, "still_running": { "summary": "Проверка с этим идентификатором всё ещё выполняется", "value": { "error": "A check with this client_reference is already running. Retry with the same reference later." } }, "verification_deleted": { "summary": "Верификация была удалена до завершения проверки", "value": { "error": "This verification was deleted before the check completed." } } } } }, "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой; отправляется, когда проверка с тем же `client_reference` всё ещё выполняется.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Fraud Check" ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.fraud_checks.create(\n client_reference=\"review-attempt-001\",\n subject={\n \"identifiers\": [{\n \"type\": \"email\",\n \"value\": \"applicant@example.com\",\n }],\n \"attributes\": {\n \"first_name\": \"Alex\",\n \"last_name\": \"Example\",\n },\n },\n checks={\n \"include\": [\"networks_same_org\", \"networks_cross_org\", \"email_risk\"],\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.fraudChecks.create({\n client_reference: \"review-attempt-001\",\n subject: {\n identifiers: [{\n type: \"email\",\n value: \"applicant@example.com\",\n }],\n attributes: {\n first_name: \"Alex\",\n last_name: \"Example\",\n },\n },\n checks: {\n include: [\"networks_same_org\", \"networks_cross_org\", \"email_risk\"],\n },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.FraudChecks.Create(ctx, didit.FraudCheckRequestRequest{\n\tClientReference: didit.String(\"review-attempt-001\"),\n\tSubject: didit.FraudCheckSubjectRequest{\n\t\tIdentifiers: []didit.FraudCheckIdentifierRequest{{\n\t\t\tType: didit.FraudTypeEnum(\"email\"),\n\t\t\tValue: \"applicant@example.com\",\n\t\t}},\n\t\tAttributes: didit.Some(didit.FraudCheckAttributesRequest{\n\t\t\tFirstName: didit.String(\"Alex\"),\n\t\t\tLastName: didit.String(\"Example\"),\n\t\t}),\n\t},\n\tChecks: didit.Some(didit.FraudCheckModuleSelectionRequest{\n\t\tInclude: didit.Some([]didit.FraudExcludeEnum{didit.FraudExcludeEnum(\"networks_same_org\"), didit.FraudExcludeEnum(\"networks_cross_org\"), didit.FraudExcludeEnum(\"email_risk\")}),\n\t}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.FraudCheckAttributesRequest;\nimport me.didit.types.FraudCheckIdentifierRequest;\nimport me.didit.types.FraudCheckModuleSelectionRequest;\nimport me.didit.types.FraudCheckRequestRequest;\nimport me.didit.types.FraudCheckSubjectRequest;\nimport me.didit.types.FraudExcludeEnum;\nimport me.didit.types.FraudTypeEnum;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.fraudChecks().create(FraudCheckRequestRequest.builder()\n .clientReference(\"review-attempt-001\")\n .subject(FraudCheckSubjectRequest.builder()\n .identifiers(List.of(FraudCheckIdentifierRequest.builder()\n .type(FraudTypeEnum.of(\"email\"))\n .value(\"applicant@example.com\")\n .build()))\n .attributes(FraudCheckAttributesRequest.builder()\n .firstName(\"Alex\")\n .lastName(\"Example\")\n .build())\n .build())\n .checks(FraudCheckModuleSelectionRequest.builder()\n .include(List.of(FraudExcludeEnum.of(\"networks_same_org\"), FraudExcludeEnum.of(\"networks_cross_org\"), FraudExcludeEnum.of(\"email_risk\")))\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "fraudChecks->create([\n 'client_reference' => 'review-attempt-001',\n 'subject' => [\n 'identifiers' => [[\n 'type' => 'email',\n 'value' => 'applicant@example.com',\n ]],\n 'attributes' => [\n 'first_name' => 'Alex',\n 'last_name' => 'Example',\n ],\n ],\n 'checks' => [\n 'include' => ['networks_same_org', 'networks_cross_org', 'email_risk'],\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.fraud_checks.create(\n client_reference: \"review-attempt-001\",\n subject: {\n identifiers: [{\n type: \"email\",\n value: \"applicant@example.com\",\n }],\n attributes: {\n first_name: \"Alex\",\n last_name: \"Example\",\n },\n },\n checks: {\n include: [\"networks_same_org\", \"networks_cross_org\", \"email_risk\"],\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.FraudChecks.CreateAsync(new FraudCheckRequestRequest\n{\n ClientReference = \"review-attempt-001\",\n Subject = new()\n {\n Identifiers = new FraudCheckIdentifierRequest[]\n {\n new()\n {\n Type = \"email\",\n Value = \"applicant@example.com\",\n },\n },\n Attributes = new FraudCheckAttributesRequest\n {\n FirstName = \"Alex\",\n LastName = \"Example\",\n },\n },\n Checks = new FraudCheckModuleSelectionRequest\n {\n Include = new FraudExcludeEnum[] { \"networks_same_org\", \"networks_cross_org\", \"email_risk\" },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/{request_uuid}/cancel/": { "post": { "operationId": "organization_application_cases_requests_cancel_create", "x-didit-sdk": { "resource": "cases.requests", "method": "cancel", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "request_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequest" } } }, "description": "" }, "404": { "description": "Запрос или кейс недоступен для вызывающей стороны." }, "403": { "description": "У вызывающей стороны отсутствует необходимое разрешение для работы с кейсами." }, "400": { "description": "Недопустимые входные данные, неподдерживаемая цель, недоступный подтверждённый контакт или существующий неизменяемый ответ." }, "409": { "description": "Предварительный просмотр изменился или истек. Снова запросите предварительный просмотр перед подтверждением." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.requests.cancel(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.requests.cancel(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Requests.Cancel(ctx, \"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().requests().cancel(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->requests->cancel('11111111-2222-3333-4444-555555555555', '11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.requests.cancel(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Requests.CancelAsync(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/options/": { "get": { "operationId": "organization_application_cases_requests_options_retrieve", "x-didit-sdk": { "resource": "cases.requests", "method": "retrieve_options", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequestOptions" } } }, "description": "" }, "404": { "description": "Запрос или кейс недоступен для вызывающей стороны." }, "403": { "description": "У вызывающей стороны отсутствует необходимое разрешение для работы с кейсами." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.requests.retrieve_options(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.requests.retrieveOptions(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Requests.RetrieveOptions(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().requests().retrieveOptions(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->requests->retrieveOptions('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.requests.retrieve_options(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Requests.RetrieveOptionsAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/{request_uuid}/attachment/": { "get": { "operationId": "organization_application_cases_requests_attachment_retrieve", "x-didit-sdk": { "resource": "cases.requests", "method": "retrieve_attachment", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "request_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "image/jpeg": { "schema": { "type": "string", "format": "binary" } } }, "description": "" }, "404": { "description": "Запрос или кейс недоступен для вызывающей стороны." }, "403": { "description": "У вызывающей стороны отсутствует необходимое разрешение для работы с кейсами." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\ncontent = client.cases.requests.retrieve_attachment(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n)\nwith open(\"download.png\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst content = await didit.cases.requests.retrieveAttachment(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n);\nawait writeFile(\"download.png\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresp, err := client.Cases.Requests.RetrieveAttachment(ctx, \"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.png\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.cases().requests().retrieveAttachment(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\")\n .writeTo(Path.of(\"download.png\"));" }, { "lang": "php", "label": "PHP", "source": "cases->requests->retrieveAttachment('11111111-2222-3333-4444-555555555555', '11111111-2222-3333-4444-555555555555');\n$content->saveTo('download.png');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ncontent = didit.cases.requests.retrieve_attachment(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n)\nFile.binwrite(\"download.png\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar content = await client.Cases.Requests.RetrieveAttachmentAsync(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nawait content.SaveToAsync(\"download.png\");" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/{record_uuid}/history/": { "get": { "operationId": "list_case_routing_rule_history", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "list_history", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "record_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "name": "ordering", "required": false, "in": "query", "description": "Какое поле использовать для сортировки результатов.", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Количество возвращаемых результатов на страницу.", "schema": { "type": "integer" } }, { "name": "offset", "required": false, "in": "query", "description": "Начальный индекс, с которого возвращаются результаты.", "schema": { "type": "integer" } } ], "tags": [ "Case Assignment" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPaginatedPolicyRevisionList" } } }, "description": "" }, "403": { "description": "Требуется доступ к кейсу." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.routing_rules.list_history(\n \"11111111-2222-3333-4444-555555555555\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.routingRules.listHistory(\"11111111-2222-3333-4444-555555555555\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.RoutingRules.ListHistoryAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CasesRoutingRulesListHistoryParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().routingRules().listHistory(\"11111111-2222-3333-4444-555555555555\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->listHistory('11111111-2222-3333-4444-555555555555') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.routing_rules.list_history(\"11111111-2222-3333-4444-555555555555\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.RoutingRules.ListHistoryAsync(\"11111111-2222-3333-4444-555555555555\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] } }, "/v3/session/{sessionId}/resubmission-preview/": { "post": { "summary": "Предварительный просмотр письма с запросом повторной отправки", "description": "Сформировать предпросмотр электронного письма, сопровождающего повторную отправку KYC или KYB, без изменения сессии, сброса проверок, продления срока действия, запуска проверок или отправки почты. Требуется привилегия `write:sessions` (для API-ключа с ограниченным доступом необходим доступ на запись к решениям) и сессия в статусе `Approved`, `Declined`, `In Review`, `Kyc Expired` или `Abandoned`. Сервер проверяет выбранные шаги сценария и формирует фиксированный переведённый шаблон с соответствующим верифицированным отправителем White label и брендингом. В запросе нельзя задать тему, текст сообщения или URL действия.\n\nПоле `email_address` необязательно. Без него письмо отправляется на собственный адрес пользователя: подтверждённый им на шаге проверки электронной почты в сценарии либо указанный в `contact_details` при создании сессии. Переданный вами адрес имеет приоритет (`recipient_source: request`). Если адрес неизвестен и вы его не передали, поля `recipient` и `preview_token` будут пустыми строками, и отправить письмо нельзя.\n\nОтвет включает получателя и источник адреса, отправителя, тему, HTML, язык, определённые шаги, признак отправки письма при подтверждении (`will_be_sent`, `not_sent_reason`) и подписанный `preview_token`. Поле `requires_user_action` имеет значение `false`, если все выбранные шаги выполняются без участия пользователя: в этом случае повторная отправка завершается автоматически, и письмо не отправляется (`not_sent_reason: no_user_action`).\n\nЭтот предпросмотр не резервирует состояние сессии и не разрешает доставку. После его проверки вызовите [Update Session Status](/ru/sessions-api/update-status) со значением `new_status: Resubmitted`, теми же `nodes_to_resubmit` и `email_language`, что и в предпросмотре, `send_email: true`, `email_address`, установленным в `recipient`, и `email_preview_token`, установленным в `preview_token`. Квитанция истекает через 15 минут. Если квитанция предоставлена, изменённые входные данные, текст сообщения, отправитель или состояние сессии возвращают ошибку `409` до любых изменений или отправки. Существующие интеграции могут опускать квитанцию. После конфликта сгенерируйте предпросмотр заново. Относитесь к ответу как к конфиденциальным данным верификации; в ответах используется заголовок `Cache-Control: no-store`. Отрисовывайте HTML в изолированном фрейме, никогда напрямую в DOM вашего приложения.", "operationId": "post_v3_session_resubmission_preview", "x-didit-sdk": { "resource": "sessions", "method": "preview_resubmission", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID сессии верификации для обновления. Принимает ID сессий как пользователей (KYC), так и компаний (KYB) — сервис сопоставляет ID для обоих типов сессий.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nodes_to_resubmit": { "type": "array", "description": "Шаги для предварительного просмотра с использованием тех же правил валидации, выбора и порядка выполнения сценария, что и при повторной подаче. Опустите, чтобы автоматически выбрать записанные попытки, требующие повторной подачи.", "items": { "type": "object", "required": [ "node_id", "feature" ], "properties": { "node_id": { "type": "string", "description": "Идентификатор узла в том виде, в каком он указан в определении сценария сессии (например, `feature_ocr`, `feature_liveness`).", "example": "feature_ocr" }, "feature": { "type": "string", "description": "Тип функции узла. Алиасы `ID_VERIFICATION`, `POA`, `PHONE` и `EMAIL` нормализуются на стороне сервера в `OCR`, `PROOF_OF_ADDRESS`, `PHONE_VERIFICATION` и `EMAIL_VERIFICATION`. `KYB_REGISTRY`, `KYB_KEY_PEOPLE` и `KYB` проходят валидацию схемы, но всегда отклоняются с бизнес-ошибкой `400`, показанной в примерах.", "enum": [ "OCR", "OCR_BACK", "NFC", "AML", "FACE", "LIVENESS", "FACE_MATCH", "IP_ANALYSIS", "AGE_ESTIMATION", "PROOF_OF_ADDRESS", "PHONE_VERIFICATION", "EMAIL_VERIFICATION", "FACE_SEARCH", "DATABASE_VALIDATION", "QUESTIONNAIRE", "DOCUMENT_AI", "KYB_DOCUMENTS", "ID_VERIFICATION", "POA", "PHONE", "EMAIL", "KYB_REGISTRY", "KYB_KEY_PEOPLE", "KYB", "GEOLOCATION" ], "example": "OCR" } } } }, "email_address": { "type": "string", "format": "email", "description": "Необязательно. Отправить электронное письмо на этот адрес вместо собственного адреса человека. Без него получателем является адрес, который человек подтвердил в сценарии, либо адрес, указанный в `contact_details`. Этот вызов не отправляет электронное письмо.", "example": "user@example.com" }, "email_language": { "type": "string", "description": "Язык для письма с уведомлением. На уровне схемы принимается любая строка; для неподдерживаемых кодов без уведомления используется английский (`en`).", "default": "en", "example": "en" } } }, "examples": { "Person's Own Address": { "summary": "Предварительный просмотр повторной отправки подтверждения адреса для собственного адреса пользователя", "value": { "nodes_to_resubmit": [ { "node_id": "feature_poa_1", "feature": "POA" } ], "email_language": "en" } }, "Named Recipient": { "summary": "Предварительный просмотр письма для указанного вами адреса", "value": { "nodes_to_resubmit": [ { "node_id": "feature_ocr", "feature": "OCR" } ], "email_address": "person@example.com", "email_language": "en" } } } } } }, "responses": { "200": { "description": "Только предварительный просмотр. Сессия остаётся без изменений, письмо не отправляется.", "content": { "application/json": { "schema": { "type": "object", "required": [ "recipient", "recipient_source", "sender", "sender_name", "sender_email", "sender_kind", "subject", "html", "text", "language", "will_be_sent", "not_sent_reason", "preview_token", "nodes_to_resubmit", "requires_user_action" ], "properties": { "recipient": { "type": "string", "description": "Адрес, на который отправляется электронное письмо. Пустая строка, если адрес человека неизвестен: в этом случае письмо отправить нельзя, и `preview_token` также пуст. Передайте его как `email_address` при подтверждении.", "example": "person@example.com" }, "recipient_source": { "type": "string", "enum": [ "email_verification", "contact_details", "request", "" ], "description": "Источник значения `recipient`. `request`: переданный вами `email_address`. `email_verification`: адрес, подтвержденный пользователем на шаге проверки электронной почты сценария. `contact_details`: адрес, указанный в `contact_details` при создании сессии. Пустая строка, если адрес отсутствует.", "example": "email_verification" }, "sender": { "type": "string", "description": "Заголовок `From`, с которым отправляется электронное письмо.", "example": "Example App " }, "sender_name": { "type": "string", "description": "Отображаемая часть имени в `sender`.", "example": "Example App" }, "sender_email": { "type": "string", "format": "email", "description": "Часть адреса `sender`.", "example": "no-reply@mail.example.com" }, "sender_kind": { "type": "string", "enum": [ "customer", "didit" ], "description": "`customer`: письмо отправляется с подтверждённого домена отправителя вашего приложения (White label). `didit`: отправляется с собственного отправителя Didit.", "example": "customer" }, "subject": { "type": "string", "description": "Тема письма в точности так, как она отправляется.", "example": "Action Required: Complete your verification in Example App" }, "html": { "type": "string", "description": "HTML письма точно в том виде, в котором оно отправляется, со встроенным логотипом в формате data URL. Отображайте его в изолированном фрейме (sandbox), ни в коем случае не напрямую в DOM вашего приложения.", "example": "..." }, "text": { "type": "string", "description": "Текст письма в виде обычного текста, как он хранится в цепочке сообщений пользователя, для компактного предварительного просмотра (в качестве получаемого письма остаётся HTML).", "example": "Almost there\n\nSome steps need to be completed again.\nHere’s what to fix:\n\nhttps://verify.didit.me/session/abc123" }, "language": { "type": "string", "description": "Язык, на котором составлено письмо. Английский (`en`), если запрошенный `email_language` недоступен.", "example": "en" }, "will_be_sent": { "type": "boolean", "description": "Отправляет ли подтверждение изменения с помощью `send_email: true` это электронное письмо. Значение `false`, если задан `not_sent_reason`.", "example": true }, "not_sent_reason": { "type": "string", "nullable": true, "enum": [ "no_user_action", "no_recipient", "sandbox", null ], "description": "Причина, по которой подтверждение не приведёт к отправке электронного письма, или `null`, если письмо будет отправлено. `no_user_action`: каждый выбранный шаг выполняется без участия человека, поэтому повторная отправка завершается автоматически и электронное письмо не отправляется. `no_recipient`: адрес человека неизвестен, и вы его не передали. `sandbox`: сессия в песочнице, получатель которой не дал согласие на доставку тестовых электронных писем, поэтому отправка только имитируется.", "example": null }, "nodes_to_resubmit": { "type": "array", "items": { "type": "object", "required": [ "node_id", "feature" ], "properties": { "node_id": { "type": "string", "description": "Идентификатор узла в том виде, в каком он указан в определении сценария сессии (например, `feature_ocr`, `feature_liveness`).", "example": "feature_ocr" }, "feature": { "type": "string", "description": "Тип функции узла. Алиасы `ID_VERIFICATION`, `POA`, `PHONE` и `EMAIL` нормализуются на стороне сервера в `OCR`, `PROOF_OF_ADDRESS`, `PHONE_VERIFICATION` и `EMAIL_VERIFICATION`. `KYB_REGISTRY`, `KYB_KEY_PEOPLE` и `KYB` проходят валидацию схемы, но всегда отклоняются с бизнес-ошибкой `400`, показанной в примерах.", "enum": [ "OCR", "OCR_BACK", "NFC", "AML", "FACE", "LIVENESS", "FACE_MATCH", "IP_ANALYSIS", "AGE_ESTIMATION", "PROOF_OF_ADDRESS", "PHONE_VERIFICATION", "EMAIL_VERIFICATION", "FACE_SEARCH", "DATABASE_VALIDATION", "QUESTIONNAIRE", "DOCUMENT_AI", "KYB_DOCUMENTS", "ID_VERIFICATION", "POA", "PHONE", "EMAIL", "KYB_REGISTRY", "KYB_KEY_PEOPLE", "KYB", "GEOLOCATION" ], "example": "OCR" } } } }, "requires_user_action": { "type": "boolean", "description": "Требует ли хотя бы одна выбранная проверка взаимодействия с пользователем. Это не предопределяет итоговый результат сценария." }, "preview_token": { "type": "string", "description": "Подписанная квитанция для этого конкретного письма, действующая в течение 15 минут. Передайте ее как `email_preview_token` в [Обновить статус сессии](/ru/sessions-api/update-status). Пустая строка, если получатель отсутствует.", "example": "eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000" } } }, "examples": { "Will Be Sent": { "summary": "Получатель по умолчанию: адрес, верифицированный в процессе проверки", "value": { "recipient": "person@example.com", "recipient_source": "email_verification", "sender": "Example App ", "sender_name": "Example App", "sender_email": "no-reply@mail.example.com", "sender_kind": "customer", "subject": "Action Required: Complete your verification in Example App", "html": "...", "language": "en", "will_be_sent": true, "not_sent_reason": null, "nodes_to_resubmit": [ { "node_id": "feature_poa_1", "feature": "PROOF_OF_ADDRESS" } ], "requires_user_action": true, "preview_token": "eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000" } }, "No User Action": { "summary": "Выбраны только бэкенд-шаги, поэтому электронное письмо не отправляется", "value": { "recipient": "person@example.com", "recipient_source": "contact_details", "sender": "Example App ", "sender_name": "Example App", "sender_email": "no-reply@mail.example.com", "sender_kind": "customer", "subject": "Action Required: Complete your verification in Example App", "html": "...", "language": "en", "will_be_sent": false, "not_sent_reason": "no_user_action", "nodes_to_resubmit": [ { "node_id": "feature_aml", "feature": "AML" } ], "requires_user_action": false, "preview_token": "eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000" } } } } }, "headers": { "Cache-Control": { "description": "Всегда `no-store`: предпросмотр содержит данные верификации и не должен кэшироваться.", "schema": { "type": "string", "example": "no-store" } } } }, "400": { "description": "Сессия не находится в статусе, который принимает этот endpoint, она уже находится в статусе `Resubmitted`, выбранные шаги не могут быть отправлены повторно, либо поле недействительно.", "content": { "application/json": { "examples": { "Wrong Current Status": { "summary": "Сессия не находится в статусе, допустимом для этого endpoint", "value": { "detail": "Only sessions with status Approved, Declined, In Review, Kyc Expired, Abandoned, Resubmitted can be updated. Current status: In Progress" } }, "Already Resubmitted": { "summary": "Сессия уже находится в статусе Resubmitted", "value": [ "The new status is the same as the current status." ] }, "Nothing To Resubmit": { "summary": "Автовыбор не нашел шагов, требующих повторной отправки", "value": { "nodes_to_resubmit": "No features found that need resubmission. All features are already approved." } }, "Invalid Email": { "summary": "email_address не является адресом электронной почты", "value": { "email_address": [ "Enter a valid email address." ] } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "API-ключ с ограниченной областью действия с истёкшим сроком действия", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Отсутствуют учетные данные, у вызывающей стороны нет привилегии `write:sessions`, у API-ключа с ограниченной областью видимости нет необходимого для этого endpoint доступа, либо передан `session_id`, принадлежащий другому приложению.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Отсутствует или недействителен x-api-key", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "У вызывающей стороны отсутствует разрешение write:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "API-ключ с ограниченной областью действия без данного доступа", "value": { "detail": "This API key has no write access to decisions." } } } } } }, "404": { "description": "Сессия KYC или KYB с таким `session_id` не существует.", "content": { "application/json": { "examples": { "Not Found": { "summary": "Неизвестный session_id", "value": { "detail": "Not found." } } } } } }, "429": { "description": "Все шаги для повторной отправки относятся только к бэкенду (AML, DATABASE_VALIDATION, IP_ANALYSIS), и сессия уже отправлялась повторно для таких шагов за последние 30 секунд, поэтому Update Session Status отклонит повторную отправку. Повторите попытку через интервал, указанный в `Retry-After`.", "content": { "application/json": { "examples": { "Backend-only resubmit throttled": { "value": { "detail": "This session was already resubmitted for backend-only features within the last 30 seconds; repeating it cannot change the outcome. Wait before resubmitting again." } } } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.preview_resubmission(\n \"11111111-2222-3333-4444-555555555555\",\n nodes_to_resubmit=[{\n \"node_id\": \"feature_poa_1\",\n \"feature\": \"POA\",\n }],\n email_language=\"en\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.previewResubmission(\"11111111-2222-3333-4444-555555555555\", {\n nodes_to_resubmit: [{\n node_id: \"feature_poa_1\",\n feature: \"POA\",\n }],\n email_language: \"en\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.PreviewResubmission(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsPreviewResubmissionParams{\n\tNodesToResubmit: didit.Some([]didit.SessionsPreviewResubmissionParamsNodesToResubmit{{\n\t\tNodeID: \"feature_poa_1\",\n\t\tFeature: \"POA\",\n\t}}),\n\tEmailLanguage: didit.String(\"en\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.SessionsPreviewResubmissionParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().previewResubmission(\"11111111-2222-3333-4444-555555555555\", SessionsPreviewResubmissionParams.builder()\n .nodesToResubmit(List.of(SessionsPreviewResubmissionParams.NodesToResubmit.builder()\n .nodeId(\"feature_poa_1\")\n .feature(SessionsPreviewResubmissionParams.NodesToResubmit.Feature.of(\"POA\"))\n .build()))\n .emailLanguage(\"en\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->previewResubmission('11111111-2222-3333-4444-555555555555', [\n 'nodes_to_resubmit' => [[\n 'node_id' => 'feature_poa_1',\n 'feature' => 'POA',\n ]],\n 'email_language' => 'en',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.preview_resubmission(\n \"11111111-2222-3333-4444-555555555555\",\n nodes_to_resubmit: [{\n node_id: \"feature_poa_1\",\n feature: \"POA\",\n }],\n email_language: \"en\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.PreviewResubmissionAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsPreviewResubmissionParams\n{\n NodesToResubmit = new SessionsPreviewResubmissionParamsNodesToResubmit[]\n {\n new()\n {\n NodeId = \"feature_poa_1\",\n Feature = \"POA\",\n },\n },\n EmailLanguage = \"en\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/{record_uuid}/": { "get": { "summary": "Получить правило маршрутизации", "description": "Требуется разрешение `read:cases` для запрошенного приложения.", "operationId": "retrieve_case_routing_rules", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "retrieve", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "record_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Успешно", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingRule" } } } }, "400": { "description": "Недопустимые входные данные." }, "403": { "description": "Недостаточно прав." }, "404": { "description": "Запись не найдена в этом приложении." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.routing_rules.retrieve(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.routingRules.retrieve(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RoutingRules.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().routingRules().retrieve(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->retrieve('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.routing_rules.retrieve(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RoutingRules.RetrieveAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "patch": { "summary": "Обновить правило маршрутизации", "description": "Требуется разрешение `write:cases` для запрошенного приложения.", "operationId": "update_case_routing_rules", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "update", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "record_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Успешно", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingRule" } } } }, "400": { "description": "Недопустимые входные данные." }, "403": { "description": "Недостаточно прав." }, "404": { "description": "Запись не найдена в этом приложении." }, "409": { "description": "Правило маршрутизации изменилось со времени expected_version. Проверьте актуальную версию правила перед повторной попыткой." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingRuleUpdate" } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.routing_rules.update(\n \"11111111-2222-3333-4444-555555555555\",\n name=\"your-name\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.routingRules.update(\"11111111-2222-3333-4444-555555555555\", {\n name: \"your-name\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RoutingRules.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CaseRoutingRuleUpdate{\n\tName: didit.String(\"your-name\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CaseRoutingRuleUpdate;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().routingRules().update(\"11111111-2222-3333-4444-555555555555\", CaseRoutingRuleUpdate.builder()\n .name(\"your-name\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->update('11111111-2222-3333-4444-555555555555', [\n 'name' => 'your-name',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.routing_rules.update(\n \"11111111-2222-3333-4444-555555555555\",\n name: \"your-name\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RoutingRules.UpdateAsync(\"11111111-2222-3333-4444-555555555555\", new CaseRoutingRuleUpdate\n{\n Name = \"your-name\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/case-requests/{request_uuid}/": { "get": { "operationId": "case_requests_retrieve", "x-didit-sdk": { "resource": "case_requests", "method": "retrieve", "auth": "device_token", "server": false }, "parameters": [ { "in": "path", "name": "request_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequestPublic" } } }, "description": "" }, "404": { "description": "Запрос или кейс недоступен для вызывающей стороны." } }, "security": [ { "CaseRequestToken": [] } ], "description": "Доступ к одному запросу клиента с использованием токена, привязанного к запросу. Конфиденциальные результаты кейса, исходные идентификационные данные и адрес получателя не возвращаются. Запросы, требующие действия, истекают через семь дней. Отмена или завершение кейса аннулирует ссылку. Ответы неизменяемы и остаются доказательствами, которые проверяющий использует для оценки; они никогда не одобряют и не обновляют исходную верификацию." }, "post": { "operationId": "case_requests_create", "x-didit-sdk": { "resource": "case_requests", "method": "respond", "auth": "device_token", "server": false }, "parameters": [ { "in": "path", "name": "request_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseCustomerResponseRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseCustomerResponseRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseCustomerResponseResult" } } }, "description": "" }, "404": { "description": "Запрос или кейс недоступен для вызывающей стороны." }, "400": { "description": "Недопустимые входные данные, неподдерживаемая цель, недоступный подтверждённый контакт или существующий неизменяемый ответ." }, "409": { "description": "Предварительный просмотр изменился или истек. Снова запросите предварительный просмотр перед подтверждением." } }, "security": [ { "CaseRequestToken": [] } ], "description": "Доступ к одному запросу клиента с использованием токена, привязанного к запросу. Конфиденциальные результаты кейса, исходные идентификационные данные и адрес получателя не возвращаются. Запросы, требующие действия, истекают через семь дней. Отмена или завершение кейса аннулирует ссылку. Ответы неизменяемы и остаются доказательствами, которые проверяющий использует для оценки; они никогда не одобряют и не обновляют исходную верификацию." } }, "/v3/fraud/checks/plan/": { "post": { "operationId": "plan_create", "x-didit-sdk": { "resource": "fraud_checks", "method": "plan", "auth": "api_key", "server": true }, "description": "Проверить выбранные проверки и оценить их цену без выполнения, создания сессии или биллинга.", "summary": "Запланировать проверку на мошенничество", "tags": [ "Fraud Check" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/FraudCheckRequestRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FraudCheckRequestRequest" }, "example": { "client_reference": "review-attempt-001", "subject": { "identifiers": [ { "type": "email", "value": "applicant@example.com" } ], "attributes": { "first_name": "Alex", "last_name": "Example" } }, "checks": { "include": [ "networks_same_org", "networks_cross_org", "email_risk" ] } } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/FraudCheckRequestRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudCheckPlan" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudBadRequestErrorMessage" } } }, "description": "" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.fraud_checks.plan(\n client_reference=\"review-attempt-001\",\n subject={\n \"identifiers\": [{\n \"type\": \"email\",\n \"value\": \"applicant@example.com\",\n }],\n \"attributes\": {\n \"first_name\": \"Alex\",\n \"last_name\": \"Example\",\n },\n },\n checks={\n \"include\": [\"networks_same_org\", \"networks_cross_org\", \"email_risk\"],\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.fraudChecks.plan({\n client_reference: \"review-attempt-001\",\n subject: {\n identifiers: [{\n type: \"email\",\n value: \"applicant@example.com\",\n }],\n attributes: {\n first_name: \"Alex\",\n last_name: \"Example\",\n },\n },\n checks: {\n include: [\"networks_same_org\", \"networks_cross_org\", \"email_risk\"],\n },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.FraudChecks.Plan(ctx, didit.FraudCheckRequestRequest{\n\tClientReference: didit.String(\"review-attempt-001\"),\n\tSubject: didit.FraudCheckSubjectRequest{\n\t\tIdentifiers: []didit.FraudCheckIdentifierRequest{{\n\t\t\tType: didit.FraudTypeEnum(\"email\"),\n\t\t\tValue: \"applicant@example.com\",\n\t\t}},\n\t\tAttributes: didit.Some(didit.FraudCheckAttributesRequest{\n\t\t\tFirstName: didit.String(\"Alex\"),\n\t\t\tLastName: didit.String(\"Example\"),\n\t\t}),\n\t},\n\tChecks: didit.Some(didit.FraudCheckModuleSelectionRequest{\n\t\tInclude: didit.Some([]didit.FraudExcludeEnum{didit.FraudExcludeEnum(\"networks_same_org\"), didit.FraudExcludeEnum(\"networks_cross_org\"), didit.FraudExcludeEnum(\"email_risk\")}),\n\t}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.FraudCheckAttributesRequest;\nimport me.didit.types.FraudCheckIdentifierRequest;\nimport me.didit.types.FraudCheckModuleSelectionRequest;\nimport me.didit.types.FraudCheckRequestRequest;\nimport me.didit.types.FraudCheckSubjectRequest;\nimport me.didit.types.FraudExcludeEnum;\nimport me.didit.types.FraudTypeEnum;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.fraudChecks().plan(FraudCheckRequestRequest.builder()\n .clientReference(\"review-attempt-001\")\n .subject(FraudCheckSubjectRequest.builder()\n .identifiers(List.of(FraudCheckIdentifierRequest.builder()\n .type(FraudTypeEnum.of(\"email\"))\n .value(\"applicant@example.com\")\n .build()))\n .attributes(FraudCheckAttributesRequest.builder()\n .firstName(\"Alex\")\n .lastName(\"Example\")\n .build())\n .build())\n .checks(FraudCheckModuleSelectionRequest.builder()\n .include(List.of(FraudExcludeEnum.of(\"networks_same_org\"), FraudExcludeEnum.of(\"networks_cross_org\"), FraudExcludeEnum.of(\"email_risk\")))\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "fraudChecks->plan([\n 'client_reference' => 'review-attempt-001',\n 'subject' => [\n 'identifiers' => [[\n 'type' => 'email',\n 'value' => 'applicant@example.com',\n ]],\n 'attributes' => [\n 'first_name' => 'Alex',\n 'last_name' => 'Example',\n ],\n ],\n 'checks' => [\n 'include' => ['networks_same_org', 'networks_cross_org', 'email_risk'],\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.fraud_checks.plan(\n client_reference: \"review-attempt-001\",\n subject: {\n identifiers: [{\n type: \"email\",\n value: \"applicant@example.com\",\n }],\n attributes: {\n first_name: \"Alex\",\n last_name: \"Example\",\n },\n },\n checks: {\n include: [\"networks_same_org\", \"networks_cross_org\", \"email_risk\"],\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.FraudChecks.PlanAsync(new FraudCheckRequestRequest\n{\n ClientReference = \"review-attempt-001\",\n Subject = new()\n {\n Identifiers = new FraudCheckIdentifierRequest[]\n {\n new()\n {\n Type = \"email\",\n Value = \"applicant@example.com\",\n },\n },\n Attributes = new FraudCheckAttributesRequest\n {\n FirstName = \"Alex\",\n LastName = \"Example\",\n },\n },\n Checks = new FraudCheckModuleSelectionRequest\n {\n Include = new FraudExcludeEnum[] { \"networks_same_org\", \"networks_cross_org\", \"email_risk\" },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/": { "get": { "summary": "Получить список правил маршрутизации", "description": "Требуется разрешение `list:cases` для запрошенного приложения.", "operationId": "list_case_routing_rules", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 1000000, "default": 0 } } ], "responses": { "200": { "description": "Успешно", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseRoutingRule" } }, "count": { "type": "integer", "description": "Количество совпадений, ограничено 100. Перейдите по ссылке next, чтобы продолжить дальше лимита." }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true } } } } } }, "400": { "description": "Недопустимые входные данные." }, "403": { "description": "Недостаточно прав." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.routing_rules.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.routingRules.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.RoutingRules.ListAutoPaging(ctx, didit.CasesRoutingRulesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().routingRules().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.routing_rules.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.RoutingRules.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] }, "post": { "summary": "Создать правило маршрутизации", "description": "Требуется разрешение `write:cases` для запрошенного приложения. Укажите publish=false, чтобы создать неопубликованный черновик; публикация создаёт его первую активную версию. Удаление никогда не публиковавшегося черновика удаляет его.", "operationId": "create_case_routing_rules", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." } ], "responses": { "201": { "description": "Успешно", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingRule" } } } }, "400": { "description": "Недопустимые входные данные." }, "403": { "description": "Недостаточно прав." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingRuleCreate" }, "example": { "name": "AML screening alerts", "conditions": [ { "field": "source", "operator": "equals", "value": "AML_SCREENING" } ], "blueprint": "b1de0000-0000-4000-8000-000000000002" } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.routing_rules.create(\n name=\"AML screening alerts\",\n conditions=[{\n \"field\": \"source\",\n \"operator\": \"equals\",\n \"value\": \"AML_SCREENING\",\n }],\n blueprint=\"b1de0000-0000-4000-8000-000000000002\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.routingRules.create({\n name: \"AML screening alerts\",\n conditions: [{\n field: \"source\",\n operator: \"equals\",\n value: \"AML_SCREENING\",\n }],\n blueprint: \"b1de0000-0000-4000-8000-000000000002\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RoutingRules.Create(ctx, didit.CaseRoutingRuleCreate{\n\tName: \"AML screening alerts\",\n\tConditions: []didit.CaseRoutingConditionParam{{\n\t\tField: \"source\",\n\t\tOperator: \"equals\",\n\t\tValue: \"AML_SCREENING\",\n\t}},\n\tBlueprint: \"b1de0000-0000-4000-8000-000000000002\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CaseRoutingCondition;\nimport me.didit.types.CaseRoutingRuleCreate;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().routingRules().create(CaseRoutingRuleCreate.builder()\n .name(\"AML screening alerts\")\n .conditions(List.of(CaseRoutingCondition.builder()\n .field(CaseRoutingCondition.Field.of(\"source\"))\n .operator(CaseRoutingCondition.Operator.of(\"equals\"))\n .value(CaseRoutingCondition.Value.ofString(\"AML_SCREENING\"))\n .build()))\n .blueprint(\"b1de0000-0000-4000-8000-000000000002\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->create([\n 'name' => 'AML screening alerts',\n 'conditions' => [[\n 'field' => 'source',\n 'operator' => 'equals',\n 'value' => 'AML_SCREENING',\n ]],\n 'blueprint' => 'b1de0000-0000-4000-8000-000000000002',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.routing_rules.create(\n name: \"AML screening alerts\",\n conditions: [{\n field: \"source\",\n operator: \"equals\",\n value: \"AML_SCREENING\",\n }],\n blueprint: \"b1de0000-0000-4000-8000-000000000002\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RoutingRules.CreateAsync(new CaseRoutingRuleCreate\n{\n Name = \"AML screening alerts\",\n Conditions = new CaseRoutingCondition[]\n {\n new()\n {\n Field = \"source\",\n Operator = \"equals\",\n Value = \"AML_SCREENING\",\n },\n },\n Blueprint = \"b1de0000-0000-4000-8000-000000000002\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/{record_uuid}/publish/": { "post": { "operationId": "publish_case_routing_rule", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "publish", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "record_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Assignment" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraftPreconditionRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraftPreconditionRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraftPreconditionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingPublicationCaseRoutingRule" } } }, "description": "" }, "403": { "description": "Требуется доступ к кейсу." }, "409": { "description": "Опубликованная версия или черновик изменились. Перезагрузите страницу перед повторной попыткой." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.routing_rules.publish(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version=0,\n expected_revision=\"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.routingRules.publish(\"11111111-2222-3333-4444-555555555555\", {\n expected_version: 0,\n expected_revision: \"11111111-2222-3333-4444-555555555555\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RoutingRules.Publish(ctx, \"11111111-2222-3333-4444-555555555555\", didit.RoutingPublicationPolicyDraftPreconditionRequest{\n\tExpectedVersion: 0,\n\tExpectedRevision: didit.String(\"11111111-2222-3333-4444-555555555555\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.RoutingPublicationPolicyDraftPreconditionRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().routingRules().publish(\"11111111-2222-3333-4444-555555555555\", RoutingPublicationPolicyDraftPreconditionRequest.builder()\n .expectedVersion(0L)\n .expectedRevision(\"11111111-2222-3333-4444-555555555555\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->publish('11111111-2222-3333-4444-555555555555', [\n 'expected_version' => 0,\n 'expected_revision' => '11111111-2222-3333-4444-555555555555',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.routing_rules.publish(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version: 0,\n expected_revision: \"11111111-2222-3333-4444-555555555555\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RoutingRules.PublishAsync(\"11111111-2222-3333-4444-555555555555\", new RoutingPublicationPolicyDraftPreconditionRequest\n{\n ExpectedVersion = 0,\n ExpectedRevision = \"11111111-2222-3333-4444-555555555555\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/publish/": { "post": { "operationId": "publish_case_blueprint", "x-didit-sdk": { "resource": "cases.blueprints", "method": "publish", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "blueprint_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CasePublicationPolicyDraftPreconditionRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CasePublicationPolicyDraftPreconditionRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CasePublicationPolicyDraftPreconditionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CasePublicationCaseBlueprint" } } }, "description": "" }, "409": { "description": "Опубликованная версия или сохранённая редакция черновика изменилась. Перезагрузите страницу перед повторной попыткой." }, "403": { "description": "Отсутствует необходимое разрешение для кейса." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.blueprints.publish(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version=0,\n expected_revision=\"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.blueprints.publish(\"11111111-2222-3333-4444-555555555555\", {\n expected_version: 0,\n expected_revision: \"11111111-2222-3333-4444-555555555555\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Blueprints.Publish(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CasePublicationPolicyDraftPreconditionRequest{\n\tExpectedVersion: 0,\n\tExpectedRevision: didit.String(\"11111111-2222-3333-4444-555555555555\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasePublicationPolicyDraftPreconditionRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().blueprints().publish(\"11111111-2222-3333-4444-555555555555\", CasePublicationPolicyDraftPreconditionRequest.builder()\n .expectedVersion(0L)\n .expectedRevision(\"11111111-2222-3333-4444-555555555555\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->publish('11111111-2222-3333-4444-555555555555', [\n 'expected_version' => 0,\n 'expected_revision' => '11111111-2222-3333-4444-555555555555',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.blueprints.publish(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version: 0,\n expected_revision: \"11111111-2222-3333-4444-555555555555\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Blueprints.PublishAsync(\"11111111-2222-3333-4444-555555555555\", new CasePublicationPolicyDraftPreconditionRequest\n{\n ExpectedVersion = 0,\n ExpectedRevision = \"11111111-2222-3333-4444-555555555555\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/preview/": { "post": { "operationId": "organization_application_cases_requests_preview_create", "x-didit-sdk": { "resource": "cases.requests", "method": "preview", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequestPreviewRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequestPreviewRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequestPreviewRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequestPreviewResponse" } } }, "description": "" }, "404": { "description": "Запрос или кейс недоступен для вызывающей стороны." }, "403": { "description": "У вызывающей стороны отсутствует необходимое разрешение для работы с кейсами." }, "400": { "description": "Недопустимые входные данные, неподдерживаемая цель, недоступный подтверждённый контакт или существующий неизменяемый ответ." }, "409": { "description": "Предварительный просмотр изменился или истек. Снова запросите предварительный просмотр перед подтверждением." } }, "security": [ { "ApiKeyAuth": [] } ], "description": "Сформировать продакшн-email без отправки и без изменения кейса. Возвращает точного получателя, отправителя, тему, тело письма и подписанный preview_token. Отправьте те же contact_id, purpose, language, request_id, expires_at и preview_token для подтверждения в течение 15 минут.", "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.requests.preview(\n \"11111111-2222-3333-4444-555555555555\",\n contact_id=\"11111111-2222-3333-4444-555555555555\",\n purpose=\"identity_document\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.requests.preview(\"11111111-2222-3333-4444-555555555555\", {\n contact_id: \"11111111-2222-3333-4444-555555555555\",\n purpose: \"identity_document\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Requests.Preview(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CustomerMessagingCaseRequestPreviewRequest{\n\tContactID: \"11111111-2222-3333-4444-555555555555\",\n\tPurpose: didit.CustomerMessagingPurposeEnum(\"identity_document\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CustomerMessagingCaseRequestPreviewRequest;\nimport me.didit.types.CustomerMessagingPurposeEnum;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().requests().preview(\"11111111-2222-3333-4444-555555555555\", CustomerMessagingCaseRequestPreviewRequest.builder()\n .contactId(\"11111111-2222-3333-4444-555555555555\")\n .purpose(CustomerMessagingPurposeEnum.of(\"identity_document\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->requests->preview('11111111-2222-3333-4444-555555555555', [\n 'contact_id' => '11111111-2222-3333-4444-555555555555',\n 'purpose' => 'identity_document',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.requests.preview(\n \"11111111-2222-3333-4444-555555555555\",\n contact_id: \"11111111-2222-3333-4444-555555555555\",\n purpose: \"identity_document\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Requests.PreviewAsync(\"11111111-2222-3333-4444-555555555555\", new CustomerMessagingCaseRequestPreviewRequest\n{\n ContactId = \"11111111-2222-3333-4444-555555555555\",\n Purpose = \"identity_document\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/action-receipts/": { "get": { "operationId": "action_receipts_retrieve", "x-didit-sdk": { "resource": "cases", "method": "list_action_receipts", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "query", "name": "offset", "schema": { "type": "integer", "maximum": 1000000, "minimum": 0, "default": 0 } } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseActionCaseActionReceiptPage" } } }, "description": "" } }, "security": [ { "ApiKeyAuth": [] } ], "description": "Получить список квитанций по действиям субъекта, начиная с самых новых, максимум 20 результатов на страницу. Используйте next_offset для перехода к следующей странице. Текст введённой заметки не отображается в истории.", "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.list_action_receipts(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.listActionReceipts(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.ListActionReceipts(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CasesListActionReceiptsParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().listActionReceipts(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->listActionReceipts('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.list_action_receipts(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.ListActionReceiptsAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/notes/{note_uuid}/": { "delete": { "operationId": "delete_network_note", "x-didit-sdk": { "resource": "networks.notes", "method": "delete", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "summary": "Удалить вашу заметку о сети", "description": "Требуются разрешение write:networks и аутентифицированный автор заметки. Удаление необратимо. Связанный аккаунт и данные верификации не затрагиваются.", "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID сети." }, { "name": "note_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Токен доступа пользователя Console в формате Bearer ." } ], "responses": { "204": { "description": "Заметка удалена." }, "401": { "description": "Требуется аутентификация." }, "403": { "description": "Отсутствует разрешение или доступ к Networks." }, "404": { "description": "Сеть или заметка не видна этому приложению." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\n# Also needs a console user's access token.\nclient = Didit()\n\nclient.networks.notes.delete(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n extra_headers={\"Authorization\": \"Bearer YOUR_CONSOLE_USER_TOKEN\"},\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nconst didit = new Didit({\n fetch: (url, init) => {\n const headers = new Headers(init?.headers);\n headers.set(\"Authorization\", \"Bearer YOUR_CONSOLE_USER_TOKEN\");\n return fetch(url, { ...init, headers });\n },\n});\n\nawait didit.networks.notes.delete(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nclient := didit.NewClient()\n\nif err := client.Networks.Notes.Delete(ctx, \"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\", didit.NetworksNotesDeleteParams{\n\tAuthorization: \"Bearer YOUR_CONSOLE_USER_TOKEN\",\n}); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.core.RequestOptions;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nDidit client = new Didit();\n\nclient.networks().notes().delete(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\", RequestOptions.builder()\n .header(\"Authorization\", \"Bearer YOUR_CONSOLE_USER_TOKEN\")\n .build());" }, { "lang": "php", "label": "PHP", "source": "networks->notes->delete('11111111-2222-3333-4444-555555555555', '11111111-2222-3333-4444-555555555555', [\n 'authorization' => 'Bearer YOUR_CONSOLE_USER_TOKEN',\n]);" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\n# Also needs a console user's access token.\ndidit = Didit::Client.new\n\ndidit.networks.notes.delete(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n request_options: { extra_headers: { \"Authorization\" => \"Bearer YOUR_CONSOLE_USER_TOKEN\" } }\n)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nusing var client = new DiditClient();\n\nawait client.Networks.Notes.DeleteAsync(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\", requestOptions: new RequestOptions\n{\n Headers = new Dictionary\n {\n [\"Authorization\"] = \"Bearer YOUR_CONSOLE_USER_TOKEN\",\n },\n});" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/action-receipts/{receipt_uuid}/retry/": { "post": { "operationId": "action_receipts_retry_create", "x-didit-sdk": { "resource": "cases", "method": "retry_action_receipt", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "receipt_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseActionCaseActionReceipt" } } }, "description": "" } }, "security": [ { "ApiKeyAuth": [] } ], "description": "Повторить только это неудавшееся действие субъекта, используя сохранённые входные данные. Проверяется текущее разрешение на запись. Применённые действия возвращают квитанцию без повторного выполнения. Закрытие кейса выполняется независимо.", "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.retry_action_receipt(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.retryActionReceipt(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RetryActionReceipt(ctx, \"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().retryActionReceipt(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->retryActionReceipt('11111111-2222-3333-4444-555555555555', '11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.retry_action_receipt(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RetryActionReceiptAsync(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/draft/": { "get": { "operationId": "get_case_blueprint_draft", "x-didit-sdk": { "resource": "cases.blueprints", "method": "retrieve_draft", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "blueprint_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CasePublicationPolicyDraftResponse" } } }, "description": "" }, "403": { "description": "Отсутствует необходимое разрешение для кейса." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.blueprints.retrieve_draft(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.blueprints.retrieveDraft(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Blueprints.RetrieveDraft(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().blueprints().retrieveDraft(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->retrieveDraft('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.blueprints.retrieve_draft(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Blueprints.RetrieveDraftAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "put": { "operationId": "save_case_blueprint_draft", "x-didit-sdk": { "resource": "cases.blueprints", "method": "save_draft", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "blueprint_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CasePublicationPolicyDraftWriteRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CasePublicationPolicyDraftWriteRequest" }, "example": { "expected_version": 1, "expected_revision": "4e5f0000-0000-4000-8000-000000000003", "changes": { "max_active_cases": 20 } } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CasePublicationPolicyDraftWriteRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CasePublicationPolicyDraft" } } }, "description": "" }, "409": { "description": "Опубликованная версия или сохранённая редакция черновика изменилась. Перезагрузите страницу перед повторной попыткой." }, "403": { "description": "Отсутствует необходимое разрешение для кейса." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.blueprints.save_draft(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version=1,\n expected_revision=\"4e5f0000-0000-4000-8000-000000000003\",\n changes={\"max_active_cases\": 20},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.blueprints.saveDraft(\"11111111-2222-3333-4444-555555555555\", {\n expected_version: 1,\n expected_revision: \"4e5f0000-0000-4000-8000-000000000003\",\n changes: { max_active_cases: 20 },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Blueprints.SaveDraft(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CasePublicationPolicyDraftWriteRequest{\n\tExpectedVersion: 1,\n\tExpectedRevision: didit.String(\"4e5f0000-0000-4000-8000-000000000003\"),\n\tChanges: map[string]any{\"max_active_cases\": 20},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.CasePublicationPolicyDraftWriteRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().blueprints().saveDraft(\"11111111-2222-3333-4444-555555555555\", CasePublicationPolicyDraftWriteRequest.builder()\n .expectedVersion(1L)\n .expectedRevision(\"4e5f0000-0000-4000-8000-000000000003\")\n .changes(Map.of(\"max_active_cases\", 20))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->saveDraft('11111111-2222-3333-4444-555555555555', [\n 'expected_version' => 1,\n 'expected_revision' => '4e5f0000-0000-4000-8000-000000000003',\n 'changes' => ['max_active_cases' => 20],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.blueprints.save_draft(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version: 1,\n expected_revision: \"4e5f0000-0000-4000-8000-000000000003\",\n changes: { max_active_cases: 20 }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Blueprints.SaveDraftAsync(\"11111111-2222-3333-4444-555555555555\", new CasePublicationPolicyDraftWriteRequest\n{\n ExpectedVersion = 1,\n ExpectedRevision = \"4e5f0000-0000-4000-8000-000000000003\",\n Changes = new Dictionary { [\"max_active_cases\"] = 20 },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "delete": { "operationId": "discard_case_blueprint_draft", "x-didit-sdk": { "resource": "cases.blueprints", "method": "discard_draft", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "blueprint_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "responses": { "204": { "description": "Тело ответа отсутствует" }, "409": { "description": "Опубликованная версия или сохранённая редакция черновика изменилась. Перезагрузите страницу перед повторной попыткой." }, "403": { "description": "Отсутствует необходимое разрешение для кейса." } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CasePublicationPolicyDraftPreconditionRequest" } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nclient.cases.blueprints.discard_draft(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version=0,\n expected_revision=\"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nawait didit.cases.blueprints.discardDraft(\"11111111-2222-3333-4444-555555555555\", {\n expected_version: 0,\n expected_revision: \"11111111-2222-3333-4444-555555555555\",\n});" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nif err := client.Cases.Blueprints.DiscardDraft(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CasePublicationPolicyDraftPreconditionRequest{\n\tExpectedVersion: 0,\n\tExpectedRevision: didit.String(\"11111111-2222-3333-4444-555555555555\"),\n}); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasePublicationPolicyDraftPreconditionRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.cases().blueprints().discardDraft(\"11111111-2222-3333-4444-555555555555\", CasePublicationPolicyDraftPreconditionRequest.builder()\n .expectedVersion(0L)\n .expectedRevision(\"11111111-2222-3333-4444-555555555555\")\n .build());" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->discardDraft('11111111-2222-3333-4444-555555555555', [\n 'expected_version' => 0,\n 'expected_revision' => '11111111-2222-3333-4444-555555555555',\n]);" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.blueprints.discard_draft(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version: 0,\n expected_revision: \"11111111-2222-3333-4444-555555555555\"\n)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait client.Cases.Blueprints.DiscardDraftAsync(\"11111111-2222-3333-4444-555555555555\", new CasePublicationPolicyDraftPreconditionRequest\n{\n ExpectedVersion = 0,\n ExpectedRevision = \"11111111-2222-3333-4444-555555555555\",\n});" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/teams/{record_uuid}/": { "get": { "summary": "Получить команду проверяющих", "description": "Требуется разрешение `read:cases` для запрошенного приложения.", "operationId": "retrieve_case_teams", "x-didit-sdk": { "resource": "cases.teams", "method": "retrieve", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "record_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Успешно", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseReviewTeam" } } } }, "400": { "description": "Недопустимые входные данные." }, "403": { "description": "Недостаточно прав." }, "404": { "description": "Запись не найдена в этом приложении." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.teams.retrieve(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.teams.retrieve(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Teams.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().teams().retrieve(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->teams->retrieve('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.teams.retrieve(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Teams.RetrieveAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "patch": { "summary": "Обновить команду проверяющих", "description": "Требуется разрешение `write:cases` для запрошенного приложения.", "operationId": "update_case_teams", "x-didit-sdk": { "resource": "cases.teams", "method": "update", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "record_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Успешно", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseReviewTeam" } } } }, "400": { "description": "Недопустимые входные данные." }, "403": { "description": "Недостаточно прав." }, "404": { "description": "Запись не найдена в этом приложении." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseReviewTeamUpdate" } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.teams.update(\n \"11111111-2222-3333-4444-555555555555\",\n name=\"your-name\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.teams.update(\"11111111-2222-3333-4444-555555555555\", {\n name: \"your-name\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Teams.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CaseReviewTeamUpdate{\n\tName: didit.String(\"your-name\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CaseReviewTeamUpdate;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().teams().update(\"11111111-2222-3333-4444-555555555555\", CaseReviewTeamUpdate.builder()\n .name(\"your-name\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->teams->update('11111111-2222-3333-4444-555555555555', [\n 'name' => 'your-name',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.teams.update(\n \"11111111-2222-3333-4444-555555555555\",\n name: \"your-name\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Teams.UpdateAsync(\"11111111-2222-3333-4444-555555555555\", new CaseReviewTeamUpdate\n{\n Name = \"your-name\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/report/": { "get": { "operationId": "download_network_report", "x-didit-sdk": { "resource": "networks", "method": "download_report", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "summary": "Скачать отчёт с доказательной базой по сети", "description": "Скачать PDF-файл текущей сети организации, зафиксированных связей учётных записей, ссылок на сигналы и статуса проверки. Требуется разрешение read:networks. Глобальные аналитические данные и личные заметки аналитиков не включаются. Списки учётных записей и сигналов ограничены 500 записями каждый, и в отчёте указывается, если список не полон. Запрос не меняет статус сети. Ошибки возвращаются в формате JSON.", "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID сети." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Токен доступа пользователя Console в формате Bearer ." } ], "responses": { "200": { "description": "Отчёт с доказательствами по сети. Cache-Control: no-store.", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Требуется аутентификация." }, "403": { "description": "Отсутствует разрешение или доступ к Networks." }, "404": { "description": "Сеть или заметка не видна этому приложению." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\n# Also needs a console user's access token.\nclient = Didit()\n\ncontent = client.networks.download_report(\n \"11111111-2222-3333-4444-555555555555\",\n extra_headers={\"Authorization\": \"Bearer YOUR_CONSOLE_USER_TOKEN\"},\n)\nwith open(\"download.pdf\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nconst didit = new Didit({\n fetch: (url, init) => {\n const headers = new Headers(init?.headers);\n headers.set(\"Authorization\", \"Bearer YOUR_CONSOLE_USER_TOKEN\");\n return fetch(url, { ...init, headers });\n },\n});\n\nconst content = await didit.networks.downloadReport(\"11111111-2222-3333-4444-555555555555\");\nawait writeFile(\"download.pdf\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nclient := didit.NewClient()\n\nresp, err := client.Networks.DownloadReport(ctx, \"11111111-2222-3333-4444-555555555555\", didit.NetworksDownloadReportParams{\n\tAuthorization: \"Bearer YOUR_CONSOLE_USER_TOKEN\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.pdf\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\nimport me.didit.core.RequestOptions;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nDidit client = new Didit();\n\nclient.networks().downloadReport(\"11111111-2222-3333-4444-555555555555\", RequestOptions.builder()\n .header(\"Authorization\", \"Bearer YOUR_CONSOLE_USER_TOKEN\")\n .build())\n .writeTo(Path.of(\"download.pdf\"));" }, { "lang": "php", "label": "PHP", "source": "networks->downloadReport('11111111-2222-3333-4444-555555555555', [\n 'authorization' => 'Bearer YOUR_CONSOLE_USER_TOKEN',\n]);\n$content->saveTo('download.pdf');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\n# Also needs a console user's access token.\ndidit = Didit::Client.new\n\ncontent = didit.networks.download_report(\n \"11111111-2222-3333-4444-555555555555\",\n request_options: { extra_headers: { \"Authorization\" => \"Bearer YOUR_CONSOLE_USER_TOKEN\" } }\n)\nFile.binwrite(\"download.pdf\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nusing var client = new DiditClient();\n\nvar content = await client.Networks.DownloadReportAsync(\"11111111-2222-3333-4444-555555555555\", requestOptions: new RequestOptions\n{\n Headers = new Dictionary\n {\n [\"Authorization\"] = \"Bearer YOUR_CONSOLE_USER_TOKEN\",\n },\n});\nawait content.SaveToAsync(\"download.pdf\");" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/notes/": { "get": { "operationId": "list_network_notes", "x-didit-sdk": { "resource": "networks.notes", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "summary": "Получить список приватных заметок к сети", "description": "Пользователи Console с разрешением read:networks могут читать заметки по сети, видимой приложению. Заметки остаются внутри организации и не передаются в общую систему аналитики. Сначала отображаются самые новые заметки.", "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID сети." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Токен доступа пользователя Console в формате Bearer ." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 30 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 1000000, "default": 0 } } ], "responses": { "200": { "description": "Страница заметок. Количество ограничено 100; используйте next для продолжения.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkNote" } } } } } } }, "401": { "description": "Требуется аутентификация." }, "403": { "description": "Отсутствует разрешение или доступ к Networks." }, "404": { "description": "Сеть или заметка не видна этому приложению." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\n# Also needs a console user's access token.\nclient = Didit()\n\nfor item in client.networks.notes.list(\n \"11111111-2222-3333-4444-555555555555\",\n extra_headers={\"Authorization\": \"Bearer YOUR_CONSOLE_USER_TOKEN\"},\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nconst didit = new Didit({\n fetch: (url, init) => {\n const headers = new Headers(init?.headers);\n headers.set(\"Authorization\", \"Bearer YOUR_CONSOLE_USER_TOKEN\");\n return fetch(url, { ...init, headers });\n },\n});\n\nfor await (const item of didit.networks.notes.list(\"11111111-2222-3333-4444-555555555555\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nclient := didit.NewClient()\n\niter := client.Networks.Notes.ListAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.NetworksNotesListParams{\n\tAuthorization: \"Bearer YOUR_CONSOLE_USER_TOKEN\",\n})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.core.RequestOptions;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nDidit client = new Didit();\n\nfor (var item : client.networks().notes().list(\"11111111-2222-3333-4444-555555555555\", RequestOptions.builder()\n .header(\"Authorization\", \"Bearer YOUR_CONSOLE_USER_TOKEN\")\n .build())) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "networks->notes->list('11111111-2222-3333-4444-555555555555', [\n 'authorization' => 'Bearer YOUR_CONSOLE_USER_TOKEN',\n]) as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\n# Also needs a console user's access token.\ndidit = Didit::Client.new\n\ndidit.networks.notes.list(\n \"11111111-2222-3333-4444-555555555555\",\n request_options: { extra_headers: { \"Authorization\" => \"Bearer YOUR_CONSOLE_USER_TOKEN\" } }\n).auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Networks.Notes.ListAsync(\"11111111-2222-3333-4444-555555555555\", requestOptions: new RequestOptions\n{\n Headers = new Dictionary\n {\n [\"Authorization\"] = \"Bearer YOUR_CONSOLE_USER_TOKEN\",\n },\n}))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] }, "post": { "operationId": "create_network_note", "x-didit-sdk": { "resource": "networks.notes", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "summary": "Добавить приватную заметку к сети", "description": "Требуется пользователь консоли с write:networks. Автор назначается на основе аутентифицированного пользователя. Указывайте новый случайный UUID client_reference для каждой заметки; повторяйте запрос с теми же телом и идентификатором после неоднозначного ответа во избежание дубликатов. Повторное использование идентификатора для другого тела, автора или сети возвращает 409. При объединении сетей заметки переходят к сохранившемуся расследованию.", "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID сети." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Токен доступа пользователя Console в формате Bearer ." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "comment", "client_reference" ], "properties": { "comment": { "type": "string", "minLength": 1, "maxLength": 10000 }, "client_reference": { "type": "string", "format": "uuid" } } } } } }, "responses": { "201": { "description": "Сохранённая приватная заметка.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkNote" } } } }, "200": { "description": "Сохранённая приватная заметка.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkNote" } } } }, "400": { "description": "Недопустимая или пустая заметка." }, "409": { "description": "Ссылка уже использовалась для другой заметки." }, "401": { "description": "Требуется аутентификация." }, "403": { "description": "Отсутствует разрешение или доступ к Networks." }, "404": { "description": "Сеть или заметка не видна этому приложению." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\n# Also needs a console user's access token.\nclient = Didit()\n\nresult = client.networks.notes.create(\n \"11111111-2222-3333-4444-555555555555\",\n comment=\"your-comment\",\n client_reference=\"11111111-2222-3333-4444-555555555555\",\n extra_headers={\"Authorization\": \"Bearer YOUR_CONSOLE_USER_TOKEN\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nconst didit = new Didit({\n fetch: (url, init) => {\n const headers = new Headers(init?.headers);\n headers.set(\"Authorization\", \"Bearer YOUR_CONSOLE_USER_TOKEN\");\n return fetch(url, { ...init, headers });\n },\n});\n\nconst result = await didit.networks.notes.create(\"11111111-2222-3333-4444-555555555555\", {\n comment: \"your-comment\",\n client_reference: \"11111111-2222-3333-4444-555555555555\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nclient := didit.NewClient()\n\nresult, err := client.Networks.Notes.Create(ctx, \"11111111-2222-3333-4444-555555555555\", didit.NetworksNotesCreateParams{\n\tComment: \"your-comment\",\n\tClientReference: \"11111111-2222-3333-4444-555555555555\",\n\tAuthorization: \"Bearer YOUR_CONSOLE_USER_TOKEN\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.core.RequestOptions;\nimport me.didit.types.NetworksNotesCreateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nDidit client = new Didit();\n\nvar result = client.networks().notes().create(\"11111111-2222-3333-4444-555555555555\", NetworksNotesCreateParams.builder()\n .comment(\"your-comment\")\n .clientReference(\"11111111-2222-3333-4444-555555555555\")\n .build(), RequestOptions.builder()\n .header(\"Authorization\", \"Bearer YOUR_CONSOLE_USER_TOKEN\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "networks->notes->create('11111111-2222-3333-4444-555555555555', [\n 'comment' => 'your-comment',\n 'client_reference' => '11111111-2222-3333-4444-555555555555',\n 'authorization' => 'Bearer YOUR_CONSOLE_USER_TOKEN',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\n# Also needs a console user's access token.\ndidit = Didit::Client.new\n\nresult = didit.networks.notes.create(\n \"11111111-2222-3333-4444-555555555555\",\n comment: \"your-comment\",\n client_reference: \"11111111-2222-3333-4444-555555555555\",\n request_options: { extra_headers: { \"Authorization\" => \"Bearer YOUR_CONSOLE_USER_TOKEN\" } }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nusing var client = new DiditClient();\n\nvar result = await client.Networks.Notes.CreateAsync(\"11111111-2222-3333-4444-555555555555\", new NetworksNotesCreateParams\n{\n Comment = \"your-comment\",\n ClientReference = \"11111111-2222-3333-4444-555555555555\",\n}, requestOptions: new RequestOptions\n{\n Headers = new Dictionary\n {\n [\"Authorization\"] = \"Bearer YOUR_CONSOLE_USER_TOKEN\",\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/{record_uuid}/draft/": { "get": { "operationId": "get_case_routing_rule_draft", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "retrieve_draft", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "record_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Assignment" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraftResponse" } } }, "description": "" }, "403": { "description": "Требуется доступ к кейсу." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.routing_rules.retrieve_draft(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.routingRules.retrieveDraft(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RoutingRules.RetrieveDraft(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().routingRules().retrieveDraft(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->retrieveDraft('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.routing_rules.retrieve_draft(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RoutingRules.RetrieveDraftAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "put": { "operationId": "save_case_routing_rule_draft", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "save_draft", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "record_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Assignment" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraftWriteRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraftWriteRequest" }, "example": { "expected_version": 1, "expected_revision": "4e5f0000-0000-4000-8000-000000000003", "changes": { "priority": 10 } } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraftWriteRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraft" } } }, "description": "" }, "403": { "description": "Требуется доступ к кейсу." }, "409": { "description": "Опубликованная версия или черновик изменились. Перезагрузите страницу перед повторной попыткой." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.routing_rules.save_draft(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version=1,\n expected_revision=\"4e5f0000-0000-4000-8000-000000000003\",\n changes={\"priority\": 10},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.routingRules.saveDraft(\"11111111-2222-3333-4444-555555555555\", {\n expected_version: 1,\n expected_revision: \"4e5f0000-0000-4000-8000-000000000003\",\n changes: { priority: 10 },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RoutingRules.SaveDraft(ctx, \"11111111-2222-3333-4444-555555555555\", didit.RoutingPublicationPolicyDraftWriteRequest{\n\tExpectedVersion: 1,\n\tExpectedRevision: didit.String(\"4e5f0000-0000-4000-8000-000000000003\"),\n\tChanges: map[string]any{\"priority\": 10},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.RoutingPublicationPolicyDraftWriteRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().routingRules().saveDraft(\"11111111-2222-3333-4444-555555555555\", RoutingPublicationPolicyDraftWriteRequest.builder()\n .expectedVersion(1L)\n .expectedRevision(\"4e5f0000-0000-4000-8000-000000000003\")\n .changes(Map.of(\"priority\", 10))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->saveDraft('11111111-2222-3333-4444-555555555555', [\n 'expected_version' => 1,\n 'expected_revision' => '4e5f0000-0000-4000-8000-000000000003',\n 'changes' => ['priority' => 10],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.routing_rules.save_draft(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version: 1,\n expected_revision: \"4e5f0000-0000-4000-8000-000000000003\",\n changes: { priority: 10 }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RoutingRules.SaveDraftAsync(\"11111111-2222-3333-4444-555555555555\", new RoutingPublicationPolicyDraftWriteRequest\n{\n ExpectedVersion = 1,\n ExpectedRevision = \"4e5f0000-0000-4000-8000-000000000003\",\n Changes = new Dictionary { [\"priority\"] = 10 },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "delete": { "operationId": "discard_case_routing_rule_draft", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "discard_draft", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "record_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Assignment" ], "responses": { "204": { "description": "Тело ответа отсутствует" }, "403": { "description": "Требуется доступ к кейсу." }, "409": { "description": "Опубликованная версия или черновик изменились. Перезагрузите страницу перед повторной попыткой." } }, "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraftPreconditionRequest" } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nclient.cases.routing_rules.discard_draft(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version=0,\n expected_revision=\"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nawait didit.cases.routingRules.discardDraft(\"11111111-2222-3333-4444-555555555555\", {\n expected_version: 0,\n expected_revision: \"11111111-2222-3333-4444-555555555555\",\n});" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nif err := client.Cases.RoutingRules.DiscardDraft(ctx, \"11111111-2222-3333-4444-555555555555\", didit.RoutingPublicationPolicyDraftPreconditionRequest{\n\tExpectedVersion: 0,\n\tExpectedRevision: didit.String(\"11111111-2222-3333-4444-555555555555\"),\n}); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.RoutingPublicationPolicyDraftPreconditionRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.cases().routingRules().discardDraft(\"11111111-2222-3333-4444-555555555555\", RoutingPublicationPolicyDraftPreconditionRequest.builder()\n .expectedVersion(0L)\n .expectedRevision(\"11111111-2222-3333-4444-555555555555\")\n .build());" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->discardDraft('11111111-2222-3333-4444-555555555555', [\n 'expected_version' => 0,\n 'expected_revision' => '11111111-2222-3333-4444-555555555555',\n]);" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.routing_rules.discard_draft(\n \"11111111-2222-3333-4444-555555555555\",\n expected_version: 0,\n expected_revision: \"11111111-2222-3333-4444-555555555555\"\n)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait client.Cases.RoutingRules.DiscardDraftAsync(\"11111111-2222-3333-4444-555555555555\", new RoutingPublicationPolicyDraftPreconditionRequest\n{\n ExpectedVersion = 0,\n ExpectedRevision = \"11111111-2222-3333-4444-555555555555\",\n});" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/duplicates/": { "post": { "operationId": "duplicates_create", "x-didit-sdk": { "resource": "cases", "method": "find_duplicates", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CaseDuplicateCaseDuplicateQueryRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CaseDuplicateCaseDuplicateQueryRequest" }, "example": { "subject": { "type": "user", "uuid": "5b9a0000-0000-4000-8000-00000000f00d" } } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CaseDuplicateCaseDuplicateQueryRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDuplicateCaseDuplicatePage" } } }, "description": "" } }, "security": [ { "ApiKeyAuth": [] } ], "description": "Проверьте существующие кейсы по субъекту или принадлежащей исходной записи перед созданием кейса вручную. Возвращаются как открытые, так и завершённые расследования. Каждая страница содержит не более 20 кейсов; используйте next_offset для запроса следующей страницы.", "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.find_duplicates(\n subject={\n \"type\": \"user\",\n \"uuid\": \"5b9a0000-0000-4000-8000-00000000f00d\",\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.findDuplicates({\n subject: {\n type: \"user\",\n uuid: \"5b9a0000-0000-4000-8000-00000000f00d\",\n },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.FindDuplicates(ctx, didit.CaseDuplicateCaseDuplicateQueryRequest{\n\tSubject: didit.Some(didit.CaseDuplicateCaseSubjectInputRequest{\n\t\tType: didit.CaseDuplicateTypeEnum(\"user\"),\n\t\tUUID: \"5b9a0000-0000-4000-8000-00000000f00d\",\n\t}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CaseDuplicateCaseDuplicateQueryRequest;\nimport me.didit.types.CaseDuplicateCaseSubjectInputRequest;\nimport me.didit.types.CaseDuplicateTypeEnum;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().findDuplicates(CaseDuplicateCaseDuplicateQueryRequest.builder()\n .subject(CaseDuplicateCaseSubjectInputRequest.builder()\n .type(CaseDuplicateTypeEnum.of(\"user\"))\n .uuid(\"5b9a0000-0000-4000-8000-00000000f00d\")\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->findDuplicates([\n 'subject' => [\n 'type' => 'user',\n 'uuid' => '5b9a0000-0000-4000-8000-00000000f00d',\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.find_duplicates(\n subject: {\n type: \"user\",\n uuid: \"5b9a0000-0000-4000-8000-00000000f00d\",\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.FindDuplicatesAsync(new CaseDuplicateCaseDuplicateQueryRequest\n{\n Subject = new CaseDuplicateCaseSubjectInputRequest\n {\n Type = \"user\",\n Uuid = \"5b9a0000-0000-4000-8000-00000000f00d\",\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/preview/": { "post": { "summary": "Маршрутизация тестового кейса", "description": "Требуется разрешение `read:cases` для запрошенного приложения. Оценивает текущие правила или предоставленный черновик с учётом текущего доступа, доступности, навыков и загрузки проверяющих. Не сохраняет черновик и не резервирует ресурсы проверяющих.", "operationId": "preview_case_routing", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "preview", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." } ], "responses": { "200": { "description": "Успешно", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingPreview" } } } }, "400": { "description": "Недопустимые входные данные." }, "403": { "description": "Недостаточно прав." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingPreviewRequest" } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.routing_rules.preview(\n source=\"MANUAL\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.routingRules.preview({\n source: \"MANUAL\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RoutingRules.Preview(ctx, didit.CaseRoutingPreviewRequest{\n\tSource: \"MANUAL\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CaseRoutingPreviewRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().routingRules().preview(CaseRoutingPreviewRequest.builder()\n .source(CaseRoutingPreviewRequest.Source.of(\"MANUAL\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->preview([\n 'source' => 'MANUAL',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.routing_rules.preview(source: \"MANUAL\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RoutingRules.PreviewAsync(new CaseRoutingPreviewRequest\n{\n Source = \"MANUAL\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/reviewers/": { "get": { "summary": "Получить список доступных проверяющих кейса", "description": "Требуется разрешение `list:cases` для запрошенного приложения.", "operationId": "list_case_reviewers", "x-didit-sdk": { "resource": "cases", "method": "list_reviewers", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." } ], "responses": { "200": { "description": "Успешно", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "user_id": { "type": "string", "format": "uuid" }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" } } } } } } } } }, "400": { "description": "Недопустимые входные данные." }, "403": { "description": "Недостаточно прав." }, "503": { "description": "Не удалось подтвердить доступ проверяющего. Повторите попытку позже." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.list_reviewers()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.listReviewers();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.ListReviewers(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().listReviewers();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->listReviewers();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.list_reviewers\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.ListReviewersAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/history/": { "get": { "operationId": "list_case_blueprint_history", "x-didit-sdk": { "resource": "cases.blueprints", "method": "list_history", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "blueprint_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "name": "ordering", "required": false, "in": "query", "description": "Какое поле использовать для сортировки результатов.", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Количество возвращаемых результатов на страницу.", "schema": { "type": "integer" } }, { "name": "offset", "required": false, "in": "query", "description": "Начальный индекс, с которого возвращаются результаты.", "schema": { "type": "integer" } } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CasePublicationPaginatedPolicyRevisionList" } } }, "description": "" }, "403": { "description": "Отсутствует необходимое разрешение для кейса." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.blueprints.list_history(\n \"11111111-2222-3333-4444-555555555555\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.blueprints.listHistory(\"11111111-2222-3333-4444-555555555555\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.Blueprints.ListHistoryAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CasesBlueprintsListHistoryParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().blueprints().listHistory(\"11111111-2222-3333-4444-555555555555\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->listHistory('11111111-2222-3333-4444-555555555555') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.blueprints.list_history(\"11111111-2222-3333-4444-555555555555\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.Blueprints.ListHistoryAsync(\"11111111-2222-3333-4444-555555555555\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] } }, "/v3/session/{sessionId}/signatures/{nodeId}/documents/{documentId}/file/": { "get": { "summary": "Скачать подписанный документ", "description": "Скачать подписанный PDF-файл одного документа из шага «Электронная подпись». Используйте путь `signed_file` в `signatures[].documents[]` в решении. PDF содержит документ, показанный подписанту, с проставленными значениями полей и страницей с доказательствами (если не отключён параметр `signature_evidence_page`). PDF с усиленной подписью (AES) также содержит подпись PAdES с меткой времени; простой PDF не содержит цифровой подписи, печати или метки времени. Didit сверяет файл с `sha256_signed` перед его возвратом.\n\nРаботает для сессий проверки пользователей (KYC) и верификации бизнеса (KYB). Требуется `read:sessions`; ваш API-ключ подходит. См. [отчёт об электронной подписи](/ru/core-technology/electronic-signature/report-electronic-signature#скачивание-подписанных-документов).", "operationId": "get_v3_session_signature_document_file", "x-didit-sdk": { "resource": "sessions.signatures", "method": "download_document", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "Сессия проверки пользователей (KYC) или верификации бизнеса (KYB).", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "nodeId", "in": "path", "required": true, "description": "Шаг «Электронная подпись»: `node_id` элемента в `signatures[]`.", "schema": { "type": "string", "example": "feature_signature" } }, { "name": "documentId", "in": "path", "required": true, "description": "`id` документа в `signatures[].documents[]`.", "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Подписанный PDF.", "headers": { "Content-Disposition": { "description": "Вложение с именем файла.", "schema": { "type": "string", "example": "attachment; filename=\"agreement-signed.pdf\"" } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Отсутствуют учетные данные или используются учетные данные, не позволяющие прочитать эту сессию. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "You do not have permission to perform this action." } } } }, "404": { "description": "Подходящий подписанный документ не найден: сессия, шаг или документ не существуют, были удалены или ещё не подписаны.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Not signed yet": { "summary": "Подписант ещё не подписал", "value": { "code": "signature_not_signed", "detail": "signature_not_signed" } }, "Unknown document": { "summary": "Такой документ отсутствует в этом шаге", "value": { "code": "signature_not_found", "detail": "signature_not_found" } } } } } }, "409": { "description": "Сохранённый файл больше не совпадает с записанным значением SHA-256. Ничего не возвращено.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Changed file": { "summary": "Сохраненный файл не соответствует своему хешу", "value": { "code": "signature_document_changed", "detail": "signature_document_changed" } } } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\ncontent = client.sessions.signatures.download_document(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\",\n \"11111111-2222-3333-4444-555555555555\",\n)\nwith open(\"download.pdf\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst content = await didit.sessions.signatures.downloadDocument(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\",\n \"11111111-2222-3333-4444-555555555555\",\n);\nawait writeFile(\"download.pdf\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresp, err := client.Sessions.Signatures.DownloadDocument(ctx, \"11111111-2222-3333-4444-555555555555\", \"feature_signature\", \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.pdf\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.sessions().signatures().downloadDocument(\"11111111-2222-3333-4444-555555555555\", \"feature_signature\", \"11111111-2222-3333-4444-555555555555\")\n .writeTo(Path.of(\"download.pdf\"));" }, { "lang": "php", "label": "PHP", "source": "sessions->signatures->downloadDocument('11111111-2222-3333-4444-555555555555', 'feature_signature', '11111111-2222-3333-4444-555555555555');\n$content->saveTo('download.pdf');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ncontent = didit.sessions.signatures.download_document(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\",\n \"11111111-2222-3333-4444-555555555555\"\n)\nFile.binwrite(\"download.pdf\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar content = await client.Sessions.Signatures.DownloadDocumentAsync(\"11111111-2222-3333-4444-555555555555\", \"feature_signature\", \"11111111-2222-3333-4444-555555555555\");\nawait content.SaveToAsync(\"download.pdf\");" } ] } }, "/v3/session/{sessionId}/signatures/{nodeId}/evidence/": { "get": { "summary": "Скачать доказательства подписи", "description": "Скачать PDF-файл с доказательствами подписанта: уровень и формат, подписант, IP-адрес, каждый документ с его исходным хэшем SHA-256 и значениями полей, а также SHA-256 каждого подписанного файла. Для усиленной электронной подписи (AES) также указываются сессия подтверждённой личности, подтверждение кода, сертификат и метка времени. Используйте путь `evidence_file` элемента подписанта в `signatures[]`.\n\nВсегда передавайте `signature_id`, если на шаге «Верификация бизнеса» несколько подписантов: без него маршрут выберет одного из подписантов шага. Требуется `read:sessions`; ваш API-ключ подходит.", "operationId": "get_v3_session_signature_evidence", "x-didit-sdk": { "resource": "sessions.signatures", "method": "download_evidence", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "Сессия проверки пользователей (KYC) или верификации бизнеса (KYB).", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "nodeId", "in": "path", "required": true, "description": "Шаг «Электронная подпись»: `node_id` элемента в `signatures[]`.", "schema": { "type": "string", "example": "feature_signature" } }, { "name": "signature_id", "in": "query", "required": false, "description": "`id` элемента подписанта в `signatures[]`.", "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "PDF-файл со свидетельствами.", "headers": { "Content-Disposition": { "description": "Вложение с именем файла.", "schema": { "type": "string", "example": "attachment; filename=\"signature-evidence.pdf\"" } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Отсутствуют учетные данные или используются учетные данные, не позволяющие прочитать эту сессию. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "You do not have permission to perform this action." } } } }, "404": { "description": "Ни одно подтверждение не подходит: сессия, шаг или подписант не существуют, были удалены или еще не поставили подпись.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Not signed yet": { "summary": "Подписант ещё не подписал", "value": { "code": "signature_not_signed", "detail": "signature_not_signed" } }, "Unknown signer": { "summary": "Такая подпись отсутствует в этом шаге", "value": { "code": "signature_not_found", "detail": "signature_not_found" } } } } } }, "409": { "description": "Сохранённый файл больше не совпадает с записанным значением SHA-256. Ничего не возвращено.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Changed file": { "summary": "Сохраненный файл не соответствует своему хешу", "value": { "code": "signature_document_changed", "detail": "signature_document_changed" } } } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\ncontent = client.sessions.signatures.download_evidence(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\",\n)\nwith open(\"download.pdf\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst content = await didit.sessions.signatures.downloadEvidence(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\",\n);\nawait writeFile(\"download.pdf\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresp, err := client.Sessions.Signatures.DownloadEvidence(ctx, \"11111111-2222-3333-4444-555555555555\", \"feature_signature\", didit.SessionsSignaturesDownloadEvidenceParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.pdf\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.sessions().signatures().downloadEvidence(\"11111111-2222-3333-4444-555555555555\", \"feature_signature\")\n .writeTo(Path.of(\"download.pdf\"));" }, { "lang": "php", "label": "PHP", "source": "sessions->signatures->downloadEvidence('11111111-2222-3333-4444-555555555555', 'feature_signature');\n$content->saveTo('download.pdf');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ncontent = didit.sessions.signatures.download_evidence(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\"\n)\nFile.binwrite(\"download.pdf\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar content = await client.Sessions.Signatures.DownloadEvidenceAsync(\"11111111-2222-3333-4444-555555555555\", \"feature_signature\");\nawait content.SaveToAsync(\"download.pdf\");" } ] } }, "/v3/session/{sessionId}/signatures/{nodeId}/fields/{fieldId}/image/": { "get": { "summary": "Скачать изображение подписи", "description": "Скачать подпись или инициалы, поставленные подписантом в поле, в формате PNG. Используйте `image_url` поля в `signatures[].documents[].fields[]`. Требуется `read:sessions`; ваш API-ключ подходит.", "operationId": "get_v3_session_signature_field_image", "x-didit-sdk": { "resource": "sessions.signatures", "method": "download_field_image", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "Сессия проверки пользователей (KYC) или верификации бизнеса (KYB).", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "nodeId", "in": "path", "required": true, "description": "Шаг «Электронная подпись»: `node_id` элемента в `signatures[]`.", "schema": { "type": "string", "example": "feature_signature" } }, { "name": "fieldId", "in": "path", "required": true, "description": "Поле в копии этого подписанта, как в `image_url` поля.", "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Изображение.", "content": { "image/png": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Сохранённое изображение больше не совпадает с записанным значением SHA-256.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "example": { "code": "signature_document_changed", "detail": "signature_document_changed" } } } }, "403": { "description": "Отсутствуют учетные данные или используются учетные данные, не позволяющие прочитать эту сессию. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "You do not have permission to perform this action." } } } }, "404": { "description": "Ни одно изображение не подходит: сессия, шаг или поле не существуют, были удалены либо не содержат добавленной подписи или инициалов.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Unknown field": { "summary": "Такое поле отсутствует", "value": { "code": "signature_field_not_found", "detail": "signature_field_not_found" } } } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\ncontent = client.sessions.signatures.download_field_image(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\",\n \"11111111-2222-3333-4444-555555555555\",\n)\nwith open(\"download.png\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst content = await didit.sessions.signatures.downloadFieldImage(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\",\n \"11111111-2222-3333-4444-555555555555\",\n);\nawait writeFile(\"download.png\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresp, err := client.Sessions.Signatures.DownloadFieldImage(ctx, \"11111111-2222-3333-4444-555555555555\", \"feature_signature\", \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.png\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.sessions().signatures().downloadFieldImage(\"11111111-2222-3333-4444-555555555555\", \"feature_signature\", \"11111111-2222-3333-4444-555555555555\")\n .writeTo(Path.of(\"download.png\"));" }, { "lang": "php", "label": "PHP", "source": "sessions->signatures->downloadFieldImage('11111111-2222-3333-4444-555555555555', 'feature_signature', '11111111-2222-3333-4444-555555555555');\n$content->saveTo('download.png');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ncontent = didit.sessions.signatures.download_field_image(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\",\n \"11111111-2222-3333-4444-555555555555\"\n)\nFile.binwrite(\"download.png\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar content = await client.Sessions.Signatures.DownloadFieldImageAsync(\"11111111-2222-3333-4444-555555555555\", \"feature_signature\", \"11111111-2222-3333-4444-555555555555\");\nawait content.SaveToAsync(\"download.png\");" } ] } }, "/v3/session/{sessionId}/signatures/{nodeId}/validate/": { "post": { "summary": "Повторно проверить подписи", "description": "Повторно проверить подписанные документы шага Электронная подпись. Didit повторно считывает каждый подписанный PDF-файл, проверяет его SHA-256 и для усиленной (AES) подписи валидирует подпись PAdES, сертификат, данные об отзыве и метку времени (простая подпись не содержит цифровой подписи, поэтому проверяется только целостность файла), затем сохраняет результат в поле `validation` каждого подписанта и возвращает обновлённые элементы. Повторное подписание не выполняется. Передайте `signature_id`, чтобы проверить одного подписанта; без него проверяется каждый подписант шага, и вызов завершается ошибкой, если кто-либо из них ещё не подписал документ.\n\nТребуется разрешение `write:sessions`; ваш API-ключ подходит. В консоли это кнопка **Проверить ещё раз**.", "operationId": "post_v3_session_signature_validate", "x-didit-sdk": { "resource": "sessions.signatures", "method": "validate", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "Сессия проверки пользователей (KYC) или верификации бизнеса (KYB).", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "nodeId", "in": "path", "required": true, "description": "Шаг «Электронная подпись»: `node_id` элемента в `signatures[]`.", "schema": { "type": "string", "example": "feature_signature" } } ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "signature_id": { "type": "string", "format": "uuid", "description": "`id` элемента подписанта в `signatures[]`." } } }, "example": { "signature_id": "0e6c2a8e-6c2f-4b8e-9a51-3f2f6a7d9b10" } } } }, "responses": { "200": { "description": "Проверенные подписанты с обновлённым полем `validation`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "signatures": { "type": "array", "items": { "$ref": "#/components/schemas/SignatureResult" } } } } } } }, "400": { "description": "Сохранённый подписанный PDF больше не совпадает со значением SHA-256, зафиксированным при подписании.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Document changed": { "summary": "Подписанный файл больше не совпадает со своим хешем", "value": { "code": "signature_document_changed", "detail": "signature_document_changed" } } } } } }, "403": { "description": "Отсутствуют учетные данные или используются учетные данные, не позволяющие прочитать эту сессию. При отсутствии ключа возвращается `403`; при неверном, отозванном или истекшем ключе возвращается `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "You do not have permission to perform this action." } } } }, "404": { "description": "Подходящая подпись не найдена: сессия, шаг или подписант не существуют или были удалены.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Unknown signer": { "summary": "Такая подпись отсутствует в этом шаге", "value": { "code": "signature_not_found", "detail": "signature_not_found" } } } } } }, "409": { "description": "Подписант шага ещё не подписал документ, поэтому проверять нечего.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Not signed": { "summary": "Подписант ещё не подписал документ", "value": { "code": "signature_not_signed", "detail": "signature_not_signed" } } } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.signatures.validate(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\",\n signature_id=\"0e6c2a8e-6c2f-4b8e-9a51-3f2f6a7d9b10\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.signatures.validate(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\",\n {\n signature_id: \"0e6c2a8e-6c2f-4b8e-9a51-3f2f6a7d9b10\",\n },\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Signatures.Validate(ctx, \"11111111-2222-3333-4444-555555555555\", \"feature_signature\", didit.SessionsSignaturesValidateParams{\n\tSignatureID: didit.String(\"0e6c2a8e-6c2f-4b8e-9a51-3f2f6a7d9b10\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsSignaturesValidateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().signatures().validate(\"11111111-2222-3333-4444-555555555555\", \"feature_signature\", SessionsSignaturesValidateParams.builder()\n .signatureId(\"0e6c2a8e-6c2f-4b8e-9a51-3f2f6a7d9b10\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->signatures->validate('11111111-2222-3333-4444-555555555555', 'feature_signature', [\n 'signature_id' => '0e6c2a8e-6c2f-4b8e-9a51-3f2f6a7d9b10',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.signatures.validate(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_signature\",\n signature_id: \"0e6c2a8e-6c2f-4b8e-9a51-3f2f6a7d9b10\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Signatures.ValidateAsync(\"11111111-2222-3333-4444-555555555555\", \"feature_signature\", new SessionsSignaturesValidateParams\n{\n SignatureId = \"0e6c2a8e-6c2f-4b8e-9a51-3f2f6a7d9b10\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/document-ai/{sessionId}/documents/{documentUuid}/": { "patch": { "summary": "Обновить документ Document AI", "description": "Скорректируйте поля, извлечённые Document AI из одного загруженного документа, установите его статус проверки или выполните и то, и другое в сессии KYC или KYB. Поле `extracted_data` должно быть JSON-объектом и объединяется по ключам: отправленный ключ заменяет сохранённое значение (ключ, переданный со значением `null`, сохраняется как `null`), а опущенные ключи сохраняют свои значения. Статус документа передаётся в результат Document AI соответствующего узла сценария в решении по сессии; сам статус сессии повторно не пересчитывается. Каждый успешный вызов, даже если он ничего не изменяет, отправляет [webhook](https://docs.didit.me/ru/integration/webhooks) `data.updated` с триггером `manual_review`. Для API-ключа с ограниченной областью действия требуется `decisions: write`; см. [Document AI](https://docs.didit.me/ru/core-technology/document-ai/overview).", "operationId": "patch_v3_document_ai_document", "x-didit-sdk": { "resource": "sessions", "method": "update_document_ai_data", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID сессии верификации (`session_id`, возвращённый `POST /v3/session/`). Принимает ID сессий как Проверки пользователей (KYC), так и Верификации бизнеса (KYB): сервер сопоставляет ID для обоих типов сессий. Должен быть корректным UUID; некорректное значение не соответствует маршруту и возвращает HTML `404`.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "documentUuid", "in": "path", "required": true, "description": "UUID документа Document AI (`document_ai_documents[].items[].uuid` в `GET /v3/session/{sessionId}/decision/`). Он должен принадлежать сессии, указанной в пути.", "schema": { "type": "string", "format": "uuid", "example": "44444444-5555-6666-7777-888888888888" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "extracted_data": { "type": "object", "additionalProperties": true, "description": "Ключи полей (ключи, которые вы настроили для документа) и их исправленные значения. Должно быть объектом JSON; объединяется по ключам с сохранёнными данными. Лучше опустить поле, чем передавать `null`, что приведёт к ошибке `400`.", "example": { "invoice_number": "INV-2026-0042" } }, "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Not Finished" ], "description": "Новый статус проверки документа.", "example": "Approved" } } }, "example": { "extracted_data": { "invoice_number": "INV-2026-0042" }, "status": "Approved" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/document-ai/11111111-2222-3333-4444-555555555555/documents/44444444-5555-6666-7777-888888888888/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"extracted_data\": {\"invoice_number\": \"INV-2026-0042\"}, \"status\": \"Approved\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_document_ai_data(\n \"11111111-2222-3333-4444-555555555555\",\n \"44444444-5555-6666-7777-888888888888\",\n extracted_data={\"invoice_number\": \"INV-2026-0042\"},\n status=\"Approved\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updateDocumentAiData(\n \"11111111-2222-3333-4444-555555555555\",\n \"44444444-5555-6666-7777-888888888888\",\n {\n extracted_data: { invoice_number: \"INV-2026-0042\" },\n status: \"Approved\",\n },\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateDocumentAiData(ctx, \"11111111-2222-3333-4444-555555555555\", \"44444444-5555-6666-7777-888888888888\", didit.SessionsUpdateDocumentAiDataParams{\n\tExtractedData: didit.Some(map[string]any{\"invoice_number\": \"INV-2026-0042\"}),\n\tStatus: didit.Some(didit.SessionsUpdateDocumentAiDataParamsStatus(\"Approved\")),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.SessionsUpdateDocumentAiDataParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updateDocumentAiData(\"11111111-2222-3333-4444-555555555555\", \"44444444-5555-6666-7777-888888888888\", SessionsUpdateDocumentAiDataParams.builder()\n .extractedData(Map.of(\"invoice_number\", \"INV-2026-0042\"))\n .status(SessionsUpdateDocumentAiDataParams.Status.of(\"Approved\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updateDocumentAiData('11111111-2222-3333-4444-555555555555', '44444444-5555-6666-7777-888888888888', [\n 'extracted_data' => ['invoice_number' => 'INV-2026-0042'],\n 'status' => 'Approved',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_document_ai_data(\n \"11111111-2222-3333-4444-555555555555\",\n \"44444444-5555-6666-7777-888888888888\",\n extracted_data: { invoice_number: \"INV-2026-0042\" },\n status: \"Approved\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdateDocumentAiDataAsync(\"11111111-2222-3333-4444-555555555555\", \"44444444-5555-6666-7777-888888888888\", new SessionsUpdateDocumentAiDataParams\n{\n ExtractedData = new Dictionary { [\"invoice_number\"] = \"INV-2026-0042\" },\n Status = new SessionsUpdateDocumentAiDataParamsStatus(\"Approved\"),\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Документ обновлён. Возвращает документ после объединения.", "content": { "application/json": { "schema": { "type": "object", "required": [ "uuid", "document_key", "original_filename", "file_url", "status", "extracted_data" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Идентификатор документа." }, "document_key": { "type": "string", "description": "Настроенный документ, которому соответствует эта загрузка." }, "original_filename": { "type": "string", "nullable": true, "description": "Имя файла, с которым был загружен документ." }, "file_url": { "type": "string", "nullable": true, "description": "Путь хранения загруженного файла. Это не ссылка на скачивание: чтобы скачать файл, прочитайте предварительно подписанный `file_url` из решения по сессии." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Статус проверки документа." }, "extracted_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Все извлечённые поля после объединения, с ключами, соответствующими ключам полей." } } }, "example": { "uuid": "44444444-5555-6666-7777-888888888888", "document_key": "invoice", "original_filename": "invoice-2026-09.pdf", "file_url": "document_ai/11111111-2222-3333-4444-555555555555-66666666-7777-8888-9999-000000000000.pdf", "status": "Approved", "extracted_data": { "invoice_number": "INV-2026-0042", "total_amount": 1250.0, "issue_date": "2026-09-01" } } } } }, "400": { "description": "Ошибка валидации; проверка выполняется до поиска документа: `status` не входит в список допустимых значений или `extracted_data` передан как `null`.", "content": { "application/json": { "examples": { "Invalid status": { "summary": "status отсутствует в перечислении enum", "value": { "status": [ "\"Rejected\" is not a valid choice." ] } }, "Null extracted_data": { "summary": "extracted_data имеет значение null", "value": { "extracted_data": [ "This field may not be null." ] } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Это единственный случай, возвращающий `401`: отсутствующий, недействительный или отозванный ключ возвращает `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Expired key": { "summary": "Срок действия ключа истёк", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Ошибка аутентификации или авторизации. Отсутствующий ключ возвращает `403`, как и ключ другого приложения, ключ с ограниченной областью действия без необходимого для этого endpoint разрешения, а также запрос не из разрешённого списка IP-адресов ключа; неверный, отозванный или истекший ключ возвращает `401`. Различайте их по полю `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Missing or invalid credentials": { "summary": "Заголовок x-api-key отсутствует, либо ключ не прошёл валидацию", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Действительный ключ, принадлежащий приложению, отличному от приложения сессии", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "У ключа с ограниченной областью действия отсутствует разрешение decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Запрос с IP-адреса вне списка разрешённых IP ключа", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Сессия не существует, была удалена или находится за пределами ограничений ключа с ограниченным доступом, либо к ней не относится ни один текущий документ с этим UUID. Поиск сессии выполняется до проверки учетных данных, поэтому неизвестный `sessionId` возвращает `404` даже без действительного ключа.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Unknown session": { "summary": "Сессия с этим ID не существует или была удалена", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "Сессия находится за пределами ограничений ключа с ограниченным доступом (также возвращается для сессии, удаленной только что)", "value": { "detail": "Session not found." } }, "Unknown document": { "summary": "documentUuid не принадлежит сессии", "value": { "detail": "Document AI document not found." } } } } } }, "429": { "description": "Превышен лимит запросов: 300 запросов на запись (POST, PATCH, DELETE) в минуту на один API-ключ. Подождите указанное в `Retry-After` количество секунд перед повторной попыткой; заголовки `X-RateLimit-*` показывают доступный лимит.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Rate limited": { "summary": "Бюджет на текущую минуту исчерпан", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/aml/dataset-freshness/": { "get": { "summary": "Получить актуальность набора данных AML", "description": "Предоставить отчёт об актуальности наборов данных, используемых для AML-скрининга, по семействам источников (`sanctions`, `pep`, `warnings`, `adverse_media`), в качестве аудиторских доказательств для [постоянного AML-мониторинга](https://docs.didit.me/ru/core-technology/aml-screening/continuous-monitoring-aml-screening#подтверждение-выполнения-мониторинга). Ответ относится ко всей платформе: пути не содержат сессии, тело не содержит данных клиентов, ответ одинаков для каждого приложения.\n\nВсегда возвращает `200` при валидном ключе. Сначала проверьте `availability`: если значение не `available`, то `dataset_freshness` равен `null`. Даты никогда не оцениваются приблизительно: семейство, наборы данных которого не сообщили дату, отсутствует в `sources`, а для семейства, где дату сообщили лишь некоторые наборы данных, установлено `oldest_updated_at: null`. Показатели фиксируются во время работы постоянного мониторинга, а не при каждом вызове; `captured_at` указывает время фиксации.\n\nAPI-ключу с ограниченной областью действия требуется разрешение `sessions: read`; ключ, ограниченный определёнными сценариями или одобренными сессиями, не может вызывать этот endpoint. Плата не взимается.", "operationId": "get_aml_dataset_freshness", "x-didit-sdk": { "resource": "aml", "method": "retrieve_dataset_freshness", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "parameters": [], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/aml/dataset-freshness/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.aml.retrieve_dataset_freshness()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.aml.retrieveDatasetFreshness();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.AML.RetrieveDatasetFreshness(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.aml().retrieveDatasetFreshness();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "aml->retrieveDatasetFreshness();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.aml.retrieve_dataset_freshness\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Aml.RetrieveDatasetFreshnessAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Последнее значение актуальности набора данных или `null` с указанием причины.", "content": { "application/json": { "schema": { "type": "object", "required": [ "dataset_freshness", "availability" ], "properties": { "dataset_freshness": { "allOf": [ { "$ref": "#/components/schemas/AMLDatasetFreshness" } ], "nullable": true, "description": "Последнее значение или `null`, если `availability` не равно `available`." }, "availability": { "type": "string", "enum": [ "available", "not_configured", "not_yet_collected" ], "description": "`available`, если показание существует; `not_configured`, если даты наборов данных не собираются в этой среде; `not_yet_collected`, если сбор настроен, но показаний пока нет." } } }, "examples": { "Available": { "value": { "dataset_freshness": { "captured_at": "2026-10-17T06:00:12.345678+00:00", "provider": "aml_data_source", "catalog_version": "20261017054500-abc", "sources": { "sanctions": { "last_updated_at": "2026-10-17T04:10:00+00:00", "oldest_updated_at": "2026-10-15T22:30:00+00:00", "dataset_count": 48, "dated_dataset_count": 48 }, "pep": { "last_updated_at": "2026-10-16T23:05:00+00:00", "oldest_updated_at": null, "dataset_count": 12, "dated_dataset_count": 11 } } }, "availability": "available" } }, "Not collected yet": { "value": { "dataset_freshness": null, "availability": "not_yet_collected" } } } } } }, "401": { "description": "Срок действия API-ключа истёк. Истечь может только ключ, созданный со сроком действия; после этой даты каждый запрос с ним возвращает `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Запрос запрещён. При отсутствии ключа возвращается стандартное сообщение; при неверном, отозванном или истёкшем ключе возвращается `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without sessions read": { "value": { "detail": "This API key has no read access to sessions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "Outside the key's IP list": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "429": { "description": "Более 600 GET-запросов в минуту с этим API-ключом. Подождите указанное в `Retry-After` количество секунд, затем повторите попытку.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Количество секунд до сброса текущего минутного окна.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Количество разрешённых запросов в минуту в рамках этого бюджета.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Количество оставшихся запросов в текущем окне.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix-время, когда окно сбрасывается.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/lists/": { "get": { "summary": "Получить списки", "description": "Возвращает списки приложения, начиная с самых новых: системные списки, предоставляемые Didit (по одному списку блокировки на каждый тип записи, пользовательский список **High Risk Countries** и любые системные списки разрешений), а также созданные вами списки разрешений и пользовательские списки. Фильтрация с помощью `list_type` и `entry_type`; удалённые списки никогда не отображаются. Результаты разбиты на страницы с использованием `limit` и `offset`. Для API-ключа с ограниченной областью действия требуется разрешение `workflows: read`. О назначении каждого типа списков см. в разделе [Списки](https://docs.didit.me/ru/management-api/lists/overview).", "operationId": "list_lists", "x-didit-sdk": { "resource": "lists", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Lists" ], "parameters": [ { "name": "list_type", "in": "query", "required": false, "description": "Только списки этого типа.", "schema": { "type": "string", "enum": [ "blocklist", "allowlist", "custom" ] } }, { "name": "entry_type", "in": "query", "required": false, "description": "Только списки с этим типом записей.", "schema": { "type": "string", "enum": [ "face", "document", "phone", "email", "ip_address", "device_fingerprint", "wallet_address", "bank_account", "country", "user", "business", "key" ] } }, { "name": "ordering", "in": "query", "required": false, "description": "Порядок сортировки: `-created_at` (сначала новые, по умолчанию) или `created_at` (сначала старые).", "schema": { "type": "string", "enum": [ "-created_at", "created_at" ], "default": "-created_at" } }, { "name": "limit", "in": "query", "required": false, "description": "Размер страницы. По умолчанию 50. Значение больше 1000000 возвращает `400`; для нулевого, отрицательного или нечислового значения используется 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 } }, { "name": "offset", "in": "query", "required": false, "description": "Индекс первого возвращаемого элемента, начиная с нуля. Рекомендуется переходить по ссылке `next`. Значение больше 1000000 возвращает `400`; отрицательное или нечисловое значение сбрасывается на 0.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/lists/?list_type=blocklist' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.lists.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.lists.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Lists.ListAutoPaging(ctx, didit.ListsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.lists().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "lists->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.lists.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Lists.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Страница списков.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "minimum": 0, "description": "Общее количество списков, соответствующих фильтрам." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "Абсолютный URL следующей страницы или `null` на последней странице." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "Абсолютный URL предыдущей страницы или `null` на первой странице." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ComplianceList" } } } }, "examples": { "Lists": { "value": { "count": 2, "next": null, "previous": null, "results": [ { "uuid": "22222222-3333-4444-5555-666666666666", "name": "Trusted office IPs", "description": "Office egress ranges", "list_type": "allowlist", "entry_type": "ip_address", "is_system": false, "entry_count": 3, "last_entry_added_at": "2026-10-02T08:15:27.501334Z", "created_at": "2026-09-30T13:20:45.889120Z", "updated_at": "2026-09-30T13:20:45.889120Z" }, { "uuid": "11111111-2222-3333-4444-555555555555", "name": "Face Blocklist", "description": "Blocked biometric faces. When a face matching an entry in this list is detected during liveness verification, the session will be automatically declined.", "list_type": "blocklist", "entry_type": "face", "is_system": true, "entry_count": 12, "last_entry_added_at": "2026-10-09T16:42:03.118204Z", "created_at": "2026-01-14T10:02:11.402917Z", "updated_at": "2026-01-14T10:02:11.402917Z" } ] } } } } } }, "400": { "description": "Недопустимый параметр запроса.", "content": { "application/json": { "examples": { "Unknown list type": { "value": { "list_type": [ "\"denylist\" is not a valid choice." ] } }, "Unsupported ordering": { "value": { "ordering": [ "\"name\" is not a valid choice." ] } }, "Limit too large": { "value": [ "limit must not exceed 1000000." ] } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Другие ошибки аутентификации возвращают `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Заголовок `x-api-key` отсутствует (при неверном, отозванном или истёкшем ключе возвращается `401`), либо API-ключ с ограниченной областью действия не имеет разрешения `workflows: read` или используется с IP-адреса вне своего списка разрешённых.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no read access to workflows." } } } } } }, "429": { "description": "Превышен общий лимит на чтение в 600 запросов в минуту на один API-ключ. Подождите время, указанное в `Retry-After`, перед повторной попыткой.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Создать список", "description": "Создаёт список разрешений или кастомный список в приложении, которому принадлежит API-ключ. Списки блокировки создавать нельзя: Didit предоставляет один системный список блокировки для каждого типа записей, и вы добавляете элементы в него через [Create a list entry](https://docs.didit.me/ru/management-api/lists/create-entry). Параметр `entry_type` нельзя изменить после создания; он определяет, как валидируются и сопоставляются значения записей. Записи в списке разрешений отмечают совпавшие элементы как доверенные (например, список разрешений лиц пропускает действие по дубликату лица) и никогда не переопределяют совпадение со списком блокировки; ссылайтесь на любой список из условия правила сценария или транзакции с помощью `value_type: \"list\"`. Для API-ключа с ограниченными правами требуется разрешение `workflows: write`.", "operationId": "create_list", "x-didit-sdk": { "resource": "lists", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Lists" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "list_type", "entry_type" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Название списка. Должно отличаться от названий всех остальных списков приложения, включая системные списки." }, "description": { "type": "string", "default": "", "description": "Необязательное текстовое описание в свободной форме." }, "list_type": { "type": "string", "enum": [ "allowlist", "custom" ], "description": "`allowlist` или `custom`. `blocklist` отклоняется с кодом `400`." }, "entry_type": { "type": "string", "enum": [ "face", "document", "phone", "email", "ip_address", "device_fingerprint", "wallet_address", "bank_account", "country", "user", "business", "key" ], "description": "Что содержит список: `face`, `document` (номер документа), `phone`, `email`, `ip_address` (IP-адрес или диапазон CIDR), `device_fingerprint`, `wallet_address`, `bank_account`, `country` (ISO 3166-1 alpha-3), `user` или `business` (ваши `vendor_data`), либо `key` (любая строка). Это определяет, как проверяются и сопоставляются значения записей. Его нельзя изменить позже." } } }, "examples": { "IP allowlist": { "value": { "name": "Trusted office IPs", "description": "Office egress ranges", "list_type": "allowlist", "entry_type": "ip_address" } }, "Custom country list": { "value": { "name": "Enhanced due diligence countries", "list_type": "custom", "entry_type": "country" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/lists/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"name\": \"Trusted office IPs\",\n \"description\": \"Office egress ranges\",\n \"list_type\": \"allowlist\",\n \"entry_type\": \"ip_address\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.lists.create(\n name=\"Trusted office IPs\",\n description=\"Office egress ranges\",\n list_type=\"allowlist\",\n entry_type=\"ip_address\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.lists.create({\n name: \"Trusted office IPs\",\n description: \"Office egress ranges\",\n list_type: \"allowlist\",\n entry_type: \"ip_address\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Create(ctx, didit.ListsCreateParams{\n\tName: \"Trusted office IPs\",\n\tDescription: didit.String(\"Office egress ranges\"),\n\tListType: \"allowlist\",\n\tEntryType: \"ip_address\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.ListsCreateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.lists().create(ListsCreateParams.builder()\n .name(\"Trusted office IPs\")\n .description(\"Office egress ranges\")\n .listType(ListsCreateParams.ListType.of(\"allowlist\"))\n .entryType(ListsCreateParams.EntryType.of(\"ip_address\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "lists->create([\n 'name' => 'Trusted office IPs',\n 'description' => 'Office egress ranges',\n 'list_type' => 'allowlist',\n 'entry_type' => 'ip_address',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.lists.create(\n name: \"Trusted office IPs\",\n description: \"Office egress ranges\",\n list_type: \"allowlist\",\n entry_type: \"ip_address\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Lists.CreateAsync(new ListsCreateParams\n{\n Name = \"Trusted office IPs\",\n Description = \"Office egress ranges\",\n ListType = \"allowlist\",\n EntryType = \"ip_address\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Список создан.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplianceList" }, "examples": { "New allowlist": { "value": { "uuid": "22222222-3333-4444-5555-666666666666", "name": "Trusted office IPs", "description": "Office egress ranges", "list_type": "allowlist", "entry_type": "ip_address", "is_system": false, "entry_count": 0, "last_entry_added_at": null, "created_at": "2026-10-12T09:15:44.031876Z", "updated_at": "2026-10-12T09:15:44.031876Z" } } } } } }, "400": { "description": "Некорректное тело запроса.", "content": { "application/json": { "examples": { "Blocklist refused": { "value": { "list_type": [ "Cannot create additional blocklist lists. System blocklists are auto-created for each application." ] } }, "Duplicate name": { "value": { "name": [ "A list with this name already exists for this application." ] } }, "Missing fields": { "value": { "name": [ "This field is required." ], "list_type": [ "This field is required." ], "entry_type": [ "This field is required." ] } }, "Unknown entry type": { "value": { "entry_type": [ "\"iban\" is not a valid choice." ] } }, "Name too long": { "value": { "name": [ "Ensure this field has no more than 255 characters." ] } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Другие ошибки аутентификации возвращают `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Заголовок `x-api-key` отсутствует (при неверном, отозванном или истёкшем ключе возвращается `401`), либо API-ключ с ограниченной областью действия не имеет разрешения `workflows: write` или используется с IP-адреса вне своего списка разрешённых.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no write access to workflows." } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/lists/{list_uuid}/": { "get": { "summary": "Получить список", "description": "Возвращает один список приложения с количеством записей и временем добавления самой новой записи. Список другого приложения или удалённый список возвращает `404`. Этот запрос возвращает только сам список: его значения можно прочитать с помощью [Получение записей списка](https://docs.didit.me/ru/management-api/lists/list-entries). Для API-ключа с ограниченной областью действия требуется разрешение `workflows: read`.", "operationId": "get_list", "x-didit-sdk": { "resource": "lists", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Lists" ], "parameters": [ { "name": "list_uuid", "in": "path", "required": true, "description": "UUID списка, возвращённый методами List lists или Create a list.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.lists.retrieve(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.lists.retrieve(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.lists().retrieve(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "lists->retrieve('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.lists.retrieve(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Lists.RetrieveAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Список.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplianceList" }, "examples": { "System face blocklist": { "value": { "uuid": "11111111-2222-3333-4444-555555555555", "name": "Face Blocklist", "description": "Blocked biometric faces. When a face matching an entry in this list is detected during liveness verification, the session will be automatically declined.", "list_type": "blocklist", "entry_type": "face", "is_system": true, "entry_count": 12, "last_entry_added_at": "2026-10-09T16:42:03.118204Z", "created_at": "2026-01-14T10:02:11.402917Z", "updated_at": "2026-01-14T10:02:11.402917Z" } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Другие ошибки аутентификации возвращают `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Заголовок `x-api-key` отсутствует (при неверном, отозванном или истёкшем ключе возвращается `401`), либо API-ключ с ограниченной областью действия не имеет разрешения `workflows: read` или используется с IP-адреса вне своего списка разрешённых.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no read access to workflows." } } } } } }, "404": { "description": "Списка с таким UUID не существует в приложении этого API-ключа, или он был удален.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "No List matches the given query." } } } } } }, "429": { "description": "Превышен общий лимит на чтение в 600 запросов в минуту на один API-ключ. Подождите время, указанное в `Retry-After`, перед повторной попыткой.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Обновить список", "description": "Переименовывает список или изменяет его описание. Считываются только `name` и `description`; любые другие поля игнорируются, поэтому `list_type` и `entry_type` сохраняют значения, с которыми они были созданы. Системные списки нельзя изменять, возвращается `400`. Ответ содержит только `name` и `description`: вызовите [Получить список](https://docs.didit.me/ru/management-api/lists/get) для получения полного списка. Для API-ключа с ограниченной областью действия требуется `workflows: write`.", "operationId": "update_list", "x-didit-sdk": { "resource": "lists", "method": "update", "auth": "api_key", "server": true }, "tags": [ "Lists" ], "parameters": [ { "name": "list_uuid", "in": "path", "required": true, "description": "UUID списка, возвращённый методами List lists или Create a list.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Новое имя. Должно отличаться от имён всех остальных списков приложения." }, "description": { "type": "string", "description": "Новое описание. Передайте пустую строку, чтобы очистить его." } } }, "examples": { "Rename": { "value": { "name": "Trusted office and VPN IPs" } }, "Rename and describe": { "value": { "name": "Trusted office and VPN IPs", "description": "Office egress ranges and the corporate VPN" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"name\": \"Trusted office and VPN IPs\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.lists.update(\n \"11111111-2222-3333-4444-555555555555\",\n name=\"Trusted office and VPN IPs\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.lists.update(\"11111111-2222-3333-4444-555555555555\", {\n name: \"Trusted office and VPN IPs\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.ListsUpdateParams{\n\tName: didit.String(\"Trusted office and VPN IPs\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.ListsUpdateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.lists().update(\"11111111-2222-3333-4444-555555555555\", ListsUpdateParams.builder()\n .name(\"Trusted office and VPN IPs\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "lists->update('11111111-2222-3333-4444-555555555555', [\n 'name' => 'Trusted office and VPN IPs',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.lists.update(\n \"11111111-2222-3333-4444-555555555555\",\n name: \"Trusted office and VPN IPs\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Lists.UpdateAsync(\"11111111-2222-3333-4444-555555555555\", new ListsUpdateParams\n{\n Name = \"Trusted office and VPN IPs\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Список обновлён. Возвращаются только редактируемые поля.", "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "description" ], "properties": { "name": { "type": "string", "description": "Название списка после обновления." }, "description": { "type": "string", "description": "Описание списка после обновления." } } }, "examples": { "Renamed": { "value": { "name": "Trusted office and VPN IPs", "description": "Office egress ranges" } } } } } }, "400": { "description": "Список является системным, либо тело запроса недействительно.", "content": { "application/json": { "examples": { "System list": { "value": { "non_field_errors": [ "System lists cannot be modified." ] } }, "Duplicate name": { "value": { "name": [ "A list with this name already exists for this application." ] } }, "Blank name": { "value": { "name": [ "This field may not be blank." ] } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Другие ошибки аутентификации возвращают `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Заголовок `x-api-key` отсутствует (при неверном, отозванном или истёкшем ключе возвращается `401`), либо API-ключ с ограниченной областью действия не имеет разрешения `workflows: write` или используется с IP-адреса вне своего списка разрешённых.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no write access to workflows." } } } } } }, "404": { "description": "Списка с таким UUID не существует в приложении этого API-ключа, или он был удален.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "No List matches the given query." } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "summary": "Удалить список", "description": "Удаляет список разрешений или кастомный список вместе с его записями. Удаление необратимо: список и его записи больше не отображаются ни в каких операциях чтения, а условия правил сценариев и транзакций, ссылающиеся на этот список, с этого момента оценивают его как пустой список. Уже проверенные сессии и транзакции сохраняют свои результаты, а имя можно использовать повторно для нового списка. Системные списки удалить нельзя, при попытке возвращается `400`; чтобы очистить такой список, [удалите его записи](https://docs.didit.me/ru/management-api/lists/delete-entry). Для API-ключа с ограниченной областью действия требуется разрешение `workflows: write`.", "operationId": "delete_list", "x-didit-sdk": { "resource": "lists", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Lists" ], "parameters": [ { "name": "list_uuid", "in": "path", "required": true, "description": "UUID списка, возвращённый методами List lists или Create a list.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.lists.delete(\n \"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.lists.delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.Lists.Delete(ctx, \"11111111-2222-3333-4444-555555555555\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.lists().delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "php", "label": "PHP", "source": "lists->delete('11111111-2222-3333-4444-555555555555');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.lists.delete(\"11111111-2222-3333-4444-555555555555\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.Lists.DeleteAsync(\"11111111-2222-3333-4444-555555555555\");" } ], "responses": { "204": { "description": "Список и его записи были удалены. Тело ответа отсутствует." }, "400": { "description": "Список является системным.", "content": { "application/json": { "examples": { "System list": { "value": { "detail": "System lists cannot be deleted." } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Другие ошибки аутентификации возвращают `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Заголовок `x-api-key` отсутствует (при неверном, отозванном или истёкшем ключе возвращается `401`), либо API-ключ с ограниченной областью действия не имеет разрешения `workflows: write` или используется с IP-адреса вне своего списка разрешённых.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no write access to workflows." } } } } } }, "404": { "description": "Списка с таким UUID не существует в приложении этого API-ключа, или он уже был удален.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "No List matches the given query." } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/lists/{list_uuid}/entries/": { "get": { "summary": "Получить список записей списка", "description": "Возвращает текущие записи одного списка, начиная с самых новых. Параметр `search` выполняет нечувствительный к регистру поиск по части `value` или `display_label` записи, а `reference_session_id` ограничивает результаты записями, полученными из одной сессии верификации пользователя. URL-адреса изображений в `metadata` представляют собой временные подписанные URL-адреса, генерируемые заново при каждом вызове; API-ключ с ограниченной областью действия без `media: read` получает вместо них `null`. Для API-ключа с ограниченной областью действия требуется разрешение `workflows: read`.", "operationId": "list_list_entries", "x-didit-sdk": { "resource": "lists.entries", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Lists" ], "parameters": [ { "name": "list_uuid", "in": "path", "required": true, "description": "UUID списка, возвращённый методами List lists или Create a list.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "search", "in": "query", "required": false, "description": "Текст без учёта регистра, который должно содержать поле `value` или `display_label` записи.", "schema": { "type": "string" } }, { "name": "reference_session_id", "in": "query", "required": false, "description": "Только записи, полученные из этой сессии верификации личности, например, чтобы увидеть, какие из её лиц уже внесены в списки.", "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "description": "Размер страницы. По умолчанию 50. Значение больше 1000000 возвращает `400`; для нулевого, отрицательного или нечислового значения используется 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 } }, { "name": "offset", "in": "query", "required": false, "description": "Индекс первого возвращаемого элемента, начиная с нуля. Рекомендуется переходить по ссылке `next`. Значение больше 1000000 возвращает `400`; отрицательное или нечисловое значение сбрасывается на 0.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/entries/?search=example.com' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.lists.entries.list(\n \"11111111-2222-3333-4444-555555555555\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.lists.entries.list(\"11111111-2222-3333-4444-555555555555\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Lists.Entries.ListAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.ListsEntriesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.lists().entries().list(\"11111111-2222-3333-4444-555555555555\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "lists->entries->list('11111111-2222-3333-4444-555555555555') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.lists.entries.list(\"11111111-2222-3333-4444-555555555555\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Lists.Entries.ListAsync(\"11111111-2222-3333-4444-555555555555\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Страница записей, начиная с самых новых.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "minimum": 0, "description": "Общее количество записей, соответствующих фильтрам." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "Абсолютный URL следующей страницы или `null` на последней странице." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "Абсолютный URL предыдущей страницы или `null` на первой странице." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ComplianceListEntry" } } } }, "examples": { "Entries": { "value": { "count": 2, "next": null, "previous": null, "results": [ { "uuid": "bbbbbbbb-cccc-dddd-eeee-ffffffffffff", "value": "X1234567", "display_label": "Jane Doe - X1234567", "comment": "", "added_by": "api", "reference_session_id": "33333333-4444-5555-6666-777777777777", "reference_session_number": 1042, "reference_session_type": "kyc", "reference_object_uuid": "66666666-7777-8888-9999-000000000000", "metadata": { "full_name": "Jane Doe", "issuing_state": "ESP", "document_type": "ID", "region": "", "document_number": "X1234567" }, "created_at": "2026-10-12T10:06:12.774915Z" }, { "uuid": "eeeeeeee-ffff-0000-1111-222222222222", "value": "y7654321", "display_label": "", "comment": "Reported by a partner", "added_by": "api", "reference_session_id": null, "reference_session_number": null, "reference_session_type": null, "reference_object_uuid": null, "metadata": null, "created_at": "2026-10-03T07:48:30.552810Z" } ] } } } } } }, "400": { "description": "Недопустимый параметр запроса.", "content": { "application/json": { "examples": { "Invalid session id": { "value": { "reference_session_id": [ "Must be a valid UUID." ] } }, "Limit too large": { "value": [ "limit must not exceed 1000000." ] } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Другие ошибки аутентификации возвращают `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Заголовок `x-api-key` отсутствует (при неверном, отозванном или истёкшем ключе возвращается `401`), либо API-ключ с ограниченной областью действия не имеет разрешения `workflows: read` или используется с IP-адреса вне своего списка разрешённых.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no read access to workflows." } } } } } }, "404": { "description": "Списка с таким UUID не существует в приложении этого API-ключа, или он был удален.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "List not found." } } } } } }, "429": { "description": "Превышен общий лимит на чтение в 600 запросов в минуту на один API-ключ. Подождите время, указанное в `Retry-After`, перед повторной попыткой.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Создать запись в списке", "description": "Добавляет одну запись в список одним из трех способов: по `value`; из сессии верификации с `reference_session_id`, где Didit считывает значение из самой последней записи сессии для типа записи списка и связывает запись с ней; или по `value` с `reference_object_uuid` и `metadata.reference_type`, указывающими на транзакцию, пользователя или компанию. В системных списках блокировки лиц, документов, телефонов и email запись, считанная из сессии, также помечается как добавленная в список блокировки, поэтому новые совпадающие сессии будут отклонены; в системных списках блокировки пользователей и компаний совпадающие пользователи или компании переводятся в статус `BLOCKED`. Уже завершенные сессии и транзакции не изменяются. Для ограниченного API-ключа требуется разрешение `workflows: write`. См. раздел [Создание записи списка](https://docs.didit.me/ru/management-api/lists/create-entry) для каждого режима.", "operationId": "create_list_entry", "x-didit-sdk": { "resource": "lists.entries", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Lists" ], "parameters": [ { "name": "list_uuid", "in": "path", "required": true, "description": "UUID списка, в который нужно добавить запись. Если лицо есть только в виде изображения, используйте вместо этого Upload a face to a list.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Отправьте `value`, `reference_session_id` или оба параметра. Какие поля применимы, зависит от `entry_type` списка.", "properties": { "value": { "type": "string", "description": "Значение для включения в список, проверяемое на соответствие параметру списка `entry_type`: для `email`: корректный адрес электронной почты; для `phone`: корректный международный номер, сохраняемый в формате E.164; для `ip_address`: IP-адрес или CIDR-диапазон (например, `10.0.0.0/8`); для `device_fingerprint`: не менее 8 символов, состоящих из букв, цифр, `-`, `_`, `:` и `.` (список блокировки отклоняет отпечаток, о котором сообщили несколько различных устройств); для `country`: код ISO 3166-1 alpha-2 или alpha-3, сохраняемый как alpha-3; для `user` и `business`: значение `vendor_data`; для любого другого типа: непустая строка. Сохраняется в нижнем регистре, за исключением телефонных номеров и кодов стран, при этом список содержит каждое значение только один раз (без учёта регистра). Обязательно, если не передан `reference_session_id`; должно оставаться пустым при `face_image_source` с захватом документа." }, "reference_session_id": { "type": "string", "format": "uuid", "description": "Сессия верификации личности или компании вашего приложения, из которой берётся значение. Didit считывает самую последнюю запись сессии для указанного типа (`face`, `document`, `phone`, `email`, `ip_address` или `device_fingerprint`), связывает запись списка с сессией и этой записью, а также заполняет `display_label` и `metadata` для документов. Для списка блокировки типа `device_fingerprint` сессия, имеющая только отпечаток класса устройства или завершённая более чем на одном устройстве, отклоняется: передайте точный фингерпринт в качестве `value`. Для других типов записей или если в сессии нет такой записи, также передайте `value`; в этом случае ваше значение `value` сохраняется, а запись всё равно связывается с сессией." }, "reference_object_uuid": { "type": "string", "format": "uuid", "description": "UUID записи, которой соответствует элемент, если он получен не из сессии: UUID транзакции или `didit_internal_id` пользователя либо компании. Используйте в паре с `metadata.reference_type`. Заменяется записью сессии, если указан `reference_session_id`." }, "face_image_source": { "type": "string", "enum": [ "liveness", "front_image_camera_front", "back_image_camera_front" ], "default": "liveness", "description": "Списки лиц с `reference_session_id`: из какого изображения сессии взято лицо. `liveness` (по умолчанию) означает селфи проверки живости. `front_image_camera_front` и `back_image_camera_front` представляют собой селфи, сделанные фронтальной камерой во время фотографирования пользователем лицевой или обратной стороны документа: принимаются только в системном списке блокировки лиц, с `reference_session_id` и пустым `value`. Каждое селфи можно добавить один раз, и на нем должно быть четко видно одно лицо." }, "reference_node_id": { "type": "string", "nullable": true, "maxLength": 100, "description": "При `face_image_source` из захвата документа: узел верификации личности, чьё селфи использовать (для сценариев с несколькими узлами). По умолчанию используется самая последняя верификация личности с этим изображением. Отклоняется при `liveness`." }, "display_label": { "type": "string", "maxLength": 512, "description": "Понятная метка. Если она пуста, Didit формирует её на основе сессии, где это возможно (например, имя владельца и номер документа)." }, "comment": { "type": "string", "description": "Примечание в виде произвольного текста, например причина включения в список." }, "metadata": { "type": "object", "additionalProperties": true, "description": "JSON в свободной форме, сохраняемый с записью и возвращаемый в сохранённом виде. Используйте `reference_type` и `reference_id`, чтобы консоль ссылалась на первоисточник. Поля `reference_image_url` и `front_image_url` задаются только Didit и игнорируются при их отправке вами. Для записи, считанной из сессии, ключи Didit объединяются с вашими.", "properties": { "reference_type": { "type": "string", "enum": [ "transaction", "vendor_user", "vendor_business" ], "description": "На что указывает `reference_object_uuid`." }, "reference_id": { "type": "string", "description": "Идентификатор исходной записи." } } } } }, "examples": { "By value": { "value": { "value": "+14155552671", "comment": "Reported fraud" } }, "From a session": { "value": { "reference_session_id": "33333333-4444-5555-6666-777777777777" } }, "Face from a document-capture selfie": { "value": { "reference_session_id": "33333333-4444-5555-6666-777777777777", "face_image_source": "front_image_camera_front" } }, "From a transaction": { "value": { "value": "0x52908400098527886E0F7030069857D2E4169EE7", "reference_object_uuid": "55555555-6666-7777-8888-999999999999", "comment": "Linked to a chargeback", "metadata": { "reference_type": "transaction", "reference_id": "55555555-6666-7777-8888-999999999999" } } }, "Country": { "value": { "value": "PRK", "comment": "Sanctioned jurisdiction" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/entries/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"value\": \"+14155552671\", \"comment\": \"Reported fraud\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.lists.entries.create(\n \"11111111-2222-3333-4444-555555555555\",\n value=\"+14155552671\",\n comment=\"Reported fraud\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.lists.entries.create(\"11111111-2222-3333-4444-555555555555\", {\n value: \"+14155552671\",\n comment: \"Reported fraud\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Entries.Create(ctx, \"11111111-2222-3333-4444-555555555555\", didit.ListsEntriesCreateParams{\n\tValue: didit.String(\"+14155552671\"),\n\tComment: didit.String(\"Reported fraud\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.ListsEntriesCreateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.lists().entries().create(\"11111111-2222-3333-4444-555555555555\", ListsEntriesCreateParams.builder()\n .value(\"+14155552671\")\n .comment(\"Reported fraud\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "lists->entries->create('11111111-2222-3333-4444-555555555555', [\n 'value' => '+14155552671',\n 'comment' => 'Reported fraud',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.lists.entries.create(\n \"11111111-2222-3333-4444-555555555555\",\n value: \"+14155552671\",\n comment: \"Reported fraud\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Lists.Entries.CreateAsync(\"11111111-2222-3333-4444-555555555555\", new ListsEntriesCreateParams\n{\n Value = \"+14155552671\",\n Comment = \"Reported fraud\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Запись была создана.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplianceListEntry" }, "examples": { "By value": { "value": { "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "value": "+14155552671", "display_label": "", "comment": "Reported fraud", "added_by": "api", "reference_session_id": null, "reference_session_number": null, "reference_session_type": null, "reference_object_uuid": null, "metadata": null, "created_at": "2026-10-12T10:04:51.220391Z" } }, "Document from a session": { "value": { "uuid": "bbbbbbbb-cccc-dddd-eeee-ffffffffffff", "value": "X1234567", "display_label": "Jane Doe - X1234567", "comment": "", "added_by": "api", "reference_session_id": "33333333-4444-5555-6666-777777777777", "reference_session_number": 1042, "reference_session_type": "kyc", "reference_object_uuid": "66666666-7777-8888-9999-000000000000", "metadata": { "full_name": "Jane Doe", "issuing_state": "ESP", "document_type": "ID", "region": "", "document_number": "X1234567" }, "created_at": "2026-10-12T10:06:12.774915Z" } }, "From a transaction": { "value": { "uuid": "dddddddd-eeee-ffff-0000-111111111111", "value": "0x52908400098527886e0f7030069857d2e4169ee7", "display_label": "", "comment": "Linked to a chargeback", "added_by": "api", "reference_session_id": null, "reference_session_number": null, "reference_session_type": null, "reference_object_uuid": "55555555-6666-7777-8888-999999999999", "metadata": { "reference_type": "transaction", "reference_id": "55555555-6666-7777-8888-999999999999" }, "created_at": "2026-10-12T10:20:40.117062Z" } } } } } }, "400": { "description": "Некорректное тело запроса, значение уже находится в списке или сессия не может предоставить это значение.", "content": { "application/json": { "examples": { "Nothing to list": { "value": { "value": [ "Either 'value' or 'reference_session_id' must be provided." ] } }, "Duplicate value": { "value": { "value": [ "An entry with this value already exists in this list." ] } }, "Invalid phone": { "value": { "value": [ "Invalid phone number. Provide a valid international number (e.g. +1234567890)." ] } }, "Invalid IP": { "value": { "value": [ "Invalid IP address or CIDR range (e.g. 192.168.1.1 or 10.0.0.0/24)." ] } }, "Invalid country": { "value": { "value": [ "Invalid country code: XX. Provide a valid ISO 3166-1 alpha-2 or alpha-3 country code." ] } }, "Device-class fingerprint": { "value": { "value": [ "This value is a device-class fingerprint: several distinct devices have reported it, so blocklisting it would decline unrelated people. Block the user by document, face, email or phone instead." ] } }, "Unknown session": { "value": { "reference_session_id": [ "Session not found or does not belong to this application." ] } }, "No data in session": { "value": { "value": [ "Either provide a 'value' or ensure the session contains data for this entry type." ] } }, "Selfie on another list": { "value": { "face_image_source": [ "A document-capture selfie can only be added to the face blocklist." ] } }, "No clear face in selfie": { "value": { "face_image_source": [ "No clear face was found in this selfie, so it cannot be blocklisted." ] } }, "Selfie already listed": { "value": { "face_image_source": [ "This selfie is already in the blocklist." ] } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Другие ошибки аутентификации возвращают `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Заголовок `x-api-key` отсутствует (при неверном, отозванном или истёкшем ключе возвращается `401`), либо API-ключ с ограниченной областью действия не имеет разрешения `workflows: write` или используется с IP-адреса вне своего списка разрешённых.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no write access to workflows." } } } } } }, "404": { "description": "Списка с таким UUID не существует в приложении этого API-ключа, или он был удален.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "List not found." } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" }, "503": { "description": "Анализ лица по селфи, полученному при захвате документа, временно недоступен. Ничего не добавлено; повторите попытку позже.", "content": { "application/json": { "examples": { "Unavailable": { "value": { "detail": "Service temporarily unavailable. Please try again later." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/lists/{list_uuid}/entries/{entry_uuid}/": { "delete": { "summary": "Удалить запись из списка", "description": "Удаляет одну запись из списка, включая системные списки. Запись перестает сопоставляться немедленно, и удаление необратимо: чтобы снова добавить значение в список, создайте новую запись. В системном списке блокировки лиц, документов, телефонов или адресов электронной почты запись, которую представляет элемент, больше не помечается как заблокированная; в системном списке блокировки пользователей или компаний пользователи или компании приложения, чье значение `vendor_data` совпадает со значением записи (или чей `didit_internal_id` совпадает с её `reference_object_uuid`) и имеющие статус `BLOCKED`, возвращаются в статус `ACTIVE`. Сессии и транзакции, которые уже завершены, сохраняют свой статус. Для API-ключа с ограниченной областью действия требуется разрешение `workflows: write`.", "operationId": "delete_list_entry", "x-didit-sdk": { "resource": "lists.entries", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Lists" ], "parameters": [ { "name": "list_uuid", "in": "path", "required": true, "description": "UUID списка, содержащего запись.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "entry_uuid", "in": "path", "required": true, "description": "UUID записи, возвращённый методами List list entries или Create a list entry.", "schema": { "type": "string", "format": "uuid" }, "example": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/entries/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.lists.entries.delete(\n \"11111111-2222-3333-4444-555555555555\",\n \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.lists.entries.delete(\n \"11111111-2222-3333-4444-555555555555\",\n \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.Lists.Entries.Delete(ctx, \"11111111-2222-3333-4444-555555555555\", \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.lists().entries().delete(\"11111111-2222-3333-4444-555555555555\", \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\");" }, { "lang": "php", "label": "PHP", "source": "lists->entries->delete('11111111-2222-3333-4444-555555555555', 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.lists.entries.delete(\n \"11111111-2222-3333-4444-555555555555\",\n \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"\n)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.Lists.Entries.DeleteAsync(\"11111111-2222-3333-4444-555555555555\", \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\");" } ], "responses": { "204": { "description": "Запись была удалена. Тело ответа отсутствует." }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Другие ошибки аутентификации возвращают `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Заголовок `x-api-key` отсутствует (при неверном, отозванном или истёкшем ключе возвращается `401`), либо API-ключ с ограниченной областью действия не имеет разрешения `workflows: write` или используется с IP-адреса вне своего списка разрешённых.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no write access to workflows." } } } } } }, "404": { "description": "В этом списке нет записи с таким UUID, список не принадлежит приложению этого API-ключа или был удален, либо запись уже была удалена.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "No ListEntry matches the given query." } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/lists/{list_uuid}/entries/face-upload/": { "post": { "summary": "Загрузить лицо в список", "description": "Добавляет лицо в список блокировки лиц или список разрешённых лиц из изображения JPEG или PNG в кодировке base64, когда у вас нет сессии верификации, на которую можно сослаться. Didit обнаруживает лица на изображении, использует самое крупное и создаёт запись, чьи `value` и `reference_object_uuid` являются UUID нового лица. Лицо из списка блокировки приводит к отклонению новых сессий, чьё лицо совпадает; лицо из списка разрешённых пропускает действие для дублирующегося лица и никогда не переопределяет совпадение со списком блокировки. В приложении песочницы изображение не анализируется, и запись ни с чем не совпадает. Для API-ключа с ограниченными правами требуется `workflows: write`. Чтобы внести лицо в список из существующей сессии, используйте вместо этого [Create a list entry](https://docs.didit.me/ru/management-api/lists/create-entry) с `reference_session_id`.", "operationId": "upload_list_entry_face", "x-didit-sdk": { "resource": "lists.entries", "method": "upload_face", "auth": "api_key", "server": true }, "tags": [ "Lists" ], "parameters": [ { "name": "list_uuid", "in": "path", "required": true, "description": "UUID списка с `entry_type: face` и `list_type: blocklist` или `allowlist`.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "image" ], "properties": { "image": { "type": "string", "format": "byte", "description": "Изображение в формате JPEG или PNG в кодировке Base64, размером не более 2 МБ после декодирования, с чётко видимым лицом. Отправляйте чистую строку base64 без префикса `data:image/...;base64,`." }, "comment": { "type": "string", "default": "", "description": "Необязательная текстовая заметка в свободной форме, например причина внесения в список." } } }, "examples": { "Face image": { "value": { "image": "/9j/4AAQSkZJRgABAQAAAQABAAD...", "comment": "Known fraud attempt" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/entries/face-upload/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d \"{\\\"image\\\": \\\"$(base64 < face.jpg | tr -d '\\n')\\\", \\\"comment\\\": \\\"Known fraud attempt\\\"}\"" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.lists.entries.upload_face(\n \"11111111-2222-3333-4444-555555555555\",\n image=\"/9j/4AAQSkZJRgABAQAAAQABAAD...\",\n comment=\"Known fraud attempt\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.lists.entries.uploadFace(\"11111111-2222-3333-4444-555555555555\", {\n image: \"/9j/4AAQSkZJRgABAQAAAQABAAD...\",\n comment: \"Known fraud attempt\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Entries.UploadFace(ctx, \"11111111-2222-3333-4444-555555555555\", didit.ListsEntriesUploadFaceParams{\n\tImage: \"/9j/4AAQSkZJRgABAQAAAQABAAD...\",\n\tComment: didit.String(\"Known fraud attempt\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.ListsEntriesUploadFaceParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.lists().entries().uploadFace(\"11111111-2222-3333-4444-555555555555\", ListsEntriesUploadFaceParams.builder()\n .image(\"/9j/4AAQSkZJRgABAQAAAQABAAD...\")\n .comment(\"Known fraud attempt\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "lists->entries->uploadFace('11111111-2222-3333-4444-555555555555', [\n 'image' => '/9j/4AAQSkZJRgABAQAAAQABAAD...',\n 'comment' => 'Known fraud attempt',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.lists.entries.upload_face(\n \"11111111-2222-3333-4444-555555555555\",\n image: \"/9j/4AAQSkZJRgABAQAAAQABAAD...\",\n comment: \"Known fraud attempt\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Lists.Entries.UploadFaceAsync(\"11111111-2222-3333-4444-555555555555\", new ListsEntriesUploadFaceParams\n{\n Image = \"/9j/4AAQSkZJRgABAQAAAQABAAD...\",\n Comment = \"Known fraud attempt\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Запись лица создана.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplianceListEntry" }, "examples": { "Uploaded face": { "value": { "uuid": "cccccccc-dddd-eeee-ffff-000000000000", "value": "44444444-5555-6666-7777-888888888888", "display_label": "Manually uploaded face", "comment": "Known fraud attempt", "added_by": "api", "reference_session_id": null, "reference_session_number": null, "reference_session_type": null, "reference_object_uuid": "44444444-5555-6666-7777-888888888888", "metadata": { "reference_image_url": "https://media.example.com/faces/reference.jpg?expires=1760263938&signature=3f9a1c" }, "created_at": "2026-10-12T10:12:18.904467Z" } }, "Sandbox application": { "value": { "uuid": "cccccccc-dddd-eeee-ffff-000000000000", "value": "44444444-5555-6666-7777-888888888888", "display_label": "Sandbox face entry", "comment": "Known fraud attempt", "added_by": "api", "reference_session_id": null, "reference_session_number": null, "reference_session_type": null, "reference_object_uuid": "44444444-5555-6666-7777-888888888888", "metadata": { "sandbox": true }, "created_at": "2026-10-12T10:12:18.904467Z" } } } } } }, "400": { "description": "Список не принимает загрузку лиц, либо изображение отсутствует, недействительно, слишком велико или не содержит пригодного для использования лица. Запись создана не была.", "content": { "application/json": { "examples": { "Not a face list": { "value": { "detail": "Face upload is only available for face-type lists." } }, "Custom face list": { "value": { "detail": "Face upload is only available for face blocklists and allowlists." } }, "Missing image": { "value": { "image": [ "This field is required." ] } }, "Invalid base64": { "value": { "image": [ "Invalid base64 encoding." ] } }, "Too large": { "value": { "image": [ "Image exceeds maximum size of 2 MB." ] } }, "Unreadable image": { "value": { "image": "Invalid image. Provide a valid base64-encoded JPG or PNG." } }, "No face": { "value": { "image": "No face detected in the image. Please upload a clear photo with a visible face." } }, "No usable face": { "value": { "image": "Could not extract face embedding. Try a different image." } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Другие ошибки аутентификации возвращают `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Заголовок `x-api-key` отсутствует (при неверном, отозванном или истёкшем ключе возвращается `401`), либо API-ключ с ограниченной областью действия не имеет разрешения `workflows: write` или используется с IP-адреса вне своего списка разрешённых.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no write access to workflows." } } } } } }, "404": { "description": "Списка с таким UUID не существует в приложении этого API-ключа, или он был удален.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "List not found." } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" }, "503": { "description": "Анализ лица временно недоступен. Запись не была создана; повторите попытку позже.", "content": { "application/json": { "examples": { "Unavailable": { "value": { "detail": "Service temporarily unavailable. Please try again later." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/blocklist/": { "get": { "summary": "Получить список элементов списка блокировки", "description": "Возвращает одну постранично разбитую ленту с лицами, документами, удостоверяющими личность, номерами телефонов и адресами электронной почты сессий верификации приложения, которые в данный момент находятся в списке блокировки, начиная с самых новых по `blocklisted_at`; фильтрация с помощью `item_type`. Элементы удалённых сессий не включаются. Лента охватывает записи, добавленные в список блокировки из сессии (с помощью [Добавить элементы сессии в список блокировки](https://docs.didit.me/ru/management-api/blocklist/add), из консоли или через элемент списка, созданный из сессии); значения, добавленные в список вручную, загруженные лица, лица из селфи при захвате документа и другие типы записей получаются с помощью [Списка записей списка](https://docs.didit.me/ru/management-api/lists/list-entries). `face_image` и `front_image` представляют собой временные подписанные URL-адреса, и API-ключ с ограниченной областью действия без `media: read` получает `null`. Для API-ключа с ограниченной областью действия требуется разрешение `workflows: read`.", "operationId": "list_blocklist_items", "x-didit-sdk": { "resource": "blocklist", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Blocklist" ], "parameters": [ { "name": "item_type", "in": "query", "required": false, "description": "Только элементы этого типа. Если параметр опущен, возвращаются все типы.", "schema": { "type": "string", "enum": [ "face", "document", "phone", "email" ] } }, { "name": "limit", "in": "query", "required": false, "description": "Размер страницы. По умолчанию 50. Значение больше 1000000 возвращает `400`; для нулевого, отрицательного или нечислового значения используется 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 } }, { "name": "offset", "in": "query", "required": false, "description": "Индекс первого возвращаемого элемента, начиная с нуля. Рекомендуется переходить по ссылке `next`. Значение больше 1000000 возвращает `400`; отрицательное или нечисловое значение сбрасывается на 0.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/blocklist/?item_type=document' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.blocklist.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.blocklist.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Blocklist.ListAutoPaging(ctx, didit.BlocklistListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.blocklist().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "blocklist->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.blocklist.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Blocklist.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Страница элементов списка блокировки, начиная с самых новых.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "minimum": 0, "description": "Общее количество элементов списка блокировки, соответствующих фильтрам." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "Абсолютный URL следующей страницы или `null` на последней странице." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "Абсолютный URL предыдущей страницы или `null` на первой странице." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/BlocklistedItem" } } } }, "examples": { "Mixed feed": { "value": { "count": 2, "next": null, "previous": null, "results": [ { "type": "document", "session_id": "33333333-4444-5555-6666-777777777777", "session_number": 1042, "blocklisted_at": "2026-10-12T10:06:12.701553Z", "face_image": null, "document_type": "ID", "document_number": "X1234567", "front_image": "https://media.example.com/documents/front.jpg?expires=1760263938&signature=8b2e47", "phone_number": null, "country_code": null, "email": null }, { "type": "phone", "session_id": "77777777-8888-9999-0000-111111111111", "session_number": 1017, "blocklisted_at": "2026-10-08T15:31:09.400127Z", "face_image": null, "document_type": null, "document_number": null, "front_image": null, "phone_number": "+14155552671", "country_code": "US", "email": null } ] } } } } } }, "400": { "description": "Недопустимый параметр запроса.", "content": { "application/json": { "examples": { "Unknown item type": { "value": { "item_type": [ "\"wallet\" is not a valid choice." ] } }, "Limit too large": { "value": [ "limit must not exceed 1000000." ] } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Другие ошибки аутентификации возвращают `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Заголовок `x-api-key` отсутствует (при неверном, отозванном или истёкшем ключе возвращается `401`), либо API-ключ с ограниченной областью действия не имеет разрешения `workflows: read` или используется с IP-адреса вне своего списка разрешённых.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no read access to workflows." } } } } } }, "429": { "description": "Превышен общий лимит на чтение в 600 запросов в минуту на один API-ключ. Подождите время, указанное в `Retry-After`, перед повторной попыткой.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/blocklist/add/": { "post": { "summary": "Добавить элементы сессии в список блокировки", "description": "Добавляет лицо, документ, удостоверяющий личность, номер телефона или адрес электронной почты из сессии проверки пользователя приложения в список блокировки. Для каждого выбранного типа Didit берёт самую последнюю запись сессии, помечает её как занесённую в список блокировки и добавляет связанную с сессией запись в соответствующий системный список блокировки (`added_by: \"api\"`), поэтому новые сессии с совпадающим лицом, номером документа, номером телефона или адресом электронной почты отклоняются. Каждый выбранный элемент сначала проверяется, поэтому, если хотя бы один из них отсутствует, ничего не добавляется в список блокировки; повторный вызов для уже внесённого элемента сохраняет единственную запись и обновляет `blocklisted_at`. Сама сессия и уже завершённые сессии не изменяются. Для ограниченного API-ключа требуется `workflows: write`.", "operationId": "add_to_blocklist", "x-didit-sdk": { "resource": "blocklist", "method": "add", "auth": "api_key", "server": true }, "tags": [ "Blocklist" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "session_id" ], "description": "Хотя бы один флаг `blocklist_*` должен иметь значение `true`.", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "Сессия верификации личности вашего приложения. Удалённые сессии отклоняются." }, "blocklist_face": { "type": "boolean", "default": false, "description": "Добавить лицо сессии в список блокировки." }, "blocklist_document": { "type": "boolean", "default": false, "description": "Добавить документ сессии, удостоверяющий личность, в список блокировки. Для документа требуются государство выдачи, тип документа, номер документа и полное имя." }, "blocklist_phone": { "type": "boolean", "default": false, "description": "Добавить номер телефона сессии в список блокировки." }, "blocklist_email": { "type": "boolean", "default": false, "description": "Добавить адрес электронной почты сессии в список блокировки." } } }, "examples": { "Face and document": { "value": { "session_id": "33333333-4444-5555-6666-777777777777", "blocklist_face": true, "blocklist_document": true } }, "Phone only": { "value": { "session_id": "33333333-4444-5555-6666-777777777777", "blocklist_phone": true } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/blocklist/add/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"session_id\": \"33333333-4444-5555-6666-777777777777\",\n \"blocklist_face\": true,\n \"blocklist_document\": true\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.blocklist.add(\n session_id=\"33333333-4444-5555-6666-777777777777\",\n blocklist_face=True,\n blocklist_document=True,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.blocklist.add({\n session_id: \"33333333-4444-5555-6666-777777777777\",\n blocklist_face: true,\n blocklist_document: true,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Blocklist.Add(ctx, didit.BlocklistAddParams{\n\tSessionID: \"33333333-4444-5555-6666-777777777777\",\n\tBlocklistFace: didit.Bool(true),\n\tBlocklistDocument: didit.Bool(true),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.BlocklistAddParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.blocklist().add(BlocklistAddParams.builder()\n .sessionId(\"33333333-4444-5555-6666-777777777777\")\n .blocklistFace(true)\n .blocklistDocument(true)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "blocklist->add([\n 'session_id' => '33333333-4444-5555-6666-777777777777',\n 'blocklist_face' => true,\n 'blocklist_document' => true,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.blocklist.add(\n session_id: \"33333333-4444-5555-6666-777777777777\",\n blocklist_face: true,\n blocklist_document: true\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Blocklist.AddAsync(new BlocklistAddParams\n{\n SessionId = \"33333333-4444-5555-6666-777777777777\",\n BlocklistFace = true,\n BlocklistDocument = true,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Выбранные элементы были добавлены в список блокировки.", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string", "description": "Всегда `Successfully updated blocklist.`" } } }, "examples": { "Blocklisted": { "value": { "message": "Successfully updated blocklist." } } } } } }, "400": { "description": "Некорректное тело запроса, сессия не является сессией верификации этого приложения или не содержит записей выбранного типа. Ничего не было добавлено в список блокировки.", "content": { "application/json": { "examples": { "Unknown session": { "value": { "non_field_errors": [ "Session not found" ] } }, "No item selected": { "value": { "non_field_errors": [ "Must specify at least one item to blocklist" ] } }, "No face record": { "value": { "non_field_errors": [ "Session does not have a face record" ] } }, "Incomplete document": { "value": { "non_field_errors": [ "To blocklist a document, the document must have an issuing state, document type, document number and full name" ] } }, "Invalid session id": { "value": { "session_id": [ "Must be a valid UUID." ] } }, "Missing session id": { "value": { "session_id": [ "This field is required." ] } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Другие ошибки аутентификации возвращают `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Заголовок `x-api-key` отсутствует (при неверном, отозванном или истёкшем ключе возвращается `401`), либо API-ключ с ограниченной областью действия не имеет разрешения `workflows: write` или используется с IP-адреса вне своего списка разрешённых.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no write access to workflows." } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/blocklist/remove/": { "post": { "summary": "Удалить элементы сессии из списка блокировки", "description": "Снимает блокировку с лица, документа, удостоверяющего личность, номера телефона или адреса электронной почты одной сессии проверки пользователей приложения. Для каждого выбранного типа Didit берёт самую свежую запись сессии, снимает с неё флаг блокировки и удаляет системные записи списка блокировки, созданные из этой записи, поэтому новые сессии больше не будут отклоняться. Записи, добавленные в список по значению, не затрагиваются: найдите их с помощью [Получить список записей списка](https://docs.didit.me/ru/management-api/lists/list-entries) и удалите с помощью [Удалить запись списка](https://docs.didit.me/ru/management-api/lists/delete-entry). Разблокировка записи, не находящейся в списке блокировки, проходит успешно и ничего не меняет, а уже завершённые сессии не изменяются. Для API-ключа с ограниченной областью действия требуется `workflows: write`.", "operationId": "remove_from_blocklist", "x-didit-sdk": { "resource": "blocklist", "method": "remove", "auth": "api_key", "server": true }, "tags": [ "Blocklist" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "session_id" ], "description": "Хотя бы один флаг `unblock_*` должен иметь значение `true`.", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "Сессия верификации личности вашего приложения. Удалённые сессии отклоняются." }, "unblock_face": { "type": "boolean", "default": false, "description": "Снять блокировку с лица сессии." }, "unblock_document": { "type": "boolean", "default": false, "description": "Снять блокировку с документа, удостоверяющего личность, указанного в сессии." }, "unblock_phone": { "type": "boolean", "default": false, "description": "Снять блокировку с номера телефона сессии." }, "unblock_email": { "type": "boolean", "default": false, "description": "Снять блокировку с адреса электронной почты сессии." } } }, "examples": { "Face and document": { "value": { "session_id": "33333333-4444-5555-6666-777777777777", "unblock_face": true, "unblock_document": true } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/blocklist/remove/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"session_id\": \"33333333-4444-5555-6666-777777777777\",\n \"unblock_face\": true,\n \"unblock_document\": true\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.blocklist.remove(\n session_id=\"33333333-4444-5555-6666-777777777777\",\n unblock_face=True,\n unblock_document=True,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.blocklist.remove({\n session_id: \"33333333-4444-5555-6666-777777777777\",\n unblock_face: true,\n unblock_document: true,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Blocklist.Remove(ctx, didit.BlocklistRemoveParams{\n\tSessionID: \"33333333-4444-5555-6666-777777777777\",\n\tUnblockFace: didit.Bool(true),\n\tUnblockDocument: didit.Bool(true),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.BlocklistRemoveParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.blocklist().remove(BlocklistRemoveParams.builder()\n .sessionId(\"33333333-4444-5555-6666-777777777777\")\n .unblockFace(true)\n .unblockDocument(true)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "blocklist->remove([\n 'session_id' => '33333333-4444-5555-6666-777777777777',\n 'unblock_face' => true,\n 'unblock_document' => true,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.blocklist.remove(\n session_id: \"33333333-4444-5555-6666-777777777777\",\n unblock_face: true,\n unblock_document: true\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Blocklist.RemoveAsync(new BlocklistRemoveParams\n{\n SessionId = \"33333333-4444-5555-6666-777777777777\",\n UnblockFace = true,\n UnblockDocument = true,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Блокировка выбранных элементов была снята.", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string", "description": "Всегда `Successfully removed from blocklist.`" } } }, "examples": { "Unblocked": { "value": { "message": "Successfully removed from blocklist." } } } } } }, "400": { "description": "Некорректное тело запроса, сессия не является сессией верификации этого приложения или не содержит записей выбранного типа. Ничего не было изменено.", "content": { "application/json": { "examples": { "Unknown session": { "value": { "non_field_errors": [ "Session not found" ] } }, "No item selected": { "value": { "non_field_errors": [ "Must specify at least one item to unblock" ] } }, "No email record": { "value": { "non_field_errors": [ "Session does not have an email record" ] } }, "Invalid session id": { "value": { "session_id": [ "Must be a valid UUID." ] } }, "Missing session id": { "value": { "session_id": [ "This field is required." ] } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Другие ошибки аутентификации возвращают `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Заголовок `x-api-key` отсутствует (при неверном, отозванном или истёкшем ключе возвращается `401`), либо API-ключ с ограниченной областью действия не имеет разрешения `workflows: write` или используется с IP-адреса вне своего списка разрешённых.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without workflows access": { "value": { "detail": "This API key has no write access to workflows." } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/webhook/": { "get": { "summary": "Получить конфигурацию webhook", "description": "Возвращает настройки webhook приложения за один вызов: каждый [адрес назначения webhook](https://docs.didit.me/ru/management-api/webhook/list-destinations) с его секретом подписи, типы событий, на которые может подписаться адрес назначения, URL webhook уровня приложения (устаревший), версию и секрет, политику хранения данных и биометрических шаблонов, а также хосты возврата кошелька Digital ID. Didit доставляет события webhook на адреса назначения; каждое событие подписывается собственным `secret_shared_key`; поля верхнего уровня `webhook_url`, `webhook_version` и `secret_shared_key` используются только при отсутствии включённых адресов назначения и исключительно для `status.updated` и `data.updated`. Ответ содержит секреты подписи, поэтому не сохраняйте его в журналах и клиентском коде. Для API-ключа с ограниченным набором прав требуется `webhooks: read`.", "operationId": "get_webhook_config", "x-didit-sdk": { "resource": "webhooks", "method": "retrieve_config", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "parameters": [], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/webhook/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.webhooks.retrieve_config()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.webhooks.retrieveConfig();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.RetrieveConfig(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.webhooks().retrieveConfig();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "webhooks->retrieveConfig();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.webhooks.retrieve_config\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Webhooks.RetrieveConfigAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Конфигурация webhook.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookConfig" }, "examples": { "One destination": { "value": { "webhook_url": "https://yourapp.com/webhooks/didit", "webhook_version": "v3", "secret_shared_key": "dGhpcy1pcy10aGUtYXBwLWxldmVsLXNlY3JldC0wMDA", "capture_method": "MOBILE", "data_retention_months": 24, "face_retention_policy": "delete_with_session", "face_retention_days": null, "biometric_consent_mode": "auto", "available_events": [ { "value": "status.updated", "label": "Session status updated" }, { "value": "data.updated", "label": "Session data updated" }, { "value": "user.status.updated", "label": "User status updated" }, { "value": "user.data.updated", "label": "User data updated" }, { "value": "business.status.updated", "label": "Business status updated" }, { "value": "business.data.updated", "label": "Business data updated" }, { "value": "activity.created", "label": "Activity created" }, { "value": "transaction.created", "label": "Transaction created" }, { "value": "transaction.status.updated", "label": "Transaction status updated" }, { "value": "travel_rule.status.updated", "label": "Travel Rule Status Updated" }, { "value": "workflow.compliance_changed", "label": "Workflow Compliance Changed" } ], "allowed_return_hosts": [ "shop.example.com" ], "endpoints": [ { "uuid": "11111111-2222-3333-4444-555555555555", "label": "Production session webhooks", "url": "https://yourapp.com/webhooks/didit", "enabled": true, "webhook_version": "v3", "secret_shared_key": "dGhpcy1pcy1hbi1leGFtcGxlLXNlY3JldC0wMDAwMDA", "subscribed_events": [ "status.updated", "data.updated" ], "created_at": "2026-01-04T08:00:00.000000Z", "updated_at": "2026-04-22T14:09:11.523671Z" } ] } } } } } }, "401": { "description": "Срок действия API-ключа истёк: он был создан со сроком действия, который уже прошёл. Неверный или отозванный ключ также возвращает `401`; отсутствующий ключ возвращает `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Запрос не разрешён. Отсутствующий, недействительный или отозванный `x-api-key` возвращает `You do not have permission to perform this action.` Ключ с ограниченной областью действия без требуемых для этого endpoint прав возвращает сообщение с указанием недостающих разрешений, а ключ, используемый не из разрешённого списка IP-адресов, возвращает `This API key can't be used from this IP address.`", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Missing or invalid key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without webhooks read": { "value": { "detail": "This API key has no read access to webhooks." } }, "Outside the IP allowlist": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "429": { "description": "Лимит запросов превышен: более 600 GET-запросов в текущем минутном окне для этого API-ключа. Подождите `Retry-After` секунд перед повторной попыткой.", "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Количество разрешённых запросов в минутном окне (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Количество оставшихся запросов в текущем окне.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Unix-время (в секундах), когда текущее окно сбрасывается.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Название бюджета, который был превышен.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Обновить конфигурацию webhook", "description": "Частично обновить настройки уровня приложения: устаревший URL webhook, версию и секрет, политику хранения данных и биометрических шаблонов, а также хосты возврата кошелька Digital ID. Передавайте только поля, которые необходимо изменить; в ответе возвращается полная конфигурация того же формата, что и в `GET /v3/webhook/`. Адреса назначения здесь не настраиваются: создавайте, обновляйте и удаляйте их через endpoint'ы `/v3/webhook/destinations/` и не отправляйте поле `endpoints` в этот endpoint. Изменение `data_retention_months` также применяется к существующим сессиям, а удаленные сессии восстановить невозможно; сначала ознакомьтесь с разделом [Хранение данных](https://docs.didit.me/ru/console/data-retention). Для API-ключа с ограниченными правами требуется `webhooks: write`.", "operationId": "update_webhook_config", "x-didit-sdk": { "resource": "webhooks", "method": "update_config", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Отправляйте только те поля, которые нужно изменить. Адреса назначения здесь не настраиваются.", "properties": { "webhook_url": { "type": "string", "format": "uri", "nullable": true, "maxLength": 2000, "description": "Устаревший URL webhook на уровне приложения. Didit использует его только тогда, когда у приложения нет включённого адреса назначения, и только для `status.updated` и `data.updated`. Он не создаёт адрес назначения, и следующее создание, обновление или удаление адреса назначения заменяет его. Чтобы получать webhook, создайте адрес назначения с помощью `POST /v3/webhook/destinations/` вместо этого." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Версия payload устаревшего `webhook_url`." }, "rotate_secret_key": { "type": "boolean", "default": false, "description": "`true` немедленно заменяет `secret_shared_key` на уровне приложения новым случайным значением; новое значение возвращается в ответе. Секреты адресов назначения не изменяются. Каждый вызов с `true` генерирует новый секрет, поэтому операция не является идемпотентной." }, "capture_method": { "type": "string", "enum": [ "MOBILE", "MOBILE_AND_DESKTOP" ], "description": "Устаревшая настройка приложения. Сценарий верификации её не считывает." }, "data_retention_months": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 120, "description": "Окно автоматического удаления в месяцах (месяц считается как 30 дней) или `null` для отключения автоматического удаления. Изменение применяется и к существующим сессиям: каждая сессия проверки пользователей старше нового окна удаляется автоматически, и это удаление необратимо." }, "face_retention_policy": { "type": "string", "enum": [ "delete_with_session", "retain_until_user_deleted" ], "description": "Что происходит с эмбеддингом лица сессии при удалении сессии. Для `retain_until_user_deleted` требуется параметр `face_retention_days` в том же запросе или уже установленный ранее. Изменение применяется ко всем последующим удалениям сессий; оно не создаёт и не удаляет существующие биометрические шаблоны." }, "face_retention_days": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 3650, "description": "Срок хранения биометрических шаблонов в днях согласно политике `retain_until_user_deleted`." }, "biometric_consent_mode": { "type": "string", "enum": [ "auto", "always", "never" ], "description": "Когда размещённый сценарий и нативные SDK запрашивают у человека явное биометрическое согласие перед захватом лица. Значение `auto` (по умолчанию) запрашивает согласие только при срабатывании триггера: указанный штат, IP-адрес пользователя или эмитент документа, удостоверяющего личность, относятся к Иллинойсу, Техасу или Колорадо, либо пользователь предположительно находится в США без определённого штата. Значение `always` запрашивает согласие у каждого человека, чей сценарий включает захват лица. Значение `never` никогда не показывает этот шаг, и вы собираете согласие самостоятельно перед селфи. Каждое изменение фиксируется в журнале аудита. См. [Biometric consent](https://docs.didit.me/ru/getting-started/biometric-consent)." }, "allowed_return_hosts": { "type": "array", "maxItems": 20, "description": "Заменяет весь список хостов возврата кошелька Digital ID. Только «чистые» имена хостов, например `shop.example.com`: без схемы, порта, пути или масок (wildcard). Значения приводятся к нижнему регистру, а дубликаты удаляются. Отправьте `[]`, чтобы очистить список.", "items": { "type": "string", "maxLength": 253 } }, "allowed_domains": { "type": "array", "maxItems": 50, "items": { "type": "string", "maxLength": 300 }, "description": "Заменяет весь список разрешённых источников. Источники (например, `https://app.example.com`; `http` только для `localhost`), в которые может быть встроен размещённый сценарий верификации и на которые он может вернуть пользователя через callback сессии. Межсерверные вызовы не затрагиваются. Пустой список означает отсутствие ограничений. Didit сохраняет каждый источник в нижнем регистре без порта по умолчанию. Некорректная запись завершается ошибкой `400` для `allowed_domains`. Отправьте `[]`, чтобы снять ограничение.", "example": [ "https://app.example.com" ] } } }, "examples": { "Enable biometric template retention": { "value": { "face_retention_policy": "retain_until_user_deleted", "face_retention_days": 365, "biometric_consent_mode": "auto" } }, "Rotate the legacy secret": { "value": { "rotate_secret_key": true } }, "Set data retention": { "value": { "data_retention_months": 24 } }, "Register return hosts": { "value": { "allowed_return_hosts": [ "shop.example.com", "app.example.com" ] } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/webhook/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"face_retention_policy\": \"retain_until_user_deleted\", \"face_retention_days\": 365}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.webhooks.update_config(\n face_retention_policy=\"retain_until_user_deleted\",\n face_retention_days=365,\n biometric_consent_mode=\"auto\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.webhooks.updateConfig({\n face_retention_policy: \"retain_until_user_deleted\",\n face_retention_days: 365,\n biometric_consent_mode: \"auto\",\n});\nconsole.log(result);" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.WebhooksUpdateConfigParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.webhooks().updateConfig(WebhooksUpdateConfigParams.builder()\n .faceRetentionPolicy(WebhooksUpdateConfigParams.FaceRetentionPolicy.of(\"retain_until_user_deleted\"))\n .faceRetentionDays(365L)\n .biometricConsentMode(WebhooksUpdateConfigParams.BiometricConsentMode.of(\"auto\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "webhooks->updateConfig([\n 'face_retention_policy' => 'retain_until_user_deleted',\n 'face_retention_days' => 365,\n 'biometric_consent_mode' => 'auto',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.webhooks.update_config(\n face_retention_policy: \"retain_until_user_deleted\",\n face_retention_days: 365,\n biometric_consent_mode: \"auto\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Webhooks.UpdateConfigAsync(new WebhooksUpdateConfigParams\n{\n FaceRetentionPolicy = new WebhooksUpdateConfigParamsFaceRetentionPolicy(\"retain_until_user_deleted\"),\n FaceRetentionDays = 365,\n BiometricConsentMode = new WebhooksUpdateConfigParamsBiometricConsentMode(\"auto\"),\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Полная конфигурация после обновления в том же формате, что и в `GET /v3/webhook/`. Если вы выполнили ротацию секрета, сохраните новый `secret_shared_key`, прежде чем отбросить ответ.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookConfig" }, "examples": { "Retention enabled": { "value": { "webhook_url": "https://yourapp.com/webhooks/didit", "webhook_version": "v3", "secret_shared_key": "dGhpcy1pcy10aGUtYXBwLWxldmVsLXNlY3JldC0wMDA", "capture_method": "MOBILE", "data_retention_months": 24, "face_retention_policy": "retain_until_user_deleted", "face_retention_days": 365, "biometric_consent_mode": "auto", "available_events": [ { "value": "status.updated", "label": "Session status updated" }, { "value": "data.updated", "label": "Session data updated" }, { "value": "user.status.updated", "label": "User status updated" }, { "value": "user.data.updated", "label": "User data updated" }, { "value": "business.status.updated", "label": "Business status updated" }, { "value": "business.data.updated", "label": "Business data updated" }, { "value": "activity.created", "label": "Activity created" }, { "value": "transaction.created", "label": "Transaction created" }, { "value": "transaction.status.updated", "label": "Transaction status updated" }, { "value": "travel_rule.status.updated", "label": "Travel Rule Status Updated" }, { "value": "workflow.compliance_changed", "label": "Workflow Compliance Changed" } ], "allowed_return_hosts": [ "shop.example.com" ], "endpoints": [ { "uuid": "11111111-2222-3333-4444-555555555555", "label": "Production session webhooks", "url": "https://yourapp.com/webhooks/didit", "enabled": true, "webhook_version": "v3", "secret_shared_key": "dGhpcy1pcy1hbi1leGFtcGxlLXNlY3JldC0wMDAwMDA", "subscribed_events": [ "status.updated", "data.updated" ], "created_at": "2026-01-04T08:00:00.000000Z", "updated_at": "2026-04-22T14:09:11.523671Z" } ] } } } } } }, "400": { "description": "Ошибка валидации: каждое некорректное поле сопоставляется со списком сообщений, и ничего не изменяется. Тело запроса, не являющееся валидным JSON, возвращает `{\"detail\": \"JSON parse error - ...\"}`.", "content": { "application/json": { "schema": { "type": "object", "description": "Каждое некорректное поле, сопоставленное со списком сообщений.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "examples": { "Retention days missing": { "value": { "face_retention_days": [ "A finite retention duration is required when face retention is enabled." ], "biometric_consent_mode": "auto" } }, "Retention window out of range": { "value": { "data_retention_months": [ "Ensure this value is less than or equal to 120." ] } }, "Invalid return host": { "value": { "allowed_return_hosts": [ "'https://shop.example.com' is not a hostname. Register the bare host (e.g. shop.example.com): no scheme, port, path or wildcard." ] } }, "Invalid choice": { "value": { "face_retention_policy": [ "\"forever\" is not a valid choice." ] } } } } } }, "401": { "description": "Срок действия API-ключа истёк: он был создан со сроком действия, который уже прошёл. Неверный или отозванный ключ также возвращает `401`; отсутствующий ключ возвращает `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Запрос не разрешён. Отсутствующий, недействительный или отозванный `x-api-key` возвращает `You do not have permission to perform this action.` Ключ с ограниченной областью действия без требуемых для этого endpoint прав возвращает сообщение с указанием недостающих разрешений, а ключ, используемый не из разрешённого списка IP-адресов, возвращает `This API key can't be used from this IP address.`", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Missing or invalid key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without webhooks write": { "value": { "detail": "This API key has no write access to webhooks." } }, "Outside the IP allowlist": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "429": { "description": "Лимит запросов превышен: более 300 запросов на запись (POST, PATCH, PUT, DELETE) в текущем минутном окне для этого API-ключа. Подождите `Retry-After` секунд перед повторной попыткой.", "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Количество разрешённых запросов в минутном окне (300).", "schema": { "type": "integer", "example": 300 } }, "X-RateLimit-Remaining": { "description": "Количество оставшихся запросов в текущем окне.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Unix-время (в секундах), когда текущее окно сбрасывается.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Название бюджета, который был превышен.", "schema": { "type": "string", "example": "generic-write" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Throttled": { "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/webhook/destinations/{destination_uuid}/analytics/": { "get": { "summary": "Получить аналитику адреса назначения webhook", "description": "Общие показатели доставки, доля неудачных доставок и время ответа для одного адреса назначения webhook за весь диапазон (`summary`) и по дням UTC (`points`). Каждая попытка считается доставкой: первая отправка события, каждая автоматическая [повторная попытка](https://docs.didit.me/ru/integration/webhooks#политика-повторных-попыток) и каждая повторная отправка. Доставка считается неудачной, если зафиксированный статус HTTP равен 400 или выше, поэтому таймауты (фиксируемые как `504`) и сбои соединения (`503`) считаются неудачными; доставка, которая всё ещё находится в очереди, учитывается только в `total_deliveries`. Записи о доставке доступны приблизительно в течение 30 дней. Для API-ключа с ограниченной областью действия требуется `webhooks: read`.", "operationId": "get_webhook_destination_analytics", "x-didit-sdk": { "resource": "webhooks.destinations", "method": "retrieve_analytics", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "parameters": [ { "name": "destination_uuid", "in": "path", "required": true, "description": "UUID адреса назначения webhook (`uuid`, возвращаемый методом `GET /v3/webhook/destinations/`).", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "date_from", "in": "query", "required": false, "description": "Первый день по UTC, который нужно включить, в формате `YYYY-MM-DD` (включительно). Опустите, чтобы начать с самой ранней доступной доставки. В качестве псевдонима принимается `dateFrom`.", "schema": { "type": "string", "format": "date" }, "example": "2026-10-01" }, { "name": "date_to", "in": "query", "required": false, "description": "Последний день по UTC для включения в выборку, в формате `YYYY-MM-DD` (включительно). Не должен быть раньше `date_from`. В качестве псевдонима принимается `dateTo`.", "schema": { "type": "string", "format": "date" }, "example": "2026-10-16" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/analytics/?date_from=2026-10-01&date_to=2026-10-16' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.webhooks.destinations.retrieve_analytics(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.webhooks.destinations.retrieveAnalytics(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.Destinations.RetrieveAnalytics(ctx, \"11111111-2222-3333-4444-555555555555\", didit.WebhooksDestinationsRetrieveAnalyticsParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.webhooks().destinations().retrieveAnalytics(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->retrieveAnalytics('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.webhooks.destinations.retrieve_analytics(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Webhooks.Destinations.RetrieveAnalyticsAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Статистика доставки для адреса назначения.", "content": { "application/json": { "schema": { "type": "object", "required": [ "summary", "points" ], "properties": { "summary": { "type": "object", "description": "Итоговые значения за запрошенный диапазон.", "required": [ "total_deliveries", "failed_deliveries", "min_response_time_ms", "avg_response_time_ms", "max_response_time_ms", "error_rate_percentage" ], "properties": { "total_deliveries": { "type": "integer", "minimum": 0, "description": "Попытки доставки, включая те, что находятся в очереди." }, "failed_deliveries": { "type": "integer", "minimum": 0, "description": "Попытки, для которых зафиксирован HTTP-статус 400 или выше." }, "min_response_time_ms": { "type": "integer", "nullable": true, "description": "Самая быстрая попытка в миллисекундах или `null`, если ни у одной попытки нет зафиксированного времени." }, "avg_response_time_ms": { "type": "integer", "nullable": true, "description": "Среднее время попытки в миллисекундах, округлённое, или `null`, если ни у одной попытки нет зафиксированного времени." }, "max_response_time_ms": { "type": "integer", "nullable": true, "description": "Самая медленная попытка в миллисекундах или `null`, если ни у одной попытки нет зафиксированного времени." }, "error_rate_percentage": { "type": "integer", "minimum": 0, "maximum": 100, "description": "`failed_deliveries` / `total_deliveries` x 100, округлённое до целого числа. `0`, если доставок нет." } } }, "points": { "type": "array", "description": "Одна запись на каждый день по UTC, в который были доставки, начиная с самых старых. Дни без доставок опущены, поэтому при построении графиков заполняйте пропуски нулями.", "items": { "type": "object", "required": [ "date", "total_deliveries", "failed_deliveries", "min_response_time_ms", "avg_response_time_ms", "max_response_time_ms" ], "properties": { "date": { "type": "string", "format": "date", "description": "День по UTC, `YYYY-MM-DD`." }, "total_deliveries": { "type": "integer", "minimum": 0, "description": "Попытки доставки, включая те, что находятся в очереди." }, "failed_deliveries": { "type": "integer", "minimum": 0, "description": "Попытки, для которых зафиксирован HTTP-статус 400 или выше." }, "min_response_time_ms": { "type": "integer", "nullable": true, "description": "Самая быстрая попытка в миллисекундах или `null`, если ни у одной попытки нет зафиксированного времени." }, "avg_response_time_ms": { "type": "integer", "nullable": true, "description": "Среднее время попытки в миллисекундах, округлённое, или `null`, если ни у одной попытки нет зафиксированного времени." }, "max_response_time_ms": { "type": "integer", "nullable": true, "description": "Самая медленная попытка в миллисекундах или `null`, если ни у одной попытки нет зафиксированного времени." } } } } } }, "examples": { "Three days of deliveries": { "value": { "summary": { "total_deliveries": 1250, "failed_deliveries": 12, "min_response_time_ms": 38, "avg_response_time_ms": 164, "max_response_time_ms": 5004, "error_rate_percentage": 1 }, "points": [ { "date": "2026-10-14", "total_deliveries": 410, "failed_deliveries": 0, "min_response_time_ms": 38, "avg_response_time_ms": 152, "max_response_time_ms": 911 }, { "date": "2026-10-15", "total_deliveries": 395, "failed_deliveries": 12, "min_response_time_ms": 41, "avg_response_time_ms": 190, "max_response_time_ms": 5004 }, { "date": "2026-10-16", "total_deliveries": 445, "failed_deliveries": 0, "min_response_time_ms": 40, "avg_response_time_ms": 151, "max_response_time_ms": 1220 } ] } }, "No deliveries in range": { "value": { "summary": { "total_deliveries": 0, "failed_deliveries": 0, "min_response_time_ms": null, "avg_response_time_ms": null, "max_response_time_ms": null, "error_rate_percentage": 0 }, "points": [] } } } } } }, "400": { "description": "`date_from` или `date_to` не являются датой в формате `YYYY-MM-DD`, либо `date_to` раньше `date_from`.", "content": { "application/json": { "schema": { "type": "object", "description": "Каждое некорректное поле, сопоставленное со списком сообщений.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "examples": { "Malformed date": { "value": { "date_from": [ "Date has wrong format. Use one of these formats instead: YYYY-MM-DD." ] } }, "Reversed range": { "value": { "date_to": [ "date_to must be greater than or equal to date_from." ] } } } } } }, "401": { "description": "Срок действия API-ключа истёк: он был создан со сроком действия, который уже прошёл. Неверный или отозванный ключ также возвращает `401`; отсутствующий ключ возвращает `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Запрос не разрешён. Отсутствующий, недействительный или отозванный `x-api-key` возвращает `You do not have permission to perform this action.` Ключ с ограниченной областью действия без требуемых для этого endpoint прав возвращает сообщение с указанием недостающих разрешений, а ключ, используемый не из разрешённого списка IP-адресов, возвращает `This API key can't be used from this IP address.`", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Missing or invalid key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without webhooks read": { "value": { "detail": "This API key has no read access to webhooks." } }, "Outside the IP allowlist": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Адреса назначения с таким UUID для этого приложения не существует, или он был удален.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Destination not found": { "value": { "detail": "Webhook destination not found." } } } } } }, "429": { "description": "Лимит запросов превышен: более 600 GET-запросов в текущем минутном окне для этого API-ключа. Подождите `Retry-After` секунд перед повторной попыткой.", "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Количество разрешённых запросов в минутном окне (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Количество оставшихся запросов в текущем окне.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Unix-время (в секундах), когда текущее окно сбрасывается.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Название бюджета, который был превышен.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/webhook/destinations/{destination_uuid}/deliveries/": { "get": { "summary": "Получить список доставок на адрес назначения webhook", "description": "Постраничный просмотр всех попыток доставки в один адрес назначения webhook, сначала новые. Первая отправка каждого события, каждая автоматическая [повторная попытка](https://docs.didit.me/ru/integration/webhooks#политика-повторных-попыток) и каждая повторная отправка представляют собой отдельные записи. Записи содержат HTTP-статус и время ответа, но не payload: запросите отдельную доставку, чтобы прочитать её заголовки и тело. Значение `count` точно указывает количество до 100 и отображает 100 при превышении этого порога, поэтому переходите по `next`, пока оно не станет `null`. Записи о доставке хранятся около 30 дней. API-ключу с ограниченной областью действия требуются разрешения `webhooks: read` и `decisions: read`; ключ, ограниченный определёнными сценариями или одобренными сессиями, не может вызывать этот endpoint.", "operationId": "list_webhook_destination_deliveries", "x-didit-sdk": { "resource": "webhooks.destinations", "method": "list_deliveries", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "parameters": [ { "name": "destination_uuid", "in": "path", "required": true, "description": "UUID адреса назначения webhook (`uuid`, возвращаемый методом `GET /v3/webhook/destinations/`).", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "limit", "in": "query", "required": false, "description": "Максимальное количество доставок на страницу. По умолчанию 50. Если значение не является положительным целым числом, используется 50; значение выше 1000000 возвращает `400`.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "example": 50 }, { "name": "offset", "in": "query", "required": false, "description": "Количество доставок, которые нужно пропустить. По умолчанию: 0. Рекомендуется переходить по URL-адресам `next` и `previous` из ответа.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "example": 0 }, { "name": "date_from", "in": "query", "required": false, "description": "Первый день по UTC, который нужно включить, в формате `YYYY-MM-DD` (включительно). Опустите, чтобы начать с самой ранней доступной доставки. В качестве псевдонима принимается `dateFrom`.", "schema": { "type": "string", "format": "date" }, "example": "2026-10-01" }, { "name": "date_to", "in": "query", "required": false, "description": "Последний день по UTC для включения в выборку, в формате `YYYY-MM-DD` (включительно). Не должен быть раньше `date_from`. В качестве псевдонима принимается `dateTo`.", "schema": { "type": "string", "format": "date" }, "example": "2026-10-16" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/deliveries/?limit=50&date_from=2026-10-01' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.webhooks.destinations.list_deliveries(\n \"11111111-2222-3333-4444-555555555555\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.webhooks.destinations.listDeliveries(\"11111111-2222-3333-4444-555555555555\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Webhooks.Destinations.ListDeliveriesAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.WebhooksDestinationsListDeliveriesParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.webhooks().destinations().listDeliveries(\"11111111-2222-3333-4444-555555555555\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->listDeliveries('11111111-2222-3333-4444-555555555555') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.webhooks.destinations.list_deliveries(\"11111111-2222-3333-4444-555555555555\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Webhooks.Destinations.ListDeliveriesAsync(\"11111111-2222-3333-4444-555555555555\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Одна страница доставок, сначала новые.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "minimum": 0, "description": "Количество совпадающих доставок: точное значение до 100, а свыше этого порога ограничено 100. Используйте `next`, чтобы узнать, есть ли следующие страницы." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "Абсолютный URL следующей страницы или `null` на последней странице." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "Абсолютный URL предыдущей страницы или `null` на первой странице." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookDestinationDelivery" } } } }, "examples": { "Failed delivery, its retry and a queued event": { "value": { "count": 3, "next": null, "previous": null, "results": [ { "uuid": "66666666-7777-8888-9999-000000000003", "session_id": null, "request_url": "https://yourapp.com/webhooks/didit", "response_status": null, "response_time_ms": null, "status": "APPROVED", "webhook_type": "transaction.created", "created_at": "2026-10-15T09:23:02.871190Z" }, { "uuid": "66666666-7777-8888-9999-000000000002", "session_id": "22222222-3333-4444-5555-666666666666", "request_url": "https://yourapp.com/webhooks/didit", "response_status": 200, "response_time_ms": 143, "status": "In Progress", "webhook_type": "status.updated", "created_at": "2026-10-15T09:22:19.104233Z" }, { "uuid": "66666666-7777-8888-9999-000000000001", "session_id": "22222222-3333-4444-5555-666666666666", "request_url": "https://yourapp.com/webhooks/didit", "response_status": 503, "response_time_ms": 412, "status": "In Progress", "webhook_type": "status.updated", "created_at": "2026-10-15T09:21:18.412345Z" } ] } } } } } }, "400": { "description": "`date_from` или `date_to` не являются датой в формате `YYYY-MM-DD`, `date_to` раньше `date_from`, либо `limit` или `offset` превышают 1000000 (эта ошибка представляет собой JSON-массив сообщений).", "content": { "application/json": { "examples": { "Malformed date": { "value": { "date_from": [ "Date has wrong format. Use one of these formats instead: YYYY-MM-DD." ] } }, "Reversed range": { "value": { "date_to": [ "date_to must be greater than or equal to date_from." ] } }, "Limit too large": { "value": [ "limit must not exceed 1000000." ] } } } } }, "401": { "description": "Срок действия API-ключа истёк: он был создан со сроком действия, который уже прошёл. Неверный или отозванный ключ также возвращает `401`; отсутствующий ключ возвращает `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Запрос не разрешён. Отсутствующий, недействительный или отозванный `x-api-key` возвращает `You do not have permission to perform this action.` Ключ с ограниченной областью действия без требуемых для этого endpoint прав возвращает сообщение с указанием недостающих разрешений, а ключ, используемый не из разрешённого списка IP-адресов, возвращает `This API key can't be used from this IP address.` Ключ, ограниченный определёнными сценариями или одобренными сессиями, возвращает `This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint.`", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Missing or invalid key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without webhooks read": { "value": { "detail": "This API key has no read access to webhooks." } }, "Scoped key without decisions read": { "value": { "detail": "This API key has no read access to decisions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "Outside the IP allowlist": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Адреса назначения с таким UUID для этого приложения не существует, или он был удален.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Destination not found": { "value": { "detail": "Webhook destination not found." } } } } } }, "429": { "description": "Лимит запросов превышен: более 600 GET-запросов в текущем минутном окне для этого API-ключа. Подождите `Retry-After` секунд перед повторной попыткой.", "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Количество разрешённых запросов в минутном окне (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Количество оставшихся запросов в текущем окне.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Unix-время (в секундах), когда текущее окно сбрасывается.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Название бюджета, который был превышен.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/webhook/destinations/{destination_uuid}/deliveries/{delivery_uuid}/": { "get": { "summary": "Получить доставку webhook для адреса назначения", "description": "Получить одну попытку доставки на адрес назначения webhook с точными заголовками запроса и JSON-телом, отправленными Didit, HTTP-статусом, возвращённым вашим endpoint, и временем ответа. Поля `request_header` и `request_body` представляют собой текст JSON: распарсите их, чтобы прочитать заголовки подписи и payload, например для вашей [проверки подписи](https://docs.didit.me/ru/integration/webhooks#проверка-подписи) с использованием `secret_shared_key` адреса назначения. Доставка никогда не содержит секрет подписи, и Didit не сохраняет тело ответа вашего endpoint. API-ключу с ограниченной областью действия требуются разрешения `webhooks: read` и `decisions: read`; ключ, ограниченный определёнными сценариями или одобренными сессиями, не может вызывать этот endpoint.", "operationId": "get_webhook_destination_delivery", "x-didit-sdk": { "resource": "webhooks.destinations", "method": "retrieve_delivery", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "parameters": [ { "name": "destination_uuid", "in": "path", "required": true, "description": "UUID адреса назначения webhook, на который была отправлена доставка.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "delivery_uuid", "in": "path", "required": true, "description": "UUID доставки: `uuid` записи, возвращаемой методом `GET /v3/webhook/destinations/{destination_uuid}/deliveries/`.", "schema": { "type": "string", "format": "uuid" }, "example": "66666666-7777-8888-9999-000000000001" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/deliveries/66666666-7777-8888-9999-000000000001/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.webhooks.destinations.retrieve_delivery(\n \"11111111-2222-3333-4444-555555555555\",\n \"66666666-7777-8888-9999-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.webhooks.destinations.retrieveDelivery(\n \"11111111-2222-3333-4444-555555555555\",\n \"66666666-7777-8888-9999-000000000001\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.Destinations.RetrieveDelivery(ctx, \"11111111-2222-3333-4444-555555555555\", \"66666666-7777-8888-9999-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.webhooks().destinations().retrieveDelivery(\"11111111-2222-3333-4444-555555555555\", \"66666666-7777-8888-9999-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->retrieveDelivery('11111111-2222-3333-4444-555555555555', '66666666-7777-8888-9999-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.webhooks.destinations.retrieve_delivery(\n \"11111111-2222-3333-4444-555555555555\",\n \"66666666-7777-8888-9999-000000000001\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Webhooks.Destinations.RetrieveDeliveryAsync(\"11111111-2222-3333-4444-555555555555\", \"66666666-7777-8888-9999-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Доставка вместе с заголовками и телом её запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDestinationDeliveryDetail" }, "examples": { "Connection failure": { "value": { "uuid": "66666666-7777-8888-9999-000000000001", "session_id": "22222222-3333-4444-5555-666666666666", "request_url": "https://yourapp.com/webhooks/didit", "response_status": 503, "response_time_ms": 412, "status": "In Progress", "webhook_type": "status.updated", "created_at": "2026-10-15T09:21:18.412345Z", "request_header": "{\"Content-Type\": \"application/json\", \"X-Signature\": \"a5e02a03404e1337a0198e6be15d34abbd053c658a0e51e5d0e78554213ef29b\", \"X-Signature-V2\": \"927e7cb770c94ce745939bff73f04aa200015f3bc64795ba46c2aaf78a6cedc5\", \"X-Signature-Simple\": \"e37b0d4c716c72bb5ae7127b9cc455d28ab4686e9e22312b4ec2327409a73302\", \"X-Timestamp\": \"1792056078\", \"User-Agent\": \"DiditWebhook/2.0 +https://didit.me\"}", "request_body": "{\"application_id\":\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\"created_at\":1792056057,\"environment\":\"live\",\"event_id\":\"33333333-4444-5555-6666-777777777777\",\"sandbox_scenario\":null,\"session_id\":\"22222222-3333-4444-5555-666666666666\",\"status\":\"In Progress\",\"timestamp\":1792056078,\"vendor_data\":\"user-123\",\"webhook_type\":\"status.updated\",\"workflow_id\":\"44444444-5555-6666-7777-888888888888\",\"workflow_version\":3}" } } } } } }, "401": { "description": "Срок действия API-ключа истёк: он был создан со сроком действия, который уже прошёл. Неверный или отозванный ключ также возвращает `401`; отсутствующий ключ возвращает `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Запрос не разрешён. Отсутствующий, недействительный или отозванный `x-api-key` возвращает `You do not have permission to perform this action.` Ключ с ограниченной областью действия без требуемых для этого endpoint прав возвращает сообщение с указанием недостающих разрешений, а ключ, используемый не из разрешённого списка IP-адресов, возвращает `This API key can't be used from this IP address.` Ключ, ограниченный определёнными сценариями или одобренными сессиями, возвращает `This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint.`", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Missing or invalid key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without webhooks read": { "value": { "detail": "This API key has no read access to webhooks." } }, "Scoped key without decisions read": { "value": { "detail": "This API key has no read access to decisions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "Outside the IP allowlist": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Адрес назначения не существует для данного приложения или был удалён, либо доставка не существует, принадлежит другому адресу назначения или больше недоступна.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Destination not found": { "value": { "detail": "Webhook destination not found." } }, "Delivery not found": { "value": { "detail": "Webhook delivery not found." } } } } } }, "429": { "description": "Лимит запросов превышен: более 600 GET-запросов в текущем минутном окне для этого API-ключа. Подождите `Retry-After` секунд перед повторной попыткой.", "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Количество разрешённых запросов в минутном окне (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Количество оставшихся запросов в текущем окне.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Unix-время (в секундах), когда текущее окно сбрасывается.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Название бюджета, который был превышен.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/webhook/destinations/{destination_uuid}/deliveries/{delivery_uuid}/resend/": { "post": { "summary": "Повторить доставку в адрес назначения webhook", "description": "Отправьте прошлую доставку повторно, например, если ваш endpoint был недоступен. Didit берет сохраненный payload, устанавливает актуальный `timestamp`, снова подписывает его текущим `secret_shared_key` адреса назначения (`X-Signature`, `X-Signature-V2`, `X-Signature-Simple` и `X-Timestamp`) и отправляет методом POST на `request_url` доставки, даже если URL адреса назначения с тех пор изменился или адрес назначения отключен. `event_id` и остальная часть payload остаются без изменений, поэтому выполняйте дедупликацию по `event_id`. Вызов ожидает ответа вашего endpoint до 5 секунд и возвращает новую доставку с кодом `200`, независимо от того, что ответил ваш endpoint: проверяйте `response_status`. Повторная отправка не выполняется автоматически повторно: каждый вызов отправляет данные заново и создает новую доставку, а сам запрос не имеет тела. API-ключу с ограниченной областью действия требуются разрешения `webhooks: write` и `decisions: read`; ключ, ограниченный определенными сценариями или одобренными сессиями, не может использовать этот endpoint.", "operationId": "resend_webhook_destination_delivery", "x-didit-sdk": { "resource": "webhooks.destinations", "method": "resend_delivery", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "parameters": [ { "name": "destination_uuid", "in": "path", "required": true, "description": "UUID адреса назначения webhook, на который была отправлена доставка.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "delivery_uuid", "in": "path", "required": true, "description": "UUID доставки для повторной отправки: `uuid` записи, возвращаемой методом `GET /v3/webhook/destinations/{destination_uuid}/deliveries/`.", "schema": { "type": "string", "format": "uuid" }, "example": "66666666-7777-8888-9999-000000000001" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/deliveries/66666666-7777-8888-9999-000000000001/resend/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.webhooks.destinations.resend_delivery(\n \"11111111-2222-3333-4444-555555555555\",\n \"66666666-7777-8888-9999-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.webhooks.destinations.resendDelivery(\n \"11111111-2222-3333-4444-555555555555\",\n \"66666666-7777-8888-9999-000000000001\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.Destinations.ResendDelivery(ctx, \"11111111-2222-3333-4444-555555555555\", \"66666666-7777-8888-9999-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.webhooks().destinations().resendDelivery(\"11111111-2222-3333-4444-555555555555\", \"66666666-7777-8888-9999-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->resendDelivery('11111111-2222-3333-4444-555555555555', '66666666-7777-8888-9999-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.webhooks.destinations.resend_delivery(\n \"11111111-2222-3333-4444-555555555555\",\n \"66666666-7777-8888-9999-000000000001\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Webhooks.Destinations.ResendDeliveryAsync(\"11111111-2222-3333-4444-555555555555\", \"66666666-7777-8888-9999-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Новая доставка, попытка которой уже была совершена. Поле `response_status` содержит то, что ваш endpoint вернул на этот раз (`504` тайм-аут, `503` сбой подключения). Исходная доставка остаётся без изменений.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDestinationDeliveryDetail" }, "examples": { "Accepted on resend": { "value": { "uuid": "66666666-7777-8888-9999-000000000004", "session_id": "22222222-3333-4444-5555-666666666666", "request_url": "https://yourapp.com/webhooks/didit", "response_status": 200, "response_time_ms": 151, "status": "In Progress", "webhook_type": "status.updated", "created_at": "2026-10-16T14:05:42.330981Z", "request_header": "{\"Content-Type\": \"application/json\", \"X-Signature\": \"b8eb1e376517ee0cad8ba98ff7f8fd35fc72eca231000963a96a335f82328835\", \"X-Signature-V2\": \"9efd2ce9ed1303e1d05273ef9608a59363ed9789a05253db4748b3e8e50cb109\", \"X-Signature-Simple\": \"bf3a9dc04b2c20ab539203b0cd5cca2a10f630bf62d8feb6d68d82af80f64774\", \"X-Timestamp\": \"1792159542\", \"User-Agent\": \"DiditWebhook/2.0 +https://didit.me\"}", "request_body": "{\"application_id\":\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\"created_at\":1792056057,\"environment\":\"live\",\"event_id\":\"33333333-4444-5555-6666-777777777777\",\"sandbox_scenario\":null,\"session_id\":\"22222222-3333-4444-5555-666666666666\",\"status\":\"In Progress\",\"timestamp\":1792159542,\"vendor_data\":\"user-123\",\"webhook_type\":\"status.updated\",\"workflow_id\":\"44444444-5555-6666-7777-888888888888\",\"workflow_version\":3}" } } } } } }, "400": { "description": "Сохранённую доставку не удалось подписать повторно. Ничего не отправлено.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." }, "code": { "type": "string", "description": "Постоянный машиночитаемый код ошибки. Делайте ветвление по нему, а не по `detail`." } } }, "examples": { "Unsignable delivery": { "value": { "detail": "Invalid webhook data format", "code": "invalid_webhook_payload" } } } } } }, "401": { "description": "Срок действия API-ключа истёк: он был создан со сроком действия, который уже прошёл. Неверный или отозванный ключ также возвращает `401`; отсутствующий ключ возвращает `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Запрос не разрешён. Отсутствующий, недействительный или отозванный `x-api-key` возвращает `You do not have permission to perform this action.` Ключ с ограниченной областью действия без требуемых для этого endpoint прав возвращает сообщение с указанием недостающих разрешений, а ключ, используемый не из разрешённого списка IP-адресов, возвращает `This API key can't be used from this IP address.` Ключ, ограниченный определёнными сценариями или одобренными сессиями, возвращает `This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint.`", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Missing or invalid key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without webhooks write": { "value": { "detail": "This API key has no write access to webhooks." } }, "Scoped key without decisions read": { "value": { "detail": "This API key has no read access to decisions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "Outside the IP allowlist": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Адрес назначения не существует для данного приложения или был удалён, либо доставка не существует, принадлежит другому адресу назначения или больше недоступна.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Destination not found": { "value": { "detail": "Webhook destination not found." } }, "Delivery not found": { "value": { "detail": "Webhook delivery not found." } } } } } }, "429": { "description": "Лимит запросов превышен: более 300 запросов на запись (POST, PATCH, PUT, DELETE) в текущем минутном окне для этого API-ключа. Подождите `Retry-After` секунд перед повторной попыткой.", "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Количество разрешённых запросов в минутном окне (300).", "schema": { "type": "integer", "example": 300 } }, "X-RateLimit-Remaining": { "description": "Количество оставшихся запросов в текущем окне.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Unix-время (в секундах), когда текущее окно сбрасывается.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Название бюджета, который был превышен.", "schema": { "type": "string", "example": "generic-write" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Throttled": { "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/events/": { "get": { "summary": "Получить список событий мониторинга", "description": "Получить список событий мониторинга, сохранённых для вашего приложения, начиная с самых новых по `occurred_at`, с опциональными фильтрами, объединяемыми через AND. Фильтры с несколькими значениями (`event_category`, `action_type`, `status`, `retention_class`) повторяют параметр и соответствуют любому из значений; остальные фильтры требуют точного совпадения, а неизвестные значения просто не возвращают событий. Каждый результат представляет собой сводку: вызовите `GET /v3/events/{event_uuid}/` для получения payload, контекста устройства, обогащения IP и обоснования правил, а для истории одного субъекта рекомендуется использовать `GET /v3/events/subjects/{vendor_data}/`. Чтение работает независимо от того, включён ли приём событий. Для API-ключа с ограниченным доступом требуется разрешение `transactions: read`. См. [Приём событий](https://docs.didit.me/ru/transaction-monitoring/events).", "operationId": "list_monitoring_events", "x-didit-sdk": { "resource": "monitoring_events", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Monitoring Events" ], "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Максимальное количество событий на страницу. По умолчанию 50. Значения выше 1000000 возвращают `400`; нечисловое, нулевое или отрицательное значение заменяется на 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "example": 50 }, { "name": "offset", "in": "query", "required": false, "description": "Количество событий, которые нужно пропустить. По умолчанию: 0. Рекомендуется переходить по URL `next` из ответа.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "example": 0 }, { "name": "event_category", "in": "query", "required": false, "description": "Только события в этих категориях. Повторите параметр для нескольких значений (`?event_category=payment&event_category=dispute`); возвращается событие, соответствующее любому из них.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "auth", "session", "gameplay", "bonus", "affiliate", "payment", "dispute", "security", "responsible_gambling", "custom" ] } }, "example": [ "payment", "dispute" ] }, { "name": "action_type", "in": "query", "required": false, "description": "Только события с этими типами действий (точное совпадение с учётом регистра). Повторите для нескольких значений.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "deposit_completed", "chargeback_opened" ] }, { "name": "status", "in": "query", "required": false, "description": "Только события с этими статусами. Повторите для нескольких значений.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "ACCEPTED", "APPROVED", "IN_REVIEW", "DECLINED" ] } }, "example": [ "IN_REVIEW", "DECLINED" ] }, { "name": "retention_class", "in": "query", "required": false, "description": "Только события в этих классах хранения. Повторите для нескольких значений.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "low_value", "standard", "risk_relevant", "monetary_or_compliance" ] } }, "example": [ "risk_relevant" ] }, { "name": "subject_vendor_data", "in": "query", "required": false, "description": "Точное совпадение по `vendor_data` субъекта. Один и тот же идентификатор может указывать как на физическое лицо, так и на компанию; передайте `subject_entity_type`, чтобы выбрать один из них, или используйте `GET /v3/events/subjects/{vendor_data}/`.", "schema": { "type": "string" }, "example": "user-42" }, { "name": "subject_entity_type", "in": "query", "required": false, "description": "`company` возвращает события только для субъектов-компаний; любое другое непустое значение (например, `individual`) возвращает события только физических лиц. Опустите этот параметр, чтобы получить оба типа.", "schema": { "type": "string", "enum": [ "individual", "company" ] }, "example": "individual" }, { "name": "business_vendor_data", "in": "query", "required": false, "description": "Точное совпадение по `business.vendor_data`, переданному вместе с событием.", "schema": { "type": "string" }, "example": "merchant-7" }, { "name": "session_id", "in": "query", "required": false, "description": "Точное совпадение по `session.session_id`.", "schema": { "type": "string" }, "example": "web-session-abc" }, { "name": "device_fingerprint", "in": "query", "required": false, "description": "Точное совпадение по `device_context.fingerprint`.", "schema": { "type": "string" }, "example": "fp-a8c1" }, { "name": "ip_address", "in": "query", "required": false, "description": "Точное совпадение по IP-адресу события.", "schema": { "type": "string" }, "example": "203.0.113.42" }, { "name": "game_id", "in": "query", "required": false, "description": "Точное совпадение по продвигаемому `game_id`.", "schema": { "type": "string" }, "example": "poker-holdem-01" }, { "name": "round_id", "in": "query", "required": false, "description": "Точное совпадение по продвигаемому `round_id`.", "schema": { "type": "string" }, "example": "round-88231" }, { "name": "affiliate_code", "in": "query", "required": false, "description": "Точное совпадение по продвигаемому `affiliate_code`.", "schema": { "type": "string" }, "example": "aff-summer" }, { "name": "payment_reference_id", "in": "query", "required": false, "description": "Точное совпадение по платёжному идентификатору (из `transaction_context.payment_reference_id` или `payload.payment_reference_id`).", "schema": { "type": "string" }, "example": "dep_735" }, { "name": "counterparty_vendor_data", "in": "query", "required": false, "description": "Точное совпадение по продвигаемому `counterparty_vendor_data`.", "schema": { "type": "string" }, "example": "user-77" }, { "name": "matched_only", "in": "query", "required": false, "description": "`true` (также `1` или `yes`, без учёта регистра) возвращает только события, которым соответствует хотя бы одно правило (`rules_matched_count` больше 0). Любое другое значение игнорируется.", "schema": { "type": "boolean", "default": false }, "example": true }, { "name": "occurred_from", "in": "query", "required": false, "description": "Только события с `occurred_at` в этот момент или позже (включительно). Передайте значение в формате ISO 8601: `2026-10-01T00:00:00Z`, явное смещение с закодированным знаком `+` (`2026-10-01T02:00:00%2B02:00`; незакодированный `+` декодируется как пробел, и значение перестаёт распознаваться) или только дату (`2026-10-01`), что означает 00:00:00 UTC этого дня. Значение без смещения считывается как UTC. Значения в любом другом формате не принимаются.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-10-01T00:00:00Z" }, { "name": "occurred_to", "in": "query", "required": false, "description": "Только события с `occurred_at` в этот момент или раньше (включительно). Дата без времени означает начало этого дня, поэтому `occurred_to=2026-10-15` исключает остальную часть 15 октября; отправьте `2026-10-15T23:59:59Z`, чтобы включить её. Передайте значение в формате ISO 8601: `2026-10-01T00:00:00Z`, явное смещение с закодированным знаком `+` (`2026-10-01T02:00:00%2B02:00`; незакодированный `+` декодируется как пробел, и значение перестаёт распознаваться) или только дату (`2026-10-01`), что означает 00:00:00 UTC этого дня. Значение без смещения считывается как UTC. Значения в любом другом формате не принимаются.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-10-17T23:59:59Z" }, { "name": "search", "in": "query", "required": false, "description": "Поиск подстроки без учёта регистра по `event_id`, `action_type`, `subject_vendor_data` или `counterparty_vendor_data`.", "schema": { "type": "string" }, "example": "chargeback" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/events/?event_category=payment&event_category=dispute&matched_only=true&occurred_from=2026-10-01T00:00:00Z&limit=50' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.monitoring_events.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.monitoringEvents.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.MonitoringEvents.ListAutoPaging(ctx, didit.MonitoringEventsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.monitoringEvents().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "monitoringEvents->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.monitoring_events.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.MonitoringEvents.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Одна страница со сводкой событий.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringEventPage" }, "examples": { "Payment and dispute events": { "value": { "count": 2, "next": null, "previous": null, "results": [ { "event_uuid": "11111111-2222-3333-4444-555555555555", "event_id": "chargeback-2026-10-16-000318", "event_category": "dispute", "action_type": "chargeback_opened", "occurred_at": "2026-10-16T14:02:11Z", "received_at": "2026-10-16T14:02:12.418230Z", "status": "IN_REVIEW", "score": 60, "subject_vendor_data": "user-42", "subject_entity_type": "individual", "subject_uuid": "66666666-7777-8888-9999-000000000000", "counterparty_vendor_data": null, "session_id": null, "device_fingerprint": null, "ip_address": null, "ip_country": null, "amount": "250.000000000000000000", "currency": "EUR", "game_id": null, "round_id": null, "bonus_id": null, "affiliate_code": null, "payment_reference_id": "dep_735", "retention_class": "monetary_or_compliance", "rules_matched_count": 1, "correlation_pending": false, "is_droppable": false }, { "event_uuid": "22222222-3333-4444-5555-666666666666", "event_id": "login-2026-10-15-000912", "event_category": "auth", "action_type": "login", "occurred_at": "2026-10-15T08:30:00.120000Z", "received_at": "2026-10-15T08:30:00.734512Z", "status": "ACCEPTED", "score": 0, "subject_vendor_data": "user-42", "subject_entity_type": "individual", "subject_uuid": "66666666-7777-8888-9999-000000000000", "counterparty_vendor_data": null, "session_id": "web-session-abc", "device_fingerprint": "fp-a8c1", "ip_address": "203.0.113.42", "ip_country": "ES", "amount": null, "currency": null, "game_id": null, "round_id": null, "bonus_id": null, "affiliate_code": null, "payment_reference_id": null, "retention_class": "standard", "rules_matched_count": 0, "correlation_pending": false, "is_droppable": true } ] } } } } } }, "400": { "description": "`limit` или `offset` превышает 1000000. Тело ответа представляет собой JSON-массив с одним сообщением. Нечисловое или неположительное значение `limit` возвращается к значению по умолчанию 50 вместо ошибки.", "content": { "application/json": { "examples": { "limit too large": { "summary": "limit превышает 1000000", "value": [ "limit must not exceed 1000000." ] }, "offset too large": { "summary": "offset превышает 1000000", "value": [ "offset must not exceed 1000000." ] } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Только при истёкшем сроке действия ключа возвращается `401`; при отсутствии ключа или его недействительности возвращается `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Отсутствует `x-api-key` (неверный, отозванный или истекший ключ возвращает `401`), ключ с ограниченной областью действия без права `transactions: read`, ключ, ограниченный определёнными сценариями или одобренными сессиями (такой ключ никогда не получает доступ к данным мониторинга транзакций), либо запрос отправлен не из списка разрешённых адресов ключа.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without access": { "value": { "detail": "This API key has no read access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "IP not allowed": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "429": { "description": "Лимит запросов превышен: `GET`-запросы разделяют лимит в 600 запросов в минуту на один API-ключ. Подождите `Retry-After` секунд, затем повторите попытку.", "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } }, "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Создать событие мониторинга", "description": "Отправьте одно немонетарное событие (логин, сессия, игровой процесс, бонус, реферал, платёж, спор, безопасность, ответственная игра или кастомное) из вашего бэкенда. Событие валидируется на соответствие контракту категории, сохраняется, обогащается IP-данными один раз для каждого уникального публичного адреса и проверяется вашими правилами событий реального времени до возврата ответа; межсубъектные правила и правила с длинным окном выполняются асинхронно (`correlation_pending: true`), а в приложении песочницы правила не выполняются вовсе. Поле `event_id` служит ключом идемпотентности: запрос с тем же `event_id`, `event_category`, `action_type`, `occurred_at`, `subject.vendor_data` и `payload` возвращает `200` с флагом `idempotent_replay: true` и сохранённым результатом (другие поля конверта не сравниваются), в то время как отличающиеся значения возвращают `409`. Приём событий подключается отдельно для каждого приложения: пока он не включён, этот endpoint возвращает `403` с кодом `code: event_monitoring_disabled` и ничего не сохраняет. API-ключу с ограниченными правами требуется разрешение `transactions: write`. См. [Приём событий](https://docs.didit.me/ru/transaction-monitoring/events) и [Правила для событий](https://docs.didit.me/ru/transaction-monitoring/event-rules); для отправки событий из браузера или приложения используйте [Отправку событий через SDK](https://docs.didit.me/ru/transaction-monitoring/sdk-event-submission).", "operationId": "create_monitoring_event", "x-didit-sdk": { "resource": "monitoring_events", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Monitoring Events" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringEventCreateRequest" }, "examples": { "Login": { "value": { "event_id": "login-2026-10-17-000001", "event_category": "auth", "action_type": "login", "occurred_at": "2026-10-17T09:15:02.481Z", "time_zone": "Europe/Madrid", "subject": { "vendor_data": "user-42", "entity_type": "individual" }, "session": { "session_id": "web-session-abc", "sequence": 142 }, "device_context": { "fingerprint": "fp-a8c1", "network_context": { "ip_address": "203.0.113.42" } }, "payload": { "method": "password" }, "custom_values": { "vip_tier": "gold" } } }, "Deposit completed": { "value": { "event_id": "deposit-2026-10-17-000002", "event_category": "payment", "action_type": "deposit_completed", "occurred_at": "2026-10-17T09:16:40Z", "subject": { "vendor_data": "user-42" }, "transaction_context": { "amount": "100.00", "currency": "EUR", "direction": "inbound", "payment_reference_id": "dep_736" }, "payload": { "payment_method": "card", "status": "completed" } } }, "Chargeback opened": { "value": { "event_id": "chargeback-2026-10-16-000318", "event_category": "dispute", "action_type": "chargeback_opened", "occurred_at": "2026-10-16T14:02:11Z", "subject": { "vendor_data": "user-42" }, "payload": { "payment_reference_id": "dep_735", "chargeback_id": "cb_5521", "amount": "250.00", "currency": "EUR", "reason_code": "fraud" } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/events/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"event_id\": \"login-2026-10-17-000001\",\n \"event_category\": \"auth\",\n \"action_type\": \"login\",\n \"occurred_at\": \"2026-10-17T09:15:02.481Z\",\n \"subject\": {\"vendor_data\": \"user-42\", \"entity_type\": \"individual\"},\n \"session\": {\"session_id\": \"web-session-abc\", \"sequence\": 142},\n \"device_context\": {\n \"fingerprint\": \"fp-a8c1\",\n \"network_context\": {\"ip_address\": \"203.0.113.42\"}\n },\n \"payload\": {\"method\": \"password\"}\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.monitoring_events.create(\n event_id=\"login-2026-10-17-000001\",\n event_category=\"auth\",\n action_type=\"login\",\n occurred_at=\"2026-10-17T09:15:02.481Z\",\n time_zone=\"Europe/Madrid\",\n subject={\n \"vendor_data\": \"user-42\",\n \"entity_type\": \"individual\",\n },\n session={\n \"session_id\": \"web-session-abc\",\n \"sequence\": 142,\n },\n device_context={\n \"fingerprint\": \"fp-a8c1\",\n \"network_context\": {\n \"ip_address\": \"203.0.113.42\",\n },\n },\n payload={\"method\": \"password\"},\n custom_values={\"vip_tier\": \"gold\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.monitoringEvents.create({\n event_id: \"login-2026-10-17-000001\",\n event_category: \"auth\",\n action_type: \"login\",\n occurred_at: \"2026-10-17T09:15:02.481Z\",\n time_zone: \"Europe/Madrid\",\n subject: {\n vendor_data: \"user-42\",\n entity_type: \"individual\",\n },\n session: {\n session_id: \"web-session-abc\",\n sequence: 142,\n },\n device_context: {\n fingerprint: \"fp-a8c1\",\n network_context: {\n ip_address: \"203.0.113.42\",\n },\n },\n payload: { method: \"password\" },\n custom_values: { vip_tier: \"gold\" },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.MonitoringEvents.Create(ctx, didit.MonitoringEventCreateRequest{\n\tEventID: \"login-2026-10-17-000001\",\n\tEventCategory: \"auth\",\n\tActionType: \"login\",\n\tOccurredAt: time.Date(2026, 10, 17, 9, 15, 2, 0, time.UTC),\n\tTimeZone: didit.String(\"Europe/Madrid\"),\n\tSubject: didit.MonitoringEventCreateRequestSubject{\n\t\tVendorData: \"user-42\",\n\t\tEntityType: didit.String(\"individual\"),\n\t},\n\tSession: didit.Some(didit.MonitoringEventCreateRequestSession{\n\t\tSessionID: didit.String(\"web-session-abc\"),\n\t\tSequence: didit.Int(142),\n\t}),\n\tDeviceContext: didit.Some(didit.MonitoringEventCreateRequestDeviceContext{\n\t\tFingerprint: didit.String(\"fp-a8c1\"),\n\t\tNetworkContext: didit.Some(didit.MonitoringEventCreateRequestDeviceContextNetworkContext{\n\t\t\tIPAddress: didit.String(\"203.0.113.42\"),\n\t\t}),\n\t}),\n\tPayload: didit.Some(map[string]any{\"method\": \"password\"}),\n\tCustomValues: didit.Some(map[string]any{\"vip_tier\": \"gold\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.OffsetDateTime;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.MonitoringEventCreateRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.monitoringEvents().create(MonitoringEventCreateRequest.builder()\n .eventId(\"login-2026-10-17-000001\")\n .eventCategory(MonitoringEventCreateRequest.EventCategory.of(\"auth\"))\n .actionType(\"login\")\n .occurredAt(OffsetDateTime.parse(\"2026-10-17T09:15:02.481Z\"))\n .timeZone(\"Europe/Madrid\")\n .subject(MonitoringEventCreateRequest.Subject.builder()\n .vendorData(\"user-42\")\n .entityType(\"individual\")\n .build())\n .session(MonitoringEventCreateRequest.Session.builder()\n .sessionId(\"web-session-abc\")\n .sequence(142L)\n .build())\n .deviceContext(MonitoringEventCreateRequest.DeviceContext.builder()\n .fingerprint(\"fp-a8c1\")\n .networkContext(MonitoringEventCreateRequest.DeviceContext.NetworkContext.builder()\n .ipAddress(\"203.0.113.42\")\n .build())\n .build())\n .payload(Map.of(\"method\", \"password\"))\n .customValues(Map.of(\"vip_tier\", MonitoringEventCreateRequest.CustomValuesValue.ofString(\"gold\")))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "monitoringEvents->create([\n 'event_id' => 'login-2026-10-17-000001',\n 'event_category' => 'auth',\n 'action_type' => 'login',\n 'occurred_at' => '2026-10-17T09:15:02.481Z',\n 'time_zone' => 'Europe/Madrid',\n 'subject' => [\n 'vendor_data' => 'user-42',\n 'entity_type' => 'individual',\n ],\n 'session' => [\n 'session_id' => 'web-session-abc',\n 'sequence' => 142,\n ],\n 'device_context' => [\n 'fingerprint' => 'fp-a8c1',\n 'network_context' => [\n 'ip_address' => '203.0.113.42',\n ],\n ],\n 'payload' => ['method' => 'password'],\n 'custom_values' => ['vip_tier' => 'gold'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.monitoring_events.create(\n event_id: \"login-2026-10-17-000001\",\n event_category: \"auth\",\n action_type: \"login\",\n occurred_at: \"2026-10-17T09:15:02.481Z\",\n time_zone: \"Europe/Madrid\",\n subject: {\n vendor_data: \"user-42\",\n entity_type: \"individual\",\n },\n session: {\n session_id: \"web-session-abc\",\n sequence: 142,\n },\n device_context: {\n fingerprint: \"fp-a8c1\",\n network_context: {\n ip_address: \"203.0.113.42\",\n },\n },\n payload: { method: \"password\" },\n custom_values: { vip_tier: \"gold\" }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.MonitoringEvents.CreateAsync(new MonitoringEventCreateRequest\n{\n EventId = \"login-2026-10-17-000001\",\n EventCategory = \"auth\",\n ActionType = \"login\",\n OccurredAt = DateTimeOffset.Parse(\"2026-10-17T09:15:02.481Z\"),\n TimeZone = \"Europe/Madrid\",\n Subject = new()\n {\n VendorData = \"user-42\",\n EntityType = \"individual\",\n },\n Session = new MonitoringEventCreateRequestSession\n {\n SessionId = \"web-session-abc\",\n Sequence = 142,\n },\n DeviceContext = new MonitoringEventCreateRequestDeviceContext\n {\n Fingerprint = \"fp-a8c1\",\n NetworkContext = new MonitoringEventCreateRequestDeviceContextNetworkContext\n {\n IpAddress = \"203.0.113.42\",\n },\n },\n Payload = new Dictionary { [\"method\"] = \"password\" },\n CustomValues = new Dictionary { [\"vip_tier\"] = \"gold\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Событие сохранено и оценено.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringEventIngestResult" }, "examples": { "Stored, no rule matched": { "value": { "event_uuid": "33333333-4444-5555-6666-777777777777", "event_id": "login-2026-10-17-000001", "status": "ACCEPTED", "score": 0, "rules_evaluated_count": 6, "rules_matched_count": 0, "correlation_pending": false, "retention_class": "standard", "expires_at": "2026-11-16T09:15:02.481000Z", "idempotent_replay": false, "rule_matches": [] } }, "Rule matched, async rule pending": { "value": { "event_uuid": "33333333-4444-5555-6666-777777777777", "event_id": "login-2026-10-17-000001", "status": "IN_REVIEW", "score": 40, "rules_evaluated_count": 6, "rules_matched_count": 1, "correlation_pending": true, "retention_class": "risk_relevant", "expires_at": "2027-01-15T09:15:02.481000Z", "idempotent_replay": false, "rule_matches": [ { "rule_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "library_key": null, "mode": "ACTIVE", "is_async": false } ] } } } } } }, "200": { "description": "Идемпотентный повтор: событие с таким `event_id` и тем же содержимым уже сохранено. Повторное сохранение или оценка не выполнялись; тело ответа описывает сохранённое событие.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringEventIngestResult" }, "examples": { "Replay": { "value": { "event_uuid": "33333333-4444-5555-6666-777777777777", "event_id": "login-2026-10-17-000001", "status": "ACCEPTED", "score": 0, "rules_evaluated_count": 6, "rules_matched_count": 0, "correlation_pending": false, "retention_class": "standard", "expires_at": "2026-11-16T09:15:02.481000Z", "idempotent_replay": true, "rule_matches": [] } } } } } }, "400": { "description": "Ошибка валидации. Ключами тела запроса являются поля; вложенные поля представляют собой вложенные объекты. Ничего не сохранено.", "content": { "application/json": { "examples": { "Missing fields": { "value": { "event_id": [ "This field is required." ], "subject": [ "This field is required." ] } }, "Unknown category": { "value": { "event_category": [ "\"login\" is not a valid choice." ] } }, "occurred_at too old": { "value": { "occurred_at": [ "occurred_at is more than 7 days in the past. Use the batch import lane for backfills." ] } }, "occurred_at in the future": { "value": { "occurred_at": [ "occurred_at is more than 5 minutes in the future." ] } }, "Missing subject vendor_data": { "value": { "subject": { "vendor_data": [ "This field is required." ] } } }, "Missing required payload keys": { "value": { "payload": [ "payment.deposit_completed requires: payment_method, status." ] } }, "Missing one-of payload key": { "value": { "payload": [ "dispute.chargeback_opened requires one of: dispute_id, chargeback_id." ] } }, "Security change without changed_field": { "value": { "payload": [ "security.*_changed requires 'changed_field'." ] } }, "Payload too large": { "value": { "payload": [ "payload exceeds 16384 bytes. Summarise telemetry client-side." ] } }, "Too many custom_values": { "value": { "custom_values": [ "custom_values accepts at most 100 keys." ] } }, "Nested custom value": { "value": { "custom_values": [ "custom_values['limits'] must be a scalar - rule conditions cannot address nested values." ] } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Только при истёкшем сроке действия ключа возвращается `401`; при отсутствии ключа или его недействительности возвращается `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Отсутствует `x-api-key` (неверный, отозванный или истекший ключ возвращает `401`), ключ с ограниченной областью действия без права `transactions: write`, ключ, ограниченный определёнными сценариями или одобренными сессиями (такой ключ никогда не получает доступ к данным мониторинга транзакций), либо запрос отправлен не из списка разрешённых адресов ключа. Также возвращается с `code: event_monitoring_disabled`, пока сбор событий выключен для приложения; в этом случае ничего не сохраняется, а проверка выполняется до валидации тела запроса.", "content": { "application/json": { "examples": { "Event monitoring disabled": { "value": { "detail": "Event monitoring is not enabled for this application. Turn on event ingestion in the transaction monitoring settings before submitting events.", "code": "event_monitoring_disabled" } }, "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without access": { "value": { "detail": "This API key has no write access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "IP not allowed": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "409": { "description": "`event_id` уже использовался для события с другим содержимым (категория, тип действия, `occurred_at`, `vendor_data` субъекта или payload). Отправьте событие с новым `event_id`.", "content": { "application/json": { "examples": { "event_id reused": { "value": { "event_id": "event_id 'login-2026-10-17-000001' already exists with a different payload." } } } } } }, "429": { "description": "Лимит запросов превышен: создание транзакций и приём событий (`POST /v3/transactions/`, `POST /v3/events/`, `POST /v3/events/batch/`) разделяют лимит в 600 запросов в минуту на один API-ключ, отдельно от лимита в 300 запросов для всех остальных запросов на запись. Подождите `Retry-After` секунд, затем повторите попытку.", "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой, округлённое в большую сторону, чтобы повторный запрос попал в следующее окно.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } }, "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Ingestion rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/events/batch/": { "post": { "summary": "Создать события мониторинга пакетом", "description": "Отправьте от 1 до 500 событий в одном запросе, каждое в таком же конверте, как и в `POST /v3/events/`. Каждый элемент валидируется, сохраняется и оценивается независимо и получает собственный результат (`accepted`, `replayed` или `rejected`), поэтому одно некорректное событие никогда не отменяет остальные: возвращается ответ `201`, если ни один элемент не был отклонен, и `207`, если был отклонен хотя бы один, причем оба статуса означают, что запрос был обработан. Отправьте `{\"events\": [...]}`; простой JSON-массив событий также принимается. Сбор событий должен быть включен для приложения, иначе весь запрос вернет `403` с `code: event_monitoring_disabled` и ничего не сохранится. API-ключу с ограниченной областью действия требуется разрешение `transactions: write`. См. [Пакеты](https://docs.didit.me/ru/transaction-monitoring/events#пакетная-отправка).", "operationId": "create_monitoring_events_batch", "x-didit-sdk": { "resource": "monitoring_events", "method": "create_batch", "auth": "api_key", "server": true }, "tags": [ "Monitoring Events" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "events" ], "properties": { "events": { "type": "array", "minItems": 1, "maxItems": 500, "description": "От 1 до 500 событий. Каждый элемент соответствует `MonitoringEventCreateRequest`, включая окно для `occurred_at`: не более 7 дней в прошлом и не более 5 минут в будущем.", "items": { "$ref": "#/components/schemas/MonitoringEventCreateRequest" } } } }, "example": { "events": [ { "event_id": "login-2026-10-17-000001", "event_category": "auth", "action_type": "login", "occurred_at": "2026-10-17T09:15:02.481Z", "subject": { "vendor_data": "user-42" } }, { "event_id": "deposit-2026-10-17-000002", "event_category": "payment", "action_type": "deposit_completed", "occurred_at": "2026-10-17T09:16:40Z", "subject": { "vendor_data": "user-42" }, "transaction_context": { "amount": "100.00", "currency": "EUR", "payment_reference_id": "dep_736" }, "payload": { "payment_method": "card", "status": "completed" } } ] } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/events/batch/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"events\": [\n {\"event_id\": \"login-2026-10-17-000001\", \"event_category\": \"auth\", \"action_type\": \"login\",\n \"occurred_at\": \"2026-10-17T09:15:02.481Z\", \"subject\": {\"vendor_data\": \"user-42\"}},\n {\"event_id\": \"deposit-2026-10-17-000002\", \"event_category\": \"payment\", \"action_type\": \"deposit_completed\",\n \"occurred_at\": \"2026-10-17T09:16:40.000Z\", \"subject\": {\"vendor_data\": \"user-42\"},\n \"transaction_context\": {\"amount\": \"100.00\", \"currency\": \"EUR\", \"payment_reference_id\": \"dep_736\"},\n \"payload\": {\"payment_method\": \"card\", \"status\": \"completed\"}}\n ]\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.monitoring_events.create_batch(\n events=[{\n \"event_id\": \"login-2026-10-17-000001\",\n \"event_category\": \"auth\",\n \"action_type\": \"login\",\n \"occurred_at\": \"2026-10-17T09:15:02.481Z\",\n \"subject\": {\n \"vendor_data\": \"user-42\",\n },\n }, {\n \"event_id\": \"deposit-2026-10-17-000002\",\n \"event_category\": \"payment\",\n \"action_type\": \"deposit_completed\",\n \"occurred_at\": \"2026-10-17T09:16:40Z\",\n \"subject\": {\n \"vendor_data\": \"user-42\",\n },\n \"transaction_context\": {\n \"amount\": \"100.00\",\n \"currency\": \"EUR\",\n \"payment_reference_id\": \"dep_736\",\n },\n \"payload\": {\"payment_method\": \"card\", \"status\": \"completed\"},\n }],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.monitoringEvents.createBatch({\n events: [{\n event_id: \"login-2026-10-17-000001\",\n event_category: \"auth\",\n action_type: \"login\",\n occurred_at: \"2026-10-17T09:15:02.481Z\",\n subject: {\n vendor_data: \"user-42\",\n },\n }, {\n event_id: \"deposit-2026-10-17-000002\",\n event_category: \"payment\",\n action_type: \"deposit_completed\",\n occurred_at: \"2026-10-17T09:16:40Z\",\n subject: {\n vendor_data: \"user-42\",\n },\n transaction_context: {\n amount: \"100.00\",\n currency: \"EUR\",\n payment_reference_id: \"dep_736\",\n },\n payload: { payment_method: \"card\", status: \"completed\" },\n }],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.MonitoringEvents.CreateBatch(ctx, didit.MonitoringEventsCreateBatchParams{\n\tEvents: []didit.MonitoringEventCreateRequest{{\n\t\tEventID: \"login-2026-10-17-000001\",\n\t\tEventCategory: \"auth\",\n\t\tActionType: \"login\",\n\t\tOccurredAt: time.Date(2026, 10, 17, 9, 15, 2, 0, time.UTC),\n\t\tSubject: didit.MonitoringEventCreateRequestSubject{\n\t\t\tVendorData: \"user-42\",\n\t\t},\n\t}, {\n\t\tEventID: \"deposit-2026-10-17-000002\",\n\t\tEventCategory: \"payment\",\n\t\tActionType: \"deposit_completed\",\n\t\tOccurredAt: time.Date(2026, 10, 17, 9, 16, 40, 0, time.UTC),\n\t\tSubject: didit.MonitoringEventCreateRequestSubject{\n\t\t\tVendorData: \"user-42\",\n\t\t},\n\t\tTransactionContext: didit.Some(didit.MonitoringEventCreateRequestTransactionContext{\n\t\t\tAmount: didit.String(\"100.00\"),\n\t\t\tCurrency: didit.String(\"EUR\"),\n\t\t\tPaymentReferenceID: didit.String(\"dep_736\"),\n\t\t}),\n\t\tPayload: didit.Some(map[string]any{\"payment_method\": \"card\", \"status\": \"completed\"}),\n\t}},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.MonitoringEventCreateRequest;\nimport me.didit.types.MonitoringEventsCreateBatchParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.monitoringEvents().createBatch(MonitoringEventsCreateBatchParams.builder()\n .events(List.of(\n MonitoringEventCreateRequest.builder()\n .eventId(\"login-2026-10-17-000001\")\n .eventCategory(MonitoringEventCreateRequest.EventCategory.of(\"auth\"))\n .actionType(\"login\")\n .occurredAt(OffsetDateTime.parse(\"2026-10-17T09:15:02.481Z\"))\n .subject(MonitoringEventCreateRequest.Subject.builder()\n .vendorData(\"user-42\")\n .build())\n .build(),\n MonitoringEventCreateRequest.builder()\n .eventId(\"deposit-2026-10-17-000002\")\n .eventCategory(MonitoringEventCreateRequest.EventCategory.of(\"payment\"))\n .actionType(\"deposit_completed\")\n .occurredAt(OffsetDateTime.parse(\"2026-10-17T09:16:40Z\"))\n .subject(MonitoringEventCreateRequest.Subject.builder()\n .vendorData(\"user-42\")\n .build())\n .transactionContext(MonitoringEventCreateRequest.TransactionContext.builder()\n .amount(\"100.00\")\n .currency(\"EUR\")\n .paymentReferenceId(\"dep_736\")\n .build())\n .payload(Map.of(\"payment_method\", \"card\", \"status\", \"completed\"))\n .build()))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "monitoringEvents->createBatch([\n 'events' => [[\n 'event_id' => 'login-2026-10-17-000001',\n 'event_category' => 'auth',\n 'action_type' => 'login',\n 'occurred_at' => '2026-10-17T09:15:02.481Z',\n 'subject' => [\n 'vendor_data' => 'user-42',\n ],\n ], [\n 'event_id' => 'deposit-2026-10-17-000002',\n 'event_category' => 'payment',\n 'action_type' => 'deposit_completed',\n 'occurred_at' => '2026-10-17T09:16:40Z',\n 'subject' => [\n 'vendor_data' => 'user-42',\n ],\n 'transaction_context' => [\n 'amount' => '100.00',\n 'currency' => 'EUR',\n 'payment_reference_id' => 'dep_736',\n ],\n 'payload' => ['payment_method' => 'card', 'status' => 'completed'],\n ]],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.monitoring_events.create_batch(\n events: [{\n event_id: \"login-2026-10-17-000001\",\n event_category: \"auth\",\n action_type: \"login\",\n occurred_at: \"2026-10-17T09:15:02.481Z\",\n subject: {\n vendor_data: \"user-42\",\n },\n }, {\n event_id: \"deposit-2026-10-17-000002\",\n event_category: \"payment\",\n action_type: \"deposit_completed\",\n occurred_at: \"2026-10-17T09:16:40Z\",\n subject: {\n vendor_data: \"user-42\",\n },\n transaction_context: {\n amount: \"100.00\",\n currency: \"EUR\",\n payment_reference_id: \"dep_736\",\n },\n payload: { payment_method: \"card\", status: \"completed\" },\n }]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.MonitoringEvents.CreateBatchAsync(new MonitoringEventsCreateBatchParams\n{\n Events = new MonitoringEventCreateRequest[]\n {\n new()\n {\n EventId = \"login-2026-10-17-000001\",\n EventCategory = \"auth\",\n ActionType = \"login\",\n OccurredAt = DateTimeOffset.Parse(\"2026-10-17T09:15:02.481Z\"),\n Subject = new()\n {\n VendorData = \"user-42\",\n },\n },\n new()\n {\n EventId = \"deposit-2026-10-17-000002\",\n EventCategory = \"payment\",\n ActionType = \"deposit_completed\",\n OccurredAt = DateTimeOffset.Parse(\"2026-10-17T09:16:40Z\"),\n Subject = new()\n {\n VendorData = \"user-42\",\n },\n TransactionContext = new MonitoringEventCreateRequestTransactionContext\n {\n Amount = \"100.00\",\n Currency = \"EUR\",\n PaymentReferenceId = \"dep_736\",\n },\n Payload = new Dictionary { [\"payment_method\"] = \"card\", [\"status\"] = \"completed\" },\n },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Ни один элемент не был отклонен: каждый элемент имеет статус `accepted` или `replayed`.", "content": { "application/json": { "schema": { "type": "object", "required": [ "accepted_count", "replayed_count", "rejected_count", "results" ], "properties": { "accepted_count": { "type": "integer", "minimum": 0, "description": "Элементы сохранены и оценены." }, "replayed_count": { "type": "integer", "minimum": 0, "description": "Элементы, уже сохранённые с тем же содержимым." }, "rejected_count": { "type": "integer", "minimum": 0, "description": "Элементы не сохранены." }, "results": { "type": "array", "description": "Одна запись на каждый элемент в порядке запроса.", "items": { "type": "object", "description": "Результат для одного элемента. Принятые и повторно обработанные элементы также содержат все поля `MonitoringEventIngestResult`; отклонённые элементы вместо этого содержат `event_id` и `errors`.", "required": [ "index", "outcome" ], "properties": { "index": { "type": "integer", "minimum": 0, "description": "Позиция элемента в вашем массиве `events`." }, "outcome": { "type": "string", "enum": [ "accepted", "replayed", "rejected" ], "description": "`accepted`: сохранено и оценено. `replayed`: уже сохранено с тем же содержимым. `rejected`: не сохранено; см. `errors`." }, "event_id": { "type": "string", "nullable": true, "description": "Ваш `event_id`. Для элементов, отклонённых валидацией, он считывается из ключа элемента `event_id` в snake_case, поэтому он равен null, если в элементе отсутствовал этот ключ или был передан псевдоним `eventId`." }, "errors": { "type": "object", "additionalProperties": true, "description": "Только отклонённые элементы. Ошибки валидации с ключами по полям в том же формате, что и при ошибке `400` в `POST /v3/events/`; повторно использованный `event_id` с другим содержимым возвращается в виде строки в `errors.event_id`." }, "event_uuid": { "type": "string", "format": "uuid", "description": "Только принятые и повторно отправленные элементы." }, "status": { "type": "string", "enum": [ "ACCEPTED", "APPROVED", "IN_REVIEW", "DECLINED" ], "description": "Только принятые и повторно отправленные элементы." }, "score": { "type": "integer", "description": "Только принятые и повторно отправленные элементы." }, "rules_evaluated_count": { "type": "integer", "description": "Только принятые и повторно отправленные элементы." }, "rules_matched_count": { "type": "integer", "description": "Только принятые и повторно отправленные элементы." }, "correlation_pending": { "type": "boolean", "description": "Только принятые и повторно отправленные элементы." }, "retention_class": { "type": "string", "enum": [ "low_value", "standard", "risk_relevant", "monetary_or_compliance" ], "description": "Только принятые и повторно отправленные элементы." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Только принятые и повторно отправленные элементы." }, "idempotent_replay": { "type": "boolean", "description": "Только принятые и повторно отправленные элементы." }, "rule_matches": { "type": "array", "description": "Только принятые и повторно отправленные элементы.", "items": { "type": "object", "required": [ "rule_id", "library_key", "mode", "is_async" ], "properties": { "rule_id": { "type": "string", "format": "uuid", "description": "UUID правила." }, "library_key": { "type": "string", "nullable": true, "description": "Ключ библиотеки, если правило было установлено из библиотеки правил, иначе null." }, "mode": { "type": "string", "enum": [ "ACTIVE", "TEST" ], "description": "Правила типа `TEST` регистрируют совпадение, но не применяют никаких действий." }, "is_async": { "type": "boolean", "description": "`true`, если совпадение было получено в результате асинхронного прохода." } } } } } } } } }, "examples": { "All landed": { "value": { "accepted_count": 1, "replayed_count": 1, "rejected_count": 0, "results": [ { "index": 0, "outcome": "accepted", "event_uuid": "33333333-4444-5555-6666-777777777777", "event_id": "login-2026-10-17-000001", "status": "ACCEPTED", "score": 0, "rules_evaluated_count": 6, "rules_matched_count": 0, "correlation_pending": false, "retention_class": "standard", "expires_at": "2026-11-16T09:15:02.481000Z", "idempotent_replay": false, "rule_matches": [] }, { "index": 1, "outcome": "replayed", "event_uuid": "11111111-2222-3333-4444-555555555555", "event_id": "deposit-2026-10-17-000002", "status": "ACCEPTED", "score": 0, "rules_evaluated_count": 6, "rules_matched_count": 0, "correlation_pending": false, "retention_class": "monetary_or_compliance", "expires_at": null, "idempotent_replay": true, "rule_matches": [] } ] } } } } } }, "207": { "description": "Как минимум один элемент был отклонён. Остальные элементы были сохранены; исправьте и отправьте повторно только отклонённые (повторная отправка принятого элемента безопасна, он возвращается со статусом `replayed`).", "content": { "application/json": { "schema": { "type": "object", "required": [ "accepted_count", "replayed_count", "rejected_count", "results" ], "properties": { "accepted_count": { "type": "integer", "minimum": 0, "description": "Элементы сохранены и оценены." }, "replayed_count": { "type": "integer", "minimum": 0, "description": "Элементы, уже сохранённые с тем же содержимым." }, "rejected_count": { "type": "integer", "minimum": 0, "description": "Элементы не сохранены." }, "results": { "type": "array", "description": "Одна запись на каждый элемент в порядке запроса.", "items": { "type": "object", "description": "Результат для одного элемента. Принятые и повторно обработанные элементы также содержат все поля `MonitoringEventIngestResult`; отклонённые элементы вместо этого содержат `event_id` и `errors`.", "required": [ "index", "outcome" ], "properties": { "index": { "type": "integer", "minimum": 0, "description": "Позиция элемента в вашем массиве `events`." }, "outcome": { "type": "string", "enum": [ "accepted", "replayed", "rejected" ], "description": "`accepted`: сохранено и оценено. `replayed`: уже сохранено с тем же содержимым. `rejected`: не сохранено; см. `errors`." }, "event_id": { "type": "string", "nullable": true, "description": "Ваш `event_id`. Для элементов, отклонённых валидацией, он считывается из ключа элемента `event_id` в snake_case, поэтому он равен null, если в элементе отсутствовал этот ключ или был передан псевдоним `eventId`." }, "errors": { "type": "object", "additionalProperties": true, "description": "Только отклонённые элементы. Ошибки валидации с ключами по полям в том же формате, что и при ошибке `400` в `POST /v3/events/`; повторно использованный `event_id` с другим содержимым возвращается в виде строки в `errors.event_id`." }, "event_uuid": { "type": "string", "format": "uuid", "description": "Только принятые и повторно отправленные элементы." }, "status": { "type": "string", "enum": [ "ACCEPTED", "APPROVED", "IN_REVIEW", "DECLINED" ], "description": "Только принятые и повторно отправленные элементы." }, "score": { "type": "integer", "description": "Только принятые и повторно отправленные элементы." }, "rules_evaluated_count": { "type": "integer", "description": "Только принятые и повторно отправленные элементы." }, "rules_matched_count": { "type": "integer", "description": "Только принятые и повторно отправленные элементы." }, "correlation_pending": { "type": "boolean", "description": "Только принятые и повторно отправленные элементы." }, "retention_class": { "type": "string", "enum": [ "low_value", "standard", "risk_relevant", "monetary_or_compliance" ], "description": "Только принятые и повторно отправленные элементы." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Только принятые и повторно отправленные элементы." }, "idempotent_replay": { "type": "boolean", "description": "Только принятые и повторно отправленные элементы." }, "rule_matches": { "type": "array", "description": "Только принятые и повторно отправленные элементы.", "items": { "type": "object", "required": [ "rule_id", "library_key", "mode", "is_async" ], "properties": { "rule_id": { "type": "string", "format": "uuid", "description": "UUID правила." }, "library_key": { "type": "string", "nullable": true, "description": "Ключ библиотеки, если правило было установлено из библиотеки правил, иначе null." }, "mode": { "type": "string", "enum": [ "ACTIVE", "TEST" ], "description": "Правила типа `TEST` регистрируют совпадение, но не применяют никаких действий." }, "is_async": { "type": "boolean", "description": "`true`, если совпадение было получено в результате асинхронного прохода." } } } } } } } } }, "examples": { "Partial success": { "value": { "accepted_count": 1, "replayed_count": 0, "rejected_count": 2, "results": [ { "index": 0, "outcome": "accepted", "event_uuid": "33333333-4444-5555-6666-777777777777", "event_id": "login-2026-10-17-000001", "status": "ACCEPTED", "score": 0, "rules_evaluated_count": 6, "rules_matched_count": 0, "correlation_pending": false, "retention_class": "standard", "expires_at": "2026-11-16T09:15:02.481000Z", "idempotent_replay": false, "rule_matches": [] }, { "index": 1, "event_id": "deposit-2026-10-17-000002", "outcome": "rejected", "errors": { "payload": [ "payment.deposit_completed requires: payment_method, status." ] } }, { "index": 2, "event_id": "login-2026-10-16-000777", "outcome": "rejected", "errors": { "event_id": "event_id 'login-2026-10-16-000777' already exists with a different payload." } } ] } } } } } }, "400": { "description": "Некорректный формат пакета: `events` отсутствует, не является массивом, пуст или содержит более 500 элементов. Ничего не сохранено; разделите большие пакеты.", "content": { "application/json": { "examples": { "Not a list": { "value": { "events": "Expected a list of events." } }, "Empty": { "value": { "events": "At least one event is required." } }, "Too many": { "value": { "events": "A batch accepts at most 500 events; received 612." } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Только при истёкшем сроке действия ключа возвращается `401`; при отсутствии ключа или его недействительности возвращается `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Отсутствует `x-api-key` (неверный, отозванный или истекший ключ возвращает `401`), ключ с ограниченной областью действия без права `transactions: write`, ключ, ограниченный определёнными сценариями или одобренными сессиями (такой ключ никогда не получает доступ к данным мониторинга транзакций), либо запрос отправлен не из списка разрешённых адресов ключа. Также возвращается с `code: event_monitoring_disabled`, пока сбор событий выключен для приложения; в этом случае ничего не сохраняется, а проверка выполняется до валидации тела запроса.", "content": { "application/json": { "examples": { "Event monitoring disabled": { "value": { "detail": "Event monitoring is not enabled for this application. Turn on event ingestion in the transaction monitoring settings before submitting events.", "code": "event_monitoring_disabled" } }, "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without access": { "value": { "detail": "This API key has no write access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "IP not allowed": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "429": { "description": "Лимит запросов превышен: создание транзакций и приём событий (`POST /v3/transactions/`, `POST /v3/events/`, `POST /v3/events/batch/`) разделяют лимит в 600 запросов в минуту на один API-ключ, отдельно от лимита в 300 запросов для всех остальных запросов на запись. Подождите `Retry-After` секунд, затем повторите попытку.", "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой, округлённое в большую сторону, чтобы повторный запрос попал в следующее окно.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } }, "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Ingestion rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/events/sdk-token/": { "post": { "summary": "Выпустить SDK token для мониторинга", "description": "Выпустить кратковременные учетные данные устройства, привязанные к одному субъекту, чтобы ваше веб- или мобильное приложение могло отправлять события этого пользователя напрямую в Didit без API-ключа. Приложение передает возвращенный `monitoring_token` в заголовке `X-Monitoring-Token` на выделенный endpoint для устройств (`POST /v1/events/` и `POST /v1/events/batch/`), где субъект всегда перезаписывается этим значением `vendor_data`, события вне `allowed_event_categories` отклоняются, каждое отправленное событие расходует одно использование, а запрос, чей `Origin` не совпадает с `bind_to_origin`, отклоняется. Вызывайте его только со своего бэкенда; выпуск создает только учетные данные и ничего больше (пользователь не создается). Прием событий должен быть включен для приложения, иначе этот endpoint возвращает `403` с `code: event_monitoring_disabled` вместо выпуска учетных данных, которые никогда не смогут выполнять запись. Для API-ключа с ограниченной областью видимости требуется `transactions: write`. См. раздел [Отправка событий через SDK](https://docs.didit.me/ru/transaction-monitoring/sdk-event-submission).", "operationId": "create_monitoring_event_sdk_token", "x-didit-sdk": { "resource": "monitoring_events", "method": "create_sdk_token", "auth": "api_key", "server": true }, "tags": [ "Monitoring Events" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Принимаются псевдонимы в camelCase: `vendorData`, `entityType`, `allowedEventCategories`, `ttlSeconds`, `maxUses`, `bindToOrigin`.", "required": [ "vendor_data" ], "properties": { "vendor_data": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Ваш id субъекта, к которому относятся все события, переданные с этими учетными данными." }, "entity_type": { "type": "string", "maxLength": 32, "default": "individual", "description": "`company` привязывает субъекта-компанию; любое другое значение (по умолчанию `individual`) привязывает физическое лицо." }, "allowed_event_categories": { "type": "array", "items": { "type": "string", "enum": [ "auth", "session", "gameplay", "bonus", "affiliate", "payment", "dispute", "security", "responsible_gambling", "custom" ] }, "description": "Категории, которые могут быть отправлены с этими учетными данными. Опустите этот параметр или отправьте `[]`, чтобы разрешить все категории." }, "ttl_seconds": { "type": "integer", "minimum": 60, "maximum": 86400, "default": 900, "description": "Срок действия учетных данных в секундах." }, "max_uses": { "type": "integer", "minimum": 1, "nullable": true, "default": 1000, "description": "Количество событий, которые могут быть отправлены с помощью этих учётных данных (пакет расходует одно использование на каждое событие). Передайте `null`, чтобы не ограничивать количество событий в течение срока действия." }, "bind_to_origin": { "type": "string", "maxLength": 255, "nullable": true, "description": "Если параметр задан, заголовок браузера `Origin` каждого запроса с устройства должен в точности совпадать с этим значением; запрос без `Origin` отклоняется." } } }, "example": { "vendor_data": "user-42", "allowed_event_categories": [ "auth", "session", "gameplay" ], "ttl_seconds": 900, "max_uses": 1000, "bind_to_origin": "https://app.example.com" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/events/sdk-token/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"vendor_data\": \"user-42\",\n \"allowed_event_categories\": [\"auth\", \"session\", \"gameplay\"],\n \"ttl_seconds\": 900,\n \"max_uses\": 1000,\n \"bind_to_origin\": \"https://app.example.com\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.monitoring_events.create_sdk_token(\n vendor_data=\"user-42\",\n allowed_event_categories=[\"auth\", \"session\", \"gameplay\"],\n ttl_seconds=900,\n max_uses=1000,\n bind_to_origin=\"https://app.example.com\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.monitoringEvents.createSdkToken({\n vendor_data: \"user-42\",\n allowed_event_categories: [\"auth\", \"session\", \"gameplay\"],\n ttl_seconds: 900,\n max_uses: 1000,\n bind_to_origin: \"https://app.example.com\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.MonitoringEvents.CreateSDKToken(ctx, didit.MonitoringEventsCreateSDKTokenParams{\n\tVendorData: \"user-42\",\n\tAllowedEventCategories: didit.Some([]didit.MonitoringEventsCreateSDKTokenParamsAllowedEventCategories{\"auth\", \"session\", \"gameplay\"}),\n\tTTLSeconds: didit.Int(900),\n\tMaxUses: didit.Int(1000),\n\tBindToOrigin: didit.String(\"https://app.example.com\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.MonitoringEventsCreateSdkTokenParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.monitoringEvents().createSdkToken(MonitoringEventsCreateSdkTokenParams.builder()\n .vendorData(\"user-42\")\n .allowedEventCategories(List.of(MonitoringEventsCreateSdkTokenParams.AllowedEventCategories.of(\"auth\"), MonitoringEventsCreateSdkTokenParams.AllowedEventCategories.of(\"session\"), MonitoringEventsCreateSdkTokenParams.AllowedEventCategories.of(\"gameplay\")))\n .ttlSeconds(900L)\n .maxUses(1000L)\n .bindToOrigin(\"https://app.example.com\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "monitoringEvents->createSdkToken([\n 'vendor_data' => 'user-42',\n 'allowed_event_categories' => ['auth', 'session', 'gameplay'],\n 'ttl_seconds' => 900,\n 'max_uses' => 1000,\n 'bind_to_origin' => 'https://app.example.com',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.monitoring_events.create_sdk_token(\n vendor_data: \"user-42\",\n allowed_event_categories: [\"auth\", \"session\", \"gameplay\"],\n ttl_seconds: 900,\n max_uses: 1000,\n bind_to_origin: \"https://app.example.com\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.MonitoringEvents.CreateSdkTokenAsync(new MonitoringEventsCreateSdkTokenParams\n{\n VendorData = \"user-42\",\n AllowedEventCategories = new MonitoringEventsCreateSdkTokenParamsAllowedEventCategories[] { \"auth\", \"session\", \"gameplay\" },\n TtlSeconds = 900,\n MaxUses = 1000,\n BindToOrigin = \"https://app.example.com\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Учетные данные созданы. Передайте `monitoring_token` приложению и храните его как секрет до момента `expires_at`.", "content": { "application/json": { "schema": { "type": "object", "required": [ "monitoring_token", "expires_at", "allowed_event_categories", "max_uses", "bind_to_origin" ], "properties": { "monitoring_token": { "type": "string", "description": "Учётный token устройства (URL-безопасный token из 43 символов). Отправляйте его в заголовке `X-Monitoring-Token`." }, "expires_at": { "type": "string", "format": "date-time", "description": "Когда учетные данные перестают приниматься." }, "allowed_event_categories": { "type": "array", "items": { "type": "string", "enum": [ "auth", "session", "gameplay", "bonus", "affiliate", "payment", "dispute", "security", "responsible_gambling", "custom" ] }, "description": "Категории, которые могут быть отправлены с этими учетными данными; `[]` означает все категории." }, "max_uses": { "type": "integer", "nullable": true, "description": "Бюджет событий для учетных данных; null означает отсутствие ограничения." }, "bind_to_origin": { "type": "string", "nullable": true, "description": "Источник (origin), к которому привязаны учетные данные, или null." } } }, "example": { "monitoring_token": "q7ZtR2xKp9VbN4mWc8LdH1sYfJ3gT6uEaQ0oPiXzBkC", "expires_at": "2026-10-17T09:30:02.481000Z", "allowed_event_categories": [ "auth", "session", "gameplay" ], "max_uses": 1000, "bind_to_origin": "https://app.example.com" } } } }, "400": { "description": "Ошибка валидации: отсутствует `vendor_data`, `ttl_seconds` вне диапазона от 60 до 86400, `max_uses` меньше 1 или неизвестная категория (ключом является её позиция в массиве).", "content": { "application/json": { "examples": { "Missing vendor_data": { "value": { "vendor_data": [ "This field is required." ] } }, "ttl_seconds too short": { "value": { "ttl_seconds": [ "Ensure this value is greater than or equal to 60." ] } }, "Unknown category": { "value": { "allowed_event_categories": { "1": [ "\"login\" is not a valid choice." ] } } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Только при истёкшем сроке действия ключа возвращается `401`; при отсутствии ключа или его недействительности возвращается `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Отсутствует `x-api-key` (неверный, отозванный или истекший ключ возвращает `401`), ключ с ограниченной областью действия без права `transactions: write`, ключ, ограниченный определёнными сценариями или одобренными сессиями (такой ключ никогда не получает доступ к данным мониторинга транзакций), либо запрос отправлен не из списка разрешённых адресов ключа. Также возвращается с `code: event_monitoring_disabled`, пока сбор событий выключен для приложения; в этом случае ничего не сохраняется, а проверка выполняется до валидации тела запроса.", "content": { "application/json": { "examples": { "Event monitoring disabled": { "value": { "detail": "Event monitoring is not enabled for this application. Turn on event ingestion in the transaction monitoring settings before submitting events.", "code": "event_monitoring_disabled" } }, "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without access": { "value": { "detail": "This API key has no write access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "IP not allowed": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "429": { "description": "Лимит запросов превышен: запросы на запись (`POST`, `PATCH`, `DELETE`) разделяют лимит в 300 запросов в минуту на один API-ключ. Подождите `Retry-After` секунд, затем повторите попытку.", "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } }, "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/events/{event_uuid}/": { "get": { "summary": "Получить событие мониторинга", "description": "Получить одно событие мониторинга со всем содержимым списка, а также payload, кастомными значениями, контекстом устройства, происхождением полей (`field_sources`), полями домена, вынесенными в отдельные поля, `expires_at`, каждым совпавшим запуском правила с его подтверждающими данными, обогащением по IP и метками, добавленными правилами. Пока `correlation_pending` равен `true`, асинхронное правило еще должно выполниться; запросите событие повторно через несколько минут для получения окончательных `status`, `score` и `rule_runs`. Чтение работает независимо от того, включен ли прием событий. API-ключу с ограниченной областью действия требуется разрешение `transactions: read`. См. [Подтверждающие данные](https://docs.didit.me/ru/transaction-monitoring/event-rules#доказательства) и [Обогащение по IP](https://docs.didit.me/ru/transaction-monitoring/ip-enrichment).", "operationId": "get_monitoring_event", "x-didit-sdk": { "resource": "monitoring_events", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Monitoring Events" ], "parameters": [ { "name": "event_uuid", "in": "path", "required": true, "description": "Идентификатор события в Didit (`event_uuid` из ответа методов create, batch, list или timeline), а не ваш собственный `event_id`.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/events/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.monitoring_events.retrieve(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.monitoringEvents.retrieve(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.MonitoringEvents.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.monitoringEvents().retrieve(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "monitoringEvents->retrieve('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.monitoring_events.retrieve(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.MonitoringEvents.RetrieveAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Событие с его свидетельствами.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringEventDetail" }, "examples": { "Login from a VPN, in review": { "value": { "event_uuid": "33333333-4444-5555-6666-777777777777", "event_id": "login-2026-10-17-000001", "event_category": "auth", "action_type": "login", "occurred_at": "2026-10-17T09:15:02.481000Z", "received_at": "2026-10-17T09:15:02.903114Z", "status": "IN_REVIEW", "score": 40, "subject_vendor_data": "user-42", "subject_entity_type": "individual", "subject_uuid": "66666666-7777-8888-9999-000000000000", "counterparty_vendor_data": null, "session_id": "web-session-abc", "device_fingerprint": "fp-a8c1", "ip_address": "203.0.113.42", "ip_country": "ES", "amount": null, "currency": null, "game_id": null, "round_id": null, "bonus_id": null, "affiliate_code": null, "payment_reference_id": null, "retention_class": "risk_relevant", "rules_matched_count": 1, "correlation_pending": false, "is_droppable": true, "payload": { "method": "password" }, "custom_values": { "vip_tier": "gold", "vpn_or_proxy_detected": true }, "device_context": { "fingerprint": "fp-a8c1", "network_context": { "ip_address": "203.0.113.42", "ip_country": "Spain", "ip_country_code": "ES", "ip_city": "Madrid", "asn_number": 64500, "asn_organization": "Example Networks", "is_vpn_or_tor": true, "is_data_center": false } }, "field_sources": { "subject.vendor_data": "customer", "event_category": "customer", "action_type": "customer", "occurred_at": "customer", "received_at": "server", "payload.method": "customer", "session.session_id": "customer", "session.sequence": "customer", "device_context.fingerprint": "customer", "device_context.network_context.ip_address": "customer", "device_context.network_context.ip_country": "server", "device_context.network_context.ip_country_code": "server", "device_context.network_context.ip_city": "server", "device_context.network_context.asn_number": "server", "device_context.network_context.asn_organization": "server", "device_context.network_context.is_vpn_or_tor": "server", "device_context.network_context.is_data_center": "server" }, "session_sequence": 142, "table_id": null, "hand_id": null, "match_id": null, "market_id": null, "side": null, "role": null, "net_result_amount": null, "payment_fingerprint": null, "instrument_reference_hash": null, "withdrawal_address_hash": null, "dispute_id": null, "chargeback_id": null, "changed_field": null, "identity_match_ref": null, "schema_version": 1, "expires_at": "2027-01-15T09:15:02.481000Z", "rules_evaluated_count": 6, "rule_runs": [ { "rule_uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "rule_title": "Login from VPN or Tor", "library_key": null, "matched": true, "mode": "ACTIVE", "is_async": false, "severity": "MEDIUM", "score_delta": 40, "action_summary": "score +40; add_tag:VPN_LOGIN", "matched_payload": [ { "field": "event.ip.is_vpn_or_tor", "operator": "eq", "expected_value": true, "current_value": true, "matched": true, "group_index": null, "group_logic": "AND", "field_source": "server" } ], "created_at": "2026-10-17T09:15:02.951207Z" } ], "ip_enrichment": { "ip_country_code": "ES", "ip_city": "Madrid", "asn_number": 64500, "asn_organization": "Example Networks", "is_vpn_or_tor": true, "is_data_center": false, "proxy_type": null, "last_enriched_at": "2026-10-17T09:15:02.910442Z" }, "subject_profile": null, "tags": [ "VPN_LOGIN" ] } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Только при истёкшем сроке действия ключа возвращается `401`; при отсутствии ключа или его недействительности возвращается `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Отсутствует `x-api-key` (неверный, отозванный или истекший ключ возвращает `401`), ключ с ограниченной областью действия без права `transactions: read`, ключ, ограниченный определёнными сценариями или одобренными сессиями (такой ключ никогда не получает доступ к данным мониторинга транзакций), либо запрос отправлен не из списка разрешённых адресов ключа.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without access": { "value": { "detail": "This API key has no read access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "IP not allowed": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "События с таким `event_uuid` в приложении не существует: оно никогда не сохранялось, было удалено или принадлежит другому приложению. Сегмент пути, не являющийся UUID, не соответствует маршруту и также возвращает `404`.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "No MonitoringEvent matches the given query." } } } } } }, "429": { "description": "Лимит запросов превышен: `GET`-запросы разделяют лимит в 600 запросов в минуту на один API-ключ. Подождите `Retry-After` секунд, затем повторите попытку.", "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } }, "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/events/subjects/{vendor_data}/": { "get": { "summary": "Получить таймлайн событий субъекта", "description": "Получить список всех событий мониторинга одного субъекта, сначала самые новые по `occurred_at`. Значение `vendor_data` уникально только в пределах типа сущности, поэтому один и тот же id может относиться как к физическому лицу, так и к компании: параметр `entity_type` определяет, какую хронологию событий вы получите, и по умолчанию имеет значение `individual`, поэтому для событий компании требуется `entity_type=company`. Дополнительно применяются фильтры `GET /v3/events/`, а при отсутствии событий для `vendor_data` возвращается пустая страница, а не `404`. Для API-ключа с ограниченными правами требуется разрешение `transactions: read`. См. [Чтение событий](https://docs.didit.me/ru/transaction-monitoring/events#чтение-событий).", "operationId": "get_monitoring_event_subject_timeline", "x-didit-sdk": { "resource": "monitoring_events", "method": "retrieve_subject_timeline", "auth": "api_key", "server": true }, "tags": [ "Monitoring Events" ], "parameters": [ { "name": "vendor_data", "in": "path", "required": true, "description": "Ваш id для субъекта (`subject.vendor_data` его событий). Закодируйте его в формате URL; значение, содержащее `/`, не может быть адресовано этим endpoint.", "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "example": "user-42" }, { "name": "entity_type", "in": "query", "required": false, "description": "`company` возвращает компанию с этим `vendor_data`; любое другое значение или его отсутствие возвращает физическое лицо. `subject_entity_type` принимается как псевдоним, если `entity_type` отсутствует.", "schema": { "type": "string", "enum": [ "individual", "company" ], "default": "individual" }, "example": "individual" }, { "name": "limit", "in": "query", "required": false, "description": "Максимальное количество событий на страницу. По умолчанию 50. Значения выше 1000000 возвращают `400`; нечисловое, нулевое или отрицательное значение заменяется на 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "example": 50 }, { "name": "offset", "in": "query", "required": false, "description": "Количество событий, которые нужно пропустить. По умолчанию: 0. Рекомендуется переходить по URL `next` из ответа.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "example": 0 }, { "name": "event_category", "in": "query", "required": false, "description": "Только события в этих категориях. Повторите параметр для нескольких значений (`?event_category=payment&event_category=dispute`); возвращается событие, соответствующее любому из них.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "auth", "session", "gameplay", "bonus", "affiliate", "payment", "dispute", "security", "responsible_gambling", "custom" ] } }, "example": [ "payment", "dispute" ] }, { "name": "action_type", "in": "query", "required": false, "description": "Только события с этими типами действий (точное совпадение с учётом регистра). Повторите для нескольких значений.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "deposit_completed", "chargeback_opened" ] }, { "name": "status", "in": "query", "required": false, "description": "Только события с этими статусами. Повторите для нескольких значений.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "ACCEPTED", "APPROVED", "IN_REVIEW", "DECLINED" ] } }, "example": [ "IN_REVIEW", "DECLINED" ] }, { "name": "retention_class", "in": "query", "required": false, "description": "Только события в этих классах хранения. Повторите для нескольких значений.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "low_value", "standard", "risk_relevant", "monetary_or_compliance" ] } }, "example": [ "risk_relevant" ] }, { "name": "business_vendor_data", "in": "query", "required": false, "description": "Точное совпадение по `business.vendor_data`, переданному вместе с событием.", "schema": { "type": "string" }, "example": "merchant-7" }, { "name": "session_id", "in": "query", "required": false, "description": "Точное совпадение по `session.session_id`.", "schema": { "type": "string" }, "example": "web-session-abc" }, { "name": "device_fingerprint", "in": "query", "required": false, "description": "Точное совпадение по `device_context.fingerprint`.", "schema": { "type": "string" }, "example": "fp-a8c1" }, { "name": "ip_address", "in": "query", "required": false, "description": "Точное совпадение по IP-адресу события.", "schema": { "type": "string" }, "example": "203.0.113.42" }, { "name": "game_id", "in": "query", "required": false, "description": "Точное совпадение по продвигаемому `game_id`.", "schema": { "type": "string" }, "example": "poker-holdem-01" }, { "name": "round_id", "in": "query", "required": false, "description": "Точное совпадение по продвигаемому `round_id`.", "schema": { "type": "string" }, "example": "round-88231" }, { "name": "affiliate_code", "in": "query", "required": false, "description": "Точное совпадение по продвигаемому `affiliate_code`.", "schema": { "type": "string" }, "example": "aff-summer" }, { "name": "payment_reference_id", "in": "query", "required": false, "description": "Точное совпадение по платёжному идентификатору (из `transaction_context.payment_reference_id` или `payload.payment_reference_id`).", "schema": { "type": "string" }, "example": "dep_735" }, { "name": "counterparty_vendor_data", "in": "query", "required": false, "description": "Точное совпадение по продвигаемому `counterparty_vendor_data`.", "schema": { "type": "string" }, "example": "user-77" }, { "name": "matched_only", "in": "query", "required": false, "description": "`true` (также `1` или `yes`, без учёта регистра) возвращает только события, которым соответствует хотя бы одно правило (`rules_matched_count` больше 0). Любое другое значение игнорируется.", "schema": { "type": "boolean", "default": false }, "example": true }, { "name": "occurred_from", "in": "query", "required": false, "description": "Только события с `occurred_at` в этот момент или позже (включительно). Передайте значение в формате ISO 8601: `2026-10-01T00:00:00Z`, явное смещение с закодированным знаком `+` (`2026-10-01T02:00:00%2B02:00`; незакодированный `+` декодируется как пробел, и значение перестаёт распознаваться) или только дату (`2026-10-01`), что означает 00:00:00 UTC этого дня. Значение без смещения считывается как UTC. Значения в любом другом формате не принимаются.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-10-01T00:00:00Z" }, { "name": "occurred_to", "in": "query", "required": false, "description": "Только события с `occurred_at` в этот момент или раньше (включительно). Дата без времени означает начало этого дня, поэтому `occurred_to=2026-10-15` исключает остальную часть 15 октября; отправьте `2026-10-15T23:59:59Z`, чтобы включить её. Передайте значение в формате ISO 8601: `2026-10-01T00:00:00Z`, явное смещение с закодированным знаком `+` (`2026-10-01T02:00:00%2B02:00`; незакодированный `+` декодируется как пробел, и значение перестаёт распознаваться) или только дату (`2026-10-01`), что означает 00:00:00 UTC этого дня. Значение без смещения считывается как UTC. Значения в любом другом формате не принимаются.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-10-17T23:59:59Z" }, { "name": "search", "in": "query", "required": false, "description": "Поиск подстроки без учёта регистра по `event_id`, `action_type`, `subject_vendor_data` или `counterparty_vendor_data`.", "schema": { "type": "string" }, "example": "chargeback" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/events/subjects/user-42/?entity_type=individual&limit=50' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.monitoring_events.retrieve_subject_timeline(\n \"user-42\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.monitoringEvents.retrieveSubjectTimeline(\"user-42\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.MonitoringEvents.RetrieveSubjectTimelineAutoPaging(ctx, \"user-42\", didit.MonitoringEventsRetrieveSubjectTimelineParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.monitoringEvents().retrieveSubjectTimeline(\"user-42\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "monitoringEvents->retrieveSubjectTimeline('user-42') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.monitoring_events.retrieve_subject_timeline(\"user-42\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.MonitoringEvents.RetrieveSubjectTimelineAsync(\"user-42\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Одна страница событий субъекта.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringEventPage" }, "examples": { "Individual timeline": { "value": { "count": 2, "next": null, "previous": null, "results": [ { "event_uuid": "11111111-2222-3333-4444-555555555555", "event_id": "chargeback-2026-10-16-000318", "event_category": "dispute", "action_type": "chargeback_opened", "occurred_at": "2026-10-16T14:02:11Z", "received_at": "2026-10-16T14:02:12.418230Z", "status": "IN_REVIEW", "score": 60, "subject_vendor_data": "user-42", "subject_entity_type": "individual", "subject_uuid": "66666666-7777-8888-9999-000000000000", "counterparty_vendor_data": null, "session_id": null, "device_fingerprint": null, "ip_address": null, "ip_country": null, "amount": "250.000000000000000000", "currency": "EUR", "game_id": null, "round_id": null, "bonus_id": null, "affiliate_code": null, "payment_reference_id": "dep_735", "retention_class": "monetary_or_compliance", "rules_matched_count": 1, "correlation_pending": false, "is_droppable": false }, { "event_uuid": "22222222-3333-4444-5555-666666666666", "event_id": "login-2026-10-15-000912", "event_category": "auth", "action_type": "login", "occurred_at": "2026-10-15T08:30:00.120000Z", "received_at": "2026-10-15T08:30:00.734512Z", "status": "ACCEPTED", "score": 0, "subject_vendor_data": "user-42", "subject_entity_type": "individual", "subject_uuid": "66666666-7777-8888-9999-000000000000", "counterparty_vendor_data": null, "session_id": "web-session-abc", "device_fingerprint": "fp-a8c1", "ip_address": "203.0.113.42", "ip_country": "ES", "amount": null, "currency": null, "game_id": null, "round_id": null, "bonus_id": null, "affiliate_code": null, "payment_reference_id": null, "retention_class": "standard", "rules_matched_count": 0, "correlation_pending": false, "is_droppable": true } ] } }, "No events": { "value": { "count": 0, "next": null, "previous": null, "results": [] } } } } } }, "400": { "description": "`limit` или `offset` превышает 1000000. Тело ответа представляет собой JSON-массив с одним сообщением. Нечисловое или неположительное значение `limit` возвращается к значению по умолчанию 50 вместо ошибки.", "content": { "application/json": { "examples": { "limit too large": { "summary": "limit превышает 1000000", "value": [ "limit must not exceed 1000000." ] }, "offset too large": { "summary": "offset превышает 1000000", "value": [ "offset must not exceed 1000000." ] } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Только при истёкшем сроке действия ключа возвращается `401`; при отсутствии ключа или его недействительности возвращается `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Отсутствует `x-api-key` (неверный, отозванный или истекший ключ возвращает `401`), ключ с ограниченной областью действия без права `transactions: read`, ключ, ограниченный определёнными сценариями или одобренными сессиями (такой ключ никогда не получает доступ к данным мониторинга транзакций), либо запрос отправлен не из списка разрешённых адресов ключа.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without access": { "value": { "detail": "This API key has no read access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "IP not allowed": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "429": { "description": "Лимит запросов превышен: `GET`-запросы разделяют лимит в 600 запросов в минуту на один API-ключ. Подождите `Retry-After` секунд, затем повторите попытку.", "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } }, "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/events/enrichment-metrics/": { "get": { "summary": "Получить метрики обогащения событий", "description": "Возвращает счётчики приёма событий и обогащения IP для вашего приложения за определённый период, просуммированные по всем каналам (server, batch и device), позволяя отслеживать объём событий и убедиться, что обогащение выполняется один раз на уникальный адрес, а не для каждого события. Период охватывает сегодняшний день и предыдущие дни в количестве `days`, считая по календарной дате в UTC. Три соотношения равны null, если их знаменатель равен нулю. API-ключ с ограниченной областью действия требует `transactions: read`. См. [Обогащение IP](https://docs.didit.me/ru/transaction-monitoring/events#обогащение-ip).", "operationId": "get_monitoring_event_enrichment_metrics", "x-didit-sdk": { "resource": "monitoring_events", "method": "retrieve_enrichment_metrics", "auth": "api_key", "server": true }, "tags": [ "Monitoring Events" ], "parameters": [ { "name": "days", "in": "query", "required": false, "description": "Длина периода в днях. По умолчанию 30; значения ограничены диапазоном от 1 до 365, а при нецелом значении используется 30. Применённое значение возвращается как `period_days`.", "schema": { "type": "integer", "default": 30, "minimum": 1, "maximum": 365 }, "example": 30 } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/events/enrichment-metrics/?days=30' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.monitoring_events.retrieve_enrichment_metrics()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.monitoringEvents.retrieveEnrichmentMetrics();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.MonitoringEvents.RetrieveEnrichmentMetrics(ctx, didit.MonitoringEventsRetrieveEnrichmentMetricsParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.monitoringEvents().retrieveEnrichmentMetrics();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "monitoringEvents->retrieveEnrichmentMetrics();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.monitoring_events.retrieve_enrichment_metrics\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.MonitoringEvents.RetrieveEnrichmentMetricsAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Счётчики и соотношения за период.", "content": { "application/json": { "schema": { "type": "object", "required": [ "events_ingested", "events_rejected", "enrichment_lookups", "enrichment_cache_hits", "enrichment_provider_calls", "enrichment_skipped_low_value", "unique_ips_seen", "period_days", "cache_hit_rate", "unique_ip_ratio", "provider_calls_per_1k_events" ], "properties": { "events_ingested": { "type": "integer", "description": "Сохранены новые события. Идемпотентные повторные отправки не учитываются." }, "events_rejected": { "type": "integer", "description": "Элементы, отклонённые внутри пакетных запросов (серверный поток и поток устройства). Отклонённый запрос с одним событием не учитывается." }, "enrichment_lookups": { "type": "integer", "description": "События, чей публичный IP-адрес был определён, из кэша или заново." }, "enrichment_cache_hits": { "type": "integer", "description": "Поисковые запросы, ответы на которые получены из кэша." }, "enrichment_provider_calls": { "type": "integer", "description": "Поисковые запросы, потребовавшие нового разрешения адреса." }, "enrichment_skipped_low_value": { "type": "integer", "description": "События телеметрии с низкой ценностью, адрес которых ещё не был известен. Они никогда сами по себе не инициируют новое разрешение адреса." }, "unique_ips_seen": { "type": "integer", "description": "Адреса, потребовавшие повторного разрешения." }, "period_days": { "type": "integer", "description": "Значение `days`, применённое после ограничения диапазона." }, "cache_hit_rate": { "type": "number", "nullable": true, "description": "`enrichment_cache_hits / enrichment_lookups`, округлённое до 4 знаков после запятой. Null, если запросов не было." }, "unique_ip_ratio": { "type": "number", "nullable": true, "description": "`unique_ips_seen / events_ingested`, округлённое до 4 знаков после запятой. Null, если события не принимались." }, "provider_calls_per_1k_events": { "type": "number", "nullable": true, "description": "Количество актуальных решений на 1000 полученных событий, округлённое до 2 знаков после запятой. Null, если события не поступали." } } }, "examples": { "Last 30 days": { "value": { "events_ingested": 128450, "events_rejected": 214, "enrichment_lookups": 41230, "enrichment_cache_hits": 40118, "enrichment_provider_calls": 1112, "enrichment_skipped_low_value": 74320, "unique_ips_seen": 1112, "period_days": 30, "cache_hit_rate": 0.973, "unique_ip_ratio": 0.0087, "provider_calls_per_1k_events": 8.66 } }, "No events yet": { "value": { "events_ingested": 0, "events_rejected": 0, "enrichment_lookups": 0, "enrichment_cache_hits": 0, "enrichment_provider_calls": 0, "enrichment_skipped_low_value": 0, "unique_ips_seen": 0, "period_days": 30, "cache_hit_rate": null, "unique_ip_ratio": null, "provider_calls_per_1k_events": null } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Только при истёкшем сроке действия ключа возвращается `401`; при отсутствии ключа или его недействительности возвращается `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Отсутствует `x-api-key` (неверный, отозванный или истекший ключ возвращает `401`), ключ с ограниченной областью действия без права `transactions: read`, ключ, ограниченный определёнными сценариями или одобренными сессиями (такой ключ никогда не получает доступ к данным мониторинга транзакций), либо запрос отправлен не из списка разрешённых адресов ключа.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without access": { "value": { "detail": "This API key has no read access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "IP not allowed": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "429": { "description": "Лимит запросов превышен: `GET`-запросы разделяют лимит в 600 запросов в минуту на один API-ключ. Подождите `Retry-After` секунд, затем повторите попытку.", "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } }, "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/events/{event_uuid}/delete/": { "delete": { "summary": "Удалить событие мониторинга", "description": "Безвозвратно удалить одно событие мониторинга вместе с его запусками правил, заметками и связями тегов, например, если событие было отправлено по ошибке. После ответа `204` событие больше не возвращается ни при одной операции чтения (запрос на получение возвращает `404`, и оно больше не отображается в списке или на временной шкале субъекта), удаление необратимо, а его `event_id` освобождается для использования в новом событии. Не затрагиваются: пользователь или компания, к которым относилось событие, кейсы, открытые правилом, записи в списках, добавленные правилом, а также оценки и статусы, уже применённые к другим событиям. Чтобы стереть все данные о человеке или компании, удалите пользователя или компанию, что также удалит их события. Для API-ключа с ограниченной областью видимости требуется `transactions: write`.", "operationId": "delete_monitoring_event", "x-didit-sdk": { "resource": "monitoring_events", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Monitoring Events" ], "parameters": [ { "name": "event_uuid", "in": "path", "required": true, "description": "Идентификатор события в Didit (`event_uuid` из ответа методов create, batch, list или timeline), а не ваш собственный `event_id`.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/events/11111111-2222-3333-4444-555555555555/delete/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.monitoring_events.delete(\n \"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.monitoringEvents.delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.MonitoringEvents.Delete(ctx, \"11111111-2222-3333-4444-555555555555\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.monitoringEvents().delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "php", "label": "PHP", "source": "monitoringEvents->delete('11111111-2222-3333-4444-555555555555');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.monitoring_events.delete(\"11111111-2222-3333-4444-555555555555\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.MonitoringEvents.DeleteAsync(\"11111111-2222-3333-4444-555555555555\");" } ], "responses": { "204": { "description": "Событие удалено. Тело ответа отсутствует." }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Только при истёкшем сроке действия ключа возвращается `401`; при отсутствии ключа или его недействительности возвращается `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Отсутствует `x-api-key` (неверный, отозванный или истёкший ключ возвращает `401`), ключ с ограниченной областью действия без права `transactions: write`, ключ, ограниченный определёнными сценариями или одобренными сессиями (такой ключ никогда не получает доступ к данным мониторинга транзакций), либо запрос отправлен не из списка разрешённых адресов ключа.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without access": { "value": { "detail": "This API key has no write access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "IP not allowed": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "События с таким `event_uuid` в приложении не существует: оно никогда не сохранялось, было удалено или принадлежит другому приложению. Сегмент пути, не являющийся UUID, не соответствует маршруту и также возвращает `404`.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "No MonitoringEvent matches the given query." } } } } } }, "429": { "description": "Лимит запросов превышен: запросы на запись (`POST`, `PATCH`, `DELETE`) разделяют лимит в 300 запросов в минуту на один API-ключ. Подождите `Retry-After` секунд, затем повторите попытку.", "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } }, "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/kyb/parties/{partyUuid}/regenerate/": { "post": { "summary": "Повторно сгенерировать KYC-сессию для стороны из списка ключевых лиц", "description": "Предоставить стороне из числа ключевых лиц в сессии Верификации бизнеса (KYB) новую индивидуальную KYC-сессию после того, как предыдущая была удалена или истекла до того, как человек начал её, чтобы проверка ключевых лиц могла завершиться снова; тело запроса отправлять не нужно. Это работает, если KYC-сессия стороны была удалена (`kyc_session_deleted: true`) или истекла до начала её прохождения (`Expired`, никогда не начиналась). Сессия, которая всё ещё выполняется или завершилась в любом другом статусе (`Approved`, `Declined`, `In Review`, `Abandoned`, ...), возвращает `409`, если только она не была удалена. Для стороны, у которой сессии никогда не было, или стороны-компании всегда возвращается `409`. Didit создаёт новую размещённую KYC-сессию со сценарием, с которым сторона проходила верификацию (его последней опубликованной версией), или, если он больше неизвестен, со сценарием, который ваши настройки ключевых лиц назначают роли стороны, поэтому срок действия её ссылки равен времени истечения сессии этого KYC-сценария; Didit отправляет ссылку стороне по электронной почте, если адрес электронной почты сохранён в системе, сбрасывает `is_skipped` и пересчитывает проверку ключевых лиц и статус сессии компании. Затем отправляется [webhook](https://docs.didit.me/ru/integration/webhooks) `data.updated` для сессии компании с триггером `console_key_people_regenerate`; чтобы вместо этого освободить сторону от проверки, используйте `PATCH /v3/session/{sessionId}/kyb/parties/{partyUuid}/`. API-ключу с ограниченной областью видимости требуется `decisions: write`, а без `sessions: write` он получает `kyc_session_url` как `null`. Удалённые сессии подходят, даже если человек уже начал или завершил верификацию. Импортированные сессии не подходят по причине истечения срока; они должны быть удалены.", "operationId": "post_v3_session_kyb_party_regenerate", "x-didit-sdk": { "resource": "sessions", "method": "regenerate_kyb_party", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID родительской сессии Верификации бизнеса (KYB).", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "partyUuid", "in": "path", "required": true, "description": "UUID участника в разделе «Ключевые лица» (`key_people_checks[].submitted.parties[].uuid` в решении по бизнес-сессии). Должен принадлежать сессии, указанной в `sessionId`.", "schema": { "type": "string", "format": "uuid", "example": "0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/session/33333333-4444-5555-6666-777777777777/kyb/parties/0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41/regenerate/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.regenerate_kyb_party(\n \"33333333-4444-5555-6666-777777777777\",\n \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.regenerateKybParty(\n \"33333333-4444-5555-6666-777777777777\",\n \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.RegenerateKYBParty(ctx, \"33333333-4444-5555-6666-777777777777\", \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().regenerateKybParty(\"33333333-4444-5555-6666-777777777777\", \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->regenerateKybParty('33333333-4444-5555-6666-777777777777', '0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.regenerate_kyb_party(\n \"33333333-4444-5555-6666-777777777777\",\n \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.RegenerateKybPartyAsync(\"33333333-4444-5555-6666-777777777777\", \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Создана новая KYC-сессия. Возвращает обновлённую сторону с её новой дочерней сессией, срок действия которой истекает в соответствии со временем истечения сессии KYC-сценария.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KYBKeyPeopleParty" }, "example": { "uuid": "0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41", "entity_type": "person", "source": "USER", "name": "Jane Smith", "first_name": "Jane", "last_name": "Smith", "company_name": null, "registration_number": null, "email": "user@example.com", "nationality": "GB", "phone_number": null, "date_of_birth": "1980-05-04", "position": "Director", "custom_fields": {}, "is_active": true, "is_skipped": false, "requires_verification": true, "roles": [ { "role": "director", "ownership_percent": null, "voting_percent": null } ], "kyc_session_id": "55555555-6666-7777-8888-999999999999", "kyc_session_status": "Not Started", "kyc_session_url": "https://verify.didit.me/session/abc123def456", "kyc_session_deleted": false, "kyb_sub_session_id": null, "kyb_sub_session_status": null, "kyb_sub_session_url": null, "kyb_sub_session_deleted": false, "verification_workflow_type": "kyc", "verification_workflow_id": "12121212-3434-5656-7878-909090909090", "verification_workflow_label": "Key People KYC", "verification_workflow_features": [ { "feature": "ID_VERIFICATION", "status": "Not Finished" }, { "feature": "LIVENESS", "status": "Not Finished" }, { "feature": "AML", "status": "Not Finished" } ], "didit_internal_id": null } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Это единственный случай, возвращающий `401`: отсутствующий, недействительный или отозванный ключ возвращает `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Expired key": { "summary": "Срок действия ключа истёк", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Ошибка аутентификации или авторизации. Отсутствующий ключ возвращает `403`, как и ключ другого приложения, ключ с ограниченной областью действия без необходимого для этого endpoint разрешения, а также запрос не из разрешённого списка IP-адресов ключа; неверный, отозванный или истекший ключ возвращает `401`. Различайте их по полю `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Missing or invalid credentials": { "summary": "Заголовок x-api-key отсутствует, либо ключ не прошёл валидацию", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Действительный ключ, принадлежащий приложению, отличному от приложения сессии", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "У ключа с ограниченной областью действия отсутствует разрешение decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Запрос с IP-адреса вне списка разрешённых IP ключа", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Сессия не существует, была удалена или находится за пределами ограничений ключа с ограниченным доступом; участник с таким UUID не существует в вашем приложении; либо участник принадлежит другой сессии. Для каждого случая возвращается свой `detail`. Поиск сессии выполняется до проверки учетных данных, поэтому неизвестный `sessionId` возвращает `404` даже без действительного ключа.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Unknown session": { "summary": "Сессия с этим ID не существует или была удалена", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "Сессия находится за пределами ограничений ключа с ограниченным доступом по сценариям или доступу только к одобренным сессиям", "value": { "detail": "Session not found." } }, "Unknown party": { "summary": "В вашем приложении нет стороны с таким UUID", "value": { "detail": "No BusinessParty matches the given query." } }, "Party of another session": { "summary": "partyUuid существует, но принадлежит другой сессии", "value": { "detail": "Party does not belong to the given session." } } } } } }, "409": { "description": "У стороны нет подходящей KYC-сессии для замены. За исключением удаленных, сессия, которая все еще выполняется или завершилась в другом статусе (`Approved`, `Declined`, `In Review`, `Abandoned`, ...), не может быть создана заново. Сторона, у которой никогда не было сессии, или сторона-компания также возвращает `409`. Подходящая сессия была удалена или истекла до того, как человек ее начал. Удаленные сессии подходят, даже если человек уже начал или завершил верификацию. Импортированные сессии не подходят по истечении срока; они должны быть удалены. Ветвление выполняется по `code`.", "content": { "application/json": { "schema": { "type": "object", "required": [ "detail", "code" ], "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." }, "code": { "type": "string", "enum": [ "kyb_party_kyc_session_not_deleted" ], "description": "Постоянный машиночитаемый код ошибки." } } }, "example": { "detail": "This party's KYC session is still live (it has neither been deleted nor expired without starting), so it cannot be regenerated.", "code": "kyb_party_kyc_session_not_deleted" } } } }, "429": { "description": "Превышен лимит запросов: 300 запросов на запись (POST, PATCH, DELETE) в минуту на один API-ключ. Подождите указанное в `Retry-After` количество секунд перед повторной попыткой; заголовки `X-RateLimit-*` показывают доступный лимит.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Rate limited": { "summary": "Бюджет на текущую минуту исчерпан", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/transactions/{transaction_id}/notes/": { "get": { "summary": "Получить список заметок к транзакции", "description": "Получить список заметок по одной отслеживаемой транзакции, начиная с самых новых (по убыванию `created_at`): заметки, добавленные вами через API, заметки и изменения статуса, внесённые проверяющими в консоли, а также заметки, добавленные Didit автоматически (действие правила `add_note` или проблема при создании сессии верификации действия пользователя) с `actor_name` `Rule Engine`. Поле `metadata` позволяет различать типы заметок.\n\nПагинация с помощью `limit` и `offset`. Значение `count` является точным до 100 и ограничено 100 при больших значениях, поэтому следуйте по ссылке `next`, пока она не станет `null`, вместо вычисления страниц на основе `count`. Этот запрос на чтение не вызывает побочных эффектов.\n\nДля API-ключа с ограниченным доступом требуется разрешение `transactions: read`; ключ, ограниченный определёнными сценариями или одобренными сессиями, не может вызывать этот endpoint. Проверяющие видят этот же список в разделе **Заметки** на странице [деталей транзакции](https://docs.didit.me/ru/transaction-monitoring/console#детали-транзакции).", "operationId": "list_transaction_notes", "x-didit-sdk": { "resource": "transactions.notes", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "description": "UUID транзакции Didit: значение `uuid`, возвращаемое методами `POST /v3/transactions/` и `GET /v3/transactions/`. Собственный `txn_id` не принимается.", "schema": { "type": "string", "format": "uuid" }, "example": "abcdef12-3456-7890-abcd-ef1234567890" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "description": "Количество заметок на страницу. По умолчанию 50. Если значение не является положительным целым числом, используется 50; при значении выше 1000000 возвращается `400`." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "description": "Позиция первой возвращаемой заметки, начиная с нуля. Рекомендуется переходить по ссылке `next`. Значение, не являющееся целым неотрицательным числом, сбрасывается на 0; значение больше 1000000 возвращает `400`." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/transactions/abcdef12-3456-7890-abcd-ef1234567890/notes/?limit=50' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.transactions.notes.list(\n \"abcdef12-3456-7890-abcd-ef1234567890\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.transactions.notes.list(\"abcdef12-3456-7890-abcd-ef1234567890\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Transactions.Notes.ListAutoPaging(ctx, \"abcdef12-3456-7890-abcd-ef1234567890\", didit.TransactionsNotesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.transactions().notes().list(\"abcdef12-3456-7890-abcd-ef1234567890\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "transactions->notes->list('abcdef12-3456-7890-abcd-ef1234567890') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.transactions.notes.list(\"abcdef12-3456-7890-abcd-ef1234567890\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Transactions.Notes.ListAsync(\"abcdef12-3456-7890-abcd-ef1234567890\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Страница заметок, начиная с самых новых.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "description": "Количество заметок к транзакции: точное значение до 100, с ограничением 100 выше этого порога. Переходите по `next` вместо вычисления страниц на основе этого значения." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "Абсолютный URL следующей страницы или `null` на последней странице." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "Абсолютный URL предыдущей страницы или `null` на первой странице." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionNote" } } } }, "examples": { "API, Console and rule notes": { "value": { "count": 3, "next": null, "previous": null, "results": [ { "uuid": "c1111111-2222-4333-8444-555555555555", "note": "Customer confirmed the withdrawal by phone.", "actor_email": null, "actor_name": null, "metadata": { "mentioned_emails": [ "analyst@example.com" ] }, "created_at": "2026-10-16T10:05:12.481203Z" }, { "uuid": "c2222222-3333-4444-8555-666666666666", "note": "Status changed from IN_REVIEW to APPROVED. Reason: Source of funds verified", "actor_email": "reviewer@example.com", "actor_name": "Alex Reviewer", "metadata": { "type": "status_change", "previous_status": "IN_REVIEW", "new_status": "APPROVED", "reason_code": "SOF_VERIFIED", "reason_label": "Source of funds verified" }, "created_at": "2026-10-15T17:22:40.103911Z" }, { "uuid": "c3333333-4444-4555-8666-777777777777", "note": "Large withdrawal to a new wallet: check the source of funds.", "actor_email": null, "actor_name": "Rule Engine", "metadata": { "rule_uuid": "d1111111-2222-4333-8444-555555555555", "source": "rule_action" }, "created_at": "2026-10-15T08:42:12.004518Z" } ] } }, "No notes yet": { "value": { "count": 0, "next": null, "previous": null, "results": [] } } } } } }, "400": { "description": "`limit` или `offset` превышает 1000000. Тело ответа представляет собой JSON-массив сообщений, а не объект.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "Limit too large": { "value": [ "limit must not exceed 1000000." ] }, "Offset too large": { "value": [ "offset must not exceed 1000000." ] } } } } }, "401": { "description": "Срок действия API-ключа истёк. Истечь может только ключ, созданный со сроком действия; после этой даты каждый запрос с ним возвращает `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Запрос запрещён. При отсутствии ключа возвращается стандартное сообщение; при неверном, отозванном или истёкшем ключе возвращается `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without transactions read": { "value": { "detail": "This API key has no read access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "Outside the key's IP list": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Транзакция с этим UUID не существует в приложении (никогда не создавалась, удалена или принадлежит другому приложению). Значение `transaction_id`, не являющееся UUID, не доходит до API: вместо этого возвращается HTML-страница `404`, а не это JSON-тело.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Not found": { "value": { "detail": "No Transaction matches the given query." } } } } } }, "429": { "description": "Более 600 GET-запросов в минуту с этим API-ключом. Подождите указанное в `Retry-After` количество секунд, затем повторите попытку.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Количество секунд до сброса текущего минутного окна.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Количество разрешённых запросов в минуту в рамках этого бюджета.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Количество оставшихся запросов в текущем окне.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix-время, когда окно сбрасывается.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Создать заметку к транзакции", "description": "Добавьте заметку в виде обычного текста в таймлайн проверки отслеживаемой транзакции, где её увидят проверяющие в Console. Заметка служит контекстом, а не решением: `status`, `score` и оповещения транзакции не меняются, webhook не отправляется, и плата не взимается. В `activities` транзакции добавляется запись `TRANSACTION_NOTE_ADDED`.\n\nУ заметок, созданных с помощью API-ключа, нет автора: поля `actor_email` и `actor_name` содержат `null`, поэтому при необходимости укажите автора в тексте. Каждый адрес в `mentioned_emails` должен принадлежать участнику вашей организации, иначе весь запрос завершится ошибкой `400`; упоминания сохраняются в нижнем регистре и без дубликатов, и этот endpoint не отправляет уведомления упомянутым участникам.\n\nКаждый вызов создает новую заметку, поэтому повторная попытка запроса, завершившегося по таймауту, может добавить её дважды: запросите список заметок перед повтором. В API нет endpoint для редактирования или удаления заметок. API-ключу с ограниченными правами требуется разрешение `transactions: write`; ключ с ограничениями по определенным сценариям или одобренным сессиям не может вызывать этот endpoint.", "operationId": "create_transaction_note", "x-didit-sdk": { "resource": "transactions.notes", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "description": "UUID транзакции Didit: значение `uuid`, возвращаемое методами `POST /v3/transactions/` и `GET /v3/transactions/`. Собственный `txn_id` не принимается.", "schema": { "type": "string", "format": "uuid" }, "example": "abcdef12-3456-7890-abcd-ef1234567890" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "note" ], "properties": { "note": { "type": "string", "minLength": 1, "description": "Обычная текстовая заметка. Пробелы в начале и в конце удаляются, а пустая заметка отклоняется. Без ограничений по длине." }, "mentioned_emails": { "type": "array", "items": { "type": "string", "format": "email" }, "default": [], "description": "Электронные адреса участников вашей организации для упоминания. Каждый должен быть действующим адресом участника организации." } } }, "examples": { "Note with a mention": { "value": { "note": "Customer confirmed the withdrawal by phone.", "mentioned_emails": [ "analyst@example.com" ] } }, "Plain note": { "value": { "note": "Source of funds document requested by email." } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/transactions/abcdef12-3456-7890-abcd-ef1234567890/notes/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"note\": \"Customer confirmed the withdrawal by phone.\", \"mentioned_emails\": [\"analyst@example.com\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.notes.create(\n \"abcdef12-3456-7890-abcd-ef1234567890\",\n note=\"Customer confirmed the withdrawal by phone.\",\n mentioned_emails=[\"analyst@example.com\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.notes.create(\"abcdef12-3456-7890-abcd-ef1234567890\", {\n note: \"Customer confirmed the withdrawal by phone.\",\n mentioned_emails: [\"analyst@example.com\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Notes.Create(ctx, \"abcdef12-3456-7890-abcd-ef1234567890\", didit.TransactionsNotesCreateParams{\n\tNote: \"Customer confirmed the withdrawal by phone.\",\n\tMentionedEmails: didit.Some([]string{\"analyst@example.com\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.TransactionsNotesCreateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().notes().create(\"abcdef12-3456-7890-abcd-ef1234567890\", TransactionsNotesCreateParams.builder()\n .note(\"Customer confirmed the withdrawal by phone.\")\n .mentionedEmails(List.of(\"analyst@example.com\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->notes->create('abcdef12-3456-7890-abcd-ef1234567890', [\n 'note' => 'Customer confirmed the withdrawal by phone.',\n 'mentioned_emails' => ['analyst@example.com'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.notes.create(\n \"abcdef12-3456-7890-abcd-ef1234567890\",\n note: \"Customer confirmed the withdrawal by phone.\",\n mentioned_emails: [\"analyst@example.com\"]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.Notes.CreateAsync(\"abcdef12-3456-7890-abcd-ef1234567890\", new TransactionsNotesCreateParams\n{\n Note = \"Customer confirmed the withdrawal by phone.\",\n MentionedEmails = new string[] { \"analyst@example.com\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Заметка создана.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionNote" }, "examples": { "Created": { "value": { "uuid": "c1111111-2222-4333-8444-555555555555", "note": "Customer confirmed the withdrawal by phone.", "actor_email": null, "actor_name": null, "metadata": { "mentioned_emails": [ "analyst@example.com" ] }, "created_at": "2026-10-16T10:05:12.481203Z" } } } } } }, "400": { "description": "Некорректное тело запроса: параметр `note` отсутствует, равен null или пуст, указан недействительный адрес в `mentioned_emails` (ошибки сопоставляются по позиции в списке) либо упомянутый адрес не является участником вашей организации. Ничего не создано.", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибки полей с ключами по названию поля.", "additionalProperties": {} }, "examples": { "Missing note": { "value": { "note": [ "This field is required." ] } }, "Blank note": { "value": { "note": [ "This field may not be blank." ] } }, "Invalid email": { "value": { "mentioned_emails": { "0": [ "Enter a valid email address." ] } } }, "Not an organization member": { "value": { "mentioned_emails": [ "Mentioned users must belong to this organization and have access to this application." ] } } } } } }, "401": { "description": "Срок действия API-ключа истёк. Истечь может только ключ, созданный со сроком действия; после этой даты каждый запрос с ним возвращает `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Запрос запрещён. При отсутствии ключа возвращается стандартное сообщение; при неверном, отозванном или истёкшем ключе возвращается `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without transactions write": { "value": { "detail": "This API key has no write access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "Outside the key's IP list": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Транзакция с этим UUID не существует в приложении (никогда не создавалась, удалена или принадлежит другому приложению). Значение `transaction_id`, не являющееся UUID, не доходит до API: вместо этого возвращается HTML-страница `404`, а не это JSON-тело.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Not found": { "value": { "detail": "No Transaction matches the given query." } } } } } }, "429": { "description": "Более 300 запросов на запись в минуту с этим API-ключом. Подождите указанное в `Retry-After` количество секунд, затем повторите попытку.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Количество секунд до сброса текущего минутного окна.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Количество разрешённых запросов в минуту в рамках этого бюджета.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Количество оставшихся запросов в текущем окне.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix-время, когда окно сбрасывается.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/transactions/{transaction_id}/related/": { "get": { "summary": "Получить список связанных транзакций", "description": "Получить список других транзакций в вашем приложении, в которых участвуют те же лица или компании, что и в этой. Транзакция считается связанной, если у любой из её сторон в любой роли совпадает `vendor_data` с одной из сторон этой транзакции. Сама транзакция никогда не возвращается, а стороны без `vendor_data` игнорируются: если ни у одной из сторон этой транзакции нет такого значения, результат всегда пуст.\n\nРезультаты возвращаются в формате кратких сведений `GET /v3/transactions/`, сначала новые (`txn_date`, затем `created_at`). Поддерживается пагинация с помощью `limit` и `offset`; `count` является точным до 100 и ограничен 100 выше этого значения, поэтому переходите по `next`, пока оно не станет `null`.\n\nAPI-ключу с ограниченной областью видимости требуется `transactions: read`; ключ, ограниченный определёнными сценариями или одобренными сессиями, не может вызывать этот endpoint. Передавайте один и тот же `vendor_data` для одного и того же физического лица или компании в каждой [транзакции](https://docs.didit.me/ru/transaction-monitoring/transactions#субъект-и-контрагент), чтобы этот список был полным.", "operationId": "list_related_transactions", "x-didit-sdk": { "resource": "transactions", "method": "list_related", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "description": "UUID транзакции Didit: значение `uuid`, возвращаемое методами `POST /v3/transactions/` и `GET /v3/transactions/`. Собственный `txn_id` не принимается.", "schema": { "type": "string", "format": "uuid" }, "example": "abcdef12-3456-7890-abcd-ef1234567890" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "description": "Количество транзакций на страницу. По умолчанию 50. Если значение не является положительным целым числом, используется 50; при значении выше 1000000 возвращается `400`." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "description": "Позиция первой возвращаемой транзакции, начиная с нуля. Рекомендуется переходить по ссылке `next`. Значение, не являющееся целым неотрицательным числом, сбрасывается на 0; значение больше 1000000 возвращает `400`." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/transactions/abcdef12-3456-7890-abcd-ef1234567890/related/?limit=50' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.transactions.list_related(\n \"abcdef12-3456-7890-abcd-ef1234567890\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.transactions.listRelated(\"abcdef12-3456-7890-abcd-ef1234567890\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Transactions.ListRelatedAutoPaging(ctx, \"abcdef12-3456-7890-abcd-ef1234567890\", didit.TransactionsListRelatedParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.transactions().listRelated(\"abcdef12-3456-7890-abcd-ef1234567890\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "transactions->listRelated('abcdef12-3456-7890-abcd-ef1234567890') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.transactions.list_related(\"abcdef12-3456-7890-abcd-ef1234567890\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Transactions.ListRelatedAsync(\"abcdef12-3456-7890-abcd-ef1234567890\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Страница связанных транзакций, начиная с самых новых.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "description": "Количество связанных транзакций: точное значение до 100, с ограничением 100 выше этого порога. Переходите по `next` вместо вычисления страниц на основе этого значения." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "Абсолютный URL следующей страницы или `null` на последней странице." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "Абсолютный URL предыдущей страницы или `null` на первой странице." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionSummary" } } } }, "examples": { "One related transaction": { "value": { "count": 1, "next": null, "previous": null, "results": [ { "uuid": "abcdef99-3456-4890-abcd-ef1234567890", "transaction_number": 4087, "txn_id": "your-txn-2026-10-02-017", "transaction_type": "finance", "action_type": "deposit", "status": "APPROVED", "source": "LIVE", "direction": "INBOUND", "amount": "250", "currency": "EUR", "currency_type": "fiat", "preferred_currency_amount": "270.08", "preferred_currency_code": "USD", "payment_details": "Card top-up", "txn_date": "2026-10-02T14:10:00Z", "created_at": "2026-10-02T14:10:03.512244Z", "score": 12, "severity": "LOW", "decision_reason_code": null, "decision_reason_label": null, "tags": [], "subject_name": "Maria Garcia", "subject_vendor_data": "user-12345", "subject_type": "user", "subject_uuid": "e1111111-2222-4333-8444-555555555555", "counterparty_name": null, "counterparty_vendor_data": null, "counterparty_country": null, "subject_country": "ESP", "assigned_to_name": null, "travel_rule_status": null, "application_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "application_name": "Production app", "organization_id": "11111111-2222-3333-4444-555555555555", "organization_name": "Example Org" } ] } }, "No party has vendor_data": { "value": { "count": 0, "next": null, "previous": null, "results": [] } } } } } }, "400": { "description": "`limit` или `offset` превышает 1000000. Тело ответа представляет собой JSON-массив сообщений, а не объект.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "Limit too large": { "value": [ "limit must not exceed 1000000." ] }, "Offset too large": { "value": [ "offset must not exceed 1000000." ] } } } } }, "401": { "description": "Срок действия API-ключа истёк. Истечь может только ключ, созданный со сроком действия; после этой даты каждый запрос с ним возвращает `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Запрос запрещён. При отсутствии ключа возвращается стандартное сообщение; при неверном, отозванном или истёкшем ключе возвращается `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid key": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without transactions read": { "value": { "detail": "This API key has no read access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "Outside the key's IP list": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Транзакция с этим UUID не существует в приложении (никогда не создавалась, удалена или принадлежит другому приложению). Значение `transaction_id`, не являющееся UUID, не доходит до API: вместо этого возвращается HTML-страница `404`, а не это JSON-тело.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Not found": { "value": { "detail": "No Transaction matches the given query." } } } } } }, "429": { "description": "Более 600 GET-запросов в минуту с этим API-ключом. Подождите указанное в `Retry-After` количество секунд, затем повторите попытку.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Количество секунд до сброса текущего минутного окна.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Количество разрешённых запросов в минуту в рамках этого бюджета.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Количество оставшихся запросов в текущем окне.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix-время, когда окно сбрасывается.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/businesses/{business_session_id}/pdf/": { "get": { "summary": "Скачать PDF-отчёт по бизнес-сессии", "description": "Сформировать PDF-отчёт по одной сессии Верификации бизнеса (KYB): данные реестра компаний, ключевые лица и бенефициарные владельцы, документы, результаты AML и другие функции сценария, а также теги сессии и активность проверки. При включённой кастомизации White label отчёт содержит ваш логотип и URL политики конфиденциальности. Тело ответа представляет собой сам PDF (`application/pdf`), а не JSON.\n\nСессия должна иметь статус `Approved`, `Declined` или `In Review`; любой другой статус возвращает `403`, поэтому сначала дождитесь [webhook](https://docs.didit.me/ru/integration/webhooks) `status.updated`. Отчёт формируется при каждом вызове и не тарифицируется, поэтому сохраняйте файл у себя вместо его повторного скачивания. Запрос `GET /v3/session/{sessionId}/generate-pdf/` формирует аналогичный отчёт только по ID сессии.\n\nPDF-отчёт считается медиафайлом: для API-ключа с ограниченным доступом требуются разрешения `businesses: read` и `media: read`, а ключ, ограниченный определёнными сценариями или одобренными сессиями, не может его вызывать.", "operationId": "get_business_session_pdf", "x-didit-sdk": { "resource": "businesses", "method": "generate_session_pdf", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Businesses" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации.", "example": "11111111-2222-3333-4444-555555555555" }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения. Должно быть приложением, к которому относится API-ключ: при использовании ключа для любого другого приложения возвращается `403`.", "example": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, { "name": "business_session_id", "in": "path", "required": true, "description": "`session_id` сессии Верификации бизнеса (KYB), возвращённый при создании сессии. Сессия другого приложения возвращает `404`.", "schema": { "type": "string", "format": "uuid" }, "example": "22222222-3333-4444-5555-666666666666" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl --fail -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/businesses/22222222-3333-4444-5555-666666666666/pdf/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n --output business_report.pdf" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\ncontent = client.businesses.generate_session_pdf(\n \"22222222-3333-4444-5555-666666666666\",\n)\nwith open(\"download.pdf\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst content = await didit.businesses.generateSessionPdf(\"22222222-3333-4444-5555-666666666666\");\nawait writeFile(\"download.pdf\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresp, err := client.Businesses.GenerateSessionPDF(ctx, \"22222222-3333-4444-5555-666666666666\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.pdf\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.businesses().generateSessionPdf(\"22222222-3333-4444-5555-666666666666\")\n .writeTo(Path.of(\"download.pdf\"));" }, { "lang": "php", "label": "PHP", "source": "businesses->generateSessionPdf('22222222-3333-4444-5555-666666666666');\n$content->saveTo('download.pdf');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ncontent = didit.businesses.generate_session_pdf(\"22222222-3333-4444-5555-666666666666\")\nFile.binwrite(\"download.pdf\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar content = await client.Businesses.GenerateSessionPdfAsync(\"22222222-3333-4444-5555-666666666666\");\nawait content.SaveToAsync(\"download.pdf\");" } ], "responses": { "200": { "description": "Сформированный PDF, возвращаемый напрямую как бинарные данные `application/pdf`.", "headers": { "Content-Disposition": { "description": "Всегда `attachment; filename=business_{business_session_id}.pdf`.", "schema": { "type": "string", "example": "attachment; filename=business_22222222-3333-4444-5555-666666666666.pdf" } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Срок действия API-ключа истёк. Истечь может только ключ, созданный со сроком действия; после этой даты каждый запрос с ним возвращает `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Запрос запрещён или сессия не завершена. Проверьте `detail`: сессия не находится в статусе `Approved`, `Declined` или `In Review`, отсутствует API-ключ (при неверном, отозванном или истёкшем ключе возвращается `401`), `application_id` не принадлежит приложению ключа, ключ с ограниченной областью видимости не содержит разрешений `media: read` или `businesses: read`, ключ ограничен сценариями или одобренными сессиями, либо запрос отправлен не из списка IP-адресов ключа.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Session not finished": { "value": { "detail": "You can only generate a PDF for sessions in review, declined or approved." } }, "Missing or invalid key": { "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Another application": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without media read": { "value": { "detail": "This API key has no read access to media." } }, "Scoped key without businesses read": { "value": { "detail": "This API key has no read access to companies." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "Outside the key's IP list": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Бизнес-сессии с таким ID в приложении не существует (никогда не создавалась, была удалена или принадлежит другому приложению). Значение, не являющееся UUID, возвращает HTML-страницу `404` вместо этого JSON-тела.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Not found": { "value": { "detail": "Business session not found." } } } } } }, "429": { "description": "Более 600 GET-запросов в минуту с этим API-ключом. Подождите указанное в `Retry-After` количество секунд, затем повторите попытку.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Количество секунд до сброса текущего минутного окна.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Количество разрешённых запросов в минуту в рамках этого бюджета.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Количество оставшихся запросов в текущем окне.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix-время, когда окно сбрасывается.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/transactions/{transaction_uuid}/pdf/": { "get": { "summary": "Скачать PDF-отчёт по транзакции", "description": "Сформируйте PDF-отчёт по одной отслеживаемой транзакции: сводка и вердикт, стороны и способы оплаты, пользовательские свойства, оповещения и срабатывания правил, результаты скрининга и Travel Rule, сводка по сети, детализация расходов, до 50 связанных транзакций и 20 последних записей активности. Телом ответа является сам PDF-файл (`application/pdf`), а не JSON.\n\nОтчёт генерируется на основе актуальных данных транзакции при каждом вызове, поэтому запрашивайте его повторно после изменения статуса. Никакие данные не сохраняются и плата не взимается. Рендеринг может занять несколько секунд, поэтому используйте увеличенный таймаут на клиенте.\n\nЭтот endpoint находится по пути с областью действия приложения: укажите в URL идентификатор вашей организации и ID приложения, к которому относится ваш API-ключ ([узнайте ID вашей организации](https://docs.didit.me/ru/getting-started/api-authentication#как-найти-id-организации)). PDF-отчёт считается медиафайлом: для API-ключа с ограниченной областью действия требуются разрешения `media: read` и `transactions: read`, а ключ с доступом только к определённым сценариям или к одобренным сессиям не может вызывать этот endpoint.", "operationId": "get_transaction_pdf", "x-didit-sdk": { "resource": "transactions", "method": "generate_pdf", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Transactions" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации.", "example": "11111111-2222-3333-4444-555555555555" }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения. Должно быть приложением, к которому относится API-ключ: при использовании ключа для любого другого приложения возвращается `403`.", "example": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, { "name": "transaction_uuid", "in": "path", "required": true, "description": "UUID транзакции Didit: значение `uuid`, возвращаемое методами `POST /v3/transactions/` и `GET /v3/transactions/`. Собственный `txn_id` не принимается.", "schema": { "type": "string", "format": "uuid" }, "example": "abcdef12-3456-7890-abcd-ef1234567890" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl --fail -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/transactions/abcdef12-3456-7890-abcd-ef1234567890/pdf/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n --output transaction_report.pdf" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\ncontent = client.transactions.generate_pdf(\n \"abcdef12-3456-7890-abcd-ef1234567890\",\n)\nwith open(\"download.pdf\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst content = await didit.transactions.generatePdf(\"abcdef12-3456-7890-abcd-ef1234567890\");\nawait writeFile(\"download.pdf\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresp, err := client.Transactions.GeneratePDF(ctx, \"abcdef12-3456-7890-abcd-ef1234567890\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.pdf\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.transactions().generatePdf(\"abcdef12-3456-7890-abcd-ef1234567890\")\n .writeTo(Path.of(\"download.pdf\"));" }, { "lang": "php", "label": "PHP", "source": "transactions->generatePdf('abcdef12-3456-7890-abcd-ef1234567890');\n$content->saveTo('download.pdf');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ncontent = didit.transactions.generate_pdf(\"abcdef12-3456-7890-abcd-ef1234567890\")\nFile.binwrite(\"download.pdf\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar content = await client.Transactions.GeneratePdfAsync(\"abcdef12-3456-7890-abcd-ef1234567890\");\nawait content.SaveToAsync(\"download.pdf\");" } ], "responses": { "200": { "description": "Сформированный PDF, возвращаемый напрямую как бинарные данные `application/pdf`.", "headers": { "Content-Disposition": { "description": "Всегда `attachment; filename=transaction_{transaction_uuid}.pdf`.", "schema": { "type": "string", "example": "attachment; filename=transaction_abcdef12-3456-7890-abcd-ef1234567890.pdf" } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Срок действия API-ключа истёк. Истечь может только ключ, созданный со сроком действия; после этой даты каждый запрос с ним возвращает `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Запрос не разрешён. Проверьте `detail`: отсутствующий API-ключ (неверный, отозванный или истёкший ключ возвращает `401`), `application_id`, не относящийся к приложению ключа, ключ с ограниченной областью действия без `media: read` или `transactions: read`, ключ с ограничениями по сценариям или одобренным сессиям, либо запрос не из списка IP-адресов ключа.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid key": { "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Another application": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without media read": { "value": { "detail": "This API key has no read access to media." } }, "Scoped key without transactions read": { "value": { "detail": "This API key has no read access to transactions." } }, "Key limited to workflows or approved sessions": { "value": { "detail": "This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint." } }, "Outside the key's IP list": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Транзакция с этим UUID не существует в приложении (никогда не создавалась, удалена или принадлежит другому приложению). Значение `transaction_uuid`, не являющееся UUID, не доходит до API: вместо этого возвращается HTML-страница `404`, а не это JSON-тело.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Not found": { "value": { "detail": "No Transaction matches the given query." } } } } } }, "429": { "description": "Более 600 GET-запросов в минуту с этим API-ключом. Подождите указанное в `Retry-After` количество секунд, затем повторите попытку.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Количество секунд до сброса текущего минутного окна.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Количество разрешённых запросов в минуту в рамках этого бюджета.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Количество оставшихся запросов в текущем окне.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix-время, когда окно сбрасывается.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/analytics/": { "get": { "summary": "Получить аналитику приложения", "description": "Считывает числовые показатели для [панели аналитики](https://docs.didit.me/ru/console/analytics) в Business Console за указанный диапазон дат. Без параметров `scope` и `widget_keys` ответом будет сводка по проверке пользователей (KYC) (`ApplicationAnalyticsSummary`): ежедневное количество сессий, итоги по статусам, коэффициент конверсии, те же показатели за предшествующий период аналогичной длины, локации, демографические данные, устройства, воронки сценариев, активное время верификации, повторные отправки, предупреждения и временные ряды. При наличии `scope` или `widget_keys` возвращаются виджеты одной вкладки панели управления (`ApplicationAnalyticsWidgetResponse`): `kyc`, `kyb`, `transactions` или `home`.\n\nКоличество сессий рассчитывается по дате создания сессии (UTC) и отражает текущий статус каждой сессии. Значения берутся из ежедневных агрегаций, обновляемых в фоновом режиме, поэтому появление самых свежих действий может занять некоторое время. Недопустимые ID сценариев и версии игнорируются, а не отклоняются. Плата не взимается.\n\nВызывать этот endpoint может только API-ключ с полным доступом: любой ключ с ограниченной областью действия получает `403` независимо от его разрешений, как и ключ другого приложения. См. [API-ключи](https://docs.didit.me/ru/console/api-keys).", "operationId": "get_application_analytics", "x-didit-sdk": { "resource": "analytics", "method": "retrieve", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Analytics" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации.", "example": "11111111-2222-3333-4444-555555555555" }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения. Должно быть приложением, к которому относится API-ключ: при использовании ключа для любого другого приложения возвращается `403`.", "example": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2026-10-01" }, "description": "Первый день диапазона, `YYYY-MM-DD`, включительно (UTC). Передавайте вместе с `end_date`: если один из параметров отсутствует, оба игнорируются, и диапазон охватывает период от 30 дней назад до сегодняшнего дня." }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2026-10-15" }, "description": "Последний день диапазона, `YYYY-MM-DD`, включительно (UTC). Будущая дата считается сегодняшним днём. Диапазон не может превышать 730 дней." }, { "name": "scope", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "home", "kyc", "kyb", "transactions" ] }, "description": "Вкладка панели управления, для которой нужно вернуть виджеты (без учёта регистра). Опустите её вместе с `widget_keys` для получения сводки по KYC. Передача только `widget_keys` подразумевает `kyc`. `home` принимает любые виджеты KYC, KYB или транзакций и по умолчанию использует сохранённую раскладку главной страницы приложения." }, { "name": "widget_keys", "in": "query", "required": false, "schema": { "type": "string", "example": "tx_count_total,tx_count_daily" }, "description": "Разделённые запятыми ключи виджетов, возвращаемые в указанном порядке. Ключи, не поддерживаемые областью действия (scope), отбрасываются; если не останется ни одного, возвращаются значения по умолчанию для этой области. KYC: `kyc_sessions_volume`, `kyc_warning_insights`, `kyc_id_locations`, `kyc_ip_locations`, `kyc_workflow_funnel`, `kyc_average_verification_time`, `kyc_conversion_rate`, `kyc_conversion_by_country`, `kyc_resubmission_insights`, `kyc_original_status_distribution`, `kyc_database_validation_coverage`, `kyc_database_validation_latency`, `kyc_demographics`, `kyc_device_details`. KYB: `kyb_sessions_volume`, `kyb_workflow_funnel`, `kyb_average_verification_time`, `kyb_ip_locations`, `kyb_business_country_distribution`, `kyb_warning_insights`, `kyb_conversion_rate`, `kyb_conversion_by_country`, `kyb_industry_breakdown`, `kyb_resubmission_insights`, `kyb_original_status_distribution`, `kyb_registry_coverage`, `kyb_registry_data_completeness`, `kyb_device_details`. Транзакции: `tx_count_total`, `tx_count_daily`, `tx_volume_total_preferred_currency`, `tx_volume_daily_preferred_currency`, `tx_average_amount`, `tx_average_amount_daily`, `tx_transaction_category_breakdown`, `tx_action_type_breakdown`, `tx_status_volume_trend`, `tx_user_ip_or_country_distribution`, `tx_tag_breakdown`, `tx_top_rules_triggered`, `tx_team_member_performance`, `tx_score_histogram`." }, { "name": "workflow_ids", "in": "query", "required": false, "schema": { "type": "string", "example": "33333333-4444-5555-6666-777777777777" }, "description": "Разделённые запятыми идентификаторы сценариев. Ограничивает сводку KYC и виджеты KYC и KYB указанными сценариями. Значения, не являющиеся UUID, игнорируются; если нет ни одного валидного значения, фильтр отбрасывается. Сводка также принимает `workflow_id`." }, { "name": "versions", "in": "query", "required": false, "schema": { "type": "string", "example": "3,4" }, "description": "Разделённые запятыми номера версий сценария. Применяется только вместе с `workflow_ids`; значения, не являющиеся целыми числами, игнорируются. `version` принимается в качестве псевдонима." }, { "name": "branch_path_ids", "in": "query", "required": false, "schema": { "type": "string", "example": "default" }, "description": "Разделённые запятыми ID путей ветвей. Применяется только вместе с `workflow_ids` и только к показателям KYC. В настоящее время показатели фиксируются только для `default` (все пути вместе), поэтому любое другое значение возвращает пустые показатели. `branch_path_id` принимается в качестве псевдонима." }, { "name": "tag", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Только для виджетов транзакций: UUID тегов или названия тегов через запятую." }, { "name": "transaction_type", "in": "query", "required": false, "schema": { "type": "string", "example": "finance" }, "description": "Только для виджетов транзакций: категории транзакций через запятую." }, { "name": "action_type", "in": "query", "required": false, "schema": { "type": "string", "example": "withdrawal" }, "description": "Только для виджетов транзакций: типы действий через запятую (без учёта регистра)." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/analytics/?start_date=2026-10-01&end_date=2026-10-15' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.analytics.retrieve()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.analytics.retrieve();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Analytics.Retrieve(ctx, didit.AnalyticsRetrieveParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.analytics().retrieve();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "analytics->retrieve();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.analytics.retrieve\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Analytics.RetrieveAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Сводка KYC или запрошенные виджеты, если переданы `scope` или `widget_keys`.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ApplicationAnalyticsSummary" }, { "$ref": "#/components/schemas/ApplicationAnalyticsWidgetResponse" } ] }, "examples": { "KYC summary": { "value": { "grouping_mode": "day", "data_points": [ { "rounded_date": "2026-10-14", "total": 12, "approved": 8, "declined": 1, "canceled": 1, "pending": 2, "in_review": 1, "expired": 1, "abandoned": 0, "in_progress": 1, "not_started": 0, "manually_approved": 1, "manually_declined": 0 }, { "rounded_date": "2026-10-15", "total": 10, "approved": 6, "declined": 2, "canceled": 0, "pending": 2, "in_review": 2, "expired": 0, "abandoned": 0, "in_progress": 0, "not_started": 0, "manually_approved": 0, "manually_declined": 1 } ], "request_breakdown": { "total_approved": 14, "total_in_review": 3, "total_declined": 3, "total_canceled": 1, "total_pending": 4, "total_expired": 1, "total_abandoned": 0, "total_in_progress": 1, "total_not_started": 0, "total_manually_approved": 1, "total_manually_declined": 1 }, "conversion_rate": 70.0, "location_stats": { "countries": [ { "session_count": 15, "country": "Spain", "country_code": "ES" }, { "session_count": 7, "country": "Portugal", "country_code": "PT" } ], "ip_countries": [ { "session_count": 15, "country": "Spain", "country_code": "ES" }, { "session_count": 7, "country": "Portugal", "country_code": "PT" } ], "id_countries": [ { "country": "Spain", "country_code": "ES", "session_count": 14 }, { "country": "Portugal", "country_code": "PT", "session_count": 6 } ], "conversion_by_country": [ { "country": "Spain", "country_code": "ES", "finished": 13, "approved": 10 }, { "country": "Portugal", "country_code": "PT", "finished": 6, "approved": 4 } ], "cities": [ { "session_count": 9, "location": "Madrid, Spain", "latitude": 40.4168, "longitude": -3.7038 } ] }, "demographic_stats": { "age_distribution": { "under_18": 0, "18_24": 5, "25_34": 8, "35_44": 4, "45_64": 2, "65_plus": 1 }, "gender_distribution": { "M": 11, "F": 9 } }, "device_details": { "device_models": [ { "device": "Apple", "count": 12 }, { "device": "Android", "count": 10 } ], "browsers": [ { "browser": "Safari", "count": 12 }, { "browser": "Chrome", "count": 10 } ], "operating_systems": [ { "os": "iOS", "count": 12 }, { "os": "Android", "count": 10 } ] }, "workflow_funnel_stats": { "33333333-4444-5555-6666-777777777777": { "total": 22, "steps": { "OCR": { "reached": 21 }, "LIVENESS": { "reached": 19 }, "FACE_MATCH": { "reached": 19 }, "AML": { "reached": 18 } } } }, "verification_time_stats": { "overall_avg_seconds": 64.0, "overall_count": 18, "per_feature": { "OCR": { "avg_seconds": 41.2, "total_seconds": 741.6, "count": 18 }, "LIVENESS": { "avg_seconds": 22.8, "total_seconds": 410.4, "count": 18 } }, "per_sub_step": { "OCR": { "front_id_photo": { "avg_seconds": 18.3, "total_seconds": 329.4, "count": 18 } } } }, "resubmission_stats": { "first_pass": 17, "second": 2, "third_plus": 1, "abandoned": 0 }, "warning_stats": { "ID_VERIFICATION": { "total": 21, "risks": { "DOCUMENT_EXPIRED": { "error": 1, "warning": 0, "information": 0 } } }, "LIVENESS": { "total": 19, "risks": { "LOW_LIVENESS_SCORE": { "error": 0, "warning": 2, "information": 0 } } } }, "original_status_stats": { "approved": 13, "in_review": 5, "declined": 2 }, "demographic_time_series": [ { "date": "2026-10-14", "age_distribution": { "under_18": 0, "18_24": 3, "25_34": 4, "35_44": 2, "45_64": 1, "65_plus": 0 }, "gender_distribution": { "M": 6, "F": 4 } }, { "date": "2026-10-15", "age_distribution": { "under_18": 0, "18_24": 2, "25_34": 4, "35_44": 2, "45_64": 1, "65_plus": 1 }, "gender_distribution": { "M": 5, "F": 5 } } ], "device_time_series": [ { "date": "2026-10-14", "devices": { "Apple": 7, "Android": 5 }, "browsers": { "Safari": 7, "Chrome": 5 }, "operating_systems": { "iOS": 7, "Android": 5 } }, { "date": "2026-10-15", "devices": { "Apple": 5, "Android": 5 }, "browsers": { "Safari": 5, "Chrome": 5 }, "operating_systems": { "iOS": 5, "Android": 5 } } ], "verification_time_time_series": [ { "date": "2026-10-14", "overall_avg": 66.1, "per_feature": { "OCR": 42.0, "LIVENESS": 24.1 } }, { "date": "2026-10-15", "overall_avg": 61.5, "per_feature": { "OCR": 40.2, "LIVENESS": 21.3 } } ], "resubmission_time_series": [ { "date": "2026-10-14", "first_pass": 9, "second": 1, "third_plus": 0, "abandoned": 0 }, { "date": "2026-10-15", "first_pass": 8, "second": 1, "third_plus": 1, "abandoned": 0 } ], "original_status_time_series": [ { "date": "2026-10-14", "approved": 7, "in_review": 3, "declined": 1 }, { "date": "2026-10-15", "approved": 6, "in_review": 2, "declined": 1 } ], "previous_data_points": [ { "rounded_date": "2026-10-12", "total": 9, "approved": 6, "declined": 1, "canceled": 1, "pending": 1 }, { "rounded_date": "2026-10-13", "total": 11, "approved": 7, "declined": 2, "canceled": 0, "pending": 2 } ], "previous_request_breakdown": { "total_approved": 13, "total_in_review": 2, "total_declined": 3, "total_canceled": 1, "total_pending": 3 } } }, "Transaction widgets": { "value": { "scope": "transactions", "available_widget_keys": [ "tx_count_total", "tx_count_daily", "tx_volume_total_preferred_currency", "tx_volume_daily_preferred_currency", "tx_average_amount", "tx_average_amount_daily", "tx_transaction_category_breakdown", "tx_action_type_breakdown", "tx_status_volume_trend", "tx_user_ip_or_country_distribution", "tx_tag_breakdown", "tx_top_rules_triggered", "tx_team_member_performance", "tx_score_histogram" ], "requested_widget_keys": [ "tx_count_total", "tx_count_daily" ], "widgets": { "tx_count_total": { "kind": "metric", "title": "Transaction count", "value": 42 }, "tx_count_daily": { "kind": "time_series", "title": "Transaction count", "items": [ { "date": "2026-10-14", "value": 20 }, { "date": "2026-10-15", "value": 22 } ], "previous_items": [ { "date": "2026-10-12", "value": 18 }, { "date": "2026-10-13", "value": 15 } ] } } } } } } } }, "400": { "description": "Недопустимый диапазон дат или область действия (scope). Тело ответа представляет собой объект с ключом проблемного параметра и строковым сообщением.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Bad date format": { "value": { "start_date": "Invalid date format. Use YYYY-MM-DD (e.g., 2024-01-15)." } }, "Start after end": { "value": { "start_date": "Start date must be before or equal to end date." } }, "Range too long": { "value": { "date_range": "Date range cannot exceed 730 days (2 years)." } }, "Unknown scope": { "value": { "scope": "Unsupported analytics scope." } } } } } }, "401": { "description": "Срок действия API-ключа истёк. Истечь может только ключ, созданный со сроком действия; после этой даты каждый запрос с ним возвращает `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Запрос не разрешён. Проверьте `detail`: отсутствующий API-ключ (неверный, отозванный или истёкший ключ возвращает `401`), ключ другого приложения, любой ключ с ограниченной областью действия или запрос не из списка IP-адресов ключа.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid key": { "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Another application": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key": { "value": { "detail": "This API key has no access to this endpoint." } }, "Outside the key's IP list": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "429": { "description": "Более 600 GET-запросов в минуту с этим API-ключом. Подождите указанное в `Retry-After` количество секунд, затем повторите попытку.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Количество секунд до сброса текущего минутного окна.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Количество разрешённых запросов в минуту в рамках этого бюджета.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Количество оставшихся запросов в текущем окне.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix-время, когда окно сбрасывается.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/analytics/today/": { "get": { "summary": "Получить сегодняшние верификации по часам", "operationId": "get_application_analytics_today", "x-didit-sdk": { "resource": "analytics", "method": "retrieve_today", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Analytics" ], "description": "Сегодняшние сессии проверки пользователей (KYC) от местной полуночи в `tz`, подсчитанные по местным часам их создания, рядом с теми же часами того же дня недели неделю назад и с разбивкой по текущему результату: одобрена, на проверке или отклонена. Это карточка объёма на главной странице Business Console.\n\n`total` показывает итог за сегодня на данный момент. `previous_total_so_far` учитывает день сравнения только до того же местного времени, поэтому разница между ними сравнивает одну и ту же часть обоих дней. Часы, которые ещё не наступили сегодня, равны `0`. День с переводом часов содержит 23 или 25 часов: пропущенный час остаётся `0`, а повторяющийся час объединяет оба.", "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации.", "example": "11111111-2222-3333-4444-555555555555" }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения. Должно быть приложением, к которому относится API-ключ: при использовании ключа для любого другого приложения возвращается `403`.", "example": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, { "name": "tz", "in": "query", "required": false, "schema": { "type": "string", "default": "UTC", "example": "Europe/Madrid" }, "description": "Часовой пояс IANA, полночь которого начинает сегодняшние сутки, например `Europe/Madrid` или `America/Mexico_City`. Опустите для использования UTC." } ], "responses": { "200": { "description": "Сегодняшние верификации по местным часам, верификации дня сравнения и сегодняшние результаты.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationAnalyticsToday" }, "examples": { "Madrid, 14:00": { "value": { "time_zone": "Europe/Madrid", "date": "2026-10-30", "current_hour": 14, "previous_date": "2026-10-23", "hours": [ 3, 1, 0, 0, 1, 2, 4, 9, 14, 18, 21, 19, 22, 24, 27, 0, 0, 0, 0, 0, 0, 0, 0, 0 ], "previous_hours": [ 2, 1, 1, 0, 1, 3, 5, 8, 12, 16, 19, 18, 20, 22, 24, 26, 23, 19, 15, 12, 9, 7, 5, 3 ], "total": 165, "previous_total_so_far": 151, "outcomes": { "approved": 139, "in_review": 6, "declined": 18 } } } } } } }, "400": { "description": "Неизвестный часовой пояс. В теле ответа ключами являются параметры, для каждого из которых приведён список сообщений.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "examples": { "Unknown time zone": { "value": { "tz": [ "Unknown time zone: Europe/Atlantis." ] } } } } } }, "401": { "description": "Срок действия API-ключа истёк. Истечь может только ключ, созданный со сроком действия; после этой даты каждый запрос с ним возвращает `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Запрос не разрешён. Проверьте `detail`: отсутствующий или недействительный API-ключ (никогда не `401`), ключ другого приложения, любой ключ с ограниченной областью действия или запрос не из списка IP-адресов ключа.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid key": { "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Another application": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key": { "value": { "detail": "This API key has no access to this endpoint." } }, "Outside the key's IP list": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "429": { "description": "Более 600 GET-запросов в минуту с этим API-ключом. Подождите указанное в `Retry-After` количество секунд, затем повторите попытку.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Количество секунд до сброса текущего минутного окна.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Количество разрешённых запросов в минуту в рамках этого бюджета.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Количество оставшихся запросов в текущем окне.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix-время, когда окно сбрасывается.", "schema": { "type": "integer" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/analytics/today/?tz=Europe%2FMadrid' \\\n -H 'x-api-key: YOUR_API_KEY'" } ], "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/webhooks/": { "get": { "summary": "Получить список доставок webhook по сессии", "description": "Получить список всех доставок webhook, зафиксированных Didit для одной сессии верификации пользователя (KYC) или бизнеса (KYB), сначала новые, в виде обычного массива JSON (без пагинации). Каждая запись представляет собой одну попытку отправки на один адрес назначения: первая отправка, каждая автоматическая [повторная попытка](https://docs.didit.me/ru/integration/webhooks#политика-повторных-попыток) и каждая повторная отправка являются отдельными записями со своим `uuid`, при этом повторные попытки и повторные отправки сохраняют `event_id` payload. `request_header` и `request_body` представляют собой текст JSON; распарсите их, чтобы прочитать подписи и payload. Записи о доставках доступны около 30 дней, поэтому пустой массив означает, что для этой сессии webhook ещё не отправлялся либо все доставки старше этого срока. Для API-ключа с ограниченными правами требуются разрешения `sessions: read` и `decisions: read`.", "operationId": "get_v3_session_webhooks", "x-didit-sdk": { "resource": "sessions.webhooks", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID сессии верификации, пользователя (KYC) или компании (KYB): `session_id`, возвращённый `POST /v3/session/`. Сервер сопоставляет его для обоих типов сессий.\n\n**Должен быть корректным UUID.** Маршрут сопоставляется только с корректно сформированными UUID, поэтому некорректное значение отклоняется маршрутизатором URL ещё до выполнения кода приложения, и в ответ возвращается **HTML**-страница `404`, а не конверт JSON `{\"detail\": ...}`, показанный ниже.", "schema": { "type": "string", "format": "uuid" }, "example": "22222222-3333-4444-5555-666666666666" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/session/22222222-3333-4444-5555-666666666666/webhooks/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.webhooks.list(\n \"22222222-3333-4444-5555-666666666666\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.webhooks.list(\"22222222-3333-4444-5555-666666666666\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Webhooks.List(ctx, \"22222222-3333-4444-5555-666666666666\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().webhooks().list(\"22222222-3333-4444-5555-666666666666\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->webhooks->list('22222222-3333-4444-5555-666666666666');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.sessions.webhooks.list(\"22222222-3333-4444-5555-666666666666\").each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Webhooks.ListAsync(\"22222222-3333-4444-5555-666666666666\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Каждая доставка, зафиксированная для сессии, начиная с самых новых.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SessionWebhookDelivery" } }, "examples": { "Failed delivery and its successful retry": { "value": [ { "uuid": "66666666-7777-8888-9999-000000000002", "session_id": "22222222-3333-4444-5555-666666666666", "request_url": "https://yourapp.com/webhooks/didit", "response_status": 200, "status": "In Progress", "webhook_type": "status.updated", "request_header": "{\"Content-Type\": \"application/json\", \"X-Signature\": \"9188851d160b5b3aacfc946e4dde1f061b7e568662518942c927ddaf507f533d\", \"X-Signature-V2\": \"381236af514d3fb538579365ac5a24f2464ce1b8224c6e770c60d8201c43ecc5\", \"X-Signature-Simple\": \"4740131dc38f29e78a8508371979be74967d5307464494bd3148a03b4d6c8716\", \"X-Timestamp\": \"1792056139\", \"User-Agent\": \"DiditWebhook/2.0 +https://didit.me\"}", "request_body": "{\"application_id\":\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\"created_at\":1792056057,\"environment\":\"live\",\"event_id\":\"33333333-4444-5555-6666-777777777777\",\"sandbox_scenario\":null,\"session_id\":\"22222222-3333-4444-5555-666666666666\",\"status\":\"In Progress\",\"timestamp\":1792056139,\"vendor_data\":\"user-123\",\"webhook_type\":\"status.updated\",\"workflow_id\":\"44444444-5555-6666-7777-888888888888\",\"workflow_version\":3}", "created_at": "2026-10-15T09:22:19.104233Z" }, { "uuid": "66666666-7777-8888-9999-000000000001", "session_id": "22222222-3333-4444-5555-666666666666", "request_url": "https://yourapp.com/webhooks/didit", "response_status": 503, "status": "In Progress", "webhook_type": "status.updated", "request_header": "{\"Content-Type\": \"application/json\", \"X-Signature\": \"a5e02a03404e1337a0198e6be15d34abbd053c658a0e51e5d0e78554213ef29b\", \"X-Signature-V2\": \"927e7cb770c94ce745939bff73f04aa200015f3bc64795ba46c2aaf78a6cedc5\", \"X-Signature-Simple\": \"e37b0d4c716c72bb5ae7127b9cc455d28ab4686e9e22312b4ec2327409a73302\", \"X-Timestamp\": \"1792056078\", \"User-Agent\": \"DiditWebhook/2.0 +https://didit.me\"}", "request_body": "{\"application_id\":\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\"created_at\":1792056057,\"environment\":\"live\",\"event_id\":\"33333333-4444-5555-6666-777777777777\",\"sandbox_scenario\":null,\"session_id\":\"22222222-3333-4444-5555-666666666666\",\"status\":\"In Progress\",\"timestamp\":1792056078,\"vendor_data\":\"user-123\",\"webhook_type\":\"status.updated\",\"workflow_id\":\"44444444-5555-6666-7777-888888888888\",\"workflow_version\":3}", "created_at": "2026-10-15T09:21:18.412345Z" } ] }, "No webhook sent yet": { "value": [] } } } } }, "401": { "description": "Срок действия API-ключа истёк: он был создан со сроком действия, который уже прошёл. Неверный или отозванный ключ также возвращает `401`; отсутствующий ключ возвращает `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Запрос не разрешён. Отсутствие `x-api-key`, а также недействительный или отозванный ключ возвращают `Authentication credentials were not provided or are invalid.` Ключ другого приложения возвращает `You do not have permission to perform this action.` Ключ с ограниченной областью действия без требуемых для этого endpoint прав возвращает сообщение с указанием недостающих разрешений, а ключ, используемый не из разрешённого списка IP-адресов, возвращает `This API key can't be used from this IP address.` Неизвестный `sessionId` возвращает `404` ещё до проверки учётных данных.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Missing or invalid key": { "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Key of another application": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without sessions read": { "value": { "detail": "This API key has no read access to sessions." } }, "Scoped key without decisions read": { "value": { "detail": "This API key has no read access to decisions." } }, "Outside the IP allowlist": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Сессия не существует или была удалена (`Not found.`, возвращается до проверки учетных данных), либо находится за пределами ограничений по сценариям или статусам для ключа с ограниченным доступом (`Session not found.`).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Unknown session": { "value": { "detail": "Not found." } }, "Outside the key's limits": { "value": { "detail": "Session not found." } } } } } }, "429": { "description": "Лимит запросов превышен: более 600 GET-запросов в текущем минутном окне для этого API-ключа. Подождите `Retry-After` секунд перед повторной попыткой.", "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Количество разрешённых запросов в минутном окне (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Количество оставшихся запросов в текущем окне.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Unix-время (в секундах), когда текущее окно сбрасывается.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Название бюджета, который был превышен.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/webhook/{webhook_uuid}": { "get": { "summary": "Получить доставку webhook сессии", "description": "Получить одну доставку webhook для сессии верификации: URL, на который она была отправлена, HTTP-статус, возвращённый вашим endpoint, а также точные заголовки и JSON-тело, отправленные Didit. Поля `request_header` и `request_body` представляют собой текст JSON; чтобы выполнить вашу [проверку подписи](https://docs.didit.me/ru/integration/webhooks#проверка-подписи), пересчитайте `X-Signature-V2` на основе распарсенного тела с секретом адреса назначения, на который была отправлена доставка (или секретом уровня приложения для доставки на устаревший URL webhook). Путь не содержит слэша на конце: с ним возвращается ошибка `404`. API-ключу с ограниченной областью действия требуются разрешения `sessions: read` и `decisions: read`.", "operationId": "get_v3_session_webhook", "x-didit-sdk": { "resource": "sessions.webhooks", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID сессии верификации, пользователя (KYC) или компании (KYB): `session_id`, возвращённый `POST /v3/session/`. Сервер сопоставляет его для обоих типов сессий.\n\n**Должен быть корректным UUID.** Маршрут сопоставляется только с корректно сформированными UUID, поэтому некорректное значение отклоняется маршрутизатором URL ещё до выполнения кода приложения, и в ответ возвращается **HTML**-страница `404`, а не конверт JSON `{\"detail\": ...}`, показанный ниже.", "schema": { "type": "string", "format": "uuid" }, "example": "22222222-3333-4444-5555-666666666666" }, { "name": "webhook_uuid", "in": "path", "required": true, "description": "UUID доставки: `uuid` записи, возвращаемой методом `GET /v3/session/{sessionId}/webhooks/`. Он должен принадлежать сессии, указанной в пути.", "schema": { "type": "string", "format": "uuid" }, "example": "66666666-7777-8888-9999-000000000001" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/session/22222222-3333-4444-5555-666666666666/webhook/66666666-7777-8888-9999-000000000001' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.webhooks.retrieve(\n \"22222222-3333-4444-5555-666666666666\",\n \"66666666-7777-8888-9999-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.webhooks.retrieve(\n \"22222222-3333-4444-5555-666666666666\",\n \"66666666-7777-8888-9999-000000000001\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Webhooks.Retrieve(ctx, \"22222222-3333-4444-5555-666666666666\", \"66666666-7777-8888-9999-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().webhooks().retrieve(\"22222222-3333-4444-5555-666666666666\", \"66666666-7777-8888-9999-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->webhooks->retrieve('22222222-3333-4444-5555-666666666666', '66666666-7777-8888-9999-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.webhooks.retrieve(\n \"22222222-3333-4444-5555-666666666666\",\n \"66666666-7777-8888-9999-000000000001\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Webhooks.RetrieveAsync(\"22222222-3333-4444-5555-666666666666\", \"66666666-7777-8888-9999-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Доставка вместе с заголовками и телом её запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionWebhookDelivery" }, "examples": { "Connection failure": { "value": { "uuid": "66666666-7777-8888-9999-000000000001", "session_id": "22222222-3333-4444-5555-666666666666", "request_url": "https://yourapp.com/webhooks/didit", "response_status": 503, "status": "In Progress", "webhook_type": "status.updated", "request_header": "{\"Content-Type\": \"application/json\", \"X-Signature\": \"a5e02a03404e1337a0198e6be15d34abbd053c658a0e51e5d0e78554213ef29b\", \"X-Signature-V2\": \"927e7cb770c94ce745939bff73f04aa200015f3bc64795ba46c2aaf78a6cedc5\", \"X-Signature-Simple\": \"e37b0d4c716c72bb5ae7127b9cc455d28ab4686e9e22312b4ec2327409a73302\", \"X-Timestamp\": \"1792056078\", \"User-Agent\": \"DiditWebhook/2.0 +https://didit.me\"}", "request_body": "{\"application_id\":\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\"created_at\":1792056057,\"environment\":\"live\",\"event_id\":\"33333333-4444-5555-6666-777777777777\",\"sandbox_scenario\":null,\"session_id\":\"22222222-3333-4444-5555-666666666666\",\"status\":\"In Progress\",\"timestamp\":1792056078,\"vendor_data\":\"user-123\",\"webhook_type\":\"status.updated\",\"workflow_id\":\"44444444-5555-6666-7777-888888888888\",\"workflow_version\":3}", "created_at": "2026-10-15T09:21:18.412345Z" } } } } } }, "401": { "description": "Срок действия API-ключа истёк: он был создан со сроком действия, который уже прошёл. Неверный или отозванный ключ также возвращает `401`; отсутствующий ключ возвращает `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Запрос не разрешён. Отсутствие `x-api-key`, а также недействительный или отозванный ключ возвращают `Authentication credentials were not provided or are invalid.` Ключ другого приложения возвращает `You do not have permission to perform this action.` Ключ с ограниченной областью действия без требуемых для этого endpoint прав возвращает сообщение с указанием недостающих разрешений, а ключ, используемый не из разрешённого списка IP-адресов, возвращает `This API key can't be used from this IP address.` Неизвестный `sessionId` возвращает `404` ещё до проверки учётных данных.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Missing or invalid key": { "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Key of another application": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without sessions read": { "value": { "detail": "This API key has no read access to sessions." } }, "Scoped key without decisions read": { "value": { "detail": "This API key has no read access to decisions." } }, "Outside the IP allowlist": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Сессия не существует или была удалена (`Not found.`, возвращается до проверки учетных данных), либо находится за пределами ограничений по сценариям или статусам для ключа с ограниченным доступом (`Session not found.`). Доставка, которая не существует, принадлежит другой сессии или больше недоступна, возвращает `No WebhookLog matches the given query.`", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Unknown session": { "value": { "detail": "Not found." } }, "Outside the key's limits": { "value": { "detail": "Session not found." } }, "Delivery not in this session": { "value": { "detail": "No WebhookLog matches the given query." } } } } } }, "429": { "description": "Лимит запросов превышен: более 600 GET-запросов в текущем минутном окне для этого API-ключа. Подождите `Retry-After` секунд перед повторной попыткой.", "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Количество разрешённых запросов в минутном окне (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Количество оставшихся запросов в текущем окне.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Unix-время (в секундах), когда текущее окно сбрасывается.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Название бюджета, который был превышен.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/webhook/{webhook_uuid}/resend": { "post": { "summary": "Повторить доставку webhook сессии", "description": "Отправьте сохранённый webhook сессии повторно на URL, на который он был отправлен изначально, с тем же payload и `event_id`, но со свежими `timestamp`, заголовком `X-Timestamp` и подписями. Didit подписывает его текущим секретом адреса назначения, к которому относится доставка (или секретом уровня приложения для доставки на устаревший webhook URL), ожидает ответа вашего endpoint до 5 секунд, фиксирует попытку как новую доставку и возвращает её со статусом `200` независимо от ответа вашего endpoint: смотрите `response_status`. Повторная отправка не выполняется повторно автоматически, и каждый вызов отправляет запрос снова, поэтому сделайте ваш endpoint идемпотентным по `event_id`. Путь не содержит завершающего слеша, а запрос не имеет тела. API-ключу с ограниченными правами требуются разрешения `webhooks: write` и `decisions: read`.", "operationId": "post_v3_session_webhook_resend", "x-didit-sdk": { "resource": "sessions.webhooks", "method": "resend", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID сессии верификации, пользователя (KYC) или компании (KYB): `session_id`, возвращённый `POST /v3/session/`. Сервер сопоставляет его для обоих типов сессий.\n\n**Должен быть корректным UUID.** Маршрут сопоставляется только с корректно сформированными UUID, поэтому некорректное значение отклоняется маршрутизатором URL ещё до выполнения кода приложения, и в ответ возвращается **HTML**-страница `404`, а не конверт JSON `{\"detail\": ...}`, показанный ниже.", "schema": { "type": "string", "format": "uuid" }, "example": "22222222-3333-4444-5555-666666666666" }, { "name": "webhook_uuid", "in": "path", "required": true, "description": "UUID доставки для повторной отправки: `uuid` записи, возвращаемой методом `GET /v3/session/{sessionId}/webhooks/`. Он должен принадлежать сессии, указанной в пути.", "schema": { "type": "string", "format": "uuid" }, "example": "66666666-7777-8888-9999-000000000001" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/session/22222222-3333-4444-5555-666666666666/webhook/66666666-7777-8888-9999-000000000001/resend' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.webhooks.resend(\n \"22222222-3333-4444-5555-666666666666\",\n \"66666666-7777-8888-9999-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.webhooks.resend(\n \"22222222-3333-4444-5555-666666666666\",\n \"66666666-7777-8888-9999-000000000001\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Webhooks.Resend(ctx, \"22222222-3333-4444-5555-666666666666\", \"66666666-7777-8888-9999-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().webhooks().resend(\"22222222-3333-4444-5555-666666666666\", \"66666666-7777-8888-9999-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->webhooks->resend('22222222-3333-4444-5555-666666666666', '66666666-7777-8888-9999-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.webhooks.resend(\n \"22222222-3333-4444-5555-666666666666\",\n \"66666666-7777-8888-9999-000000000001\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Webhooks.ResendAsync(\"22222222-3333-4444-5555-666666666666\", \"66666666-7777-8888-9999-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Новая доставка, попытка которой уже была совершена. Поле `response_status` содержит то, что ваш endpoint вернул на этот раз. Исходная доставка остается без изменений.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionWebhookDelivery" }, "examples": { "Accepted on resend": { "value": { "uuid": "66666666-7777-8888-9999-000000000004", "session_id": "22222222-3333-4444-5555-666666666666", "request_url": "https://yourapp.com/webhooks/didit", "response_status": 200, "status": "In Progress", "webhook_type": "status.updated", "request_header": "{\"Content-Type\": \"application/json\", \"X-Signature\": \"b8eb1e376517ee0cad8ba98ff7f8fd35fc72eca231000963a96a335f82328835\", \"X-Signature-V2\": \"9efd2ce9ed1303e1d05273ef9608a59363ed9789a05253db4748b3e8e50cb109\", \"X-Signature-Simple\": \"bf3a9dc04b2c20ab539203b0cd5cca2a10f630bf62d8feb6d68d82af80f64774\", \"X-Timestamp\": \"1792159542\", \"User-Agent\": \"DiditWebhook/2.0 +https://didit.me\"}", "request_body": "{\"application_id\":\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\"created_at\":1792056057,\"environment\":\"live\",\"event_id\":\"33333333-4444-5555-6666-777777777777\",\"sandbox_scenario\":null,\"session_id\":\"22222222-3333-4444-5555-666666666666\",\"status\":\"In Progress\",\"timestamp\":1792159542,\"vendor_data\":\"user-123\",\"webhook_type\":\"status.updated\",\"workflow_id\":\"44444444-5555-6666-7777-888888888888\",\"workflow_version\":3}", "created_at": "2026-10-16T14:05:42.330981Z" } } } } } }, "400": { "description": "Не удалось повторно отправить доставку. Выполните ветвление по полю `code`: `webhook_url_missing` означает, что для доставки нет записанного URL и ничего не отправлено; `webhook_resend_error` означает, что сохранённую доставку не удалось подписать повторно или попытку не удалось завершить. При `webhook_resend_error` поле `detail` начинается с `Error processing webhook resend:`, за которым следует диагностический текст, который может изменяться.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." }, "code": { "type": "string", "description": "Постоянный машиночитаемый код ошибки. Делайте ветвление по нему, а не по `detail`." } } }, "examples": { "No recorded URL": { "value": { "detail": "The webhook delivery does not have a request URL configured", "code": "webhook_url_missing" } }, "Resend failed": { "value": { "detail": "Error processing webhook resend: Invalid webhook data format", "code": "webhook_resend_error" } } } } } }, "401": { "description": "Срок действия API-ключа истёк: он был создан со сроком действия, который уже прошёл. Неверный или отозванный ключ также возвращает `401`; отсутствующий ключ возвращает `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Запрос не разрешён. Отсутствие `x-api-key`, а также недействительный или отозванный ключ возвращают `Authentication credentials were not provided or are invalid.` Ключ другого приложения возвращает `You do not have permission to perform this action.` Ключ с ограниченной областью действия без требуемых для этого endpoint прав возвращает сообщение с указанием недостающих разрешений, а ключ, используемый не из разрешённого списка IP-адресов, возвращает `This API key can't be used from this IP address.` Неизвестный `sessionId` возвращает `404` ещё до проверки учётных данных.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Missing or invalid key": { "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Key of another application": { "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without webhooks write": { "value": { "detail": "This API key has no write access to webhooks." } }, "Scoped key without decisions read": { "value": { "detail": "This API key has no read access to decisions." } }, "Outside the IP allowlist": { "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Сессия не существует или была удалена (`Not found.`, возвращается до проверки учетных данных), либо находится за пределами ограничений по сценариям или статусам для ключа с ограниченным доступом (`Session not found.`). Доставка, которая не существует, принадлежит другой сессии или больше недоступна, возвращает `Webhook log not found`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Unknown session": { "value": { "detail": "Not found." } }, "Outside the key's limits": { "value": { "detail": "Session not found." } }, "Delivery not in this session": { "value": { "detail": "Webhook log not found" } } } } } }, "429": { "description": "Лимит запросов превышен: более 300 запросов на запись (POST, PATCH, PUT, DELETE) в текущем минутном окне для этого API-ключа. Подождите `Retry-After` секунд перед повторной попыткой.", "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Количество разрешённых запросов в минутном окне (300).", "schema": { "type": "integer", "example": 300 } }, "X-RateLimit-Remaining": { "description": "Количество оставшихся запросов в текущем окне.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Unix-время (в секундах), когда текущее окно сбрасывается.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Название бюджета, который был превышен.", "schema": { "type": "string", "example": "generic-write" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Throttled": { "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/events/": { "get": { "summary": "Получить список событий сессии", "description": "Считывает временную шкалу событий одной сессии верификации, от новых к старым по `sent_at`: экраны, которые видел пользователь, кнопки и загрузки, неудачные попытки, изменения статуса и шагов функций, а также трассировку маршрутизации сценария. Работает для ID сессий Проверки пользователей (KYC) и Верификации бизнеса (KYB). События сохраняются асинхронно, поэтому появление нового события может занять несколько секунд. Результаты разбиты на страницы с помощью `limit` и `offset`; переходите по `next`, пока он не станет равен `null`. API-ключу с ограниченной областью действия требуются разрешения `sessions: read` и `decisions: read`, а без `media: read` он получает `file_url` со значением `null`. События маршрутизации описаны в разделе [Получение сессии](https://docs.didit.me/ru/sessions-api/retrieve-session).", "operationId": "get_v3_session_events", "x-didit-sdk": { "resource": "sessions", "method": "list_events", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID сессии верификации (`session_id`, возвращённый `POST /v3/session/`). Принимает ID сессий как Проверки пользователей (KYC), так и Верификации бизнеса (KYB): сервер сопоставляет ID для обоих типов сессий. Должен быть корректным UUID; некорректное значение не соответствует маршруту и возвращает HTML `404`.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "limit", "in": "query", "required": false, "description": "Максимальное количество событий на страницу. По умолчанию 50. Значение меньше 1 или нечисловое значение заменяется на 50; значение выше 1,000,000 возвращает `400`.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000, "example": 50 } }, { "name": "offset", "in": "query", "required": false, "description": "Количество результатов, пропускаемых перед первым возвращаемым. По умолчанию 0; отрицательное или нечисловое значение сбрасывается до 0, значение выше 1,000,000 возвращает `400`. Рекомендуется использовать URL `next` и `previous`.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000, "example": 0 } }, { "name": "ordering", "in": "query", "required": false, "description": "Необязательное переопределение сортировки. Порядок по умолчанию: `-sent_at`. Передайте имя поля результата (например, `sent_at`, `created_at`, `event_type`, `feature_step` или `step`) для сортировки по возрастанию, добавьте префикс `-` для сортировки по убыванию и разделяйте несколько полей запятыми. Неизвестные поля игнорируются.", "schema": { "type": "string", "example": "sent_at" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/events/?limit=50' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.sessions.list_events(\n \"11111111-2222-3333-4444-555555555555\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.sessions.listEvents(\"11111111-2222-3333-4444-555555555555\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Sessions.ListEventsAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsListEventsParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.sessions().listEvents(\"11111111-2222-3333-4444-555555555555\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "sessions->listEvents('11111111-2222-3333-4444-555555555555') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.sessions.list_events(\"11111111-2222-3333-4444-555555555555\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Sessions.ListEventsAsync(\"11111111-2222-3333-4444-555555555555\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Одна страница событий сессии, сначала новые.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "description": "Общее количество событий сессии." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL следующей страницы или `null` на последней странице." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL предыдущей страницы или `null` на первой странице." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/SessionEvent" } } } }, "examples": { "Completed session": { "value": { "count": 3, "next": null, "previous": null, "results": [ { "uuid": "aaaaaaaa-1111-2222-3333-444444444444", "event_type": "SESSION_STATUS_CHANGED", "created_at": "2026-09-14T10:02:13.904512Z", "component": null, "feature_step": null, "step": null, "details": { "old_status": "In Progress", "current_status": "Approved" }, "ip_address": null, "user_agent": null, "device_info": null, "file_url": null, "sent_at": 1789380131482 }, { "uuid": "bbbbbbbb-1111-2222-3333-444444444444", "event_type": "FEATURE_STEP_CHANGED", "created_at": "2026-09-14T10:01:49.210377Z", "component": null, "feature_step": null, "step": null, "details": { "old_feature_step": "OCR", "current_feature_step": "LIVENESS" }, "ip_address": null, "user_agent": null, "device_info": null, "file_url": null, "sent_at": 1789380107103 }, { "uuid": "cccccccc-1111-2222-3333-444444444444", "event_type": "STEP_RENDERED", "created_at": "2026-09-14T10:01:00.581930Z", "component": "DocumentCapture", "feature_step": "OCR", "step": "DOCUMENT_CAPTURE_FRONT", "details": {}, "ip_address": "203.0.113.24", "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 18_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.5 Mobile/15E148 Safari/604.1", "device_info": { "device_model": "iPhone" }, "file_url": null, "sent_at": 1789380058776 } ] } } } } } }, "400": { "description": "`limit` или `offset` превышает 1,000,000. Тело ответа представляет собой JSON-массив с одним сообщением.", "content": { "application/json": { "examples": { "Limit too large": { "summary": "limit=2000000", "value": [ "limit must not exceed 1000000." ] }, "Offset too large": { "summary": "offset=2000000", "value": [ "offset must not exceed 1000000." ] } }, "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Это единственный случай, возвращающий `401`: отсутствующий, недействительный или отозванный ключ возвращает `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Expired key": { "summary": "Срок действия ключа истёк", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Ошибка аутентификации или авторизации. Отсутствующий ключ возвращает `403`, как и ключ другого приложения, ключ с ограниченной областью действия без необходимого для этого endpoint разрешения, а также запрос не из разрешённого списка IP-адресов ключа; неверный, отозванный или истекший ключ возвращает `401`. Различайте их по полю `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Missing or invalid credentials": { "summary": "Заголовок x-api-key отсутствует, либо ключ не прошёл валидацию", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Действительный ключ, принадлежащий приложению, отличному от приложения сессии", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without sessions read": { "summary": "У ключа с ограниченной областью действия отсутствует разрешение sessions: read", "value": { "detail": "This API key has no read access to sessions." } }, "Scoped key without decisions read": { "summary": "У ключа с ограниченной областью действия отсутствует разрешение decisions: read", "value": { "detail": "This API key has no read access to decisions." } }, "IP not allowed": { "summary": "Запрос с IP-адреса вне списка разрешённых IP ключа", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Сессия не существует, была удалена или находится за пределами ограничений ключа с ограниченным доступом по сценариям или доступу только к одобренным сессиям (approved-only). Поиск сессии выполняется до проверки учетных данных, поэтому неизвестный `sessionId` возвращает `404` даже без действительного ключа.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Unknown session": { "summary": "Сессия с этим ID не существует или была удалена", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "Сессия находится за пределами ограничений ключа с ограниченным доступом по сценариям или доступу только к одобренным сессиям", "value": { "detail": "Session not found." } } } } } }, "429": { "description": "Лимит запросов превышен: 600 GET-запросов в минуту на один API-ключ. Подождите `Retry-After` секунд перед повторной попыткой; заголовки `X-RateLimit-*` показывают доступный лимит.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Rate limited": { "summary": "Бюджет на текущую минуту исчерпан", "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/aml-screening-history/": { "get": { "summary": "Получить историю AML-скрининга", "description": "Получить список всех завершённых повторных AML-скринингов в рамках постоянного AML-мониторинга для AML-проверки сессии, сначала новые по `completed_at`, включая запуски, в которых ничего не изменилось: оповещения, записи активности и webhook срабатывают только при изменении результата, поэтому эта история служит подтверждением того, что субъект без совпадений продолжал проверяться. Работает с ID сессий KYC и KYB; передайте `node_id`, если в сессии выполнялось более одного AML-шага. В списке отображаются только повторные AML-скрининги постоянного мониторинга (первичный скрининг является частью решения по сессии), а запуски, выполненные до появления этой истории, не восстанавливаются, поэтому сессия без постоянного мониторинга возвращает пустой список. Значение `count` точно до 100 и ограничено 100 при больших значениях, поэтому переходите по `next`, пока оно не станет `null`. Передайте `month`, чтобы читать данные за один календарный месяц за раз. Для API-ключа с ограниченными правами требуется разрешение `decisions: read`; см. [Постоянный AML-мониторинг](https://docs.didit.me/ru/core-technology/aml-screening/continuous-monitoring-aml-screening).", "operationId": "get_v3_session_aml_screening_history", "x-didit-sdk": { "resource": "sessions", "method": "list_aml_screening_history", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID сессии верификации (`session_id`, возвращённый `POST /v3/session/`). Принимает ID сессий как Проверки пользователей (KYC), так и Верификации бизнеса (KYB): сервер сопоставляет ID для обоих типов сессий. Должен быть корректным UUID; некорректное значение не соответствует маршруту и возвращает HTML `404`.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "node_id", "in": "query", "required": false, "description": "ID узла графа сценария для AML-проверки. Требуется, только если в сессии выполнялось более одного AML-шага; без него используется последняя по времени AML-проверка. Неизвестный узел возвращает `404`.", "schema": { "type": "string", "example": "feature_aml_1" } }, { "name": "month", "in": "query", "required": false, "description": "Календарный месяц в UTC в формате `YYYY-MM`. Возвращаются только проверки, завершённые в этом месяце; если параметр не указан, возвращаются все месяцы. Некорректный формат месяца возвращает `400`.", "schema": { "type": "string", "pattern": "^\\d{4}-(0[1-9]|1[0-2])$", "example": "2026-09" } }, { "name": "limit", "in": "query", "required": false, "description": "Максимальное количество запусков скрининга на страницу. По умолчанию 50. Значение меньше 1 или нечисловое значение заменяется на 50; значение выше 1,000,000 возвращает `400`.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000, "example": 50 } }, { "name": "offset", "in": "query", "required": false, "description": "Количество результатов, пропускаемых перед первым возвращаемым. По умолчанию 0; отрицательное или нечисловое значение сбрасывается до 0, значение выше 1,000,000 возвращает `400`. Рекомендуется использовать URL `next` и `previous`.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000, "example": 0 } }, { "name": "ordering", "in": "query", "required": false, "description": "Необязательное переопределение сортировки. Порядок по умолчанию: `-completed_at`. Передайте имя поля результата (например, `completed_at`, `started_at`, `outcome` или `score`) для сортировки по возрастанию, добавьте префикс `-` для сортировки по убыванию и разделяйте несколько полей запятыми. Неизвестные поля игнорируются.", "schema": { "type": "string", "example": "completed_at" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/aml-screening-history/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.sessions.list_aml_screening_history(\n \"11111111-2222-3333-4444-555555555555\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.sessions.listAmlScreeningHistory(\"11111111-2222-3333-4444-555555555555\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Sessions.ListAMLScreeningHistoryAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsListAMLScreeningHistoryParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.sessions().listAmlScreeningHistory(\"11111111-2222-3333-4444-555555555555\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "sessions->listAmlScreeningHistory('11111111-2222-3333-4444-555555555555') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.sessions.list_aml_screening_history(\"11111111-2222-3333-4444-555555555555\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Sessions.ListAmlScreeningHistoryAsync(\"11111111-2222-3333-4444-555555555555\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Одна страница запусков скрининга, сначала новые.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "maximum": 100, "description": "Количество запусков: точное значение до 100 и с ограничением 100 выше этого порога." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL следующей страницы или `null` на последней странице." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL предыдущей страницы или `null` на первой странице." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AMLScreeningRun" } } } }, "examples": { "Monitored subject": { "value": { "count": 2, "next": null, "previous": null, "results": [ { "uuid": "dddddddd-1111-2222-3333-444444444444", "run_id": "aaaaaaaa-1111-2222-3333-444444444444", "completed_at": "2026-09-14T04:12:33.481207Z", "started_at": "2026-09-14T04:00:01.002311Z", "outcome": "NO_CHANGE", "trigger": "ONGOING_MONITORING", "provider": "aml_data_source", "status": "Approved", "score": 0.0, "total_hits": 0, "new_hits": 0, "entities_screened": 1, "dataset_freshness": { "captured_at": "2026-09-14T03:58:02.114820+00:00", "provider": "aml_data_source", "catalog_version": "2026-09-13", "sources": { "sanctions": { "last_updated_at": "2026-09-13T21:10:00+00:00", "oldest_updated_at": "2026-09-11T06:00:00+00:00", "dataset_count": 120, "dated_dataset_count": 120 }, "pep": { "last_updated_at": "2026-09-13T08:00:00+00:00", "oldest_updated_at": null, "dataset_count": 45, "dated_dataset_count": 44 }, "warnings": { "last_updated_at": "2026-09-12T18:45:00+00:00", "oldest_updated_at": "2026-09-01T00:00:00+00:00", "dataset_count": 30, "dated_dataset_count": 30 } } } }, { "uuid": "eeeeeeee-1111-2222-3333-444444444444", "run_id": "bbbbbbbb-1111-2222-3333-444444444444", "completed_at": "2026-09-13T04:11:58.020914Z", "started_at": "2026-09-13T04:00:00.871022Z", "outcome": "FAILED", "trigger": "ONGOING_MONITORING", "provider": "aml_data_source", "status": "Approved", "score": 0.0, "total_hits": 0, "new_hits": null, "entities_screened": 0, "dataset_freshness": null } ] } } } } } }, "400": { "description": "`limit` или `offset` превышает 1,000,000 (JSON-массив с одним сообщением) либо `month` не является календарным месяцем в формате `YYYY-MM` (объект с ключом `month`).", "content": { "application/json": { "examples": { "Limit too large": { "summary": "limit=2000000", "value": [ "limit must not exceed 1000000." ] }, "Offset too large": { "summary": "offset=2000000", "value": [ "offset must not exceed 1000000." ] }, "Malformed month": { "summary": "month=2026-13", "value": { "month": [ "Not a calendar month. Use YYYY-MM." ] } } }, "schema": { "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "object", "properties": { "month": { "type": "array", "items": { "type": "string" } } } } ] } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Это единственный случай, возвращающий `401`: отсутствующий, недействительный или отозванный ключ возвращает `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Expired key": { "summary": "Срок действия ключа истёк", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Ошибка аутентификации или авторизации. Отсутствующий ключ возвращает `403`, как и ключ другого приложения, ключ с ограниченной областью действия без необходимого для этого endpoint разрешения, а также запрос не из разрешённого списка IP-адресов ключа; неверный, отозванный или истекший ключ возвращает `401`. Различайте их по полю `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Missing or invalid credentials": { "summary": "Заголовок x-api-key отсутствует, либо ключ не прошёл валидацию", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Действительный ключ, принадлежащий приложению, отличному от приложения сессии", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions read": { "summary": "У ключа с ограниченной областью действия отсутствует разрешение decisions: read", "value": { "detail": "This API key has no read access to decisions." } }, "IP not allowed": { "summary": "Запрос с IP-адреса вне списка разрешённых IP ключа", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Сессия не существует, была удалена или находится за пределами ограничений ключа с ограниченным доступом, либо не содержит AML-проверки (для указанного `node_id`). Поиск сессии выполняется до проверки учетных данных, поэтому неизвестный `sessionId` возвращает `404` даже без действительного ключа.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Unknown session": { "summary": "Сессия с этим ID не существует или была удалена", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "Сессия находится за пределами ограничений ключа с ограниченным доступом (также возвращается для сессии, удаленной только что)", "value": { "detail": "Session not found." } }, "No AML check": { "summary": "В сессии никогда не выполнялся шаг AML", "value": { "detail": "The session does not have an AML check." } }, "No AML check for node": { "summary": "node_id не соответствует AML-проверке этой сессии", "value": { "detail": "The session does not have an AML check for node 'feature_aml_2'." } } } } } }, "429": { "description": "Лимит запросов превышен: 600 GET-запросов в минуту на один API-ключ. Подождите `Retry-After` секунд перед повторной попыткой; заголовки `X-RateLimit-*` показывают доступный лимит.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Rate limited": { "summary": "Бюджет на текущую минуту исчерпан", "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/aml-screening-history/export/": { "get": { "summary": "Экспорт истории AML-скрининга в формате CSV", "description": "Скачать ту же историю постоянного мониторинга, что и при `GET /v3/session/{sessionId}/aml-screening-history/`, в виде CSV-файла: по одной строке на каждую завершённую повторную проверку, сначала новые, готовые для передачи аудитору. Файл передаётся целиком в потоковом режиме (без пагинации) и начинается со строки заголовка; пустая ячейка означает неизвестное значение, даты наборов данных никогда не оцениваются приблизительно, а перед значением, которое может начать формулу таблицы, ставится апостроф. Работает для ID сессий KYC и KYB; передайте `node_id`, если в сессии выполнялось более одного шага AML. Передайте `month` для экспорта за один календарный месяц. Ошибки возвращаются в формате JSON, а не CSV. Для API-ключа с ограниченными правами требуются `decisions: read` и `media: read`: ответ представляет собой файл, поэтому ключ без `media: read` получит `403`.", "operationId": "get_v3_session_aml_screening_history_export", "x-didit-sdk": { "resource": "sessions", "method": "export_aml_screening_history", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID сессии верификации (`session_id`, возвращённый `POST /v3/session/`). Принимает ID сессий как Проверки пользователей (KYC), так и Верификации бизнеса (KYB): сервер сопоставляет ID для обоих типов сессий. Должен быть корректным UUID; некорректное значение не соответствует маршруту и возвращает HTML `404`.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "node_id", "in": "query", "required": false, "description": "ID узла графа сценария для AML-проверки. Требуется, только если в сессии выполнялось более одного AML-шага; без него используется последняя по времени AML-проверка. Неизвестный узел возвращает `404`.", "schema": { "type": "string", "example": "feature_aml_1" } }, { "name": "month", "in": "query", "required": false, "description": "Календарный месяц в UTC в формате `YYYY-MM`. Возвращаются только проверки, завершённые в этом месяце; если параметр не указан, возвращаются все месяцы. Некорректный формат месяца возвращает `400`.", "schema": { "type": "string", "pattern": "^\\d{4}-(0[1-9]|1[0-2])$", "example": "2026-09" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/aml-screening-history/export/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -o aml-screening-history.csv" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\ncontent = client.sessions.export_aml_screening_history(\n \"11111111-2222-3333-4444-555555555555\",\n)\nwith open(\"download.csv\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst content = await didit.sessions.exportAmlScreeningHistory(\"11111111-2222-3333-4444-555555555555\");\nawait writeFile(\"download.csv\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresp, err := client.Sessions.ExportAMLScreeningHistory(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsExportAMLScreeningHistoryParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.csv\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.sessions().exportAmlScreeningHistory(\"11111111-2222-3333-4444-555555555555\")\n .writeTo(Path.of(\"download.csv\"));" }, { "lang": "php", "label": "PHP", "source": "sessions->exportAmlScreeningHistory('11111111-2222-3333-4444-555555555555');\n$content->saveTo('download.csv');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ncontent = didit.sessions.export_aml_screening_history(\"11111111-2222-3333-4444-555555555555\")\nFile.binwrite(\"download.csv\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar content = await client.Sessions.ExportAmlScreeningHistoryAsync(\"11111111-2222-3333-4444-555555555555\");\nawait content.SaveToAsync(\"download.csv\");" } ], "responses": { "200": { "description": "CSV-файл, передаваемый как `text/csv` с окончаниями строк CRLF. Столбцы по порядку: `screened_at` (когда завершился повторный скрининг), `outcome` (`NO_CHANGE`, `CHANGED` или `FAILED`), `provider` (непрозрачный идентификатор источника AML-данных; не стройте логику ветвления на его основе), `aml_status`, `aml_score`, `total_hits`, `datasets_captured_at`, `datasets_sanctions_last_updated_at`, `datasets_pep_last_updated_at`, `datasets_warnings_last_updated_at`, `datasets_adverse_media_last_updated_at`, `datasets_catalog_version`, `run_id` (запуск мониторинга), `entities_screened` (`1` или `0` для неуспешного запуска) и `new_hits` (пусто, если неизвестно). Даты указаны в формате ISO 8601 со смещением UTC. Сессия без повторных скринингов возвращает только строку заголовка.", "headers": { "Content-Disposition": { "description": "`attachment; filename=\"aml-screening-history-{sessionId}.csv\"` или `aml-screening-history-{sessionId}-{month}.csv`, если передан параметр `month`.", "schema": { "type": "string", "example": "attachment; filename=\"aml-screening-history-11111111-2222-3333-4444-555555555555.csv\"" } } }, "content": { "text/csv": { "schema": { "type": "string", "format": "binary" }, "example": "screened_at,outcome,provider,aml_status,aml_score,total_hits,datasets_captured_at,datasets_sanctions_last_updated_at,datasets_pep_last_updated_at,datasets_warnings_last_updated_at,datasets_adverse_media_last_updated_at,datasets_catalog_version,run_id,entities_screened,new_hits\r\n2026-09-14T04:12:33.481207+00:00,NO_CHANGE,aml_data_source,Approved,0.0,0,2026-09-14T03:58:02.114820+00:00,2026-09-13T21:10:00+00:00,2026-09-13T08:00:00+00:00,2026-09-12T18:45:00+00:00,,2026-09-13,aaaaaaaa-1111-2222-3333-444444444444,1,0\r\n2026-09-13T04:11:58.020914+00:00,FAILED,aml_data_source,Approved,0.0,0,,,,,,,bbbbbbbb-1111-2222-3333-444444444444,0,\r\n" } } }, "400": { "description": "`month` не является календарным месяцем в формате `YYYY-MM`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "month": { "type": "array", "items": { "type": "string" } } } }, "examples": { "Malformed month": { "summary": "month=2026-13", "value": { "month": [ "Not a calendar month. Use YYYY-MM." ] } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Это единственный случай, возвращающий `401`: отсутствующий, недействительный или отозванный ключ возвращает `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Expired key": { "summary": "Срок действия ключа истёк", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Ошибка аутентификации или авторизации. Отсутствующий ключ возвращает `403`, как и ключ другого приложения, ключ с ограниченной областью действия без необходимого для этого endpoint разрешения, а также запрос не из разрешённого списка IP-адресов ключа; неверный, отозванный или истекший ключ возвращает `401`. Различайте их по полю `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Missing or invalid credentials": { "summary": "Заголовок x-api-key отсутствует, либо ключ не прошёл валидацию", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Действительный ключ, принадлежащий приложению, отличному от приложения сессии", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions read": { "summary": "У ключа с ограниченной областью действия отсутствует разрешение decisions: read", "value": { "detail": "This API key has no read access to decisions." } }, "Scoped key without media read": { "summary": "У ключа с ограниченной областью действия отсутствует разрешение media: read (ответ представляет собой файл)", "value": { "detail": "This API key has no read access to media." } }, "IP not allowed": { "summary": "Запрос с IP-адреса вне списка разрешённых IP ключа", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Сессия не существует, была удалена или находится за пределами ограничений ключа с ограниченным доступом, либо не содержит AML-проверки (для указанного `node_id`). Поиск сессии выполняется до проверки учетных данных, поэтому неизвестный `sessionId` возвращает `404` даже без действительного ключа.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Unknown session": { "summary": "Сессия с этим ID не существует или была удалена", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "Сессия находится за пределами ограничений ключа с ограниченным доступом (также возвращается для сессии, удаленной только что)", "value": { "detail": "Session not found." } }, "No AML check": { "summary": "В сессии никогда не выполнялся шаг AML", "value": { "detail": "The session does not have an AML check." } }, "No AML check for node": { "summary": "node_id не соответствует AML-проверке этой сессии", "value": { "detail": "The session does not have an AML check for node 'feature_aml_2'." } } } } } }, "429": { "description": "Лимит запросов превышен: 600 GET-запросов в минуту на один API-ключ. Подождите `Retry-After` секунд перед повторной попыткой; заголовки `X-RateLimit-*` показывают доступный лимит.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Rate limited": { "summary": "Бюджет на текущую минуту исчерпан", "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/add-images/": { "patch": { "summary": "Добавить изображение к сессии", "description": "Прикрепить одно дополнительное изображение или PDF-файл к результату верификации личности (`model_type=kyc`) или подтверждения адреса (`model_type=poa`) завершённой сессии проверки пользователей (KYC), например подтверждающие материалы, собранные вне сценария. Сессия должна находиться в статусе `Approved`, `Declined`, `In Review` или `Kyc Expired` и содержать результат, указанный в `model_type`; сессии верификации бизнеса (KYB) не поддерживаются. Каждый вызов добавляет один файл (к самому последнему результату, если шаг выполнялся более одного раза), сохраняет существующие файлы и записывает событие `FILE_ADDED` в журнал активности сессии; загрузка не отправляет webhook и не меняет статус сессии. Файл сжимается при загрузке и возвращается в поле `extra_files` решения по сессии. Этот endpoint ограничен 10 запросами в минуту на один API-ключ. Для API-ключа с ограниченной областью видимости требуется разрешение `sessions: write`, а без разрешения `media: read` ссылки в `extra_files` возвращаются как `null`.", "operationId": "patch_v3_session_add_images", "x-didit-sdk": { "resource": "sessions", "method": "add_images", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID сессии Проверки пользователей (KYC), в которую добавляется файл (`session_id`, возвращаемый методом `POST /v3/session/`). Идентификатор сессии Верификации бизнеса (KYB) вернёт `404`.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file", "model_type" ], "properties": { "file": { "type": "string", "format": "binary", "description": "Изображение или PDF. Допустимые расширения: `jpg`, `jpeg`, `png`, `webp`, `tiff`, `pdf`. Не более 15 MB при загрузке; затем файл сжимается и отклоняется с кодом `400`, если он всё ещё превышает 2 MB (2,097,152 байт). Пустые файлы отклоняются." }, "model_type": { "type": "string", "enum": [ "kyc", "poa" ], "description": "`kyc` добавляет файл к результату верификации личности, а `poa` к результату подтверждения адреса.", "example": "kyc" }, "file_password": { "type": "string", "description": "Пароль от зашифрованного PDF-файла. Без него или при неверном пароле зашифрованный PDF возвращает `400`." } } }, "example": { "file": "(binary)", "model_type": "kyc" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/add-images/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'file=@./back-of-id.jpg' \\\n -F 'model_type=kyc'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.add_images(\n \"11111111-2222-3333-4444-555555555555\",\n file=open(\"image.jpg\", \"rb\"),\n model_type=\"kyc\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.addImages(\"11111111-2222-3333-4444-555555555555\", {\n file: await fileFromPath(\"image.jpg\"),\n model_type: \"kyc\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.AddImages(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsAddImagesParams{\n\tFile: didit.FileFromPath(\"image.jpg\"),\n\tModelType: \"kyc\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\nimport me.didit.types.SessionsAddImagesParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().addImages(\"11111111-2222-3333-4444-555555555555\", SessionsAddImagesParams.builder()\n .file(Path.of(\"image.jpg\"))\n .modelType(SessionsAddImagesParams.ModelType.of(\"kyc\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->addImages('11111111-2222-3333-4444-555555555555', [\n 'file' => File::fromPath('image.jpg'),\n 'model_type' => 'kyc',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.add_images(\n \"11111111-2222-3333-4444-555555555555\",\n file: Pathname(\"image.jpg\"),\n model_type: \"kyc\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.AddImagesAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsAddImagesParams\n{\n File = FileUpload.FromPath(\"image.jpg\"),\n ModelType = \"kyc\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Файл добавлен. Возвращает все дополнительные файлы этого результата, включая новый.", "content": { "application/json": { "schema": { "type": "object", "required": [ "extra_files" ], "properties": { "extra_files": { "type": "array", "description": "Временные предварительно подписанные ссылки на все дополнительные файлы результата, определённого параметром `model_type`, от старых к новым. Каждая ссылка имеет значение `null` для API-ключа с ограниченной областью действия без права `media: read`. Свежие ссылки можно прочитать позже из решения по сессии.", "items": { "type": "string", "format": "uri", "nullable": true } } } }, "example": { "extra_files": [ "https://media.example.com/session/11111111-2222-3333-4444-555555555555/kyc-extra-files/66666666-7777-8888-9999-000000000000.jpg?expires=1789383731&signature=abc123" ] } } } }, "400": { "description": "Ошибка валидации. Ошибки полей возвращаются в виде `{\"\": [\"\"]}`; ошибки зашифрованного PDF возвращаются в виде `{\"detail\": \"...\"}`.", "content": { "application/json": { "examples": { "Missing file": { "summary": "В форме отсутствует часть с файлом", "value": { "file": [ "No file was submitted." ] } }, "Missing model_type": { "summary": "model_type пропущен", "value": { "model_type": [ "This field is required." ] } }, "Invalid model_type": { "summary": "model_type не равен ни kyc, ни poa", "value": { "model_type": [ "\"passport\" is not a valid choice." ] } }, "File too large": { "summary": "Размер загружаемого файла превышает 15 МБ", "value": { "file": [ "File size should not exceed 15 MB" ] } }, "Too large after compression": { "summary": "Размер по-прежнему превышает 2 МБ после сжатия", "value": { "file": [ "File size is too big. Max allowed size is 2097152 bytes." ] } }, "Encrypted PDF": { "summary": "Зашифрованный PDF без file_password", "value": { "detail": "The PDF is encrypted. Please upload a decrypted PDF or a photo instead." } }, "Wrong PDF password": { "summary": "file_password не открывает PDF", "value": { "detail": "The PDF password is incorrect. Please provide the correct password." } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Это единственный случай, возвращающий `401`: отсутствующий, недействительный или отозванный ключ возвращает `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Expired key": { "summary": "Срок действия ключа истёк", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Ошибка аутентификации или авторизации. Отсутствующий ключ возвращает `403`, как и ключ другого приложения, ключ с ограниченной областью действия без необходимого для этого endpoint разрешения, а также запрос не из разрешённого списка IP-адресов ключа; неверный, отозванный или истекший ключ возвращает `401`. Различайте их по полю `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Missing or invalid credentials": { "summary": "Заголовок x-api-key отсутствует, либо ключ не прошёл валидацию", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Действительный ключ, принадлежащий приложению, отличному от приложения сессии", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without sessions write": { "summary": "У ключа с ограниченной областью действия отсутствует разрешение sessions: write", "value": { "detail": "This API key has no write access to sessions." } }, "IP not allowed": { "summary": "Запрос с IP-адреса вне списка разрешённых IP ключа", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Сессия не существует, была удалена или находится за пределами ограничений ключа с ограниченным доступом; это KYB-сессия или она не находится в статусе `Approved`, `Declined`, `In Review` или `Kyc Expired`; либо у нее нет результата для запрошенного `model_type` (проверяется до валидации файла). Поиск сессии выполняется до проверки учетных данных, поэтому неизвестный `sessionId` возвращает `404` даже без действительного ключа.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Unknown session": { "summary": "Сессия с этим ID не существует или была удалена", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "Сессия находится за пределами ограничений ключа с ограниченным доступом по сценариям или доступу только к одобренным сессиям", "value": { "detail": "Session not found." } }, "Not eligible": { "summary": "Сессия ещё не завершена, либо передан ID сессии KYB", "value": { "detail": "No Session matches the given query." } }, "No ID verification": { "summary": "model_type=kyc для сессии без верификации личности", "value": { "detail": "The session does not have KYC data." } }, "No Proof of Address": { "summary": "model_type=poa для сессии без подтверждения адреса", "value": { "detail": "The session does not have POA data." } } } } } }, "429": { "description": "Превышен лимит запросов: 10 запросов на добавление изображений в минуту на один API-ключ (отклоненные запросы также учитываются). Также действует общий лимит в 300 запросов на запись в минуту. Подождите указанное в `Retry-After` количество секунд перед повторной попыткой; заголовки `X-RateLimit-*` показывают доступный лимит.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Rate limited": { "summary": "Бюджет на текущую минуту исчерпан", "value": { "detail": "Session add-images rate limit exceeded. You can make up to 10 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } }, "503": { "$ref": "#/components/responses/DocumentProcessingBusy" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/update-aml-status/": { "patch": { "summary": "Обновить статус AML-проверки", "description": "Задайте статус проверки AML-скрининга сессии в целом (поле `status` записи `aml_screenings[]` в решении по сессии), например `Approved`, после того как ваша команда разобралась со всеми совпадениями. Работает для идентификаторов сессий KYC и KYB; передайте `node_id` (параметр запроса или поле тела), если в сессии выполнялось более одного шага AML, иначе будет обновлена последняя проверка AML. При фактическом изменении статуса регистрируется запись активности `AML_STATUS_UPDATED` и отправляется [webhook](https://docs.didit.me/ru/integration/webhooks) `data.updated`; отправка текущего статуса возвращает `200` и ничего не меняет. Статус сессии повторно не вычисляется: используйте `PATCH /v3/session/{sessionId}/update-status/` для решения по сессии и `PATCH /v3/session/{sessionId}/update-aml-hit-status/` для отдельных совпадений. Для API-ключа с ограниченными правами требуется `decisions: write`.", "operationId": "patch_v3_session_update_aml_status", "x-didit-sdk": { "resource": "sessions", "method": "update_aml_status", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID сессии верификации (`session_id`, возвращённый `POST /v3/session/`). Принимает ID сессий как Проверки пользователей (KYC), так и Верификации бизнеса (KYB): сервер сопоставляет ID для обоих типов сессий. Должен быть корректным UUID; некорректное значение не соответствует маршруту и возвращает HTML `404`.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "node_id", "in": "query", "required": false, "description": "ID узла графа сценария для обновляемой AML-проверки. Требуется, только если в сессии выполнялось более одного AML-шага. Имеет приоритет над `node_id` в теле запроса.", "schema": { "type": "string", "example": "feature_aml_1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Новый статус AML-проверки.", "example": "Approved" }, "node_id": { "type": "string", "description": "ID узла графа сценария для AML-проверки в качестве альтернативы параметру запроса.", "example": "feature_aml_1" } } }, "example": { "status": "Approved" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/update-aml-status/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"status\": \"Approved\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_aml_status(\n \"11111111-2222-3333-4444-555555555555\",\n status=\"Approved\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updateAmlStatus(\"11111111-2222-3333-4444-555555555555\", {\n status: \"Approved\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateAMLStatus(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsUpdateAMLStatusParams{\n\tStatus: \"Approved\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsUpdateAmlStatusParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updateAmlStatus(\"11111111-2222-3333-4444-555555555555\", SessionsUpdateAmlStatusParams.builder()\n .status(SessionsUpdateAmlStatusParams.Status.of(\"Approved\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updateAmlStatus('11111111-2222-3333-4444-555555555555', [\n 'status' => 'Approved',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_aml_status(\n \"11111111-2222-3333-4444-555555555555\",\n status: \"Approved\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdateAmlStatusAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsUpdateAmlStatusParams\n{\n Status = \"Approved\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Статус AML-проверки установлен (или не изменён, если он уже имел это значение).", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "status", "previous_status" ], "properties": { "message": { "type": "string", "description": "Всегда `AML status updated successfully`." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Текущий статус AML-проверки." }, "previous_status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Статус до вызова. Совпадает со `status`, если изменений не было." } } }, "example": { "message": "AML status updated successfully", "status": "Approved", "previous_status": "In Review" } } } }, "400": { "description": "Ошибка валидации: `status` отсутствует или не входит в число допустимых значений. Поиск AML-проверки выполняется в первую очередь, поэтому сессия без AML-проверки возвращает `404` даже при некорректном теле запроса.", "content": { "application/json": { "examples": { "Missing status": { "summary": "Пустое тело запроса или отсутствие статуса", "value": { "status": [ "This field is required." ] } }, "Invalid status": { "summary": "status отсутствует в перечислении enum", "value": { "status": [ "\"Cleared\" is not a valid choice." ] } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Это единственный случай, возвращающий `401`: отсутствующий, недействительный или отозванный ключ возвращает `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Expired key": { "summary": "Срок действия ключа истёк", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Ошибка аутентификации или авторизации. Отсутствующий ключ возвращает `403`, как и ключ другого приложения, ключ с ограниченной областью действия без необходимого для этого endpoint разрешения, а также запрос не из разрешённого списка IP-адресов ключа; неверный, отозванный или истекший ключ возвращает `401`. Различайте их по полю `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Missing or invalid credentials": { "summary": "Заголовок x-api-key отсутствует, либо ключ не прошёл валидацию", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Действительный ключ, принадлежащий приложению, отличному от приложения сессии", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "У ключа с ограниченной областью действия отсутствует разрешение decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Запрос с IP-адреса вне списка разрешённых IP ключа", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Сессия не существует, была удалена или находится за пределами ограничений ключа с ограниченным доступом, либо не содержит AML-проверки (для указанного `node_id`). Поиск сессии выполняется до проверки учетных данных, поэтому неизвестный `sessionId` возвращает `404` даже без действительного ключа.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Unknown session": { "summary": "Сессия с этим ID не существует или была удалена", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "Сессия находится за пределами ограничений ключа с ограниченным доступом (также возвращается для сессии, удаленной только что)", "value": { "detail": "Session not found." } }, "No AML check": { "summary": "В сессии никогда не выполнялся шаг AML", "value": { "detail": "The session does not have an AML check." } }, "No AML check for node": { "summary": "node_id не соответствует AML-проверке этой сессии", "value": { "detail": "The session does not have an AML check for node 'feature_aml_2'." } } } } } }, "429": { "description": "Превышен лимит запросов: 300 запросов на запись (POST, PATCH, DELETE) в минуту на один API-ключ. Подождите указанное в `Retry-After` количество секунд перед повторной попыткой; заголовки `X-RateLimit-*` показывают доступный лимит.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Rate limited": { "summary": "Бюджет на текущую минуту исчерпан", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/status/": { "get": { "summary": "Получить статус сервиса (публичный, без аутентификации)", "description": "Возвращает состояние каждого сервиса Didit (`operational`, `degraded` или `down`), общее состояние (наихудшее из них) и инциденты, которые происходят в данный момент или были устранены за последние 7 дней. Используйте его для виджета статуса или для проверки состояния Didit из вашей интеграции.\n\nПубличный endpoint: не отправляйте заголовок авторизации. Ответ не содержит данных организации и одинаков для всех вызывающих сторон. Ответы кэшируются на 30 секунд, поэтому выполняйте опрос не чаще одного раза в 30 секунд.", "operationId": "get_v3_status", "tags": [ "Status" ], "security": [ {} ], "parameters": [], "responses": { "200": { "description": "Текущий статус сервиса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceStatusFeed" }, "examples": { "One service degraded": { "summary": "Текущий инцидент и один инцидент, решённый на этой неделе", "value": { "status": "degraded", "updated_at": "2026-10-13T09:41:07.512345Z", "services": [ { "key": "service_id_verification", "name": "ID verification", "status": "operational" }, { "key": "service_liveness_face_match", "name": "Liveness and face match", "status": "operational" }, { "key": "service_aml_screening", "name": "AML screening", "status": "operational" }, { "key": "service_kyb_registries", "name": "KYB registries", "status": "operational" }, { "key": "service_database_validation", "name": "Database validation", "status": "degraded" }, { "key": "service_phone_delivery", "name": "Phone verification delivery", "status": "operational" }, { "key": "service_email_delivery", "name": "Email verification delivery", "status": "operational" }, { "key": "service_transaction_monitoring", "name": "Transaction monitoring", "status": "operational" } ], "incidents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "service": "service_database_validation", "service_name": "Database validation", "state": "degraded", "status": "ongoing", "title": "Database validation is degraded in Brazil.", "body": "Checks against Brazil (CPF) may be slow or fail since 08:55 UTC.", "affected": "Brazil (CPF)", "country_name": "Brazil", "started_at": "2026-10-13T08:55:00Z", "resolved_at": null, "duration_minutes": null }, { "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "service": "service_aml_screening", "service_name": "AML screening", "state": "down", "status": "resolved", "title": "AML screening is back to normal.", "body": "Recovered at 14:32 UTC after 17 minutes.", "affected": "", "country_name": "", "started_at": "2026-10-11T14:15:00Z", "resolved_at": "2026-10-11T14:32:00Z", "duration_minutes": 17 } ] } }, "All operational": { "summary": "Нет инцидентов за последние 7 дней", "value": { "status": "operational", "updated_at": "2026-10-13T09:41:07.512345Z", "services": [ { "key": "service_id_verification", "name": "ID verification", "status": "operational" }, { "key": "service_liveness_face_match", "name": "Liveness and face match", "status": "operational" }, { "key": "service_aml_screening", "name": "AML screening", "status": "operational" }, { "key": "service_kyb_registries", "name": "KYB registries", "status": "operational" }, { "key": "service_database_validation", "name": "Database validation", "status": "operational" }, { "key": "service_phone_delivery", "name": "Phone verification delivery", "status": "operational" }, { "key": "service_email_delivery", "name": "Email verification delivery", "status": "operational" }, { "key": "service_transaction_monitoring", "name": "Transaction monitoring", "status": "operational" } ], "incidents": [] } } } } } }, "429": { "description": "Более 600 GET-запросов за минуту с одного IP-адреса (или одного API-ключа, если вы его передаёте). Соблюдайте значение `Retry-After` перед повторной попыткой.", "content": { "application/json": { "schema": { "type": "object", "required": [ "detail" ], "properties": { "detail": { "type": "string" } } }, "example": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -fsS https://verification.didit.me/v3/status/" }, { "lang": "python", "label": "Python", "source": "import requests\n\nresp = requests.get('https://verification.didit.me/v3/status/', timeout=5)\nresp.raise_for_status()\nfeed = resp.json()\nprint(feed['status'])\nfor service in feed['services']:\n if service['status'] != 'operational':\n print(service['key'], service['status'])" }, { "lang": "javascript", "label": "JavaScript", "source": "const feed = await fetch('https://verification.didit.me/v3/status/').then((r) => r.json());\nconsole.log(feed.status);\nconst affected = feed.services.filter((s) => s.status !== 'operational');\nconsole.log(affected.map((s) => `${s.key}: ${s.status}`));" } ], "x-didit-sdk": { "resource": "system", "method": "retrieve_status", "auth": "public", "server": false } } }, "/v3/organization/bank-verification-pricing/": { "get": { "summary": "Получить цены на банковскую верификацию (публичные, без аутентификации)", "description": "Возвращает базовую цену каждого метода верификации банка (Bank Verification) во всех странах: вход через банк с дополнениями для проверки баланса и транзакций, а также проверка счёта. Метод, который в настоящее время недоступен в стране, отображается как недоступный, без указания цены. Используйте его, чтобы оценить стоимость банковского шага перед созданием сценария или отображать цены на банковские услуги в собственном продукте.\n\nПубличный endpoint: не отправляйте заголовок авторизации. Ответ не содержит данных организации и одинаков для всех вызывающих сторон. Он публично кэшируется на один час и содержит `ETag`, поэтому отправляйте `If-None-Match`, чтобы получить `304 Not Modified`, если ничего не изменилось.\n\nМетод имеет статус `available` только там, где Didit сейчас предоставляет его в продакшене, а его `price_usd` равен `null` во всех остальных случаях, поэтому лента никогда не показывает цену, которую нельзя приобрести. Значение `available: false` распространяется на страны без утверждённой цены, методы, которые страна не поддерживает, и маршруты, которые ещё не включены.\n\nЭто базовые цены без учёта скидки по вашему тарифу. Скидка по вашему тарифу применяется ко всей стоимости банковских услуг, а договорная или контрактная цена заменяет базовую цену для вашей организации.", "operationId": "get_v3_bank_verification_pricing", "tags": [ "Pricing" ], "security": [ {} ], "parameters": [], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -fsS https://verification.didit.me/v3/organization/bank-verification-pricing/" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# This call needs no API key.\nclient = Didit()\n\nresult = client.pricing.bank_verification()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// This call needs no API key.\nconst didit = new Didit();\n\nconst result = await didit.pricing.bankVerification();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// This call needs no API key.\nclient := didit.NewClient()\n\nresult, err := client.Pricing.BankVerification(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// This call needs no API key.\nDidit client = new Didit();\n\nvar result = client.pricing().bankVerification();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "pricing->bankVerification();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# This call needs no API key.\ndidit = Didit::Client.new\n\nresult = didit.pricing.bank_verification\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// This call needs no API key.\nusing var client = new DiditClient();\n\nvar result = await client.Pricing.BankVerificationAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-sdk": { "resource": "pricing", "method": "bank_verification", "auth": "none", "server": true }, "responses": { "200": { "description": "Цены из тарифной таблицы на верификацию банковских счетов по странам.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankVerificationPricing" }, "examples": { "Two countries": { "summary": "Одна страна с обоими методами, одна ни с одним", "value": { "currency": "USD", "statement_upload": { "price_usd": "0.0000", "included_after_charged_bank_attempt": true, "standalone_available": false }, "own_provider_fee_usd": "0.0200", "countries": { "GBR": { "name": "United Kingdom", "methods": { "open_banking": { "available": true, "market": "UK and EEA", "price_usd": "0.7900", "add_ons": { "balance": "0.3500", "transactions": "1.3000" } }, "account_lookup": { "available": true, "price_usd": "0.4000" } } }, "CAN": { "name": "Canada", "methods": { "open_banking": { "available": false, "market": null, "price_usd": null, "add_ons": {} }, "account_lookup": { "available": false, "price_usd": null } } } } } } } } } }, "304": { "description": "Не модифицировано: значение `ETag`, переданное в `If-None-Match`, всё ещё совпадает. Тело ответа отсутствует." } } } }, "/v3/session/{sessionId}/simulate/": { "post": { "summary": "Симулировать статус сессии в песочнице", "description": "Принудительно установить финальный статус для сессии в песочнице постфактум из вашего бэкенда, не запуская сценарий. Только для приложений в песочнице: сессия в продакшн-среде возвращает `404`. Работает для сессий Проверки пользователей (KYC) и Верификации бизнеса (KYB).\n\nЗадайте `new_status` или позвольте параметрам `scenario` или `risk` передать его. `risk` (или первый риск, содержащийся в магических значениях сценария) добавляет это предупреждение к сессии. Изменение фиксируется в активности сессии.\n\nПараметр `send_webhooks` (по умолчанию `true`) отправляет ровно те webhook, которые отправляет реальное изменение статуса. При `false` статус по-прежнему меняется и консоль обновляется в реальном времени, но webhook не логируется и не отправляется, механизм восстановления пропущенных webhook никогда не отправляет это решение повторно, а следующее изменение статуса отправляет webhook в обычном режиме. Ответ возвращает применённое значение.\n\nТребуется право `write:sessions`; API-ключу с ограниченными правами необходим доступ на запись к сессиям. Неизвестный `session_id` возвращает `404`, а сессия другого приложения возвращает `403`, в обоих случаях до чтения тела запроса; сессия в продакшн-среде возвращает `404` только после валидации тела запроса. Чтобы симулировать процесс из размещённого сценария с собственным token сессии, используйте `POST /v3/session/{sessionId}/sandbox/simulate/`. Каталог сценариев см. в разделе [Песочница и тестовые данные](/ru/integration/sandbox-testing).", "operationId": "post_v3_session_simulate", "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID сессии верификации в песочнице. Принимает ID сессий как пользователей (KYC), так и компаний (KYB).", "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxSimulateRequest" }, "examples": { "Scenario Without Webhooks": { "summary": "Отклонить через сценарий без отправки webhook", "value": { "scenario": "decline_aml_hit", "send_webhooks": false } }, "Status Only": { "summary": "Одобрить и отправить обычные события webhook", "value": { "new_status": "Approved" } } } } } }, "responses": { "200": { "description": "Статус изменился.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxSimulateResponse" }, "examples": { "Simulated": { "summary": "Отклонена через сценарий, webhook не отправляются", "value": { "session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "previous_status": "In Progress", "status": "Declined", "scenario": "decline_aml_hit", "risk": "POSSIBLE_MATCH_FOUND", "send_webhooks": false } } } } } }, "400": { "description": "Ошибка валидации: неизвестный сценарий или риск, отсутствует `new_status`, когда ни `scenario`, ни `risk` не задают его, статус, который этот endpoint не устанавливает, или сессия уже имеет запрошенный статус (простой массив JSON).", "content": { "application/json": { "examples": { "Unknown Scenario": { "summary": "scenario отсутствует в каталоге", "value": { "scenario": [ "Unknown sandbox scenario: 'not-a-scenario'." ] } }, "Unknown Risk": { "summary": "risk отсутствует в каталоге", "value": { "risk": [ "Unknown sandbox risk case: 'NOT_A_RISK'." ] } }, "Missing new_status": { "summary": "Нет new_status, сценария или риска", "value": { "new_status": [ "This field is required." ] } }, "Invalid new_status": { "summary": "Статус, который симуляция не устанавливает", "value": { "new_status": [ "\"Resubmitted\" is not a valid choice." ] } }, "Same Status": { "summary": "Сессия уже имеет этот статус", "value": [ "The new status is the same as the current status." ] } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "API-ключ с ограниченной областью действия с истёкшим сроком действия", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Отсутствуют учетные данные, у вызывающей стороны нет привилегии `write:sessions`, у API-ключа с ограниченной областью видимости нет необходимого для этого endpoint доступа, либо передан `session_id`, принадлежащий другому приложению.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Отсутствует или недействителен x-api-key", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "У вызывающей стороны отсутствует разрешение write:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "API-ключ с ограниченной областью действия без данного доступа", "value": { "detail": "This API key has no write access to sessions." } } } } } }, "404": { "description": "Сессия с указанным `session_id` не существует, либо это сессия из продакшн-среды (не песочница).", "content": { "application/json": { "examples": { "Not Found": { "summary": "Неизвестная сессия или сессия в продакшн-среде", "value": { "detail": "Not found." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST \\\n https://verification.didit.me/v3/session/3fa85f64-5717-4562-b3fc-2c963f66afa6/simulate/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"scenario\": \"decline_aml_hit\", \"send_webhooks\": false}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.simulate(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n scenario=\"decline_aml_hit\",\n send_webhooks=False,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.simulate(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", {\n scenario: \"decline_aml_hit\",\n send_webhooks: false,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Simulate(ctx, \"3fa85f64-5717-4562-b3fc-2c963f66afa6\", didit.SandboxSimulateRequest{\n\tScenario: didit.String(\"decline_aml_hit\"),\n\tSendWebhooks: didit.Bool(false),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SandboxSimulateRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().simulate(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", SandboxSimulateRequest.builder()\n .scenario(\"decline_aml_hit\")\n .sendWebhooks(false)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->simulate('3fa85f64-5717-4562-b3fc-2c963f66afa6', [\n 'scenario' => 'decline_aml_hit',\n 'send_webhooks' => false,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.simulate(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n scenario: \"decline_aml_hit\",\n send_webhooks: false\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.SimulateAsync(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", new SandboxSimulateRequest\n{\n Scenario = \"decline_aml_hit\",\n SendWebhooks = false,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-sdk": { "resource": "sessions", "method": "simulate", "auth": "api_key", "server": true } } }, "/v3/session/{sessionId}/sandbox/simulate/": { "post": { "summary": "Симулировать статус сессии в песочнице на стороне клиента", "description": "Та же симуляция, что и в `POST /v3/session/{sessionId}/simulate/`, аутентифицированная собственным заголовком `Session-Token` сессии (возвращается в поле `session_token` методом [Create Session](/ru/sessions-api/create-session)) вместо вашего API-ключа, что позволяет тестовому стенду или размещённому сценарию вызывать её на стороне клиента. Тело запроса, ответ и параметр `send_webhooks` работают точно так же, как и на указанном endpoint.\n\nЗаголовок `Session-Token` для приложения в продакшн-среде (не в песочнице) или токен, не совпадающий с `sessionId` в пути, возвращает `404`. См. [Sandbox & Test Data](/ru/integration/sandbox-testing).", "operationId": "post_v3_session_sandbox_simulate", "tags": [ "Sessions" ], "security": [ { "SessionTokenAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID сессии верификации в песочнице. Должен совпадать с сессией, закодированной в Session-Token, используемом для аутентификации.", "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxSimulateRequest" }, "examples": { "Scenario Without Webhooks": { "summary": "Отклонить через сценарий без отправки webhook", "value": { "scenario": "decline_aml_hit", "send_webhooks": false } }, "Status Only": { "summary": "Одобрить и отправить обычные события webhook", "value": { "new_status": "Approved" } } } } } }, "responses": { "200": { "description": "Статус изменился.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxSimulateResponse" }, "examples": { "Simulated": { "summary": "Отклонена через сценарий, webhook не отправляются", "value": { "session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "previous_status": "In Progress", "status": "Declined", "scenario": "decline_aml_hit", "risk": "POSSIBLE_MATCH_FOUND", "send_webhooks": false } } } } } }, "400": { "description": "Ошибка валидации: неизвестный сценарий или риск, отсутствует `new_status`, когда ни `scenario`, ни `risk` не задают его, статус, который этот endpoint не устанавливает, или сессия уже имеет запрошенный статус (простой массив JSON).", "content": { "application/json": { "examples": { "Unknown Scenario": { "summary": "scenario отсутствует в каталоге", "value": { "scenario": [ "Unknown sandbox scenario: 'not-a-scenario'." ] } }, "Unknown Risk": { "summary": "risk отсутствует в каталоге", "value": { "risk": [ "Unknown sandbox risk case: 'NOT_A_RISK'." ] } }, "Missing new_status": { "summary": "Нет new_status, сценария или риска", "value": { "new_status": [ "This field is required." ] } }, "Invalid new_status": { "summary": "Статус, который симуляция не устанавливает", "value": { "new_status": [ "\"Resubmitted\" is not a valid choice." ] } }, "Same Status": { "summary": "Сессия уже имеет этот статус", "value": [ "The new status is the same as the current status." ] } } } } }, "403": { "description": "Заголовок `Session-Token` отсутствует или недействителен.", "content": { "application/json": { "examples": { "Invalid Session Token": { "summary": "Отсутствует или недействителен Session-Token", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "`Session-Token` принадлежит продакшн-приложению (не песочнице) или не совпадает с `sessionId` в пути.", "content": { "application/json": { "examples": { "Not Found": { "summary": "Активная сессия или несоответствие session_id / токена", "value": { "detail": "Not found." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST \\\n https://verification.didit.me/v3/session/3fa85f64-5717-4562-b3fc-2c963f66afa6/sandbox/simulate/ \\\n -H 'Session-Token: YOUR_SESSION_TOKEN' \\\n -H 'Content-Type: application/json' \\\n -d '{\"new_status\": \"Approved\", \"send_webhooks\": false}'" }, { "lang": "python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://verification.didit.me/v3/session/3fa85f64-5717-4562-b3fc-2c963f66afa6/sandbox/simulate/\",\n headers={\"Session-Token\": \"YOUR_SESSION_TOKEN\"},\n json={\"new_status\": \"Approved\", \"send_webhooks\": False},\n)\nresponse.raise_for_status()\nprint(response.json())" } ], "x-didit-sdk": { "resource": "sessions", "method": "simulate_sandbox", "auth": "device_token", "server": false } } }, "/v3/session/{sessionId}/features/overrides/": { "get": { "summary": "Получить список переопределений проверок сессии", "description": "Каждое переопределение статуса отдельной функции (шага) в сессии проверки пользователей (KYC) или верификации бизнеса (KYB), начиная с самых новых и без пагинации: применённые, ожидающие завершения сценария пользователем (`pending_until_flow_finishes`) и отменённые, каждое с указанием инициатора, причины и того, было ли оно применено, пока пользователь ещё находился в сценарии (`forced`).\n\nПоле `person_in_flow` указывает, будет ли новое переопределение с параметром `defer_until_flow_finishes: true` ожидать. Поле `flow_finished_at` фиксирует время, когда пользователь в последний раз завершил сценарий; оно равно `null`, пока он всё ещё проходит его (включая повторную отправку) и если сессия была закрыта до завершения.\n\nТребуется право `read:sessions`; API-ключ с ограниченной областью действия требует доступа для чтения решений.", "operationId": "get_v3_session_feature_overrides", "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID сессии верификации. Принимает ID сессий как пользователей (KYC), так и компаний (KYB).", "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } ], "responses": { "200": { "description": "Переопределения проверок сессии, сначала новые.", "content": { "application/json": { "schema": { "type": "object", "required": [ "session_id", "person_in_flow", "flow_finished_at", "overrides" ], "properties": { "session_id": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "person_in_flow": { "type": "boolean", "description": "Находится ли человек всё ещё в процессе прохождения, так что новое переопределение с `defer_until_flow_finishes: true` будет ожидать.", "example": true }, "flow_finished_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Время последнего завершения сценария пользователем. `null`, пока он всё ещё проходит его (включая повторную отправку), а также если сессия закрылась до завершения (прервана, истекла или решение было принято посреди сценария).", "example": null }, "overrides": { "type": "array", "description": "Каждое переопределение сессии, начиная с самых новых.", "items": { "$ref": "#/components/schemas/FeatureStatusOverride" } } } }, "examples": { "Overrides": { "summary": "Одно переопределение ожидает, одно применено", "value": { "session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "person_in_flow": true, "flow_finished_at": null, "overrides": [ { "id": "9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3", "node_id": "feature_liveness_1", "feature_type": "", "feature_model": "Face", "previous_status": "Declined", "new_status": "Approved", "state": "pending_until_flow_finishes", "forced": false, "reason": "Liveness retried with a reviewer present.", "requested_by": { "email": "reviewer@example.com", "name": "Alex Reviewer", "type": "CONSOLE_USER" }, "requested_at": "2026-10-13T09:15:00Z", "applied_at": null, "cancelled_at": null, "cancel_reason": null }, { "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "node_id": "feature_ocr_1", "feature_type": "", "feature_model": "KYC", "previous_status": "In Review", "new_status": "Approved", "state": "applied", "forced": true, "reason": "Document manually verified by compliance.", "requested_by": { "email": "reviewer@example.com", "name": "Alex Reviewer", "type": "CONSOLE_USER" }, "requested_at": "2026-10-13T09:15:00Z", "applied_at": "2026-10-13T09:15:00Z", "cancelled_at": null, "cancel_reason": null } ] } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "API-ключ с ограниченной областью действия с истёкшим сроком действия", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Отсутствуют учетные данные, у вызывающей стороны нет привилегии `read:sessions`, у API-ключа с ограниченной областью видимости нет необходимого для этого endpoint доступа, либо передан `session_id`, принадлежащий другому приложению.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Отсутствует или недействителен x-api-key", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "У вызывающей стороны отсутствует разрешение read:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "API-ключ с ограниченной областью действия без данного доступа", "value": { "detail": "This API key has no read access to decisions." } } } } } }, "404": { "description": "Сессия KYC или KYB с таким `session_id` не существует.", "content": { "application/json": { "examples": { "Not Found": { "summary": "Неизвестный session_id", "value": { "detail": "Not found." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET \\\n https://verification.didit.me/v3/session/3fa85f64-5717-4562-b3fc-2c963f66afa6/features/overrides/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.list_feature_overrides(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.listFeatureOverrides(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.ListFeatureOverrides(ctx, \"3fa85f64-5717-4562-b3fc-2c963f66afa6\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().listFeatureOverrides(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->listFeatureOverrides('3fa85f64-5717-4562-b3fc-2c963f66afa6');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.list_feature_overrides(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.ListFeatureOverridesAsync(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-sdk": { "resource": "sessions", "method": "list_feature_overrides", "auth": "api_key", "server": true } } }, "/v3/session/{sessionId}/features/overrides/{overrideId}/cancel/": { "post": { "summary": "Отменить переопределение проверки, ожидающее завершения сценария", "description": "Отменить переопределение статуса функции (шага), которое всё ещё находится в состоянии `pending_until_flow_finishes`, чтобы оно не применилось. Проверка сохраняет свой статус, отмена фиксируется в журнале активности сессии как `FEATURE_OVERRIDE_CANCELLED`, а webhook не отправляется. В ответе возвращается переопределение со значениями `state: cancelled` и `cancel_reason: cancelled_by_reviewer`.\n\nПереопределение, которое уже применилось или было отменено, возвращает `409` с кодом `feature_override_not_pending`. Получить идентификаторы переопределений можно с помощью `GET /v3/session/{sessionId}/features/overrides/` или в объекте `override`, возвращаемом при обновлении статуса функции.\n\nТребуется разрешение `write:sessions`; API-ключу с ограниченной областью видимости необходим доступ на запись к решениям.", "operationId": "post_v3_session_feature_override_cancel", "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID сессии верификации. Принимает ID сессий как пользователей (KYC), так и компаний (KYB).", "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, { "in": "path", "name": "overrideId", "required": true, "description": "`id` переопределения, которое необходимо отменить.", "schema": { "type": "string", "format": "uuid", "example": "9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3" } } ], "responses": { "200": { "description": "Переопределение отменено и больше никогда не применится.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureStatusOverride" }, "examples": { "Cancelled": { "summary": "Отменённое переопределение", "value": { "id": "9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3", "node_id": "feature_liveness_1", "feature_type": "", "feature_model": "Face", "previous_status": "Declined", "new_status": "Approved", "state": "cancelled", "forced": false, "reason": "Liveness retried with a reviewer present.", "requested_by": { "email": "reviewer@example.com", "name": "Alex Reviewer", "type": "CONSOLE_USER" }, "requested_at": "2026-10-13T09:15:00Z", "applied_at": null, "cancelled_at": "2026-10-13T09:20:00Z", "cancel_reason": "cancelled_by_reviewer" } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "API-ключ с ограниченной областью действия с истёкшим сроком действия", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Отсутствуют учетные данные, у вызывающей стороны нет привилегии `write:sessions`, у API-ключа с ограниченной областью видимости нет необходимого для этого endpoint доступа, либо передан `session_id`, принадлежащий другому приложению.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Отсутствует или недействителен x-api-key", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "У вызывающей стороны отсутствует разрешение write:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "API-ключ с ограниченной областью действия без данного доступа", "value": { "detail": "This API key has no write access to decisions." } } } } } }, "404": { "description": "Сессия KYC или KYB с таким `session_id` не существует, либо у сессии нет переопределения с таким `overrideId`.", "content": { "application/json": { "examples": { "Not Found": { "summary": "Неизвестный session_id", "value": { "detail": "Not found." } }, "Override Not Found": { "summary": "В сессии нет переопределения с таким id", "value": { "detail": "Override not found." } } } } } }, "409": { "description": "Переопределение уже применилось или было отменено.", "content": { "application/json": { "examples": { "Not Pending": { "summary": "Отменить можно только ожидающее переопределение", "value": { "detail": "This override is no longer pending: it already applied or was cancelled.", "code": "feature_override_not_pending" } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST \\\n https://verification.didit.me/v3/session/3fa85f64-5717-4562-b3fc-2c963f66afa6/features/overrides/9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3/cancel/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.cancel_feature_override(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.cancelFeatureOverride(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.CancelFeatureOverride(ctx, \"3fa85f64-5717-4562-b3fc-2c963f66afa6\", \"9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().cancelFeatureOverride(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", \"9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->cancelFeatureOverride('3fa85f64-5717-4562-b3fc-2c963f66afa6', '9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.cancel_feature_override(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.CancelFeatureOverrideAsync(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", \"9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-sdk": { "resource": "sessions", "method": "cancel_feature_override", "auth": "api_key", "server": true } } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/tags/add/": { "post": { "summary": "Добавить тег к сети", "description": "Присвоить один из тегов вашего приложения сети. Возвращает подробные сведения о сети, где поле `tags` перечисляет теги вашего приложения в сети: с кодом `201`, если тег был добавлен, и `200`, если он уже был присвоен сети. Тег, принадлежащий другому приложению или несуществующий, возвращает ошибку 404 `Tag not found.`. Требуется API-ключ с полным доступом или разрешение `write:networks` для участника консоли.", "operationId": "add_network_tag", "tags": [ "Networks" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "description": "UUID сети." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkTagRequest" }, "example": { "tag_uuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/3fa85f64-5717-4562-b3fc-2c963f66afa6/tags/add/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"tag_uuid\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.networks.add_tag(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n tag_uuid=\"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.networks.addTag(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", {\n tag_uuid: \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Networks.AddTag(ctx, \"3fa85f64-5717-4562-b3fc-2c963f66afa6\", didit.NetworkTagRequest{\n\tTagUUID: \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.NetworkTagRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.networks().addTag(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", NetworkTagRequest.builder()\n .tagUuid(\"7c9e6679-7425-40de-944b-e07fc1f90ae7\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "networks->addTag('3fa85f64-5717-4562-b3fc-2c963f66afa6', [\n 'tag_uuid' => '7c9e6679-7425-40de-944b-e07fc1f90ae7',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.networks.add_tag(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n tag_uuid: \"7c9e6679-7425-40de-944b-e07fc1f90ae7\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Networks.AddTagAsync(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", new NetworkTagRequest\n{\n TagUuid = \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Тег был добавлен. Возвращает подробную информацию о сети.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkDetailResponse" }, "example": { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "network_id": "N-0042", "name": null, "status": "in_review", "risk": { "score": 82, "band": "high", "bar": 0.82 }, "pattern_types": [ "exact_same_device", "same_email" ], "signal_types": [ "device", "email" ], "member_counts": { "total": 3, "users": 3, "businesses": 0, "transaction_parties": 0 }, "member_status": { "approved": 1, "declined": 1, "in_review": 0, "not_completed": 1 }, "signal_coverage": { "device": { "signals": 1, "subjects": 3, "coverage": 1.0 }, "email": { "signals": 1, "subjects": 2, "coverage": 0.6667 } }, "first_activity_at": "2026-10-01T09:12:44Z", "last_activity_at": "2026-10-12T16:03:10Z", "stats": { "members": { "total": 3, "users": 3, "businesses": 0, "transaction_parties": 0 }, "member_status": { "approved": 1, "declined": 1, "in_review": 0, "not_completed": 1 }, "signals": { "total": 2, "by_type": { "device": { "signals": 1, "subjects": 3, "coverage": 1.0 }, "email": { "signals": 1, "subjects": 2, "coverage": 0.6667 } } } }, "fraud_tags": [], "risk_signals": { "residential_proxy_reuse": { "detected": false, "signal_count": 0, "max_subject_count": 0 }, "email_intelligence": { "enriched_signal_count": 1, "high_risk_count": 0, "social_profile_count": 0 }, "phone_intelligence": { "enriched_signal_count": 0, "high_risk_count": 0 } }, "reviewed_at": "2026-10-12T16:30:00Z", "reviewed_by": "reviewer@example.com", "review_reason": "Shared device across three new accounts.", "notes_count": 0, "sharing_mode": "global", "cross_org_available": true, "cross_org_unavailable_reason": null, "tags": [ { "uuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "name": "SUSPICIOUS", "color": "#6366F1", "source": "custom", "added_by": null, "added_at": "2026-10-13T08:15:00Z" } ], "outcomes": { "approved": 1, "declined": 1, "in_review": 0, "total": 3 }, "patterns": [ { "type": "background", "score": 0.8125, "members": 3, "reason": null, "computed_at": "2026-10-13T08:00:00Z" } ] } } } }, "200": { "description": "Тег уже был в сети и оставлен без изменений. Возвращает подробную информацию о сети.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkDetailResponse" }, "example": { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "network_id": "N-0042", "name": null, "status": "in_review", "risk": { "score": 82, "band": "high", "bar": 0.82 }, "pattern_types": [ "exact_same_device", "same_email" ], "signal_types": [ "device", "email" ], "member_counts": { "total": 3, "users": 3, "businesses": 0, "transaction_parties": 0 }, "member_status": { "approved": 1, "declined": 1, "in_review": 0, "not_completed": 1 }, "signal_coverage": { "device": { "signals": 1, "subjects": 3, "coverage": 1.0 }, "email": { "signals": 1, "subjects": 2, "coverage": 0.6667 } }, "first_activity_at": "2026-10-01T09:12:44Z", "last_activity_at": "2026-10-12T16:03:10Z", "stats": { "members": { "total": 3, "users": 3, "businesses": 0, "transaction_parties": 0 }, "member_status": { "approved": 1, "declined": 1, "in_review": 0, "not_completed": 1 }, "signals": { "total": 2, "by_type": { "device": { "signals": 1, "subjects": 3, "coverage": 1.0 }, "email": { "signals": 1, "subjects": 2, "coverage": 0.6667 } } } }, "fraud_tags": [], "risk_signals": { "residential_proxy_reuse": { "detected": false, "signal_count": 0, "max_subject_count": 0 }, "email_intelligence": { "enriched_signal_count": 1, "high_risk_count": 0, "social_profile_count": 0 }, "phone_intelligence": { "enriched_signal_count": 0, "high_risk_count": 0 } }, "reviewed_at": "2026-10-12T16:30:00Z", "reviewed_by": "reviewer@example.com", "review_reason": "Shared device across three new accounts.", "notes_count": 0, "sharing_mode": "global", "cross_org_available": true, "cross_org_unavailable_reason": null, "tags": [ { "uuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "name": "SUSPICIOUS", "color": "#6366F1", "source": "custom", "added_by": null, "added_at": "2026-10-13T08:15:00Z" } ], "outcomes": { "approved": 1, "declined": 1, "in_review": 0, "total": 3 }, "patterns": [ { "type": "background", "score": 0.8125, "members": 3, "reason": null, "computed_at": "2026-10-13T08:00:00Z" } ] } } } }, "400": { "description": "Недопустимое тело запроса: `tag_uuid` отсутствует или не является UUID.", "content": { "application/json": { "schema": { "type": "object", "properties": { "tag_uuid": { "type": "array", "items": { "type": "string" } } } }, "examples": { "Missing tag_uuid": { "summary": "Отсутствует tag_uuid", "value": { "tag_uuid": [ "This field is required." ] } }, "Invalid tag_uuid": { "summary": "Недопустимый tag_uuid", "value": { "tag_uuid": [ "Must be a valid UUID." ] } } } } } }, "401": { "description": "Отсутствуют или недействительны учетные данные.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Присутствует при ошибках с кодом, например `networks_not_entitled`." } } }, "examples": { "Missing or invalid credentials": { "summary": "Отсутствуют или недействительны учетные данные", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "403": { "description": "API-ключ принадлежит другому приложению или имеет ограниченный доступ: для endpoint’ов раздела Networks требуется ключ с полным доступом. Для токена участника консоли требуется `write:networks`. Также возвращается с `code: networks_not_entitled`, если Networks не включен для организации.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Присутствует при ошибках с кодом, например `networks_not_entitled`." } } }, "examples": { "Networks not enabled": { "summary": "Сети не включены", "value": { "detail": "Networks is disabled for this organization. Contact Didit support if you believe this is an error.", "code": "networks_not_entitled" } }, "Restricted API key": { "summary": "Ограниченный API-ключ", "value": { "detail": "This API key has no access to this endpoint." } }, "No permission": { "summary": "Нет разрешения", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Не найдено.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Присутствует при ошибках с кодом, например `networks_not_entitled`." } } }, "examples": { "Network not found": { "summary": "Сеть не найдена", "value": { "detail": "Network not found." } }, "Tag not found": { "summary": "Тег не найден", "value": { "detail": "Tag not found." } } } } } } }, "x-didit-sdk": { "resource": "networks", "method": "add_tag", "auth": "api_key", "server": true, "scope": "application" } } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/tags/remove/": { "post": { "summary": "Удалить тег из сети", "description": "Удалить один из тегов вашего приложения из сети. Возвращает подробные сведения о сети. 404, если тег отсутствует в сети или не принадлежит вашему приложению. Требуется API-ключ с полным доступом или разрешение `write:networks` для участника консоли.", "operationId": "remove_network_tag", "tags": [ "Networks" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "description": "UUID сети." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkTagRequest" }, "example": { "tag_uuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/3fa85f64-5717-4562-b3fc-2c963f66afa6/tags/remove/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"tag_uuid\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.networks.remove_tag(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n tag_uuid=\"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.networks.removeTag(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", {\n tag_uuid: \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Networks.RemoveTag(ctx, \"3fa85f64-5717-4562-b3fc-2c963f66afa6\", didit.NetworkTagRequest{\n\tTagUUID: \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.NetworkTagRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.networks().removeTag(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", NetworkTagRequest.builder()\n .tagUuid(\"7c9e6679-7425-40de-944b-e07fc1f90ae7\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "networks->removeTag('3fa85f64-5717-4562-b3fc-2c963f66afa6', [\n 'tag_uuid' => '7c9e6679-7425-40de-944b-e07fc1f90ae7',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.networks.remove_tag(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n tag_uuid: \"7c9e6679-7425-40de-944b-e07fc1f90ae7\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Networks.RemoveTagAsync(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", new NetworkTagRequest\n{\n TagUuid = \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Тег был удален из сети. Возвращает подробную информацию о сети.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkDetailResponse" }, "example": { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "network_id": "N-0042", "name": null, "status": "in_review", "risk": { "score": 82, "band": "high", "bar": 0.82 }, "pattern_types": [ "exact_same_device", "same_email" ], "signal_types": [ "device", "email" ], "member_counts": { "total": 3, "users": 3, "businesses": 0, "transaction_parties": 0 }, "member_status": { "approved": 1, "declined": 1, "in_review": 0, "not_completed": 1 }, "signal_coverage": { "device": { "signals": 1, "subjects": 3, "coverage": 1.0 }, "email": { "signals": 1, "subjects": 2, "coverage": 0.6667 } }, "first_activity_at": "2026-10-01T09:12:44Z", "last_activity_at": "2026-10-12T16:03:10Z", "stats": { "members": { "total": 3, "users": 3, "businesses": 0, "transaction_parties": 0 }, "member_status": { "approved": 1, "declined": 1, "in_review": 0, "not_completed": 1 }, "signals": { "total": 2, "by_type": { "device": { "signals": 1, "subjects": 3, "coverage": 1.0 }, "email": { "signals": 1, "subjects": 2, "coverage": 0.6667 } } } }, "fraud_tags": [], "risk_signals": { "residential_proxy_reuse": { "detected": false, "signal_count": 0, "max_subject_count": 0 }, "email_intelligence": { "enriched_signal_count": 1, "high_risk_count": 0, "social_profile_count": 0 }, "phone_intelligence": { "enriched_signal_count": 0, "high_risk_count": 0 } }, "reviewed_at": "2026-10-12T16:30:00Z", "reviewed_by": "reviewer@example.com", "review_reason": "Shared device across three new accounts.", "notes_count": 0, "sharing_mode": "global", "cross_org_available": true, "cross_org_unavailable_reason": null, "tags": [], "outcomes": { "approved": 1, "declined": 1, "in_review": 0, "total": 3 }, "patterns": [ { "type": "background", "score": 0.8125, "members": 3, "reason": null, "computed_at": "2026-10-13T08:00:00Z" } ] } } } }, "400": { "description": "Недопустимое тело запроса: `tag_uuid` отсутствует или не является UUID.", "content": { "application/json": { "schema": { "type": "object", "properties": { "tag_uuid": { "type": "array", "items": { "type": "string" } } } }, "examples": { "Missing tag_uuid": { "summary": "Отсутствует tag_uuid", "value": { "tag_uuid": [ "This field is required." ] } }, "Invalid tag_uuid": { "summary": "Недопустимый tag_uuid", "value": { "tag_uuid": [ "Must be a valid UUID." ] } } } } } }, "401": { "description": "Отсутствуют или недействительны учетные данные.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Присутствует при ошибках с кодом, например `networks_not_entitled`." } } }, "examples": { "Missing or invalid credentials": { "summary": "Отсутствуют или недействительны учетные данные", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "403": { "description": "API-ключ принадлежит другому приложению или имеет ограниченный доступ: для endpoint’ов раздела Networks требуется ключ с полным доступом. Для токена участника консоли требуется `write:networks`. Также возвращается с `code: networks_not_entitled`, если Networks не включен для организации.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Присутствует при ошибках с кодом, например `networks_not_entitled`." } } }, "examples": { "Networks not enabled": { "summary": "Сети не включены", "value": { "detail": "Networks is disabled for this organization. Contact Didit support if you believe this is an error.", "code": "networks_not_entitled" } }, "Restricted API key": { "summary": "Ограниченный API-ключ", "value": { "detail": "This API key has no access to this endpoint." } }, "No permission": { "summary": "Нет разрешения", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Не найдено.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Присутствует при ошибках с кодом, например `networks_not_entitled`." } } }, "examples": { "Network not found": { "summary": "Сеть не найдена", "value": { "detail": "Network not found." } }, "Tag not found": { "summary": "Тег не найден", "value": { "detail": "Tag not found." } }, "Tag not on the network": { "summary": "Тег отсутствует в сети", "value": { "detail": "This tag is not on the network." } } } } } } }, "x-didit-sdk": { "resource": "networks", "method": "remove_tag", "auth": "api_key", "server": true, "scope": "application" } } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/{request_uuid}/remind/": { "post": { "summary": "Напомнить клиенту о запросе", "description": "Отправьте письмо с ожидающим запросом клиента повторно тому же верифицированному получателю и с тем же содержимым. Напоминать по запросу можно не чаще одного раза в 24 часа. Напоминание больше ничего не меняет: запрос сохраняет свой срок, а кейс сохраняет свой статус. Каждое напоминание фиксируется в кейсе как событие CUSTOMER_REQUEST с действием `reminded`. Поле `delivery_status` в ответе указывает, как завершилась доставка этого напоминания: SENT, SIMULATED (письмо не отправлялось) или UNKNOWN (письмо могло быть принято; оно не отправляется повторно автоматически). Поле `next_reminder_at` указывает, когда можно напомнить об этом запросе снова. Возвращает 409 с параметром `reason`, если клиенту больше не требуется отвечать на запрос, и 429 с параметром `retry_at` и заголовком `Retry-After`, если напоминание по запросу уже отправлялось за последние 24 часа. Требуется разрешение `write:cases`.", "operationId": "organization_application_cases_requests_remind_create", "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true, "description": "UUID организации." }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true, "description": "UUID приложения." }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true, "description": "UUID кейса." }, { "in": "path", "name": "request_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true, "description": "UUID запроса клиента из списка запросов кейса." } ], "tags": [ "Case Management" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/requests/3fa85f64-5717-4562-b3fc-2c963f66afa6/remind/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.requests.remind(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.requests.remind(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Requests.Remind(ctx, \"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().requests().remind(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->requests->remind('11111111-2222-3333-4444-555555555555', '11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.requests.remind(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Requests.RemindAsync(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Напоминание было зафиксировано, и письмо с ним отправлено.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request", "reminded_at", "delivery_status", "next_reminder_at" ], "properties": { "request": { "$ref": "#/components/schemas/CustomerMessagingCaseRequest" }, "reminded_at": { "type": "string", "format": "date-time", "description": "Когда было зафиксировано это напоминание." }, "delivery_status": { "type": "string", "enum": [ "SENT", "SIMULATED", "UNKNOWN" ], "description": "Чем завершилась доставка этого напоминания. SIMULATED: электронное письмо не отправлялось. UNKNOWN: письмо могло быть принято; повторно автоматически оно не отправляется." }, "next_reminder_at": { "type": "string", "format": "date-time", "description": "Когда можно повторно отправить напоминание по этому запросу: `reminded_at` плюс 24 часа." } } }, "example": { "request": { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "purpose": "confirm_details", "language": "en", "recipient": "customer@example.com", "expires_at": "2026-10-20T09:00:00Z", "actor_email": "reviewer@example.com", "delivery_status": "SENT", "delivered_at": "2026-10-13T09:00:04Z", "cancelled_at": null, "responded_at": null, "response": null, "has_attachment": false, "created_at": "2026-10-13T09:00:00Z" }, "reminded_at": "2026-10-14T10:30:00Z", "delivery_status": "SENT", "next_reminder_at": "2026-10-15T10:30:00Z" } } } }, "400": { "description": "У кейса есть решение, ожидающее утверждения. Тело ответа представляет собой список строк.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "Customer messages require an active case without a pending resolution." ] } } }, "403": { "description": "У вызывающей стороны отсутствует необходимое разрешение для работы с кейсами." }, "404": { "description": "Запрос или кейс недоступен для вызывающей стороны." }, "409": { "description": "Запрос больше не ожидает действий клиента, поэтому напоминать не о чем. `reason` указывает причину: `answered` (клиент ответил), `cancelled`, `expired`, `closed` (кейс был закрыт после отправки запроса, даже если позже был открыт снова), `not_actionable` (обновление статуса проверки не требует действий), `not_delivered` (первое письмо ещё не отправлено) или `contact_unavailable` (подтверждённый адрес электронной почты больше недоступен).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "case_request_not_waiting" ] }, "reason": { "type": "string", "enum": [ "answered", "cancelled", "expired", "closed", "not_actionable", "not_delivered", "contact_unavailable" ] } } }, "example": { "detail": "This request no longer waits on the customer, so there is nothing to remind them of.", "code": "case_request_not_waiting", "reason": "answered" } } } }, "429": { "description": "Напоминание по этому запросу уже отправлялось за последние 24 часа. `retry_at` и заголовок `Retry-After` указывают, когда вы сможете отправить напоминание снова.", "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной отправкой напоминания по этому запросу.", "schema": { "type": "integer", "minimum": 1, "example": 3600 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "case_request_reminder_too_soon" ] }, "retry_at": { "type": "string", "format": "date-time" } } }, "example": { "detail": "This request was already reminded in the last 24 hours.", "code": "case_request_reminder_too_soon", "retry_at": "2026-10-15T10:30:00Z" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-didit-sdk": { "resource": "cases.requests", "method": "remind", "auth": "api_key", "server": true, "scope": "application" } } }, "/v3/session/{sessionId}/decision-email-preview/": { "post": { "summary": "Предварительный просмотр письма с решением по сессии", "description": "Сформировать email, который пользователь получит при установке для сессии статуса `Approved` или `Declined` с параметром `send_email: true`, без изменения сессии и без фактической отправки. Ответ содержит тему и HTML в точности в том виде, в каком они отправляются, получателя, отправителя, язык, а также флаг, будет ли email отправлен вообще при подтверждении изменения (`will_be_sent`, `not_sent_reason`).\n\nПолучателем является собственный адрес пользователя: тот, который он подтвердил на шаге проверки электронной почты в сценарии, либо адрес, указанный в `contact_details` при создании сессии. Отправителем выступает подтверждённый домен отправителя вашего приложения, если применяется White label (`sender_kind: customer`), иначе отправитель Didit (`sender_kind: didit`).\n\nЧтобы отправить именно то, что было в предпросмотре, вызовите [Update Session Status](/ru/sessions-api/update-status) с тем же `new_status`, `send_email: true`, `email_address`, установленным в `recipient`, `email_language`, установленным в `language`, и `email_preview_token`, установленным в `preview_token`. Срок действия квитанции истекает через 15 минут. Если получатель, язык, статус сессии, отправитель или email изменились с момента предпросмотра, обновление вернёт ошибку `409` до внесения каких-либо изменений; выполните предпросмотр заново и подтвердите действие с новой квитанцией.\n\nРаботает для сессий Проверки пользователей (KYC) и Верификации бизнеса (KYB) в статусах `Approved`, `Declined`, `In Review`, `Kyc Expired`, `Abandoned` или `Resubmitted`. Проверка статуса выполняется до валидации тела запроса. Требуется разрешение `write:sessions`; API-ключу с ограниченной областью действия требуется доступ на запись к решениям. Ответы используют заголовок `Cache-Control: no-store`: относитесь к ним как к конфиденциальным данным верификации.", "operationId": "post_v3_session_decision_email_preview", "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID сессии верификации. Принимает ID сессий как пользователей (KYC), так и компаний (KYB).", "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "new_status" ], "properties": { "new_status": { "type": "string", "enum": [ "Approved", "Declined" ], "description": "Решение, электронное письмо по которому вы хотите предварительно просмотреть.", "example": "Approved" }, "email_language": { "type": "string", "default": "en", "description": "Язык письма, то же значение по умолчанию, что и у Update Session Status. Если язык недоступен, используется английский; поле `language` в ответе указывает, какой именно был применён.", "example": "en" } } }, "examples": { "Approved": { "summary": "Предварительный просмотр письма «Одобрено» на английском языке", "value": { "new_status": "Approved" } }, "Declined in Spanish": { "summary": "Предварительный просмотр письма «Отклонено» на испанском языке", "value": { "new_status": "Declined", "email_language": "es" } } } } } }, "responses": { "200": { "description": "Только предварительный просмотр. Сессия остаётся без изменений, письмо не отправляется.", "headers": { "Cache-Control": { "description": "Всегда `no-store`: предпросмотр содержит данные верификации и не должен кэшироваться.", "schema": { "type": "string", "example": "no-store" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "recipient", "recipient_source", "sender", "sender_name", "sender_email", "sender_kind", "subject", "html", "text", "language", "will_be_sent", "not_sent_reason", "preview_token" ], "properties": { "recipient": { "type": "string", "description": "Адрес, на который отправляется электронное письмо. Пустая строка, если адрес человека неизвестен: в этом случае письмо отправить нельзя, и `preview_token` также пуст. Передайте его как `email_address` при подтверждении.", "example": "person@example.com" }, "recipient_source": { "type": "string", "enum": [ "email_verification", "contact_details", "" ], "description": "Источник значения `recipient`. `email_verification`: адрес, подтвержденный пользователем на шаге проверки электронной почты сценария. `contact_details`: адрес, указанный в `contact_details` при создании сессии. Пустая строка, если адрес отсутствует.", "example": "email_verification" }, "sender": { "type": "string", "description": "Заголовок `From`, с которым отправляется электронное письмо.", "example": "Example App " }, "sender_name": { "type": "string", "description": "Отображаемая часть имени в `sender`.", "example": "Example App" }, "sender_email": { "type": "string", "format": "email", "description": "Часть адреса `sender`.", "example": "no-reply@mail.example.com" }, "sender_kind": { "type": "string", "enum": [ "customer", "didit" ], "description": "`customer`: письмо отправляется с подтверждённого домена отправителя вашего приложения (White label). `didit`: отправляется с собственного отправителя Didit.", "example": "customer" }, "subject": { "type": "string", "description": "Тема письма в точности так, как она отправляется.", "example": "Your verification has been approved in Example App" }, "html": { "type": "string", "description": "HTML письма точно в том виде, в котором оно отправляется, со встроенным логотипом в формате data URL. Отображайте его в изолированном фрейме (sandbox), ни в коем случае не напрямую в DOM вашего приложения.", "example": "..." }, "text": { "type": "string", "description": "Текст письма в виде обычного текста, как он хранится в цепочке сообщений пользователя, для компактного предварительного просмотра (в качестве получаемого письма остаётся HTML).", "example": "Verification Approved\n\nYour identity has been successfully verified with Acme Pay. No further action is needed on your part." }, "language": { "type": "string", "description": "Язык, на котором составлено письмо. Английский (`en`), если запрошенный `email_language` недоступен.", "example": "en" }, "will_be_sent": { "type": "boolean", "description": "Отправляет ли подтверждение изменения с помощью `send_email: true` это электронное письмо. Значение `false`, если задан `not_sent_reason`.", "example": true }, "not_sent_reason": { "type": "string", "nullable": true, "enum": [ "status_unchanged", "notification_emails_disabled", "no_recipient", "sandbox", null ], "description": "Причина, по которой подтверждение не приведёт к отправке электронного письма, или `null`, если оно будет отправлено. `status_unchanged`: у сессии уже установлен этот статус, поэтому обновление ничего не меняет и ничего не отправляет. `notification_emails_disabled`: сессия была создана без `contact_details.send_notification_emails: true`, поэтому электронное письмо с решением не отправляется на адрес, указанный в `contact_details`. `no_recipient`: адрес этого человека неизвестен. `sandbox`: сессия в песочнице, получатель которой не дал согласие на доставку электронных писем в песочнице, поэтому отправка только имитируется.", "example": null }, "preview_token": { "type": "string", "description": "Подписанная квитанция для этого конкретного письма, действующая в течение 15 минут. Передайте ее как `email_preview_token` в [Обновить статус сессии](/ru/sessions-api/update-status). Пустая строка, если получатель отсутствует.", "example": "eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000" } } }, "examples": { "Will Be Sent": { "summary": "Письмо об одобрении отправляется на адрес, подтверждённый в сценарии", "value": { "recipient": "person@example.com", "recipient_source": "email_verification", "sender": "Example App ", "sender_name": "Example App", "sender_email": "no-reply@mail.example.com", "sender_kind": "customer", "subject": "Your verification has been approved in Example App", "html": "...", "language": "en", "will_be_sent": true, "not_sent_reason": null, "preview_token": "eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000" } }, "No Recipient": { "summary": "Адрес для этого лица неизвестен", "value": { "recipient": "", "recipient_source": "", "sender": "Example App ", "sender_name": "Example App", "sender_email": "no-reply@mail.example.com", "sender_kind": "customer", "subject": "Your verification has been declined in Example App", "html": "...", "language": "en", "will_be_sent": false, "not_sent_reason": "no_recipient", "preview_token": "" } } } } } }, "400": { "description": "Сессия не находится в статусе, который принимает этот endpoint (`{\"detail\": ...}`), либо тело запроса недействительно (`{\"\": [\"\"]}`).", "content": { "application/json": { "examples": { "Wrong Current Status": { "summary": "Сессия не находится в статусе, допустимом для этого endpoint", "value": { "detail": "Only sessions with status Approved, Declined, In Review, Kyc Expired, Abandoned, Resubmitted can be updated. Current status: In Progress" } }, "Invalid new_status": { "summary": "new_status не равен Approved или Declined", "value": { "new_status": [ "\"Resubmitted\" is not a valid choice." ] } }, "Missing new_status": { "summary": "Обязательное поле не указано", "value": { "new_status": [ "This field is required." ] } } } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "API-ключ с ограниченной областью действия с истёкшим сроком действия", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Отсутствуют учетные данные, у вызывающей стороны нет привилегии `write:sessions`, у API-ключа с ограниченной областью видимости нет необходимого для этого endpoint доступа, либо передан `session_id`, принадлежащий другому приложению.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "Отсутствует или недействителен x-api-key", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "У вызывающей стороны отсутствует разрешение write:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "API-ключ с ограниченной областью действия без данного доступа", "value": { "detail": "This API key has no write access to decisions." } } } } } }, "404": { "description": "Сессия KYC или KYB с таким `session_id` не существует.", "content": { "application/json": { "examples": { "Not Found": { "summary": "Неизвестный session_id", "value": { "detail": "Not found." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST \\\n https://verification.didit.me/v3/session/3fa85f64-5717-4562-b3fc-2c963f66afa6/decision-email-preview/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"new_status\": \"Approved\", \"email_language\": \"en\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.preview_decision_email(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n new_status=\"Approved\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.previewDecisionEmail(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", {\n new_status: \"Approved\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.PreviewDecisionEmail(ctx, \"3fa85f64-5717-4562-b3fc-2c963f66afa6\", didit.SessionsPreviewDecisionEmailParams{\n\tNewStatus: \"Approved\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsPreviewDecisionEmailParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().previewDecisionEmail(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", SessionsPreviewDecisionEmailParams.builder()\n .newStatus(SessionsPreviewDecisionEmailParams.NewStatus.of(\"Approved\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->previewDecisionEmail('3fa85f64-5717-4562-b3fc-2c963f66afa6', [\n 'new_status' => 'Approved',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.preview_decision_email(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n new_status: \"Approved\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.PreviewDecisionEmailAsync(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\", new SessionsPreviewDecisionEmailParams\n{\n NewStatus = \"Approved\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-sdk": { "resource": "sessions", "method": "preview_decision_email", "auth": "api_key", "server": true } } }, "/v3/travel-rule/join/{token}/": { "get": { "summary": "Получить приглашение для свободного присоединения", "description": "Публичный, не требует аутентификации. Показывает данные приглашения, к которому относится ссылка для присоединения, пока она открыта: кто отправил запрос, адрес получателя и значения каталога, которые будут предзаполнены. Аутентификацией выступает token.", "operationId": "getTravelRuleJoinInvitation", "x-didit-sdk": { "resource": "travel_rule.join", "method": "get_invitation", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Token приглашения из ссылки для присоединения." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl https://verification.didit.me/v3/travel-rule/join/{token}/" } ], "responses": { "200": { "description": "Приглашение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleJoinInvitation" } } } }, "404": { "description": "Ни одно приглашение не содержит этой ссылки." }, "410": { "description": "Приглашение больше не действительно: истекло, уже использовано или отозвано." } } }, "post": { "summary": "Зарегистрировать бесплатный аккаунт Travel Rule", "description": "Публичный, не требует аутентификации. Создаёт бесплатный аккаунт Travel Rule для VASP контрагента, получившего запрос. Email должен совпадать с адресом, на который было отправлено приглашение. На него отправляется 6-значный код; отправьте его на endpoint верификации для завершения. Попытки регистрации ограничены по количеству запросов на адрес и на IP.", "operationId": "registerTravelRuleJoin", "x-didit-sdk": { "resource": "travel_rule.join", "method": "register", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Token приглашения из ссылки для присоединения." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleJoinRegisterRequest" }, "example": { "email": "compliance@example.com", "password": "a-long-passphrase" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/join/{token}/ \\\n -H 'Content-Type: application/json' \\\n -d '{\"email\": \"compliance@example.com\", \"password\": \"a-long-passphrase\"}'" } ], "responses": { "202": { "description": "Учётная запись создана, и код был отправлен по электронной почте.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Сообщает контрагенту о необходимости проверить электронную почту для получения кода верификации." }, "email": { "type": "string", "format": "email", "description": "Адрес, на который был отправлен код." } } } } } }, "400": { "description": "Электронный адрес не совпадает с адресом из приглашения, либо пароль или адрес были отклонены." }, "404": { "description": "Ни одно приглашение не содержит этой ссылки." }, "410": { "description": "Приглашение больше не действительно: истекло, уже использовано или отозвано." }, "429": { "description": "Слишком много попыток присоединиться. Заголовки `X-RateLimit-*` указывают израсходованный бюджет." } } } }, "/v3/travel-rule/join/{token}/verify/": { "post": { "summary": "Верифицировать бесплатный аккаунт Travel Rule", "description": "Публичный, не требует аутентификации. Погашает отправленный по email код, создаёт бесплатную организацию и возвращает учётные данные, которые её приложение использует на endpoints рабочей области. Получение данных Travel Rule бесплатно.", "operationId": "verifyTravelRuleJoin", "x-didit-sdk": { "resource": "travel_rule.join", "method": "verify", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Token приглашения из ссылки для присоединения." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleJoinVerifyRequest" }, "example": { "email": "compliance@example.com", "code": "123456" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/join/{token}/verify/ \\\n -H 'Content-Type: application/json' \\\n -d '{\"email\": \"compliance@example.com\", \"code\": \"123456\"}'" } ], "responses": { "201": { "description": "Учетные данные организации и приложения.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleJoinCredentials" } } } }, "400": { "description": "Код или адрес электронной почты был отклонен." }, "404": { "description": "Ни одно приглашение не содержит этой ссылки." }, "410": { "description": "Приглашение больше не действительно: истекло, уже использовано или отозвано." }, "429": { "description": "Слишком много попыток присоединиться. Заголовки `X-RateLimit-*` указывают израсходованный бюджет." } } } }, "/v3/travel-rule/workspace/": { "get": { "summary": "Получить бесплатное рабочее пространство Travel Rule", "description": "Считывает бесплатное рабочее пространство приложения, подключившегося бесплатно: подтверждение каталога, подтверждение домена, биллинг и листинг в сети Didit.", "operationId": "getTravelRuleWorkspace", "x-didit-sdk": { "resource": "travel_rule.workspace", "method": "get", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/travel-rule/workspace/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.workspace.get()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.workspace.get();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.Workspace.Get(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().workspace().get();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->workspace->get();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.workspace.get\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Workspace.GetAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Рабочее пространство.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspace" } } } }, "404": { "description": "Это приложение не присоединилось к бесплатному тарифу, поэтому у него нет бесплатного рабочего пространства." } } } }, "/v3/travel-rule/workspace/claim/": { "post": { "summary": "Заявить права на запись в каталоге", "description": "Заявляет права на запись в каталоге, которой соответствует это рабочее пространство. Если рабочий адрес электронной почты находится на домене, указанном в записи, права считаются подтверждёнными и применяются немедленно: профиль VASP и настройки Travel Rule заполняются из записи, а Travel Rule включается, поэтому следующий перевод на него будет маршрутизироваться через сеть Didit. В противном случае заявка ожидает проверки (`pending_review`).", "operationId": "claimTravelRuleWorkspace", "x-didit-sdk": { "resource": "travel_rule.workspace", "method": "claim", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspaceClaimRequest" }, "example": { "vasp_id": "0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/workspace/claim/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"vasp_id\": \"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.workspace.claim(\n vasp_id=\"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.workspace.claim({\n vasp_id: \"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.Workspace.Claim(ctx, didit.TravelRuleWorkspaceClaimRequest{\n\tVASPID: \"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleWorkspaceClaimRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().workspace().claim(TravelRuleWorkspaceClaimRequest.builder()\n .vaspId(\"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->workspace->claim([\n 'vasp_id' => '0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.workspace.claim(vasp_id: \"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Workspace.ClaimAsync(new TravelRuleWorkspaceClaimRequest\n{\n VaspId = \"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Рабочее пространство со статусом заявки на присоединение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspace" } } } }, "400": { "description": "В справочнике нет записи с таким id." }, "404": { "description": "Это приложение не присоединилось к бесплатному тарифу, поэтому у него нет бесплатного рабочего пространства." } } } }, "/v3/travel-rule/workspace/domain/code/": { "post": { "summary": "Отправить код подтверждения домена по электронной почте", "description": "Отправляет одноразовый код на рабочий адрес рабочей области, чтобы подтвердить владение почтовым доменом. Действует ограничение частоты запросов, а для каждого кода допускается ограниченное число неверных попыток. Также возвращает TXT-запись для альтернативного подтверждения через DNS.", "operationId": "sendTravelRuleWorkspaceDomainCode", "x-didit-sdk": { "resource": "travel_rule.workspace", "method": "send_domain_code", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/workspace/domain/code/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.workspace.send_domain_code()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.workspace.sendDomainCode();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.Workspace.SendDomainCode(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().workspace().sendDomainCode();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->workspace->sendDomainCode();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.workspace.send_domain_code\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Workspace.SendDomainCodeAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Домен, его статус и TXT-запись.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspaceDomainCodeResponse" } } } }, "404": { "description": "Это приложение не присоединилось к бесплатному тарифу, поэтому у него нет бесплатного рабочего пространства." } } } }, "/v3/travel-rule/workspace/domain/confirm/": { "post": { "summary": "Подтвердить код верификации домена", "description": "Использует отправленный по электронной почте код и помечает домен электронной почты как верифицированный.", "operationId": "confirmTravelRuleWorkspaceDomain", "x-didit-sdk": { "resource": "travel_rule.workspace", "method": "confirm_domain", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspaceDomainConfirmRequest" }, "example": { "code": "123456" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/workspace/domain/confirm/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"code\": \"123456\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.workspace.confirm_domain(\n code=\"123456\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.workspace.confirmDomain({\n code: \"123456\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.Workspace.ConfirmDomain(ctx, didit.TravelRuleWorkspaceDomainConfirmRequest{\n\tCode: \"123456\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleWorkspaceDomainConfirmRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().workspace().confirmDomain(TravelRuleWorkspaceDomainConfirmRequest.builder()\n .code(\"123456\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->workspace->confirmDomain([\n 'code' => '123456',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.workspace.confirm_domain(code: \"123456\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Workspace.ConfirmDomainAsync(new TravelRuleWorkspaceDomainConfirmRequest\n{\n Code = \"123456\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Рабочее пространство.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspace" } } } }, "400": { "description": "Код неверен, истек или уже использован." }, "404": { "description": "Это приложение не присоединилось к бесплатному тарифу, поэтому у него нет бесплатного рабочего пространства." } } } }, "/v3/travel-rule/workspace/domain/dns/": { "post": { "summary": "Верифицировать домен по его TXT-записи", "description": "Проверяет наличие TXT-записи `didit-tr-verify.`, которую возвращает endpoint кода, и помечает домен как верифицированный при её совпадении. Достаточно одного из двух подтверждений: кода из электронного письма или TXT-записи.", "operationId": "verifyTravelRuleWorkspaceDomainDns", "x-didit-sdk": { "resource": "travel_rule.workspace", "method": "verify_domain_dns", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/workspace/domain/dns/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.workspace.verify_domain_dns()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.workspace.verifyDomainDns();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.Workspace.VerifyDomainDNS(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().workspace().verifyDomainDns();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->workspace->verifyDomainDns();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.workspace.verify_domain_dns\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Workspace.VerifyDomainDnsAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Рабочее пространство.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspace" } } } }, "400": { "description": "TXT-запись не найдена или не совпадает." }, "404": { "description": "Это приложение не присоединилось к бесплатному тарифу, поэтому у него нет бесплатного рабочего пространства." } } } }, "/v3/travel-rule/workspace/billing/": { "post": { "summary": "Включить исходящий биллинг", "description": "Включает тарификацию исходящих запросов Travel Rule для рабочей области. Входящие запросы остаются бесплатными. Эту функцию нельзя отключить обратно через API: обратитесь в службу поддержки Didit.", "operationId": "enableTravelRuleWorkspaceBilling", "x-didit-sdk": { "resource": "travel_rule.workspace", "method": "enable_billing", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspaceBillingRequest" }, "example": { "enabled": true } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/workspace/billing/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"enabled\": true}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.workspace.enable_billing(\n enabled=True,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.workspace.enableBilling({\n enabled: true,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.Workspace.EnableBilling(ctx, didit.TravelRuleWorkspaceBillingRequest{\n\tEnabled: didit.Bool(true),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleWorkspaceBillingRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().workspace().enableBilling(TravelRuleWorkspaceBillingRequest.builder()\n .enabled(true)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->workspace->enableBilling([\n 'enabled' => true,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.workspace.enable_billing(enabled: true)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Workspace.EnableBillingAsync(new TravelRuleWorkspaceBillingRequest\n{\n Enabled = true,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Рабочее пространство с `billing_enabled`, равным true.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspace" } } } }, "400": { "description": "`enabled` имело значение false." }, "404": { "description": "Это приложение не присоединилось к бесплатному тарифу, поэтому у него нет бесплатного рабочего пространства." } } } }, "/v3/investigator/summary/": { "get": { "operationId": "investigator_summary", "summary": "Сводка по расследователю", "description": "Этап, счётчики очередей, отчёты, подготовленные сегодня, и решения, принятые сегодня, показатель соответствия за 30 дней, цены и уровень автономности каждой очереди. Для ключей с ограниченным доступом требуется область видимости `decisions` (чтение); для оповещений о транзакциях также требуется `transactions`.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "stage": { "type": "string" }, "last_report_at": { "type": "string", "format": "date-time", "nullable": true }, "prepared_today": { "type": "integer" }, "ready_to_accept": { "type": "integer" }, "open": { "type": "integer" }, "decided_today": { "type": "integer" }, "automation_rate_month": { "type": "number", "nullable": true }, "preparing": { "type": "integer" } } } } } }, "401": { "description": "Отсутствует или недействителен API-ключ." }, "403": { "description": "У ключа отсутствует разрешение, тип элемента недоступен для чтения или тариф не включает Расследователя." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (сессии, а также кейсы, открытые не правилом транзакций) или `transactions` (оповещения по транзакциям, а также кейсы, открытые правилом транзакций)." }, { "in": "query", "name": "timezone", "schema": { "type": "string" }, "description": "Часовой пояс IANA (например, `Europe/Madrid`), от которого отсчитывается «сегодня». По умолчанию UTC." } ], "x-didit-sdk": { "resource": "investigator", "method": "retrieve_summary", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.retrieve_summary()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.retrieveSummary();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.RetrieveSummary(ctx, didit.InvestigatorRetrieveSummaryParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().retrieveSummary();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->retrieveSummary();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.retrieve_summary\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.RetrieveSummaryAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/investigator/queue/": { "get": { "operationId": "investigator_queue", "summary": "Получить список очереди Investigator", "description": "Открытые отчёты, сначала **Готово к принятию**, затем по дедлайну, риску и времени ожидания. `counts` охватывает каждый тип в области видимости. `count` ограничен 100. Для ключей с ограниченным доступом требуется область `decisions` (чтение); для оповещений о транзакциях также требуется `transactions`.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "counts": { "type": "object", "additionalProperties": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/InvestigatorQueueRow" } } } } } } }, "401": { "description": "Отсутствует или недействителен API-ключ." }, "403": { "description": "У ключа отсутствует разрешение, тип элемента недоступен для чтения или тариф не включает Расследователя." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (сессии, а также кейсы, открытые не правилом транзакций) или `transactions` (оповещения по транзакциям, а также кейсы, открытые правилом транзакций)." }, { "in": "query", "name": "kind", "schema": { "type": "string" }, "description": "`session`, `business_session`, `transaction` или `case`, либо несколько значений, разделённых запятыми." }, { "in": "query", "name": "queue", "schema": { "type": "string", "enum": [ "kyc", "kyb", "aml", "transactions", "cases" ] } }, { "in": "query", "name": "recommendation", "schema": { "type": "string", "enum": [ "approve", "decline", "escalate", "request" ] } }, { "in": "query", "name": "confidence", "schema": { "type": "string", "enum": [ "high", "moderate", "low" ] } }, { "in": "query", "name": "ready", "schema": { "type": "boolean" } }, { "in": "query", "name": "search", "schema": { "type": "string" }, "description": "Имя, компания, название кейса, номер, ID транзакции или ID элемента." }, { "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "type": "integer" } } ], "x-didit-sdk": { "resource": "investigator", "method": "list_queue", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.investigator.list_queue():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.investigator.listQueue()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Investigator.ListQueueAutoPaging(ctx, didit.InvestigatorListQueueParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.investigator().listQueue()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "investigator->listQueue() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.investigator.list_queue.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Investigator.ListQueueAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] } }, "/v3/investigator/runs/{run_id}/": { "get": { "operationId": "investigator_run_retrieve", "summary": "Получить отчёт Investigator", "description": "Полный отчёт об одном запуске. 404, если у запуска нет завершённого отчёта или его элемент был удалён. Для ключей с ограниченным доступом требуется область видимости `decisions` (чтение); для оповещений по транзакциям также требуется `transactions`.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorRunDetail" } } } }, "404": { "description": "Не найдено или отчёт отсутствует." }, "401": { "description": "Отсутствует или недействителен API-ключ." }, "403": { "description": "У ключа отсутствует разрешение, тип элемента недоступен для чтения или тариф не включает Расследователя." } }, "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "x-didit-sdk": { "resource": "investigator", "method": "retrieve_run", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.retrieve_run(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.retrieveRun(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.RetrieveRun(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().retrieveRun(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->retrieveRun('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.retrieve_run(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.RetrieveRunAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/investigator/runs/{run_id}/accept/": { "post": { "operationId": "investigator_run_accept", "summary": "Принять рекомендацию", "description": "Применяет рекомендуемое действие стандартным путём для данного объекта, поэтому отправляются ваши обычные webhook. Наличие `narrative` помечает его как отредактированный и принятый. Для ключей с ограниченным доступом требуется область `decisions` (запись); для оповещений по транзакциям также требуется `transactions` (запись). Эскалация верификации или транзакции открывает кейс.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorDecision" } } } }, "409": { "description": "Решение уже принято, отчёт не готов или элемент заблокирован защитным ограничением." }, "401": { "description": "Отсутствует или недействителен API-ключ." }, "403": { "description": "У ключа отсутствует разрешение, тип элемента недоступен для чтения или тариф не включает Расследователя." } }, "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorAcceptRequest" }, "example": { "send_email": false } } } }, "x-didit-sdk": { "resource": "investigator", "method": "accept_run", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.accept_run(\n \"11111111-2222-3333-4444-555555555555\",\n send_email=False,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.acceptRun(\"11111111-2222-3333-4444-555555555555\", {\n send_email: false,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.AcceptRun(ctx, \"11111111-2222-3333-4444-555555555555\", didit.InvestigatorAcceptRequest{\n\tSendEmail: didit.Bool(false),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.InvestigatorAcceptRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().acceptRun(\"11111111-2222-3333-4444-555555555555\", InvestigatorAcceptRequest.builder()\n .sendEmail(false)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->acceptRun('11111111-2222-3333-4444-555555555555', [\n 'send_email' => false,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.accept_run(\n \"11111111-2222-3333-4444-555555555555\",\n send_email: false\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.AcceptRunAsync(\"11111111-2222-3333-4444-555555555555\", new InvestigatorAcceptRequest\n{\n SendEmail = false,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/investigator/runs/{run_id}/override/": { "post": { "operationId": "investigator_run_override", "summary": "Переопределить рекомендацию", "description": "Применяет другое действие с категорией и причиной. Также переопределяет решение, принятое Investigator самостоятельно, пока оно остается в силе. Ключам с ограниченным доступом требуется область `decisions` (запись); для оповещений по транзакциям также требуется `transactions` (запись). Эскалация верификации или транзакции открывает кейс.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorDecision" } } } }, "409": { "description": "Решение уже принято, либо элемент заблокирован защитным ограничением." }, "401": { "description": "Отсутствует или недействителен API-ключ." }, "403": { "description": "У ключа отсутствует разрешение, тип элемента недоступен для чтения или тариф не включает Расследователя." } }, "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorOverrideRequest" }, "example": { "action": "decline", "category": "evidence_misread", "reason": "The proof of address is older than three months." } } } }, "x-didit-sdk": { "resource": "investigator", "method": "override_run", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.override_run(\n \"11111111-2222-3333-4444-555555555555\",\n action=\"decline\",\n category=\"evidence_misread\",\n reason=\"The proof of address is older than three months.\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.overrideRun(\"11111111-2222-3333-4444-555555555555\", {\n action: \"decline\",\n category: \"evidence_misread\",\n reason: \"The proof of address is older than three months.\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.OverrideRun(ctx, \"11111111-2222-3333-4444-555555555555\", didit.InvestigatorOverrideRequest{\n\tAction: \"decline\",\n\tCategory: \"evidence_misread\",\n\tReason: \"The proof of address is older than three months.\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.InvestigatorOverrideRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().overrideRun(\"11111111-2222-3333-4444-555555555555\", InvestigatorOverrideRequest.builder()\n .action(InvestigatorOverrideRequest.Action.of(\"decline\"))\n .category(InvestigatorOverrideRequest.Category.of(\"evidence_misread\"))\n .reason(\"The proof of address is older than three months.\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->overrideRun('11111111-2222-3333-4444-555555555555', [\n 'action' => 'decline',\n 'category' => 'evidence_misread',\n 'reason' => 'The proof of address is older than three months.',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.override_run(\n \"11111111-2222-3333-4444-555555555555\",\n action: \"decline\",\n category: \"evidence_misread\",\n reason: \"The proof of address is older than three months.\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.OverrideRunAsync(\"11111111-2222-3333-4444-555555555555\", new InvestigatorOverrideRequest\n{\n Action = \"decline\",\n Category = \"evidence_misread\",\n Reason = \"The proof of address is older than three months.\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/investigator/runs/batch-accept/": { "post": { "operationId": "investigator_batch_accept", "summary": "Пакетное принятие рекомендаций", "description": "Принимает до 50 отчётов, помеченных готовыми к принятию. Каждый представляет собой отдельное решение: отчёт, который невозможно принять, пропускается с указанием причины. Для ключей с ограниченным доступом требуется область видимости `decisions` (запись); для оповещений по транзакциям также требуется `transactions` (запись). Эскалация верификации или транзакции открывает кейс.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorBatchAcceptResponse" } } } }, "401": { "description": "Отсутствует или недействителен API-ключ." }, "403": { "description": "У ключа отсутствует разрешение, тип элемента недоступен для чтения или тариф не включает Расследователя." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorBatchAcceptRequest" } } } }, "x-didit-sdk": { "resource": "investigator", "method": "batch_accept_runs", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.batch_accept_runs(\n run_ids=[\"11111111-2222-3333-4444-555555555555\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.batchAcceptRuns({\n run_ids: [\"11111111-2222-3333-4444-555555555555\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.BatchAcceptRuns(ctx, didit.InvestigatorBatchAcceptRequest{\n\tRunIDs: []string{\"11111111-2222-3333-4444-555555555555\"},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.InvestigatorBatchAcceptRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().batchAcceptRuns(InvestigatorBatchAcceptRequest.builder()\n .runIds(List.of(\"11111111-2222-3333-4444-555555555555\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->batchAcceptRuns([\n 'run_ids' => ['11111111-2222-3333-4444-555555555555'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.batch_accept_runs(run_ids: [\"11111111-2222-3333-4444-555555555555\"])\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.BatchAcceptRunsAsync(new InvestigatorBatchAcceptRequest\n{\n RunIds = new string[] { \"11111111-2222-3333-4444-555555555555\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/investigator/transactions/{transaction_id}/": { "get": { "operationId": "investigator_transaction_retrieve", "summary": "Получить проверку транзакции в Investigator", "description": "Последняя проверка транзакции или `investigator: null`, если она никогда не проверялась. Для ограниченных ключей требуются области видимости `decisions` и `transactions` (read).", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "transaction_id": { "type": "string", "format": "uuid" }, "investigator": { "$ref": "#/components/schemas/InvestigatorBlock" } } } } } }, "404": { "description": "Транзакция не принадлежит этому приложению." }, "401": { "description": "Отсутствует или недействителен API-ключ." }, "403": { "description": "У ключа отсутствует разрешение, тип элемента недоступен для чтения или тариф не включает Расследователя." } }, "parameters": [ { "in": "path", "name": "transaction_id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "x-didit-sdk": { "resource": "investigator", "method": "retrieve_transaction", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.retrieve_transaction(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.retrieveTransaction(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.RetrieveTransaction(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().retrieveTransaction(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->retrieveTransaction('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.retrieve_transaction(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.RetrieveTransactionAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/investigator/guardrails/": { "get": { "operationId": "investigator_guardrails", "summary": "Получить список заблокированных ограничений", "description": "Пять защитных ограничений, применяемых к каждой очереди. Их нельзя отключить. Для ключей с ограниченным доступом требуется область видимости `decisions` (чтение); для оповещений по транзакциям также требуется `transactions`.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "sanctions_to_person", "no_tipping_off", "no_protected_characteristics", "never_files_reports", "every_decision_logged" ] }, "title": { "type": "string" }, "description": { "type": "string" }, "locked": { "type": "boolean" } } } } } } } } }, "401": { "description": "Отсутствует или недействителен API-ключ." }, "403": { "description": "У ключа отсутствует разрешение, тип элемента недоступен для чтения или тариф не включает Расследователя." } }, "x-didit-sdk": { "resource": "investigator", "method": "list_guardrails", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.list_guardrails()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.listGuardrails();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.ListGuardrails(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().listGuardrails();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->listGuardrails();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.list_guardrails\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.ListGuardrailsAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/investigator/dashboard/": { "get": { "operationId": "investigator_dashboard", "summary": "Панель управления расследователя", "description": "Последние 30 дней: проверки, решения, уровень автоматизации, сэкономленные часы, расходы, переопределения, выборки контроля качества с момента запуска, показатели по очередям и неделям. Для ключей с ограниченным доступом требуется разрешение `decisions` (чтение); для оповещений по транзакциям также требуется `transactions`.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "stage": { "type": "string" }, "window_days": { "type": "integer" }, "reviews": { "type": "integer" }, "decided": { "type": "integer" }, "automated": { "type": "integer" }, "automation_rate": { "type": "number", "nullable": true }, "hours_saved": { "type": "number", "nullable": true } } } } } }, "401": { "description": "Отсутствует или недействителен API-ключ." }, "403": { "description": "У ключа отсутствует разрешение, тип элемента недоступен для чтения или тариф не включает Расследователя." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (сессии, а также кейсы, открытые не правилом транзакций) или `transactions` (оповещения по транзакциям, а также кейсы, открытые правилом транзакций)." } ], "x-didit-sdk": { "resource": "investigator", "method": "retrieve_dashboard", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.retrieve_dashboard()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.retrieveDashboard();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.RetrieveDashboard(ctx, didit.InvestigatorRetrieveDashboardParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().retrieveDashboard();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->retrieveDashboard();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.retrieve_dashboard\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.RetrieveDashboardAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/investigator/performance/": { "get": { "operationId": "investigator_performance", "summary": "Эффективность расследователя", "description": "Согласованность с вашей командой, объем, сэкономленное время, калибровка уверенности, результаты по очередям, причины переопределения решений и расхождения за период. Для ключей с ограниченным доступом требуется разрешение `decisions` (чтение); для оповещений о транзакциях также требуется `transactions`.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "period": { "type": "integer" }, "start": { "type": "string", "format": "date" }, "end": { "type": "string", "format": "date" }, "investigated": { "type": "integer" } } } } } }, "401": { "description": "Отсутствует или недействителен API-ключ." }, "403": { "description": "У ключа отсутствует разрешение, тип элемента недоступен для чтения или тариф не включает Расследователя." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (сессии, а также кейсы, открытые не правилом транзакций) или `transactions` (оповещения по транзакциям, а также кейсы, открытые правилом транзакций)." }, { "in": "query", "name": "period", "schema": { "type": "string", "enum": [ "7", "30", "90" ], "default": "30" }, "description": "Дни, заканчивающиеся сегодня." } ], "x-didit-sdk": { "resource": "investigator", "method": "retrieve_performance", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.retrieve_performance()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.retrievePerformance();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.RetrievePerformance(ctx, didit.InvestigatorRetrievePerformanceParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().retrievePerformance();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->retrievePerformance();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.retrieve_performance\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.RetrievePerformanceAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/investigator/activity/": { "get": { "operationId": "investigator_activity", "summary": "Получить список действий Investigator", "description": "Журнал аудита с возможностью только добавления, сначала новые. Пакетное принятие представляет собой одну запись. Добавляет `counts` по группам и `actors`. Для ключей с ограниченным доступом требуется область `decisions` (чтение); для оповещений о транзакциях также требуется `transactions`.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "counts": { "type": "object", "additionalProperties": true }, "actors": { "type": "array", "items": {} }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true, "description": "`id`, `at`, `kind`, `group`, `queue`, `run_id`, `item`, `actor`, `agent_version`, `data`, `report_version`, `steps`, `sources`, `batch`." } } } } } } }, "401": { "description": "Отсутствует или недействителен API-ключ." }, "403": { "description": "У ключа отсутствует разрешение, тип элемента недоступен для чтения или тариф не включает Расследователя." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (сессии, а также кейсы, открытые не правилом транзакций) или `transactions` (оповещения по транзакциям, а также кейсы, открытые правилом транзакций)." }, { "in": "query", "name": "group", "schema": { "type": "string", "enum": [ "agent", "decisions", "overrides", "autonomy" ] } }, { "in": "query", "name": "actor", "schema": { "type": "string" }, "description": "`agent` для Investigator или адрес электронной почты человека." }, { "in": "query", "name": "since", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "until", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "type": "integer" } } ], "x-didit-sdk": { "resource": "investigator", "method": "list_activity", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.investigator.list_activity():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.investigator.listActivity()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Investigator.ListActivityAutoPaging(ctx, didit.InvestigatorListActivityParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.investigator().listActivity()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "investigator->listActivity() as $item) {\n print_r($item);\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.investigator.list_activity.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Investigator.ListActivityAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] } }, "/v3/investigator/activity/export/": { "get": { "operationId": "investigator_activity_export", "summary": "Экспорт активности Investigator", "description": "Те же записи в формате CSV, по одной строке на каждое решение, начиная с самых новых, до 10,000 записей. Для ключей с ограниченным доступом требуется область видимости `decisions` (read); для оповещений по транзакциям также требуется `transactions`.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "text/csv": { "schema": { "type": "string" } } } }, "401": { "description": "Отсутствует или недействителен API-ключ." }, "403": { "description": "У ключа отсутствует разрешение, тип элемента недоступен для чтения или тариф не включает Расследователя." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (сессии, а также кейсы, открытые не правилом транзакций) или `transactions` (оповещения по транзакциям, а также кейсы, открытые правилом транзакций)." }, { "in": "query", "name": "group", "schema": { "type": "string", "enum": [ "agent", "decisions", "overrides", "autonomy" ] } }, { "in": "query", "name": "actor", "schema": { "type": "string" }, "description": "`agent` для Investigator или адрес электронной почты человека." }, { "in": "query", "name": "since", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "until", "schema": { "type": "string", "format": "date-time" } } ], "x-didit-sdk": { "resource": "investigator", "method": "export_activity", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\ncontent = client.investigator.export_activity()\nwith open(\"download.csv\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst content = await didit.investigator.exportActivity();\nawait writeFile(\"download.csv\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresp, err := client.Investigator.ExportActivity(ctx, didit.InvestigatorExportActivityParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.csv\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.investigator().exportActivity()\n .writeTo(Path.of(\"download.csv\"));" }, { "lang": "php", "label": "PHP", "source": "investigator->exportActivity();\n$content->saveTo('download.csv');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ncontent = didit.investigator.export_activity\nFile.binwrite(\"download.csv\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar content = await client.Investigator.ExportActivityAsync();\nawait content.SaveToAsync(\"download.csv\");" } ] } }, "/v3/investigator/settings/": { "get": { "operationId": "investigator_settings_retrieve", "summary": "Получить настройки Investigator", "description": "Этап (`none`, `shadow` или `live`) и месячный лимит расходов с суммой расходов за текущий месяц. Для ключей с ограничениями требуется область видимости `applications` (чтение).", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorSettings" } } } }, "401": { "description": "Отсутствует или недействителен API-ключ." }, "403": { "description": "У ключа отсутствует разрешение, тип элемента недоступен для чтения или тариф не включает Расследователя." } }, "x-didit-sdk": { "resource": "investigator", "method": "retrieve_settings", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.retrieve_settings()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.retrieveSettings();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.RetrieveSettings(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().retrieveSettings();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->retrieveSettings();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.retrieve_settings\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.RetrieveSettingsAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "patch": { "operationId": "investigator_settings_update", "summary": "Обновить настройки Investigator", "description": "Изменить стадию, ежемесячный лимит расходов или и то, и другое. Переход дальше `none` требует тарифа, включающего Investigator (Growth или выше); `live` также требует контракта с соответствующими ценами, если он у вас есть. Ключам с ограниченными правами требуется область видимости `applications` (запись).", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorSettings" } } } }, "400": { "description": "Не передано ни одно поле или указано недействительное значение." }, "401": { "description": "Отсутствует или недействителен API-ключ." }, "403": { "description": "У ключа отсутствует разрешение, тип элемента недоступен для чтения или тариф не включает Расследователя." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorSettings" }, "example": { "stage": "shadow", "monthly_spend_limit": "500.00" } } } }, "x-didit-sdk": { "resource": "investigator", "method": "update_settings", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.update_settings(\n stage=\"shadow\",\n monthly_spend_limit=\"500.00\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.updateSettings({\n stage: \"shadow\",\n monthly_spend_limit: \"500.00\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.UpdateSettings(ctx, didit.InvestigatorSettingsParam{\n\tStage: didit.Some(didit.InvestigatorSettingsStage(\"shadow\")),\n\tMonthlySpendLimit: didit.String(\"500.00\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.InvestigatorSettings;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().updateSettings(InvestigatorSettings.builder()\n .stage(InvestigatorSettings.Stage.of(\"shadow\"))\n .monthlySpendLimit(\"500.00\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->updateSettings([\n 'stage' => 'shadow',\n 'monthly_spend_limit' => '500.00',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.update_settings(\n stage: \"shadow\",\n monthly_spend_limit: \"500.00\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.UpdateSettingsAsync(new InvestigatorSettings\n{\n Stage = new InvestigatorSettingsStage(\"shadow\"),\n MonthlySpendLimit = \"500.00\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/travel-rule/wallet-addresses/import/": { "post": { "summary": "Массовый импорт адресов кошельков", "description": "Добавьте до 10,000 кошельков в адресную книгу Travel Rule за один вызов в формате JSON или CSV-файла. Кошелек можно передать по его адресу, по хэшу SHA-256 адреса в нижнем регистре (`address_hash`) для сохранения конфиденциальности адреса, или обоими способами. Импорт идемпотентен: кошелек, уже присутствующий в книге, отмечается как `existing` и остается без изменений, поэтому тот же файл можно отправить повторно. Каждая строка валидируется отдельно, поэтому одна некорректная строка не приводит к сбою остальных. Кошелек, импортированный только по хэшу, сопоставляется только с переводами на этот адрес и может быть подтвержден с помощью виджета владения кошельком, как и любая другая запись.", "operationId": "importTravelRuleWalletAddresses", "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "x-didit-sdk": { "resource": "travel_rule.wallet_addresses", "method": "bulk_import", "auth": "api_key", "server": true }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "required": [ "entries" ], "properties": { "entries": { "type": "array", "minItems": 1, "maxItems": 10000, "items": { "$ref": "#/components/schemas/WalletAddressImportRow" } } } }, { "type": "array", "minItems": 1, "maxItems": 10000, "items": { "$ref": "#/components/schemas/WalletAddressImportRow" } } ] }, "example": { "entries": [ { "address": "0xBeneficiaryWallet01", "chain": "ETH", "holder_name": "Ana Diaz", "holder_vendor_data": "user-042" }, { "address_hash": "4f7d2e1c9b8a7f6e5d4c3b2a1f0e9d8c7b6a5f4e3d2c1b0a9f8e7d6c5b4a3f2e", "chain": "bitcoin", "holder_vendor_data": "user-043" }, { "address": "rExchangeSharedAddress01", "chain": "XRP", "memo": "104729", "holder_name": "Ana Diaz" } ] } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary", "description": "CSV-файл в кодировке UTF-8 размером не более 5 МБ со строкой заголовка с названиями столбцов (поля строки или их псевдонимы). Пустые ячейки считаются непереданными; столбцы, которые не считываются импортом, игнорируются." } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl (JSON)", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/wallet-addresses/import/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"entries\": [{\"address\": \"0xBeneficiaryWallet01\", \"chain\": \"ETH\", \"holder_name\": \"Ana Diaz\"}, {\"address\": \"rExchangeSharedAddress01\", \"chain\": \"XRP\", \"memo\": \"104729\"}]}'" }, { "lang": "curl", "label": "curl (CSV)", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/wallet-addresses/import/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'file=@wallets.csv;type=text/csv'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.wallet_addresses.bulk_import(\n body={\n \"entries\": [{\n \"address\": \"0xBeneficiaryWallet01\",\n \"chain\": \"ETH\",\n \"holder_name\": \"Ana Diaz\",\n \"holder_vendor_data\": \"user-042\",\n }, {\n \"address_hash\": \"4f7d2e1c9b8a7f6e5d4c3b2a1f0e9d8c7b6a5f4e3d2c1b0a9f8e7d6c5b4a3f2e\",\n \"chain\": \"bitcoin\",\n \"holder_vendor_data\": \"user-043\",\n }, {\n \"address\": \"rExchangeSharedAddress01\",\n \"chain\": \"XRP\",\n \"memo\": \"104729\",\n \"holder_name\": \"Ana Diaz\",\n }],\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.walletAddresses.bulkImport({\n file: await fileFromPath(\"wallet-addresses.csv\"),\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.WalletAddresses.BulkImport(ctx, didit.TravelRuleWalletAddressesBulkImportParams{\n\tFile: didit.Some(didit.FileFromPath(\"wallet-addresses.csv\")),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\nimport me.didit.types.TravelRuleWalletAddressesBulkImportParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().walletAddresses().bulkImport(TravelRuleWalletAddressesBulkImportParams.builder()\n .file(Path.of(\"wallet-addresses.csv\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->walletAddresses->bulkImport([\n 'file' => File::fromPath('wallet-addresses.csv'),\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.wallet_addresses.bulk_import(\n body: {\n entries: [{\n address: \"0xBeneficiaryWallet01\",\n chain: \"ETH\",\n holder_name: \"Ana Diaz\",\n holder_vendor_data: \"user-042\",\n }, {\n address_hash: \"4f7d2e1c9b8a7f6e5d4c3b2a1f0e9d8c7b6a5f4e3d2c1b0a9f8e7d6c5b4a3f2e\",\n chain: \"bitcoin\",\n holder_vendor_data: \"user-043\",\n }, {\n address: \"rExchangeSharedAddress01\",\n chain: \"XRP\",\n memo: \"104729\",\n holder_name: \"Ana Diaz\",\n }],\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.WalletAddresses.BulkImportAsync(new TravelRuleWalletAddressesBulkImportParams\n{\n File = FileUpload.FromPath(\"wallet-addresses.csv\"),\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Каждая строка была создана, уже находилась в книге или повторяла более раннюю строку.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletAddressImportReport" }, "example": { "total": 3, "created": 2, "existing": 1, "duplicate": 0, "failed": 0, "rows": [ { "row": 1, "status": "existing", "entry_id": "11111111-2222-3333-4444-555555555555", "errors": {}, "duplicate_of_row": null }, { "row": 2, "status": "created", "entry_id": "22222222-3333-4444-5555-666666666666", "errors": {}, "duplicate_of_row": null }, { "row": 3, "status": "created", "entry_id": "33333333-4444-5555-6666-777777777777", "errors": {}, "duplicate_of_row": null } ] } } } }, "207": { "description": "Как минимум для одной строки произошла ошибка; остальные были импортированы. Для каждой строки с ошибкой указаны её ошибки.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletAddressImportReport" }, "example": { "total": 2, "created": 1, "existing": 0, "duplicate": 0, "failed": 1, "rows": [ { "row": 1, "status": "created", "entry_id": "44444444-5555-6666-7777-888888888888", "errors": {}, "duplicate_of_row": null }, { "row": 2, "status": "failed", "entry_id": null, "errors": { "address": [ "Send address, address_hash or both." ] }, "duplicate_of_row": null } ] } } } }, "400": { "description": "Сам запрос не может быть прочитан: переданы одновременно `entries` и `file` либо не передано ни то, ни другое; более 10,000 строк; файл размером более 5 MB, файл CSV не в кодировке UTF-8, без строки заголовков или без строк данных.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "file": [ "At most 10000 rows per import." ] } } } } } } }, "/v3/travel-rule/counterparty-contacts/": { "get": { "summary": "Получить список контактов контрагента", "description": "Комплаенс-адреса, на которые рельс EMAIL может отправлять сообщения для вашего приложения: контакты платформы Didit плюс собственные приватные контакты вашего приложения, включая недоставленные, сначала новые. С пагинацией по `limit` (по умолчанию 50) и `offset`; `count` останавливается на 100, поэтому 100 означает 100 или более.", "operationId": "listTravelRuleCounterpartyContacts", "x-didit-sdk": { "resource": "travel_rule.counterparty_contacts", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "counterparty", "in": "query", "schema": { "type": "string", "format": "uuid" }, "description": "Только контакты этой записи справочника. Должен быть UUID; пустое значение означает отсутствие фильтра." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 }, "description": "Размер страницы, по умолчанию 50." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "Строки, которые нужно пропустить." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/travel-rule/counterparty-contacts/?counterparty={vasp_id}' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.travel_rule.counterparty_contacts.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.travelRule.counterpartyContacts.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.TravelRule.CounterpartyContacts.ListAutoPaging(ctx, didit.TravelRuleCounterpartyContactsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.travelRule().counterpartyContacts().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "travelRule->counterpartyContacts->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.travel_rule.counterparty_contacts.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.TravelRule.CounterpartyContacts.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Контакты.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleCounterpartyContact" } } } }, "example": { "count": 1, "next": null, "previous": null, "results": [ { "uuid": "6c1f9b8e-2d4a-4f7e-8b3c-5a9d0e1f2a3b", "counterparty": "0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91", "counterparty_name": "Example Counterparty VASP", "email": "compliance@counterparty.example", "name": "Compliance desk", "source": "application", "scope": "application", "created_by": "", "verified_at": null, "is_invalid": false, "invalid_reason": "", "invalid_detail": "", "invalid_at": null, "created_at": "2026-10-19T09:00:00Z" } ] } } } }, "400": { "description": "`counterparty` не является UUID.", "content": { "application/json": { "example": { "counterparty": [ "Must be a valid UUID." ] } } } } } }, "post": { "summary": "Добавить контакт контрагента", "description": "Добавляет приватный комплаенс-адрес для одной записи справочника. Только ваше приложение видит и использует его, а канал EMAIL записывает в него данные до любого контакта с платформой. Добавление адреса, который уже есть у записи среди ваших контактов, возвращает этот контакт.", "operationId": "createTravelRuleCounterpartyContact", "x-didit-sdk": { "resource": "travel_rule.counterparty_contacts", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyContactCreate" }, "example": { "counterparty": "0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91", "email": "compliance@counterparty.example", "name": "Compliance desk" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/counterparty-contacts/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"counterparty\": \"0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91\", \"email\": \"compliance@counterparty.example\", \"name\": \"Compliance desk\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.counterparty_contacts.create(\n counterparty=\"0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91\",\n email=\"compliance@counterparty.example\",\n name=\"Compliance desk\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.counterpartyContacts.create({\n counterparty: \"0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91\",\n email: \"compliance@counterparty.example\",\n name: \"Compliance desk\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.CounterpartyContacts.Create(ctx, didit.TravelRuleCounterpartyContactCreate{\n\tCounterparty: \"0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91\",\n\tEmail: \"compliance@counterparty.example\",\n\tName: didit.String(\"Compliance desk\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleCounterpartyContactCreate;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().counterpartyContacts().create(TravelRuleCounterpartyContactCreate.builder()\n .counterparty(\"0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91\")\n .email(\"compliance@counterparty.example\")\n .name(\"Compliance desk\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->counterpartyContacts->create([\n 'counterparty' => '0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91',\n 'email' => 'compliance@counterparty.example',\n 'name' => 'Compliance desk',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.counterparty_contacts.create(\n counterparty: \"0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91\",\n email: \"compliance@counterparty.example\",\n name: \"Compliance desk\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.CounterpartyContacts.CreateAsync(new TravelRuleCounterpartyContactCreate\n{\n Counterparty = \"0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91\",\n Email = \"compliance@counterparty.example\",\n Name = \"Compliance desk\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Контакт был добавлен.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyContact" }, "example": { "uuid": "6c1f9b8e-2d4a-4f7e-8b3c-5a9d0e1f2a3b", "counterparty": "0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91", "counterparty_name": "Example Counterparty VASP", "email": "compliance@counterparty.example", "name": "Compliance desk", "source": "application", "scope": "application", "created_by": "", "verified_at": null, "is_invalid": false, "invalid_reason": "", "invalid_detail": "", "invalid_at": null, "created_at": "2026-10-19T09:00:00Z" } } } }, "400": { "description": "Поле отсутствует или недействительно, либо нет записи справочника с таким идентификатором.", "content": { "application/json": { "example": { "counterparty": [ "No directory entry with this id." ] } } } } } } }, "/v3/travel-rule/counterparty-contacts/{contact_uuid}/": { "delete": { "summary": "Удалить контакт контрагента", "description": "Удаляет один из собственных контактов вашего приложения. Канал EMAIL немедленно прекращает отправку на него сообщений. Контакты платформы удалить нельзя.", "operationId": "deleteTravelRuleCounterpartyContact", "x-didit-sdk": { "resource": "travel_rule.counterparty_contacts", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "contact_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE https://verification.didit.me/v3/travel-rule/counterparty-contacts/{contact_uuid}/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.travel_rule.counterparty_contacts.delete(\n \"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.travelRule.counterpartyContacts.delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.TravelRule.CounterpartyContacts.Delete(ctx, \"11111111-2222-3333-4444-555555555555\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.travelRule().counterpartyContacts().delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "php", "label": "PHP", "source": "travelRule->counterpartyContacts->delete('11111111-2222-3333-4444-555555555555');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.travel_rule.counterparty_contacts.delete(\"11111111-2222-3333-4444-555555555555\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.TravelRule.CounterpartyContacts.DeleteAsync(\"11111111-2222-3333-4444-555555555555\");" } ], "responses": { "204": { "description": "Удалено." }, "404": { "description": "Ни один контакт вашего приложения не имеет такого id. Контакт платформы также возвращает 404." } } } }, "/v3/travel-rule/transfers/": { "get": { "summary": "Получить список переводов Travel Rule", "description": "Переводы Travel Rule вашего приложения, сначала новые, с пагинацией по `limit` (по умолчанию 50) и `offset`. Строки содержат только названия VASP, кошельки и memo, но никогда не содержат персональных данных. Значения, разделенные запятыми, выбирают несколько вариантов. Неизвестное значение возвращает 400 с указанием параметра, например `{\"direction\": [\"Unknown value(s): inbound.\"]}`.", "operationId": "listTravelRuleTransfers", "x-didit-sdk": { "resource": "travel_rule.transfers", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "direction", "in": "query", "required": false, "schema": { "type": "string" }, "description": "INBOUND, OUTBOUND или оба значения через запятую. С учетом регистра." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Один или несколько статусов перевода через запятую." }, { "name": "rail", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Одно или несколько значений из INTERNAL, TRP, GTR, TRUST, VERIFYVASP, SYGNA, EMAIL, TEST_VASP через запятую." }, { "name": "kind", "in": "query", "required": false, "schema": { "type": "string" }, "description": "withdrawal, deposit или message, разделённые запятыми." }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Валюта транзакции, без учета регистра." }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Переводы, созданные в этот день или позже (UTC), ГГГГ-ММ-ДД." }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Переводы, созданные в этот день или раньше (UTC), ГГГГ-ММ-ДД." }, { "name": "counterparty", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Параметр `id` записи каталога или участника сети Didit из GET /v3/travel-rule/vasps/: ваши переводы с этим контрагентом. Если передан некорректный id, возвращается 400." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 }, "description": "Размер страницы, по умолчанию 50." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "Строки, которые нужно пропустить." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/travel-rule/transfers/?direction=OUTBOUND&status=AWAITING_COUNTERPARTY' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.travel_rule.transfers.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.travelRule.transfers.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.TravelRule.Transfers.ListAutoPaging(ctx, didit.TravelRuleTransfersListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.travelRule().transfers().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "travelRule->transfers->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.travel_rule.transfers.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.TravelRule.Transfers.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Страница переводов.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleTransferRow" } } } }, "example": { "count": 1, "next": null, "previous": null, "results": [ { "id": "5b0f6c2e-2a4d-4f0e-9a41-0c3f9a7e1d22", "transaction_id": "a3c1e8f4-7b62-4d1a-8e0b-2f9d6c4b7a10", "txn_id": "wd-2026-10-19-0042", "txn_date": "2026-10-19T08:41:12Z", "kind": "withdrawal", "direction": "OUTBOUND", "status": "AWAITING_COUNTERPARTY", "rail": "TRP", "asset": "ETH", "amount": "1.25", "originator_vasp": "Origin CASP SL", "beneficiary_vasp": "Example Counterparty VASP", "originator_wallet": "0x77ccff0cc624a53cd8b8d8703ced826710211ec7", "beneficiary_wallet": "0xede2d7e4f5b097e6391ab6bbcf2f47a53f4778cb", "originator_memo": "", "beneficiary_memo": "", "originator_wallet_type": "vasp", "beneficiary_wallet_type": "vasp", "matched_transaction_id": null, "deadline_at": "2026-10-21T08:41:13Z", "created_at": "2026-10-19T08:41:13Z" } ] } } } }, "400": { "description": "Недопустимое значение фильтра.", "content": { "application/json": { "example": { "start_date": [ "Use the YYYY-MM-DD format." ] } } } } } } }, "/v3/session/imports/providers/": { "get": { "summary": "Получить список провайдеров миграции", "description": "15 провайдеров, из которых можно перенести верификации: что требуется каждому для подключения, может ли его API выводить список записей, какие разрешения нужны его ключу и сопоставление статусов по умолчанию.", "operationId": "get_v3_session_imports_providers_list", "x-didit-sdk": { "resource": "sessions.imports", "method": "list_providers", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "responses": { "200": { "description": "Провайдеры миграции.", "content": { "application/json": { "schema": { "type": "object", "properties": { "providers": { "type": "array", "items": { "$ref": "#/components/schemas/ImportProvider" } }, "mapping_targets": { "type": "array", "items": { "type": "string" } }, "skipped_statuses": { "type": "array", "items": { "type": "string" } } } } } } }, "403": { "description": "Отсутствует, недействителен или отозван API-ключ, либо вызывающая сторона не может импортировать верификации для этого приложения.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.list_providers()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.listProviders();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.ListProviders(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().listProviders();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->listProviders();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.list_providers\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.ListProvidersAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/imports/providers/check/": { "post": { "summary": "Проверить ключ провайдера", "description": "Получает информацию о провайдере с помощью вашего ключа перед созданием миграции. Ничего не сохраняется.", "operationId": "post_v3_session_imports_providers_check", "x-didit-sdk": { "resource": "sessions.imports", "method": "check_provider", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "sumsub", "jumio", "veriff", "onfido", "persona", "metamap", "socure", "idnow", "shufti", "idenfy", "ondato", "trulioo", "au10tix", "complycube", "other" ], "description": "Источник миграции из `GET /v3/session/imports/providers/`. Обязателен, если `source` равен `provider`." }, "credentials": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Ключ провайдера только для чтения с именами полей, указанными в `credential_fields`. Зашифрован при хранении, никогда не возвращается в ответах и удаляется по завершении импорта. Передавайте его в виде JSON-строки в multipart." }, "options": { "type": "object", "properties": { "region": { "type": "string", "description": "Регион провайдера, один из его `regions` (Onfido: `eu`, `us`, `ca`)." } } }, "record_ids": { "type": "array", "items": { "type": "string" }, "description": "Для провайдеров `api_ids`: ID первой записи вашего экспорта." } }, "required": [ "provider", "credentials" ] }, "example": { "provider": "sumsub", "credentials": { "app_token": "YOUR_PROVIDER_APP_TOKEN", "secret_key": "YOUR_PROVIDER_SECRET_KEY" } } } } }, "responses": { "200": { "description": "Ключ может читать записи.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "provider": { "type": "string" }, "credential_hint": { "type": "string", "nullable": true } } } } } }, "400": { "description": "Провайдер отклонил ключ: `code`, `detail`, `missing_permissions`, `suggested_region`." }, "403": { "description": "Отсутствует, недействителен или отозван API-ключ, либо вызывающая сторона не может импортировать верификации для этого приложения.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.check_provider(\n provider=\"sumsub\",\n credentials={\"app_token\": \"YOUR_PROVIDER_APP_TOKEN\", \"secret_key\": \"YOUR_PROVIDER_SECRET_KEY\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.checkProvider({\n provider: \"sumsub\",\n credentials: { app_token: \"YOUR_PROVIDER_APP_TOKEN\", secret_key: \"YOUR_PROVIDER_SECRET_KEY\" },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.CheckProvider(ctx, didit.SessionsImportsCheckProviderParams{\n\tProvider: \"sumsub\",\n\tCredentials: map[string]string{\"app_token\": \"YOUR_PROVIDER_APP_TOKEN\", \"secret_key\": \"YOUR_PROVIDER_SECRET_KEY\"},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.SessionsImportsCheckProviderParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().checkProvider(SessionsImportsCheckProviderParams.builder()\n .provider(SessionsImportsCheckProviderParams.Provider.of(\"sumsub\"))\n .credentials(Map.of(\"app_token\", \"YOUR_PROVIDER_APP_TOKEN\", \"secret_key\", \"YOUR_PROVIDER_SECRET_KEY\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->checkProvider([\n 'provider' => 'sumsub',\n 'credentials' => ['app_token' => 'YOUR_PROVIDER_APP_TOKEN', 'secret_key' => 'YOUR_PROVIDER_SECRET_KEY'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.check_provider(\n provider: \"sumsub\",\n credentials: { app_token: \"YOUR_PROVIDER_APP_TOKEN\", secret_key: \"YOUR_PROVIDER_SECRET_KEY\" }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.CheckProviderAsync(new SessionsImportsCheckProviderParams\n{\n Provider = \"sumsub\",\n Credentials = new Dictionary { [\"app_token\"] = \"YOUR_PROVIDER_APP_TOKEN\", [\"secret_key\"] = \"YOUR_PROVIDER_SECRET_KEY\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/imports/{importId}/start/": { "post": { "summary": "Запустить тестовый прогон", "description": "Запустить миграцию, пробный запуск (dry run) которой завершился (`READY`): та же задача выполняет реальный импорт с сопоставлением статусов и выбором биометрических шаблонов лица, указанными в текущем запросе.", "operationId": "post_v3_session_imports_start", "x-didit-sdk": { "resource": "sessions.imports", "method": "start", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "importId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "status_mapping": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Expired", "Not Finished", "Abandoned" ] }, "description": "Изменения стандартного сопоставления статусов провайдера: исходный статус в статус Didit. Статусы `Not Finished` и `Abandoned` пропускаются и подсчитываются, но никогда не импортируются." }, "face_templates": { "type": "boolean", "default": false, "description": "Создание биометрических шаблонов лиц из импортированных селфи и поиск их по лицам приложения и списку блокировки. Совпадения помечаются только для проверки. Требуется `lawful_basis_confirmed`." }, "lawful_basis_confirmed": { "type": "boolean", "default": false, "description": "Подтверждает, что у вас есть законные основания передавать эти селфи компании Didit в качестве обработчика." } } } } } }, "responses": { "200": { "description": "Задача импорта.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "400": { "description": "Задача находится не в том состоянии, к которому применимо это действие." }, "403": { "description": "Отсутствует, недействителен или отозван API-ключ, либо вызывающая сторона не может импортировать верификации для этого приложения.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.start(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.start(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.Start(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsImportsStartParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().start(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->start('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.start(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.StartAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/imports/{importId}/pause/": { "post": { "summary": "Приостановить задачу импорта", "description": "Приостановить импорт, находящийся в очереди или в процессе выполнения.", "operationId": "post_v3_session_imports_pause", "x-didit-sdk": { "resource": "sessions.imports", "method": "pause", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "importId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Задача импорта.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "400": { "description": "Задача находится не в том состоянии, к которому применимо это действие." }, "403": { "description": "Отсутствует, недействителен или отозван API-ключ, либо вызывающая сторона не может импортировать верификации для этого приложения.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.pause(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.pause(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.Pause(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().pause(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->pause('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.pause(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.PauseAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/imports/{importId}/resume/": { "post": { "summary": "Возобновить задачу импорта", "description": "Возобновите приостановленный вами импорт. Задача, приостановленная из-за лимита запросов провайдера, возобновляется автоматически.", "operationId": "post_v3_session_imports_resume", "x-didit-sdk": { "resource": "sessions.imports", "method": "resume", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "importId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Задача импорта.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "400": { "description": "Задача находится не в том состоянии, к которому применимо это действие." }, "403": { "description": "Отсутствует, недействителен или отозван API-ключ, либо вызывающая сторона не может импортировать верификации для этого приложения.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.resume(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.resume(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.Resume(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().resume(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->resume('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.resume(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.ResumeAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/imports/{importId}/cancel/": { "post": { "summary": "Отменить задачу импорта", "description": "Отменить импорт. То, что уже было импортировано, сохраняется; загруженный файл и ключ удаляются.", "operationId": "post_v3_session_imports_cancel", "x-didit-sdk": { "resource": "sessions.imports", "method": "cancel", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "importId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Задача импорта.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "400": { "description": "Задача находится не в том состоянии, к которому применимо это действие." }, "403": { "description": "Отсутствует, недействителен или отозван API-ключ, либо вызывающая сторона не может импортировать верификации для этого приложения.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.cancel(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.cancel(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.Cancel(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().cancel(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->cancel('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.cancel(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.CancelAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/imports/{importId}/retry/": { "post": { "summary": "Повторить миграцию", "description": "Повторно запустить завершившуюся миграцию как новую задачу с новым ключом (старый был удалён). Сохраняются провайдер, сценарий, регион, сопоставление статусов и выбор биометрических шаблонов лиц; всё, что уже есть в Didit, пропускается.", "operationId": "post_v3_session_imports_retry", "x-didit-sdk": { "resource": "sessions.imports", "method": "retry", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "importId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "credentials": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Ключ провайдера только для чтения с именами полей, указанными в `credential_fields`. Зашифрован при хранении, никогда не возвращается в ответах и удаляется по завершении импорта. Передавайте его в виде JSON-строки в multipart." }, "file": { "type": "string", "format": "binary", "description": "Идентификаторы записей или файл экспорта снова, для провайдеров `api_ids` и `export_file`." } } }, "example": { "credentials": { "app_token": "YOUR_PROVIDER_APP_TOKEN", "secret_key": "YOUR_PROVIDER_SECRET_KEY" } } } } }, "responses": { "201": { "description": "Новая задача импорта.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "400": { "description": "Не является миграцией, не завершена или провайдер отклонил ключ." }, "403": { "description": "Отсутствует, недействителен или отозван API-ключ, либо вызывающая сторона не может импортировать верификации для этого приложения.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.retry(\n \"11111111-2222-3333-4444-555555555555\",\n credentials={\"app_token\": \"YOUR_PROVIDER_APP_TOKEN\", \"secret_key\": \"YOUR_PROVIDER_SECRET_KEY\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.retry(\"11111111-2222-3333-4444-555555555555\", {\n credentials: { app_token: \"YOUR_PROVIDER_APP_TOKEN\", secret_key: \"YOUR_PROVIDER_SECRET_KEY\" },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.Retry(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsImportsRetryParams{\n\tCredentials: didit.Some(map[string]string{\"app_token\": \"YOUR_PROVIDER_APP_TOKEN\", \"secret_key\": \"YOUR_PROVIDER_SECRET_KEY\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.SessionsImportsRetryParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().retry(\"11111111-2222-3333-4444-555555555555\", SessionsImportsRetryParams.builder()\n .credentials(Map.of(\"app_token\", \"YOUR_PROVIDER_APP_TOKEN\", \"secret_key\", \"YOUR_PROVIDER_SECRET_KEY\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->retry('11111111-2222-3333-4444-555555555555', [\n 'credentials' => ['app_token' => 'YOUR_PROVIDER_APP_TOKEN', 'secret_key' => 'YOUR_PROVIDER_SECRET_KEY'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.retry(\n \"11111111-2222-3333-4444-555555555555\",\n credentials: { app_token: \"YOUR_PROVIDER_APP_TOKEN\", secret_key: \"YOUR_PROVIDER_SECRET_KEY\" }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.RetryAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsImportsRetryParams\n{\n Credentials = new Dictionary { [\"app_token\"] = \"YOUR_PROVIDER_APP_TOKEN\", [\"secret_key\"] = \"YOUR_PROVIDER_SECRET_KEY\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/import-jobs/": { "get": { "summary": "Получить список задач импорта", "description": "Каждый импорт приложения в едином формате: импорты верификаций и миграции, физические лица и компании.", "operationId": "get_v3_import_jobs_list", "x-didit-sdk": { "resource": "sessions.imports", "method": "list_jobs", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "scope", "in": "query", "schema": { "type": "string", "enum": [ "all", "sessions", "users", "businesses" ], "default": "all" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "responses": { "200": { "description": "Задания на импорт, сначала новые.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/ImportJobSummary" } }, "counts": { "type": "object", "properties": { "all": { "type": "integer" }, "running_and_waiting": { "type": "integer" }, "needs_attention": { "type": "integer" }, "done": { "type": "integer" } } } } } } } }, "403": { "description": "Отсутствует, недействителен или отозван API-ключ, либо вызывающая сторона не может импортировать верификации для этого приложения.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.list_jobs()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.listJobs();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.ListJobs(ctx, didit.SessionsImportsListJobsParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().listJobs();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->listJobs();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.list_jobs\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.ListJobsAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/import-jobs/active/": { "get": { "summary": "Получить список активных задач импорта", "description": "Что выполняется или ожидает выполнения, а также что только что завершилось, для индикатора прогресса.", "operationId": "get_v3_import_jobs_active", "x-didit-sdk": { "resource": "sessions.imports", "method": "list_active_jobs", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "responses": { "200": { "description": "Активные задания импорта.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/ImportJobSummary" } }, "running": { "type": "integer" } } } } } }, "403": { "description": "Отсутствует, недействителен или отозван API-ключ, либо вызывающая сторона не может импортировать верификации для этого приложения.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.list_active_jobs()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.listActiveJobs();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.ListActiveJobs(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().listActiveJobs();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->listActiveJobs();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.list_active_jobs\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.ListActiveJobsAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/transactions/delete/": { "delete": { "summary": "Пакетное удаление транзакций", "description": "Удалить одну или несколько транзакций безвозвратно. Выберите их с помощью `transaction_uuids` или удалите все транзакции в приложении с помощью `delete_all: true`.\n\nУдаленная транзакция удаляется вместе с записями, относящимися исключительно к ней: её сторонами, тегами, заметками, связями способов оплаты, документами и всеми сохраненными версиями их файлов, запусками правил, оповещениями, результатами провайдеров, снимком сети и данными Travel Rule. Кейсы, люди и компании сохраняются; их связь с удаленной транзакцией очищается. Черновики регуляторных отчетов перестают включать её и перестраиваются без неё. Удаление является окончательным и необратимым; endpoint для отмены действия отсутствует.\n\nЕсли любая из выбранных транзакций указана в окончательно сформированном регуляторном отчете, весь запрос отклоняется с кодом `409`, и ничего не удаляется. В теле ответа возвращается `code: in_filed_report`, а также перечисляются каждая транзакция и включившие её отчеты. Удалите эти отчеты, затем повторите запрос.", "operationId": "batch_delete_transactions", "x-didit-sdk": { "resource": "transactions", "method": "batch_delete", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Transactions" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID организации." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID приложения." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "oneOf": [ { "title": "Selected transactions", "required": [ "transaction_uuids" ], "properties": { "transaction_uuids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "UUID транзакций Didit для удаления. Обязательно, если `delete_all` не равен true.", "minItems": 1 }, "delete_all": { "type": "boolean", "enum": [ false ], "default": false, "description": "Не указывайте или передайте `false`, если вы выбираете транзакции с помощью `transaction_uuids`." } } }, { "title": "All transactions", "required": [ "delete_all" ], "properties": { "delete_all": { "type": "boolean", "enum": [ true ], "description": "Удалить все транзакции в приложении. Параметр `transaction_uuids` игнорируется." }, "transaction_uuids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Игнорируется, если `delete_all` равно true." } } } ] }, "examples": { "Selected transactions": { "value": { "transaction_uuids": [ "abcdef12-3456-7890-abcd-ef1234567890", "12345678-90ab-cdef-1234-567890abcdef" ] } }, "All transactions": { "value": { "delete_all": true } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl (selected transactions)", "source": "curl -X DELETE 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/transactions/delete/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"transaction_uuids\": [\"abcdef12-3456-7890-abcd-ef1234567890\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nclient.transactions.batch_delete(\n body={\n \"transaction_uuids\": [\"abcdef12-3456-7890-abcd-ef1234567890\", \"12345678-90ab-cdef-1234-567890abcdef\"],\n },\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nawait didit.transactions.batchDelete({\n transaction_uuids: [\"abcdef12-3456-7890-abcd-ef1234567890\", \"12345678-90ab-cdef-1234-567890abcdef\"],\n});" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.TransactionsBatchDeleteParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.transactions().batchDelete(TransactionsBatchDeleteParams.builder()\n .putAdditionalProperty(\"transaction_uuids\", List.of(\"abcdef12-3456-7890-abcd-ef1234567890\", \"12345678-90ab-cdef-1234-567890abcdef\"))\n .build());" }, { "lang": "php", "label": "PHP", "source": "transactions->batchDelete([\n 'transaction_uuids' => ['abcdef12-3456-7890-abcd-ef1234567890', '12345678-90ab-cdef-1234-567890abcdef'],\n]);" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.transactions.batch_delete(\n body: {\n transaction_uuids: [\"abcdef12-3456-7890-abcd-ef1234567890\", \"12345678-90ab-cdef-1234-567890abcdef\"],\n }\n)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait client.Transactions.BatchDeleteAsync(new TransactionsBatchDeleteParams\n{\n TransactionUuids = new string[] { \"abcdef12-3456-7890-abcd-ef1234567890\", \"12345678-90ab-cdef-1234-567890abcdef\" },\n});" } ], "responses": { "204": { "description": "Выбранные транзакции удалены." }, "400": { "description": "Селектор транзакций не был указан.", "content": { "application/json": { "schema": { "type": "object", "properties": { "transaction_uuids": { "type": "array", "items": { "type": "string" } } } }, "example": { "transaction_uuids": [ "This field is required unless delete_all is true." ] } } } }, "403": { "description": "API-ключ не может удалять транзакции. endpoint требует `write:transactions`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "409": { "description": "Как минимум одна выбранная транзакция указана в окончательном регуляторном отчёте. Ничего не удалено.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InFiledReportError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/travel-rule/networks/": { "get": { "summary": "Получить сети Travel Rule", "description": "Считывает для данного приложения фактическое состояние каждой сети: использует ли она для отправки ваше членство или членство Didit и почему пока не может этого сделать. Также возвращает анкету должной осмотрительности и ваших участников. Чтение ничего не создаёт.", "operationId": "getTravelRuleNetworks", "x-didit-sdk": { "resource": "travel_rule.networks", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/travel-rule/networks/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.networks.retrieve()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.networks.retrieve();\nconsole.log(result);" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().networks().retrieve();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->networks->retrieve();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.networks.retrieve\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Networks.RetrieveAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Состояния сети, анкета и участники.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleNetworksOverview" }, "examples": { "Before the questionnaire": { "value": { "platform_networks_enabled": false, "questionnaire": { "status": "draft", "answers": {}, "submitted_at": null, "reviewed_at": null, "review_note": "", "history": [], "updated_at": null }, "participants": [], "networks": { "gtr": { "rail": "GTR", "mode": "unavailable", "state": "didit_onboarding", "reason": "didit_membership_not_live", "platform_available": false, "connected": false, "participant": null, "vasps_reachable": 0, "routed_30d": 0 }, "trust": { "rail": "TRUST", "mode": "unavailable", "state": "unavailable", "reason": "own_membership_only", "platform_available": false, "connected": false, "participant": null, "vasps_reachable": 0, "routed_30d": 0 }, "verifyvasp": { "rail": "VERIFYVASP", "mode": "unavailable", "state": "didit_onboarding", "reason": "didit_membership_not_live", "platform_available": false, "connected": false, "participant": null, "vasps_reachable": 0, "routed_30d": 0 }, "sygna": { "rail": "SYGNA", "mode": "unavailable", "state": "didit_onboarding", "reason": "didit_membership_not_live", "platform_available": false, "connected": false, "participant": null, "vasps_reachable": 0, "routed_30d": 0 } } } } } } } }, "401": { "description": "Отсутствует или недействителен API-ключ." } } } }, "/v3/travel-rule/networks/questionnaire/": { "get": { "summary": "Получить анкету сети", "description": "Получить анкету комплексной проверки сети Didit для этого приложения, её статус и заметку проверяющего Didit. Если приложение ни разу её не сохраняло, возвращается пустой черновик.", "operationId": "getTravelRuleNetworkQuestionnaire", "x-didit-sdk": { "resource": "travel_rule.networks", "method": "retrieve_questionnaire", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/travel-rule/networks/questionnaire/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.networks.retrieve_questionnaire()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.networks.retrieveQuestionnaire();\nconsole.log(result);" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().networks().retrieveQuestionnaire();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->networks->retrieveQuestionnaire();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.networks.retrieve_questionnaire\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Networks.RetrieveQuestionnaireAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Анкета.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleNetworkQuestionnaire" } } } }, "401": { "description": "Отсутствует или недействителен API-ключ." } } }, "put": { "summary": "Сохранить ответы анкеты сети", "description": "Сохранить ответы на анкету, пока она находится в статусе draft или changes_requested. Сохранение выполняется частично: неотправленные ответы сохраняются.", "operationId": "updateTravelRuleNetworkQuestionnaire", "x-didit-sdk": { "resource": "travel_rule.networks", "method": "update_questionnaire", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PUT https://verification.didit.me/v3/travel-rule/networks/questionnaire/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"legal_name\": \"Example VASP Ltd\", \"incorporation_country\": \"ES\", \"aml_ctf_policy_attested\": true}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.networks.update_questionnaire(\n legal_name=\"Example VASP Ltd\",\n incorporation_country=\"ES\",\n aml_ctf_policy_attested=True,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.networks.updateQuestionnaire({\n legal_name: \"Example VASP Ltd\",\n incorporation_country: \"ES\",\n aml_ctf_policy_attested: true,\n});\nconsole.log(result);" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleNetworkQuestionnaireAnswers;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().networks().updateQuestionnaire(TravelRuleNetworkQuestionnaireAnswers.builder()\n .legalName(\"Example VASP Ltd\")\n .incorporationCountry(\"ES\")\n .amlCtfPolicyAttested(true)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->networks->updateQuestionnaire([\n 'legal_name' => 'Example VASP Ltd',\n 'incorporation_country' => 'ES',\n 'aml_ctf_policy_attested' => true,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.networks.update_questionnaire(\n legal_name: \"Example VASP Ltd\",\n incorporation_country: \"ES\",\n aml_ctf_policy_attested: true\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Networks.UpdateQuestionnaireAsync(new TravelRuleNetworkQuestionnaireAnswers\n{\n LegalName = \"Example VASP Ltd\",\n IncorporationCountry = \"ES\",\n AmlCtfPolicyAttested = true,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleNetworkQuestionnaireAnswers" }, "example": { "legal_name": "Example VASP Ltd", "incorporation_country": "ES", "aml_ctf_policy_attested": true } } } }, "responses": { "200": { "description": "Анкета с объединёнными ответами.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleNetworkQuestionnaire" } } } }, "400": { "description": "Ошибка валидации, с ключами по полям." }, "401": { "description": "Отсутствует или недействителен API-ключ." }, "403": { "description": "Доступ к сети через членство Didit пока не открыт.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "travel_rule_platform_networks_disabled" ] } } } } } }, "409": { "description": "Анкета находится на стороне Didit или по ней принято решение: её можно изменять только в статусе draft или changes_requested.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "travel_rule_questionnaire_not_editable" ] } } } } } } } } }, "/v3/travel-rule/networks/questionnaire/submit/": { "post": { "summary": "Отправить анкету сети", "description": "Отправьте сохранённую анкету на проверку в Didit. Сохранённые ответы должны быть заполнены полностью: каждое поле, кроме lei и data_protection_contact_email, при значении true у всех трёх аттестаций. Didit одобряет её, запрашивает изменения (отредактируйте и отправьте повторно) или отклоняет. Сети, запрошенные в период ожидания, передаются на их онбординг после одобрения.", "operationId": "submitTravelRuleNetworkQuestionnaire", "x-didit-sdk": { "resource": "travel_rule.networks", "method": "submit_questionnaire", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/networks/questionnaire/submit/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.networks.submit_questionnaire()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.networks.submitQuestionnaire();\nconsole.log(result);" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().networks().submitQuestionnaire();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->networks->submitQuestionnaire();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.networks.submit_questionnaire\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Networks.SubmitQuestionnaireAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Отправленная анкета.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleNetworkQuestionnaire" } } } }, "400": { "description": "Сохранённые ответы неполны или недействительны, сгруппированы по полям." }, "401": { "description": "Отсутствует или недействителен API-ключ." }, "403": { "description": "Доступ к сети через членство Didit пока не открыт.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "travel_rule_platform_networks_disabled" ] } } } } } }, "409": { "description": "Анкета находится на стороне Didit или по ней принято решение: её можно изменять только в статусе draft или changes_requested.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "travel_rule_questionnaire_not_editable" ] } } } } } } } } }, "/v3/travel-rule/networks/{network}/request/": { "post": { "summary": "Запросить сеть Travel Rule", "description": "Запросить создание собственного участника этого приложения в сети, поддерживаемой через членство Didit (GTR или Sygna). Без одобренной анкеты участник ожидает её (questionnaire_pending); с ней он переходит к онбордингу в сети (submitted_to_network) и становится активным, когда сеть присваивает ему код. Идемпотентно: участник со статусом ожидания, онбординга или работающий в продакшне возвращается без изменений. Если сеть отклонила регистрацию (установлен last_error), повторный запрос запускает новую попытку. Доступ к TRUST и VerifyVASP возможен только через ваше собственное членство: TRUST принимает участников на уровне VASP, а анклав VerifyVASP обслуживает один ID VASP.", "operationId": "requestTravelRuleNetworkAccess", "x-didit-sdk": { "resource": "travel_rule.networks", "method": "request_access", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "network", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "gtr", "sygna" ] }, "description": "Сеть для подключения через членство Didit." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/networks/gtr/request/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.networks.request_access(\n \"your-network\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.networks.requestAccess(\"your-network\");\nconsole.log(result);" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().networks().requestAccess(\"your-network\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->networks->requestAccess('your-network');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.networks.request_access(\"your-network\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Networks.RequestAccessAsync(\"your-network\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Ваш участник сети.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleNetworkParticipant" } } } }, "400": { "description": "Неизвестная сеть, сеть, которую Didit не поддерживает (подключите собственное членство), или приложение в песочнице.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "travel_rule_network_own_membership_only", "travel_rule_network_sandbox_application" ] } } } } } }, "401": { "description": "Отсутствует или недействителен API-ключ." }, "403": { "description": "Доступ к сети через членство Didit пока не открыт.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "travel_rule_platform_networks_disabled" ] } } } } } } } } }, "/v3/address-validation/": { "post": { "summary": "Проверить адрес", "description": "Подтвердите факт существования адреса и получите его в нормализованном виде: строки доставки, компоненты и координаты. Проверяется только адрес; он никогда не связывается с человеком.\n\n**Запрос.** Отправьте адрес одной строкой (`address`) или структурированными полями (`address_line_1` и, опционально, `address_line_2`, `city`, `region`, `postal_code`), но не обоими способами одновременно, и обязательно укажите `country` (ISO 3166-1 alpha-2 или alpha-3).\n\n**Результат.** `address_validation.status` принимает значение `verified` (подтверждён до здания), `partially_verified` (подтверждён только до улицы или выше), `not_verified` (совпали только регион или город, либо совпадений нет) или `unavailable` (проверку не удалось выполнить). Код HTTP: `200` для каждого завершённого запроса, включая `unavailable`; повторите запрос с результатом `unavailable` позже.\n\n**Биллинг.** Запрос в продакшене стоит $0.10 за проверенный адрес. Результат `unavailable` не тарифицируется. Ничего не сохраняется, кроме записи об использовании: сессия не создаётся, а результат возвращается только в этом ответе.\n\n**Песочница.** Ключи песочницы проверяют корректность запроса и всегда детерминированно возвращают результат `verified`, дублирующий переданный адрес, без списания кредитов.\n\n**Аутентификация.** Передавайте API-ключ вашего приложения в заголовке `x-api-key`. При отсутствии или недействительности учётных данных возвращается `403` - этот API никогда не возвращает `401`.\n\n**Лимит запросов.** Общий лимит на запись составляет 300 запросов в минуту на API-ключ для endpoints POST/PATCH/DELETE (создание транзакций и отправка событий имеют отдельный лимит в 600).", "operationId": "post_v3_address_validation", "x-didit-sdk": { "resource": "address_validation", "method": "validate", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/address-validation/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"address_line_1\": \"1600 Amphitheatre Pkwy\",\n \"city\": \"Mountain View\",\n \"region\": \"CA\",\n \"postal_code\": \"94043\",\n \"country\": \"US\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.address_validation.validate(\n address_line_1=\"1600 Amphitheatre Pkwy\",\n city=\"Mountain View\",\n region=\"CA\",\n postal_code=\"94043\",\n country=\"US\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.addressValidation.validate({\n address_line_1: \"1600 Amphitheatre Pkwy\",\n city: \"Mountain View\",\n region: \"CA\",\n postal_code: \"94043\",\n country: \"US\",\n});\nconsole.log(result);" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.AddressValidationRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.addressValidation().validate(AddressValidationRequest.builder()\n .addressLine1(\"1600 Amphitheatre Pkwy\")\n .city(\"Mountain View\")\n .region(\"CA\")\n .postalCode(\"94043\")\n .country(\"US\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "addressValidation->validate([\n 'address_line_1' => '1600 Amphitheatre Pkwy',\n 'city' => 'Mountain View',\n 'region' => 'CA',\n 'postal_code' => '94043',\n 'country' => 'US',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.address_validation.validate(\n address_line_1: \"1600 Amphitheatre Pkwy\",\n city: \"Mountain View\",\n region: \"CA\",\n postal_code: \"94043\",\n country: \"US\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.AddressValidation.ValidateAsync(new AddressValidationRequest\n{\n AddressLine1 = \"1600 Amphitheatre Pkwy\",\n City = \"Mountain View\",\n Region = \"CA\",\n PostalCode = \"94043\",\n Country = \"US\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressValidationRequest" }, "examples": { "Structured": { "summary": "Структурированные поля адреса", "value": { "address_line_1": "1600 Amphitheatre Pkwy", "city": "Mountain View", "region": "CA", "postal_code": "94043", "country": "US" } }, "One line": { "summary": "Полный адрес одной строкой", "value": { "address": "Paseo de la Castellana 259, 28046 Madrid", "country": "ES" } } } } } }, "responses": { "200": { "description": "Проверка завершена. Проверьте `address_validation.status`; HTTP-код для завершённого запроса всегда `200`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressValidationResponse" }, "examples": { "Verified": { "summary": "Реальный адрес, подтверждённый вплоть до здания", "value": { "request_id": "6f7d2c1e-1c5a-4a1e-9b8f-2a1f0f4b9c3d", "address_validation": { "status": "verified", "verification_level": "premise", "address": { "address_line_1": "1600 Amphitheatre Pkwy", "address_line_2": null, "city": "Mountain View", "region": "CA", "postal_code": "94043-1351", "country": "US" }, "formatted_address": "1600 Amphitheatre Pkwy, Mountain View CA 94043-1351", "latitude": 37.422022, "longitude": -122.08429 }, "created_at": "2026-10-27T11:20:00.000000+00:00" } }, "Not verified": { "summary": "Вымышленная улица: совпал только город", "value": { "request_id": "0b9e3f4a-6c2d-4e8b-a1f7-5d3c2b1a0e9f", "address_validation": { "status": "not_verified", "verification_level": "locality", "address": { "address_line_1": "Calle Inventada Que No Existe 99999 28046", "address_line_2": null, "city": "Madrid", "region": "Madrid", "postal_code": null, "country": "ES" }, "formatted_address": "Calle Inventada Que No Existe 99999 28046, Madrid, MADRID, SPAIN", "latitude": 40.42603054, "longitude": -3.68645331 }, "created_at": "2026-10-27T11:21:00.000000+00:00" } }, "Unavailable": { "summary": "Проверку не удалось выполнить; плата не взимается", "value": { "request_id": "3c1b2a0f-9e8d-4c7b-b6a5-1f0e9d8c7b6a", "address_validation": { "status": "unavailable", "verification_level": null, "address": null, "formatted_address": null, "latitude": null, "longitude": null }, "created_at": "2026-10-27T11:22:00.000000+00:00" } } } } } }, "400": { "$ref": "#/components/responses/AddressValidationValidationError" }, "403": { "$ref": "#/components/responses/AddressValidationPermissionDenied" }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } } } }, "/v3/travel-rule/wallet-proofs/": { "get": { "summary": "Получить список подтверждений кошелька по скриншоту для проверки", "description": "Ваша очередь проверки подтверждений владения кошельком по скриншоту. Скриншот является единственным подтверждением, которое Didit не может проверить автоматически: после загрузки конечным пользователем из виджета оно остаётся в статусе PENDING, пока вы не одобрите или не отклоните его с помощью POST /v3/travel-rule/wallet-proofs/{proof_uuid}/decision/. Сначала самые старые, поэтому очередь обрабатывается начиная с подтверждения, которое ожидает дольше всего. Отображаются только загруженные скриншоты; подтверждения, для которых конечный пользователь ещё не загрузил файл, или подтверждения для кошелька, удалённого вами из адресной книги (Didit закрывает их со статусом OWNERSHIP_CHANGED), никогда не отображаются.", "operationId": "listTravelRuleWalletProofs", "x-didit-sdk": { "resource": "travel_rule.wallet_proofs", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "status", "in": "query", "description": "Какие подтверждения возвращать в списке. По умолчанию PENDING, то есть те, по которым ещё предстоит принять решение.", "schema": { "type": "string", "enum": [ "PENDING", "VERIFIED", "REJECTED", "EXPIRED" ], "default": "PENDING" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl https://verification.didit.me/v3/travel-rule/wallet-proofs/?status=PENDING \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.travel_rule.wallet_proofs.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.travelRule.walletProofs.list()) {\n console.log(item);\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.travelRule().walletProofs().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "travelRule->walletProofs->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.travel_rule.wallet_proofs.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.TravelRule.WalletProofs.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Скриншоты-подтверждения с пагинацией. Значение count точно для значений до 100 и ограничивается значением 100 для больших значений.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleWalletProofReview" } } } } } } }, "400": { "description": "Неизвестный статус." }, "401": { "description": "Отсутствует или недействителен x-api-key." }, "403": { "description": "У вызывающей стороны отсутствует разрешение для работы с транзакциями." } } } }, "/v3/travel-rule/wallet-proofs/{proof_uuid}/decision/": { "post": { "summary": "Одобрить или отклонить скриншот-подтверждение кошелька", "description": "Принять решение по подтверждению скриншотом из вашей очереди на проверку. approve верифицирует подтверждение и запись в адресной книге и применяет структуру владения к переводу, для которого была создана сессия виджета, в точности как подтверждённая подпись. Скриншот никогда не подтверждает перевод, отправленный другим клиентом Didit по каналу INTERNAL: для этого требуется подписанное сообщение или тестовый депозит. reject закрывает подтверждение со статусом REJECTED и причиной failure_reason REVIEW_REJECTED; конечный пользователь может запустить новое подтверждение из виджета. Заметка сохраняется вместе с подтверждением.", "operationId": "decideTravelRuleWalletProof", "x-didit-sdk": { "resource": "travel_rule.wallet_proofs", "method": "decide", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "proof_uuid", "in": "path", "required": true, "description": "proof_id из очереди на проверку.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWalletProofDecision" }, "example": { "decision": "approve", "note": "Address matches the wallet app." } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/wallet-proofs/{proof_uuid}/decision/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"decision\": \"approve\", \"note\": \"Address matches the wallet app.\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.wallet_proofs.decide(\n \"11111111-2222-3333-4444-555555555555\",\n decision=\"approve\",\n note=\"Address matches the wallet app.\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.walletProofs.decide(\"11111111-2222-3333-4444-555555555555\", {\n decision: \"approve\",\n note: \"Address matches the wallet app.\",\n});\nconsole.log(result);" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleWalletProofDecision;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().walletProofs().decide(\"11111111-2222-3333-4444-555555555555\", TravelRuleWalletProofDecision.builder()\n .decision(TravelRuleWalletProofDecision.Decision.of(\"approve\"))\n .note(\"Address matches the wallet app.\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->walletProofs->decide('11111111-2222-3333-4444-555555555555', [\n 'decision' => 'approve',\n 'note' => 'Address matches the wallet app.',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.wallet_proofs.decide(\n \"11111111-2222-3333-4444-555555555555\",\n decision: \"approve\",\n note: \"Address matches the wallet app.\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.WalletProofs.DecideAsync(\"11111111-2222-3333-4444-555555555555\", new TravelRuleWalletProofDecision\n{\n Decision = \"approve\",\n Note = \"Address matches the wallet app.\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Документ, по которому принято решение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWalletProofReview" } } } }, "400": { "description": "Недопустимое решение или заметка длиннее 512 символов." }, "401": { "description": "Отсутствует или недействителен x-api-key." }, "403": { "description": "У вызывающей стороны отсутствует разрешение для работы с транзакциями." }, "404": { "description": "Отправленное подтверждение в виде скриншота с этим id не найдено в вашем приложении." }, "409": { "description": "По подтверждению уже принято решение (тело ответа содержит его статус) или возвращен код OWNERSHIP_CHANGED: владелец кошелька сменился либо кошелек был удален после создания сессии виджета, поэтому подтверждение закрыто и текущему владельцу требуется новое.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofError" } } } } } } }, "/v3/travel-rule/widget/{token}/proofs/": { "post": { "summary": "Запустить подтверждение владения кошельком", "description": "Публичный endpoint с доступом по token сессии виджета, API-ключ не требуется: размещенный виджет вызывает его, когда конечный пользователь выбирает метод подтверждения. Подтверждение создается и учитывается в вашей воронке подтверждений только после этого вызова. Повторный выбор того же метода возвращает уже открытое подтверждение (200, тот же челендж или сумма депозита) вместо создания второго; выбор другого метода закрывает незавершенное со статусом METHOD_SWITCHED, за исключением уже отправленного скриншота или тестового депозита, находящегося на проверке. MESSAGE_SIGNING возвращает челендж для подписания; SATOSHI_TEST возвращает адрес депозита, точную сумму и временное окно; SELF_DECLARATION проверяется мгновенно (статус VERIFIED). Форматы подписей проверяются в зависимости от семейства сетей: для EVM-сетей требуется подпись personal_sign (EIP-191) в hex-кодировке; для Bitcoin требуется подпись signmessage по стандарту BIP-137 (адреса P2PKH, P2SH-P2WPKH и P2WPKH) или простая подпись BIP-322 (адреса P2WPKH и P2TR) в кодировке base64; для Solana требуется подпись Ed25519 для челенджа в кодировке base58; для Tron требуется подпись signMessageV2 (TIP-191) в hex-кодировке. Полная подпись BIP-322, подпись подтверждения наличия средств или мультисиг-адрес завершаются ошибкой с кодом SIGNATURE_UNSUPPORTED_SCHEME.", "operationId": "createTravelRuleWidgetProof", "x-didit-sdk": { "resource": "travel_rule", "method": "create_widget_proof", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "description": "Непрозрачный токен сессии, возвращённый при создании сессии виджета.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofCreate" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/widget/{token}/proofs/ \\\n -H 'Content-Type: application/json' \\\n -d '{\"method\": \"MESSAGE_SIGNING\"}'" } ], "responses": { "201": { "description": "Новое подтверждение в статусе PENDING (VERIFIED для SELF_DECLARATION).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofSummary" } } } }, "200": { "description": "Подтверждение, уже открытое для этого метода, возобновлено.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofSummary" } } } }, "400": { "description": "Недопустимое тело запроса, кошелёк не соответствует переводу, SCREENSHOT не разрешён или код CHAIN_UNSUPPORTED, если метод недоступен в данной сети.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofError" } } } }, "403": { "description": "SELF_DECLARATION не разрешено для этого приложения." }, "404": { "description": "Неизвестный token." }, "409": { "description": "код OWNERSHIP_CHANGED: владелец кошелька изменился или кошелёк был удалён после создания сессии; создайте новую сессию для текущего владельца. Также возвращается для SATOSHI_TEST, когда у сессии нет satoshi_deposit_address, и когда у сессии не осталось попыток (без кода; тело содержит max_attempts, attempts_used и attempts_remaining 0): создайте новую сессию.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofError" } } } }, "410": { "description": "Срок действия сессии истек." } } } }, "/v3/travel-rule/widget/{token}/proofs/{proof_id}/verify/": { "post": { "summary": "Отправить доказательство владения кошельком", "description": "Публичный endpoint с доступом по токену сессии виджета, API-ключ не требуется. Отправьте подтверждение, необходимое для выбранного метода: подпись для MESSAGE_SIGNING, txid для SATOSHI_TEST (JSON) или файл для SCREENSHOT (multipart). Каждая отправка считается попыткой. Подпись, не прошедшая проверку, или депозит, не соответствующий ожидаемому, возвращают 400 с кодом ошибки и оставляют подтверждение в статусе PENDING, чтобы конечный пользователь мог повторить попытку. Обнаруженный, но еще не подтвержденный депозит возвращает 200 со статусом PENDING и перепроверяется автоматически до закрытия окна. Скриншот возвращает 200 со статусом PENDING и ожидает в вашей очереди на проверку (GET /v3/travel-rule/wallet-proofs/). Подтверждение со статусом EXPIRED или REJECTED больше никогда не станет проверенным: создайте новое. Форматы подписей проверяются в зависимости от семейства сетей: для EVM-сетей требуется подпись personal_sign (EIP-191) в hex-кодировке; для Bitcoin требуется подпись signmessage по стандарту BIP-137 (адреса P2PKH, P2SH-P2WPKH и P2WPKH) или простая подпись BIP-322 (адреса P2WPKH и P2TR) в кодировке base64; для Solana требуется подпись Ed25519 для челленджа в кодировке base58; для Tron требуется подпись signMessageV2 (TIP-191) в hex-кодировке. Полная подпись BIP-322, подпись подтверждения наличия средств или мультисиг-адрес завершаются ошибкой с кодом SIGNATURE_UNSUPPORTED_SCHEME.", "operationId": "verifyTravelRuleWidgetProof", "x-didit-sdk": { "resource": "travel_rule", "method": "verify_widget_proof", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "description": "Непрозрачный токен сессии, возвращённый при создании сессии виджета.", "schema": { "type": "string" } }, { "name": "proof_id", "in": "path", "required": true, "description": "proof_id, возвращённый при запуске подтверждения.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "signature": { "type": "string", "description": "MESSAGE_SIGNING: подпись кошелька для challenge доказательства." }, "txid": { "type": "string", "description": "SATOSHI_TEST: идентификатор транзакции тестового депозита." } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary", "description": "SCREENSHOT: изображение, показывающее кошелёк в приложении кошелька конечного пользователя." } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/widget/{token}/proofs/{proof_id}/verify/ \\\n -H 'Content-Type: application/json' \\\n -d '{\"signature\": \"0x...\"}'" } ], "responses": { "200": { "description": "VERIFIED или всё ещё PENDING (скриншот ожидает проверки, депозит ещё не проиндексирован или не подтверждён, с кодом DEPOSIT_NOT_FOUND или DEPOSIT_UNCONFIRMED).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofVerifyResult" } } } }, "400": { "description": "Отсутствуют подтверждающие данные; неудачная попытка, оставляющая подтверждение в статусе PENDING, чтобы конечный пользователь мог повторить попытку (код SIGNATURE_INVALID, SIGNATURE_UNSUPPORTED_SCHEME или DEPOSIT_LOOKUP_FAILED); либо тестовый депозит, отклоняющий подтверждение (код DEPOSIT_MISMATCH, DEPOSIT_STALE или TXID_REUSED, статус REJECTED, со счетчиками попыток сессии): повторный выбор метода запускает новое подтверждение, пока attempts_remaining больше 0.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofError" } } } }, "404": { "description": "Неизвестный token или такое подтверждение отсутствует в этой сессии." }, "409": { "description": "код OWNERSHIP_CHANGED (подтверждение закрывается с ним); закрытое подтверждение (REJECTED или EXPIRED) с его статусом, кодом, с которым оно закрылось, и количеством попыток в сессии: выберите метод заново, чтобы начать новое подтверждение; либо подтверждение SELF_DECLARATION, которое считается верифицированным сразу после запуска.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofError" } } } }, "410": { "description": "Срок действия сессии истек, либо возвращен код WINDOW_EXPIRED при закрытии окна теста Сатоши.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofError" } } } } } } }, "/v3/id-verification/wallets/verifications/{request_id}/response/": { "post": { "operationId": "submit_wallet_verification_response", "x-didit-sdk": { "resource": "id_wallets", "method": "submit_verification_response", "auth": "api_key", "server": true }, "description": "Кошельки Digital Credentials API (Google Wallet): отправьте то, что кошелёк вернул вашей странице или приложению, для верификации, у которой next_action равен request_digital_credential. Didit расшифровывает данные, проверяет подпись эмитента по доверенным корневым сертификатам эмитента, каждое возвращённое значение по его подписанному дайджесту, а подпись устройства относительно вашего origin и этого запроса, после чего выносит решение по верификации: verified (с однократным списанием средств) или declined с кодом ошибки. Одноразовое использование: повторная отправка возвращает уже принятое решение по верификации.", "summary": "Отправить ответ кошелька", "parameters": [ { "in": "path", "name": "request_id", "schema": { "type": "string", "format": "uuid" }, "description": "request_id, возвращённый endpoint запуска.", "required": true } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletDigitalCredentialResponseRequest" }, "example": { "response": { "protocol": "openid4vp-v1-signed", "data": { "response": "" } } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletDigitalCredentialResponseRequest" }, "example": { "response": { "protocol": "openid4vp-v1-signed", "data": { "response": "" } } } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletDigitalCredentialResponseRequest" }, "example": { "response": { "protocol": "openid4vp-v1-signed", "data": { "response": "" } } } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "google_wallet", "name": "Google Wallet", "issuing_authority": "Google Wallet (ID pass) and US state issuers (mobile driving licence)" }, "country": "USA", "status": "Approved", "outcome": "verified", "error": null, "interaction": "digital_credentials", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": null, "identity": { "full_name": "Alex Example", "first_name": "Alex", "last_name": "Example", "date_of_birth": "1990-01-31", "nationality": "USA", "issuing_state": "USA" }, "attributes": { "document_number": "X0000000", "document_expiry_date": "2030-01-31" }, "level_of_assurance": "substantial", "verified_at": "2026-01-01T10:01:00Z", "signature_valid": true, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiClientCredentialsForbiddenErrorMessage" } } }, "description": "Отсутствуют учетные данные (x-api-key или Authorization: Bearer)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка not_found: у этого приложения нет верификации кошелька с таким request_id." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]})." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка not_a_digital_credentials_wallet: эта верификация не принимает ответ от кошелька." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может верифицировать кошелёк." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/verifications/REQUEST_ID/response/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"response\": {\n \"protocol\": \"openid4vp-v1-signed\",\n \"data\": {\n \"response\": \"\"\n }\n }\n}'" } ] } }, "/v3/id-verification/wallets/google-wallet/": { "post": { "operationId": "start_google_wallet_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_google_wallet", "auth": "api_key", "server": true }, "description": "Запустить вход через Google Wallet (Google Wallet (ID pass) и эмитенты штатов США (мобильные водительские удостоверения); USA, GBR, BRA, SGP, TWN) без какого-либо сценария. Тарифицируется один раз, только после успешной верификации личности. Ответ содержит next_action.type=request_digital_credential с запросом, подписанным Didit для вашего приложения, доступным для использования только с origin. При пользовательском действии на этой странице передайте next_action.digital_credentials.request в navigator.credentials.get({digital: ...}) (или в Android Credential Manager как GetDigitalCredentialOption requestJson), затем отправьте результат от кошелька через POST на /v3/id-verification/wallets/verifications/{request_id}/response/. Браузер предложит собственный QR-код, если кошелёк находится на другом устройстве. Приложения в песочнице получают детерминированную симуляцию (simulated: true), которая никогда не обращается к провайдеру.", "summary": "Запустить верификацию через Google Wallet", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Необязательный ключ для безопасного повтора запроса (макс. 255 символов). Повторная попытка с тем же ключом, кошельком и телом запроса возвращает исходную верификацию без запуска повторного входа; тот же ключ с другим кошельком или телом запроса возвращает 409 idempotency_key_reused." } ], "tags": [ "Digital ID wallets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiGoogleWalletWalletVerificationStartRequest" }, "example": { "country": "USA", "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "origin": "https://app.example.com" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiGoogleWalletWalletVerificationStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiGoogleWalletWalletVerificationStartRequest" } } }, "required": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResponse" }, "example": { "request_id": "00000000-0000-4000-8000-000000000001", "wallet_verification": { "wallet": { "id": "google_wallet", "name": "Google Wallet", "issuing_authority": "Google Wallet (ID pass) and US state issuers (mobile driving licence)" }, "country": "USA", "status": "Not Finished", "outcome": "pending", "error": null, "interaction": "digital_credentials", "simulated": false, "expires_at": "2026-01-01T10:10:00Z", "next_action": { "type": "request_digital_credential", "digital_credentials": { "protocol": "openid4vp-v1-signed", "request": { "requests": [ { "protocol": "openid4vp-v1-signed", "data": { "request": "" } } ] } } }, "identity": null, "attributes": null, "level_of_assurance": null, "verified_at": null, "signature_valid": null, "credential_type": "person_identification" }, "vendor_data": "your-customer-reference", "metadata": { "reference": "example" }, "created_at": "2026-01-01T10:00:00Z" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Ошибки валидации полей ({field: [messages]}) или ошибка return_url_invalid, return_url_not_allowed, origin_invalid, origin_not_allowed, invalid_personal_code, invalid_phone_number либо idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Отсутствуют учетные данные ({detail}), либо возникла ошибка wallet_unavailable, insufficient_credits или contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка idempotency_key_reused или idempotency_key_in_progress (с заголовком Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_provider_unavailable: не удалось запустить провайдера; ничего не было создано." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "ошибка wallet_not_configured: эта среда не может связаться с кошельком." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/google-wallet/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"USA\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"origin\": \"https://app.example.com\"\n}'" } ], "x-didit-wallet-id": "google_wallet" } }, "/v3/session/{sessionId}/kyb/documents/": { "post": { "summary": "Загрузить документы KYB в сессию", "description": "Загрузить один или несколько корпоративных документов (устав, реестр акционеров, свидетельство о регистрации и т. д.) на шаге «Документы KYB» сессии верификации бизнеса напрямую со своего сервера вместо размещённой страницы. Didit выполняет стандартный пайплайн: сжатие, OCR, проверки на вмешательство или подделку и сопоставление между документами, группировку документов и переводит сессию на следующий этап, когда требования к обязательным группам документов выполнены. Шаг оплачивается по фиксированной цене вне зависимости от количества переданных файлов. Сессия должна быть открыта и находиться на шаге «Документы KYB», а компания, выбранная на шаге реестра, должна существовать. Получить список лиц, указанных в документах, можно с помощью `GET /v3/session/{sessionId}/kyb/extracted-parties/`. Требуется право `write:businesses`.", "operationId": "post_v3_session_kyb_documents", "x-didit-sdk": { "resource": "sessions", "method": "upload_kyb_documents", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID сессии Верификации бизнеса (KYB). Он должен принадлежать приложению используемого API-ключа.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "node_id", "in": "query", "required": false, "description": "Узел сценария для шага KYB. Требуется, только если в сценарии несколько KYB-узлов; по умолчанию Didit использует собственный узел сессии.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "documents" ], "properties": { "documents": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "Файлы для загрузки: JPG, JPEG, PNG, TIFF, WEBP, PDF или ZIP-архивы с ними. Файлы PDF до 50 МБ, фотографии до 6 МБ до сжатия." }, "document_passwords": { "type": "array", "items": { "type": "string" }, "description": "Одна запись на каждый файл в `documents` в том же порядке: пароль для защищённого PDF, пусто для любого другого файла." }, "document_group": { "type": "string", "enum": [ "LEGAL_PRESENCE", "COMPANY_DETAILS", "OWNERSHIP_STRUCTURE", "REPRESENTATIVES_AUTHORIZATION" ], "description": "Обязательная группа документов, которую покрывает эта загрузка." }, "locale": { "type": "string", "maxLength": 10, "description": "Локаль, используемая для перевода ответа следующего шага." } } } } } }, "responses": { "200": { "description": "Обработанные документы. Когда требования для каждой обязательной группы выполнены, сессия переходит на следующий шаг, и `next_step` указывает имя следующего шага; в противном случае она остаётся на шаге «Документы», а `document_groups` и `document_answer` указывают, чего именно не хватает.", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "next_step": { "type": "string", "nullable": true, "description": "Шаг, на котором находится сессия после загрузки." }, "kyb_status": { "type": "string", "description": "Статус проверки компании." }, "document_answer": { "type": "object", "additionalProperties": true, "description": "Результат по каждому загруженному документу и оставшиеся загрузки." } }, "additionalProperties": true }, "example": { "valid": true, "next_step": "KYB_KEY_PEOPLE", "kyb_status": "In Progress" } } } }, "400": { "description": "Документ был отклонён (признаки вмешательства, нечитаемый или неподдерживаемый) либо в сессии ещё не указана компания для KYB. Повторите попытку с другим файлом, пока остаются попытки.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "example": { "message": "No KYB company found. Submit company data first." } } } }, "402": { "description": "У организации не осталось кредитов для шага с документами.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "example": { "detail": "Insufficient credits." } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Это единственный случай, возвращающий `401`: отсутствующий, недействительный или отозванный ключ возвращает `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Expired key": { "summary": "Срок действия ключа истёк", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Ошибка аутентификации или авторизации. Отсутствующий ключ возвращает `403`, как и ключ другого приложения, ключ с ограниченной областью действия без необходимого для этого endpoint разрешения, а также запрос не из разрешённого списка IP-адресов ключа; неверный, отозванный или истекший ключ возвращает `401`. Различайте их по полю `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Missing or invalid credentials": { "summary": "Заголовок x-api-key отсутствует, либо ключ не прошёл валидацию", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Действительный ключ, принадлежащий приложению, отличному от приложения сессии", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "У ключа с ограниченной областью действия отсутствует разрешение decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Запрос с IP-адреса вне списка разрешённых IP ключа", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Сессия не существует, была удалена, принадлежит другому приложению или находится за пределами ограничений ключа с ограниченным доступом; подробности не позволяют различить эти случаи.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "example": { "detail": "Session not found." } } } }, "409": { "description": "Сессия завершена (`kyb_session_not_writable`) или не находится на шаге KYB Documents (`kyb_step_mismatch`, где `next_step` указывает текущий шаг).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." }, "code": { "type": "string" }, "next_step": { "type": "string" } } }, "example": { "detail": "The session is not on the step this operation completes.", "code": "kyb_step_mismatch", "next_step": "KYB_REGISTRY" } } } }, "429": { "description": "Превышен лимит запросов: 300 запросов на запись (POST, PATCH, DELETE) в минуту на один API-ключ. Подождите указанное в `Retry-After` количество секунд перед повторной попыткой; заголовки `X-RateLimit-*` показывают доступный лимит.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Rate limited": { "summary": "Бюджет на текущую минуту исчерпан", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } }, "503": { "$ref": "#/components/responses/DocumentProcessingBusy" } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.upload_kyb_documents(\n \"33333333-4444-5555-6666-777777777777\",\n documents=[open(\"document.pdf\", \"rb\")],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.uploadKybDocuments(\"33333333-4444-5555-6666-777777777777\", {\n documents: [await fileFromPath(\"document.pdf\")],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UploadKYBDocuments(ctx, \"33333333-4444-5555-6666-777777777777\", didit.SessionsUploadKYBDocumentsParams{\n\tDocuments: []didit.File{didit.FileFromPath(\"document.pdf\")},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.SessionsUploadKybDocumentsParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().uploadKybDocuments(\"33333333-4444-5555-6666-777777777777\", SessionsUploadKybDocumentsParams.builder()\n .documents(List.of(Path.of(\"document.pdf\")))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->uploadKybDocuments('33333333-4444-5555-6666-777777777777', [\n 'documents' => [File::fromPath('document.pdf')],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.upload_kyb_documents(\n \"33333333-4444-5555-6666-777777777777\",\n documents: [Pathname(\"document.pdf\")]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UploadKybDocumentsAsync(\"33333333-4444-5555-6666-777777777777\", new SessionsUploadKybDocumentsParams\n{\n Documents = new FileUpload[] { FileUpload.FromPath(\"document.pdf\") },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/kyb/extracted-parties/": { "get": { "summary": "Получить список сторон, указанных в загруженных документах", "description": "Возвращает акционеров и директоров, указанных в загруженных в эту KYB-сессию документах, объединённых по каждому человеку и соотнесённых с указавшими их документами. Покажите их заявителю для подтверждения, затем объявите их с помощью endpoint для черновиков сторон. Диапазон остаётся диапазоном: `ownership_percent.text` сохраняет исходное значение, а `min` / `max` содержат извлечённые из него числа. На этом этапе никто не помечается как UBO; это определяется при отправке сторон на основе настроек ролей и порогов владения в сценарии. Этот же список содержится в решении по сессии в поле `document_verifications[].extracted_parties`. Требует `read:businesses` или `read:sessions`.", "operationId": "get_v3_session_kyb_extracted_parties", "x-didit-sdk": { "resource": "sessions", "method": "list_kyb_extracted_parties", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID сессии Верификации бизнеса (KYB). Он должен принадлежать приложению используемого API-ключа.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "node_id", "in": "query", "required": false, "description": "Узел сценария для шага KYB. Требуется, только если в сценарии несколько KYB-узлов; по умолчанию Didit использует собственный узел сессии.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Стороны, указанные в текущих документах.", "content": { "application/json": { "schema": { "type": "object", "required": [ "parties", "document_count" ], "properties": { "parties": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "entity_type": { "type": "string", "enum": [ "person", "company" ] }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "appointment_date": { "type": "string", "nullable": true }, "designation": { "type": "string", "nullable": true }, "roles": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ] }, "ownership_percent": { "type": "object", "properties": { "text": { "type": "string", "nullable": true, "description": "Доля владения в точности так, как указано в документе, например `25-50%`, `>50%` или `NO EXHIBE`." }, "min": { "type": "number", "nullable": true, "description": "Меньшее число, извлечённое из `text`; null, если оно не указано." }, "max": { "type": "number", "nullable": true, "description": "Верхнее число, распознанное из `text`; null, если оно отсутствует." } } } } } }, "documents": { "type": "array", "description": "Загруженные документы, в которых указана эта сторона.", "items": { "type": "object", "properties": { "document_uuid": { "type": "string", "format": "uuid" }, "document_type": { "type": "string", "nullable": true }, "document_subtype": { "type": "string", "nullable": true }, "original_filename": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true } } } } } }, "description": "Акционеры и директора, указанные в загруженных документах, объединённые по каждому лицу. Здесь никто не помечается как UBO: это определяется при отправке сторон." }, "document_count": { "type": "integer", "description": "Количество загруженных документов, из которых был прочитан список." }, "node_id": { "type": "string", "nullable": true } } }, "example": { "parties": [ { "name": "Ana Lopez", "entity_type": "person", "first_name": "Ana", "last_name": "Lopez", "appointment_date": null, "designation": "Administrador unico", "roles": [ { "role": "shareholder", "ownership_percent": { "text": "60%", "min": 60, "max": 60 } } ], "documents": [ { "document_uuid": "0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41", "document_type": "OWNERSHIP_STRUCTURE", "document_subtype": "ARTICLES_OF_INCORPORATION", "original_filename": "acta_constitutiva.pdf", "status": "Approved" } ] } ], "document_count": 1, "node_id": "node_kyb_documents" } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Это единственный случай, возвращающий `401`: отсутствующий, недействительный или отозванный ключ возвращает `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Expired key": { "summary": "Срок действия ключа истёк", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Ошибка аутентификации или авторизации. Отсутствующий ключ возвращает `403`, как и ключ другого приложения, ключ с ограниченной областью действия без необходимого для этого endpoint разрешения, а также запрос не из разрешённого списка IP-адресов ключа; неверный, отозванный или истекший ключ возвращает `401`. Различайте их по полю `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Missing or invalid credentials": { "summary": "Заголовок x-api-key отсутствует, либо ключ не прошёл валидацию", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Действительный ключ, принадлежащий приложению, отличному от приложения сессии", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "У ключа с ограниченной областью действия отсутствует разрешение decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Запрос с IP-адреса вне списка разрешённых IP ключа", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Сессия не существует, была удалена, принадлежит другому приложению или находится за пределами ограничений ключа с ограниченным доступом; подробности не позволяют различить эти случаи.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "example": { "detail": "Session not found." } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.list_kyb_extracted_parties(\n \"33333333-4444-5555-6666-777777777777\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.listKybExtractedParties(\"33333333-4444-5555-6666-777777777777\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.ListKYBExtractedParties(ctx, \"33333333-4444-5555-6666-777777777777\", didit.SessionsListKYBExtractedPartiesParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().listKybExtractedParties(\"33333333-4444-5555-6666-777777777777\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->listKybExtractedParties('33333333-4444-5555-6666-777777777777');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.list_kyb_extracted_parties(\"33333333-4444-5555-6666-777777777777\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.ListKybExtractedPartiesAsync(\"33333333-4444-5555-6666-777777777777\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/kyb/parties/drafts/": { "get": { "summary": "Получить список черновиков участников KYB", "description": "Получить список сторон, подготавливаемых для этой KYB-сессии, начиная с самых старых. Черновик не является заявленной стороной: он не отображается в решении или панели управления и не создаёт сессию верификации, пока вы не отправите его с помощью `POST /v3/session/{sessionId}/kyb/parties/submit/`. Требуется `write:businesses`.", "operationId": "get_v3_session_kyb_party_drafts", "x-didit-sdk": { "resource": "sessions", "method": "list_kyb_party_drafts", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID сессии Верификации бизнеса (KYB). Он должен принадлежать приложению используемого API-ключа.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "node_id", "in": "query", "required": false, "description": "Узел сценария для шага KYB. Требуется, только если в сценарии несколько KYB-узлов; по умолчанию Didit использует собственный узел сессии.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Сохранённые черновики.", "content": { "application/json": { "schema": { "type": "object", "properties": { "parties": { "type": "array", "items": { "type": "object", "required": [ "draft_id", "created_at", "updated_at", "party" ], "properties": { "draft_id": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "party": { "type": "object", "required": [ "entity_type", "nationality" ], "properties": { "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Является ли сторона физическим лицом или компанией." }, "full_name": { "type": "string", "maxLength": 255, "description": "Полное имя человека. Передайте его либо `first_name` и `last_name`." }, "first_name": { "type": "string", "maxLength": 128 }, "last_name": { "type": "string", "maxLength": 128 }, "role": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ], "description": "Роль стороны. Взаимозаменяема с `roles`; если переданы оба параметра, они объединяются." }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ] }, "description": "Каждая роль, которую занимает сторона. У физического лица должна быть как минимум одна роль (здесь или в `role`)." }, "position": { "type": "string", "maxLength": 128, "description": "Должность лица." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "company_name": { "type": "string", "maxLength": 255, "description": "Название участника компании. Обязательно, если `entity_type` имеет значение `company`." }, "registration_number": { "type": "string", "maxLength": 100, "description": "Регистрационный номер участника компании." }, "email": { "type": "string", "format": "email", "description": "Куда отправляется ссылка на верификацию. Обязательно, если стороне необходимо пройти верификацию, что зависит от настроек ролей и порогов структуры владения в сценарии." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Доля в компании, принадлежащая стороне." }, "nationality": { "type": "string", "maxLength": 100, "description": "Гражданство физического лица или страна регистрации компании. Обязательно для каждой стороны." }, "phone_number": { "type": "string", "maxLength": 32 }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Дополнительные поля, определённые сценарием." }, "skip_verification": { "type": "boolean", "default": false, "description": "Запросить пропуск верификации этой стороны. Учитывается только тогда, когда роль стороны позволяет пропуск в настройках «Ключевые лица» сценария." } } } } } }, "node_id": { "type": "string", "nullable": true } } }, "example": { "parties": [ { "draft_id": "5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d", "created_at": "2026-10-31T10:00:00Z", "updated_at": "2026-10-31T10:00:00Z", "party": { "entity_type": "person", "first_name": "Ana", "last_name": "Lopez", "roles": [ "ubo", "director" ], "ownership_percent": 60, "nationality": "MEX", "email": "ana.lopez@example.com", "date_of_birth": "1984-06-12" } } ], "node_id": "node_kyb_key_people" } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Это единственный случай, возвращающий `401`: отсутствующий, недействительный или отозванный ключ возвращает `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Expired key": { "summary": "Срок действия ключа истёк", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Ошибка аутентификации или авторизации. Отсутствующий ключ возвращает `403`, как и ключ другого приложения, ключ с ограниченной областью действия без необходимого для этого endpoint разрешения, а также запрос не из разрешённого списка IP-адресов ключа; неверный, отозванный или истекший ключ возвращает `401`. Различайте их по полю `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Missing or invalid credentials": { "summary": "Заголовок x-api-key отсутствует, либо ключ не прошёл валидацию", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Действительный ключ, принадлежащий приложению, отличному от приложения сессии", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "У ключа с ограниченной областью действия отсутствует разрешение decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Запрос с IP-адреса вне списка разрешённых IP ключа", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Сессия не существует, была удалена, принадлежит другому приложению или находится за пределами ограничений ключа с ограниченным доступом; подробности не позволяют различить эти случаи.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "example": { "detail": "Session not found." } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.list_kyb_party_drafts(\n \"33333333-4444-5555-6666-777777777777\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.listKybPartyDrafts(\"33333333-4444-5555-6666-777777777777\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.ListKYBPartyDrafts(ctx, \"33333333-4444-5555-6666-777777777777\", didit.SessionsListKYBPartyDraftsParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().listKybPartyDrafts(\"33333333-4444-5555-6666-777777777777\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->listKybPartyDrafts('33333333-4444-5555-6666-777777777777');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.list_kyb_party_drafts(\"33333333-4444-5555-6666-777777777777\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.ListKybPartyDraftsAsync(\"33333333-4444-5555-6666-777777777777\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "post": { "summary": "Создать черновик участника KYB", "description": "Добавить сторону (физическое лицо или компанию) в список, формируемый для этой KYB-сессии. Применяются те же поля и правила, что и на размещённом экране «Ключевые лица»: для физического лица требуются `full_name` или `first_name` и `last_name`, как минимум одна роль и гражданство; для компании требуются `company_name` и страна учреждения в `nationality`. Ничего не декларируется и не тарифицируется до вызова `POST /v3/session/{sessionId}/kyb/parties/submit/`. Требуется `write:businesses`.", "operationId": "post_v3_session_kyb_party_drafts", "x-didit-sdk": { "resource": "sessions", "method": "create_kyb_party_draft", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID сессии Верификации бизнеса (KYB). Он должен принадлежать приложению используемого API-ключа.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "node_id", "in": "query", "required": false, "description": "Узел сценария для шага KYB. Требуется, только если в сценарии несколько KYB-узлов; по умолчанию Didit использует собственный узел сессии.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "entity_type", "nationality" ], "properties": { "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Является ли сторона физическим лицом или компанией." }, "full_name": { "type": "string", "maxLength": 255, "description": "Полное имя человека. Передайте его либо `first_name` и `last_name`." }, "first_name": { "type": "string", "maxLength": 128 }, "last_name": { "type": "string", "maxLength": 128 }, "role": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ], "description": "Роль стороны. Взаимозаменяема с `roles`; если переданы оба параметра, они объединяются." }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ] }, "description": "Каждая роль, которую занимает сторона. У физического лица должна быть как минимум одна роль (здесь или в `role`)." }, "position": { "type": "string", "maxLength": 128, "description": "Должность лица." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "company_name": { "type": "string", "maxLength": 255, "description": "Название участника компании. Обязательно, если `entity_type` имеет значение `company`." }, "registration_number": { "type": "string", "maxLength": 100, "description": "Регистрационный номер участника компании." }, "email": { "type": "string", "format": "email", "description": "Куда отправляется ссылка на верификацию. Обязательно, если стороне необходимо пройти верификацию, что зависит от настроек ролей и порогов структуры владения в сценарии." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Доля в компании, принадлежащая стороне." }, "nationality": { "type": "string", "maxLength": 100, "description": "Гражданство физического лица или страна регистрации компании. Обязательно для каждой стороны." }, "phone_number": { "type": "string", "maxLength": 32 }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Дополнительные поля, определённые сценарием." }, "skip_verification": { "type": "boolean", "default": false, "description": "Запросить пропуск верификации этой стороны. Учитывается только тогда, когда роль стороны позволяет пропуск в настройках «Ключевые лица» сценария." } } }, "example": { "entity_type": "person", "first_name": "Ana", "last_name": "Lopez", "roles": [ "ubo", "director" ], "ownership_percent": 60, "nationality": "MEX", "email": "ana.lopez@example.com", "date_of_birth": "1984-06-12" } } } }, "responses": { "201": { "description": "Черновик создан.", "content": { "application/json": { "schema": { "type": "object", "required": [ "draft_id", "created_at", "updated_at", "party" ], "properties": { "draft_id": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "party": { "type": "object", "required": [ "entity_type", "nationality" ], "properties": { "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Является ли сторона физическим лицом или компанией." }, "full_name": { "type": "string", "maxLength": 255, "description": "Полное имя человека. Передайте его либо `first_name` и `last_name`." }, "first_name": { "type": "string", "maxLength": 128 }, "last_name": { "type": "string", "maxLength": 128 }, "role": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ], "description": "Роль стороны. Взаимозаменяема с `roles`; если переданы оба параметра, они объединяются." }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ] }, "description": "Каждая роль, которую занимает сторона. У физического лица должна быть как минимум одна роль (здесь или в `role`)." }, "position": { "type": "string", "maxLength": 128, "description": "Должность лица." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "company_name": { "type": "string", "maxLength": 255, "description": "Название участника компании. Обязательно, если `entity_type` имеет значение `company`." }, "registration_number": { "type": "string", "maxLength": 100, "description": "Регистрационный номер участника компании." }, "email": { "type": "string", "format": "email", "description": "Куда отправляется ссылка на верификацию. Обязательно, если стороне необходимо пройти верификацию, что зависит от настроек ролей и порогов структуры владения в сценарии." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Доля в компании, принадлежащая стороне." }, "nationality": { "type": "string", "maxLength": 100, "description": "Гражданство физического лица или страна регистрации компании. Обязательно для каждой стороны." }, "phone_number": { "type": "string", "maxLength": 32 }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Дополнительные поля, определённые сценарием." }, "skip_verification": { "type": "boolean", "default": false, "description": "Запросить пропуск верификации этой стороны. Учитывается только тогда, когда роль стороны позволяет пропуск в настройках «Ключевые лица» сценария." } } } } }, "example": { "draft_id": "5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d", "created_at": "2026-10-31T10:00:00Z", "updated_at": "2026-10-31T10:00:00Z", "party": { "entity_type": "person", "first_name": "Ana", "last_name": "Lopez", "roles": [ "ubo", "director" ], "ownership_percent": 60, "nationality": "MEX", "email": "ana.lopez@example.com", "date_of_birth": "1984-06-12" } } } } }, "400": { "description": "Поле стороны сделки недействительно или отсутствует обязательное поле.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "example": { "non_field_errors": [ "Person parties require at least one role." ] } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Это единственный случай, возвращающий `401`: отсутствующий, недействительный или отозванный ключ возвращает `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Expired key": { "summary": "Срок действия ключа истёк", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Ошибка аутентификации или авторизации. Отсутствующий ключ возвращает `403`, как и ключ другого приложения, ключ с ограниченной областью действия без необходимого для этого endpoint разрешения, а также запрос не из разрешённого списка IP-адресов ключа; неверный, отозванный или истекший ключ возвращает `401`. Различайте их по полю `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Missing or invalid credentials": { "summary": "Заголовок x-api-key отсутствует, либо ключ не прошёл валидацию", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Действительный ключ, принадлежащий приложению, отличному от приложения сессии", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "У ключа с ограниченной областью действия отсутствует разрешение decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Запрос с IP-адреса вне списка разрешённых IP ключа", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Сессия не существует, была удалена, принадлежит другому приложению или находится за пределами ограничений ключа с ограниченным доступом; подробности не позволяют различить эти случаи.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "example": { "detail": "Session not found." } } } }, "409": { "description": "Сессия завершена (`kyb_session_not_writable`).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." }, "code": { "type": "string" } } }, "example": { "detail": "This verification session is no longer accepting changes.", "code": "kyb_session_not_writable" } } } }, "429": { "description": "Превышен лимит запросов: 300 запросов на запись (POST, PATCH, DELETE) в минуту на один API-ключ. Подождите указанное в `Retry-After` количество секунд перед повторной попыткой; заголовки `X-RateLimit-*` показывают доступный лимит.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Rate limited": { "summary": "Бюджет на текущую минуту исчерпан", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.create_kyb_party_draft(\n \"33333333-4444-5555-6666-777777777777\",\n entity_type=\"person\",\n first_name=\"Ana\",\n last_name=\"Lopez\",\n roles=[\"ubo\", \"director\"],\n date_of_birth=\"1984-06-12\",\n email=\"ana.lopez@example.com\",\n ownership_percent=60.0,\n nationality=\"MEX\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.createKybPartyDraft(\"33333333-4444-5555-6666-777777777777\", {\n entity_type: \"person\",\n first_name: \"Ana\",\n last_name: \"Lopez\",\n roles: [\"ubo\", \"director\"],\n date_of_birth: \"1984-06-12\",\n email: \"ana.lopez@example.com\",\n ownership_percent: 60.0,\n nationality: \"MEX\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.CreateKYBPartyDraft(ctx, \"33333333-4444-5555-6666-777777777777\", didit.SessionsCreateKYBPartyDraftParams{\n\tEntityType: \"person\",\n\tFirstName: didit.String(\"Ana\"),\n\tLastName: didit.String(\"Lopez\"),\n\tRoles: didit.Some([]didit.SessionsCreateKYBPartyDraftParamsRoles{\"ubo\", \"director\"}),\n\tDateOfBirth: didit.String(\"1984-06-12\"),\n\tEmail: didit.String(\"ana.lopez@example.com\"),\n\tOwnershipPercent: didit.Float(60.0),\n\tNationality: \"MEX\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.LocalDate;\nimport java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.SessionsCreateKybPartyDraftParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().createKybPartyDraft(\"33333333-4444-5555-6666-777777777777\", SessionsCreateKybPartyDraftParams.builder()\n .entityType(SessionsCreateKybPartyDraftParams.EntityType.of(\"person\"))\n .firstName(\"Ana\")\n .lastName(\"Lopez\")\n .roles(List.of(SessionsCreateKybPartyDraftParams.Roles.of(\"ubo\"), SessionsCreateKybPartyDraftParams.Roles.of(\"director\")))\n .dateOfBirth(LocalDate.parse(\"1984-06-12\"))\n .email(\"ana.lopez@example.com\")\n .ownershipPercent(60.0)\n .nationality(\"MEX\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->createKybPartyDraft('33333333-4444-5555-6666-777777777777', [\n 'entity_type' => 'person',\n 'first_name' => 'Ana',\n 'last_name' => 'Lopez',\n 'roles' => ['ubo', 'director'],\n 'date_of_birth' => '1984-06-12',\n 'email' => 'ana.lopez@example.com',\n 'ownership_percent' => 60.0,\n 'nationality' => 'MEX',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.create_kyb_party_draft(\n \"33333333-4444-5555-6666-777777777777\",\n entity_type: \"person\",\n first_name: \"Ana\",\n last_name: \"Lopez\",\n roles: [\"ubo\", \"director\"],\n date_of_birth: \"1984-06-12\",\n email: \"ana.lopez@example.com\",\n ownership_percent: 60.0,\n nationality: \"MEX\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.CreateKybPartyDraftAsync(\"33333333-4444-5555-6666-777777777777\", new SessionsCreateKybPartyDraftParams\n{\n EntityType = \"person\",\n FirstName = \"Ana\",\n LastName = \"Lopez\",\n Roles = new SessionsCreateKybPartyDraftParamsRoles[] { \"ubo\", \"director\" },\n DateOfBirth = \"1984-06-12\",\n Email = \"ana.lopez@example.com\",\n OwnershipPercent = 60.0,\n Nationality = \"MEX\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/kyb/parties/drafts/{draftId}/": { "patch": { "summary": "Редактировать черновик участника KYB", "description": "Изменить поля одного черновика стороны. Изменения объединяются с сохранённым черновиком, и объединённая сторона валидируется целиком, поэтому изменение, делающее сторону неполной, отклоняется. Изменение `first_name` или `last_name` заменяет сохранённое полное имя. Требуется `write:businesses`.", "operationId": "patch_v3_session_kyb_party_draft", "x-didit-sdk": { "resource": "sessions", "method": "update_kyb_party_draft", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID сессии Верификации бизнеса (KYB). Он должен принадлежать приложению используемого API-ключа.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "draftId", "in": "path", "required": true, "description": "UUID черновика стороны (`draft_id`, возвращённый при его создании).", "schema": { "type": "string", "format": "uuid", "example": "5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d" } }, { "name": "node_id", "in": "query", "required": false, "description": "Узел сценария для шага KYB. Требуется, только если в сценарии несколько KYB-узлов; по умолчанию Didit использует собственный узел сессии.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Любое подмножество полей стороны. Изменение объединяется с сохранённым черновиком, и объединённая сторона валидируется целиком, поэтому черновик, который можно было отправить до изменения, можно будет отправить и после него.", "properties": { "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Является ли сторона физическим лицом или компанией." }, "full_name": { "type": "string", "maxLength": 255, "description": "Полное имя человека. Передайте его либо `first_name` и `last_name`." }, "first_name": { "type": "string", "maxLength": 128 }, "last_name": { "type": "string", "maxLength": 128 }, "role": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ], "description": "Роль стороны. Взаимозаменяема с `roles`; если переданы оба параметра, они объединяются." }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ] }, "description": "Каждая роль, которую занимает сторона. У физического лица должна быть как минимум одна роль (здесь или в `role`)." }, "position": { "type": "string", "maxLength": 128, "description": "Должность лица." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "company_name": { "type": "string", "maxLength": 255, "description": "Название участника компании. Обязательно, если `entity_type` имеет значение `company`." }, "registration_number": { "type": "string", "maxLength": 100, "description": "Регистрационный номер участника компании." }, "email": { "type": "string", "format": "email", "description": "Куда отправляется ссылка на верификацию. Обязательно, если стороне необходимо пройти верификацию, что зависит от настроек ролей и порогов структуры владения в сценарии." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Доля в компании, принадлежащая стороне." }, "nationality": { "type": "string", "maxLength": 100, "description": "Гражданство физического лица или страна регистрации компании. Обязательно для каждой стороны." }, "phone_number": { "type": "string", "maxLength": 32 }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Дополнительные поля, определённые сценарием." }, "skip_verification": { "type": "boolean", "default": false, "description": "Запросить пропуск верификации этой стороны. Учитывается только тогда, когда роль стороны позволяет пропуск в настройках «Ключевые лица» сценария." } } }, "example": { "ownership_percent": 55 } } } }, "responses": { "200": { "description": "Черновик обновлён.", "content": { "application/json": { "schema": { "type": "object", "required": [ "draft_id", "created_at", "updated_at", "party" ], "properties": { "draft_id": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "party": { "type": "object", "required": [ "entity_type", "nationality" ], "properties": { "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Является ли сторона физическим лицом или компанией." }, "full_name": { "type": "string", "maxLength": 255, "description": "Полное имя человека. Передайте его либо `first_name` и `last_name`." }, "first_name": { "type": "string", "maxLength": 128 }, "last_name": { "type": "string", "maxLength": 128 }, "role": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ], "description": "Роль стороны. Взаимозаменяема с `roles`; если переданы оба параметра, они объединяются." }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ] }, "description": "Каждая роль, которую занимает сторона. У физического лица должна быть как минимум одна роль (здесь или в `role`)." }, "position": { "type": "string", "maxLength": 128, "description": "Должность лица." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "company_name": { "type": "string", "maxLength": 255, "description": "Название участника компании. Обязательно, если `entity_type` имеет значение `company`." }, "registration_number": { "type": "string", "maxLength": 100, "description": "Регистрационный номер участника компании." }, "email": { "type": "string", "format": "email", "description": "Куда отправляется ссылка на верификацию. Обязательно, если стороне необходимо пройти верификацию, что зависит от настроек ролей и порогов структуры владения в сценарии." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Доля в компании, принадлежащая стороне." }, "nationality": { "type": "string", "maxLength": 100, "description": "Гражданство физического лица или страна регистрации компании. Обязательно для каждой стороны." }, "phone_number": { "type": "string", "maxLength": 32 }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Дополнительные поля, определённые сценарием." }, "skip_verification": { "type": "boolean", "default": false, "description": "Запросить пропуск верификации этой стороны. Учитывается только тогда, когда роль стороны позволяет пропуск в настройках «Ключевые лица» сценария." } } } } }, "example": { "draft_id": "5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d", "created_at": "2026-10-31T10:00:00Z", "updated_at": "2026-10-31T10:00:00Z", "party": { "entity_type": "person", "first_name": "Ana", "last_name": "Lopez", "roles": [ "ubo", "director" ], "ownership_percent": 55, "nationality": "MEX", "email": "ana.lopez@example.com", "date_of_birth": "1984-06-12" } } } } }, "400": { "description": "Объединенная сторона недействительна.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "example": { "non_field_errors": [ "Person parties require at least one role." ] } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Это единственный случай, возвращающий `401`: отсутствующий, недействительный или отозванный ключ возвращает `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Expired key": { "summary": "Срок действия ключа истёк", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Ошибка аутентификации или авторизации. Отсутствующий ключ возвращает `403`, как и ключ другого приложения, ключ с ограниченной областью действия без необходимого для этого endpoint разрешения, а также запрос не из разрешённого списка IP-адресов ключа; неверный, отозванный или истекший ключ возвращает `401`. Различайте их по полю `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Missing or invalid credentials": { "summary": "Заголовок x-api-key отсутствует, либо ключ не прошёл валидацию", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Действительный ключ, принадлежащий приложению, отличному от приложения сессии", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "У ключа с ограниченной областью действия отсутствует разрешение decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Запрос с IP-адреса вне списка разрешённых IP ключа", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Сессия или черновик не существуют, либо сессия находится вне приложения ключа или за пределами ограничений ключа с ограниченным доступом.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "example": { "detail": "Session not found." } } } }, "409": { "description": "Сессия завершена (`kyb_session_not_writable`).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." }, "code": { "type": "string" } } }, "example": { "detail": "This verification session is no longer accepting changes.", "code": "kyb_session_not_writable" } } } }, "429": { "description": "Превышен лимит запросов: 300 запросов на запись (POST, PATCH, DELETE) в минуту на один API-ключ. Подождите указанное в `Retry-After` количество секунд перед повторной попыткой; заголовки `X-RateLimit-*` показывают доступный лимит.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Rate limited": { "summary": "Бюджет на текущую минуту исчерпан", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_kyb_party_draft(\n \"33333333-4444-5555-6666-777777777777\",\n \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\",\n ownership_percent=55.0,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updateKybPartyDraft(\n \"33333333-4444-5555-6666-777777777777\",\n \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\",\n {\n ownership_percent: 55.0,\n },\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateKYBPartyDraft(ctx, \"33333333-4444-5555-6666-777777777777\", \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\", didit.SessionsUpdateKYBPartyDraftParams{\n\tOwnershipPercent: didit.Float(55.0),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsUpdateKybPartyDraftParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updateKybPartyDraft(\"33333333-4444-5555-6666-777777777777\", \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\", SessionsUpdateKybPartyDraftParams.builder()\n .ownershipPercent(55.0)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updateKybPartyDraft('33333333-4444-5555-6666-777777777777', '5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d', [\n 'ownership_percent' => 55.0,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_kyb_party_draft(\n \"33333333-4444-5555-6666-777777777777\",\n \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\",\n ownership_percent: 55.0\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdateKybPartyDraftAsync(\"33333333-4444-5555-6666-777777777777\", \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\", new SessionsUpdateKybPartyDraftParams\n{\n OwnershipPercent = 55.0,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "delete": { "summary": "Удалить черновик участника KYB", "description": "Удалить один черновик стороны. Объявленные стороны не затрагиваются. Требуется `write:businesses`.", "operationId": "delete_v3_session_kyb_party_draft", "x-didit-sdk": { "resource": "sessions", "method": "delete_kyb_party_draft", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID сессии Верификации бизнеса (KYB). Он должен принадлежать приложению используемого API-ключа.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "draftId", "in": "path", "required": true, "description": "UUID черновика стороны (`draft_id`, возвращённый при его создании).", "schema": { "type": "string", "format": "uuid", "example": "5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d" } }, { "name": "node_id", "in": "query", "required": false, "description": "Узел сценария для шага KYB. Требуется, только если в сценарии несколько KYB-узлов; по умолчанию Didit использует собственный узел сессии.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Черновик удалён. Без тела ответа." }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Это единственный случай, возвращающий `401`: отсутствующий, недействительный или отозванный ключ возвращает `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Expired key": { "summary": "Срок действия ключа истёк", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Ошибка аутентификации или авторизации. Отсутствующий ключ возвращает `403`, как и ключ другого приложения, ключ с ограниченной областью действия без необходимого для этого endpoint разрешения, а также запрос не из разрешённого списка IP-адресов ключа; неверный, отозванный или истекший ключ возвращает `401`. Различайте их по полю `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Missing or invalid credentials": { "summary": "Заголовок x-api-key отсутствует, либо ключ не прошёл валидацию", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Действительный ключ, принадлежащий приложению, отличному от приложения сессии", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "У ключа с ограниченной областью действия отсутствует разрешение decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Запрос с IP-адреса вне списка разрешённых IP ключа", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Сессия или черновик не существуют, либо сессия находится вне приложения ключа или за пределами ограничений ключа с ограниченным доступом.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "example": { "detail": "Session not found." } } } }, "409": { "description": "Сессия завершена (`kyb_session_not_writable`).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." }, "code": { "type": "string" } } }, "example": { "detail": "This verification session is no longer accepting changes.", "code": "kyb_session_not_writable" } } } }, "429": { "description": "Превышен лимит запросов: 300 запросов на запись (POST, PATCH, DELETE) в минуту на один API-ключ. Подождите указанное в `Retry-After` количество секунд перед повторной попыткой; заголовки `X-RateLimit-*` показывают доступный лимит.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Rate limited": { "summary": "Бюджет на текущую минуту исчерпан", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.sessions.delete_kyb_party_draft(\n \"33333333-4444-5555-6666-777777777777\",\n \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.sessions.deleteKybPartyDraft(\n \"33333333-4444-5555-6666-777777777777\",\n \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\",\n);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.Sessions.DeleteKYBPartyDraft(ctx, \"33333333-4444-5555-6666-777777777777\", \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\", didit.SessionsDeleteKYBPartyDraftParams{}); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.sessions().deleteKybPartyDraft(\"33333333-4444-5555-6666-777777777777\", \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\");" }, { "lang": "php", "label": "PHP", "source": "sessions->deleteKybPartyDraft('33333333-4444-5555-6666-777777777777', '5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.sessions.delete_kyb_party_draft(\n \"33333333-4444-5555-6666-777777777777\",\n \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\"\n)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.Sessions.DeleteKybPartyDraftAsync(\"33333333-4444-5555-6666-777777777777\", \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\");" } ] } }, "/v3/session/{sessionId}/kyb/parties/submit/": { "post": { "summary": "Отправить черновики сторон KYB", "description": "Объявить сохранённые черновики ключевыми лицами компании. Это размещённый шаг «Ключевые лица» с использованием вашего API-ключа: Didit на основе настроек ролей и порогов владения в сценарии определяет, какие стороны должны пройти верификацию, создаёт одну индивидуальную KYC-сессию (или подсессию KYB для корпоративного владельца) для каждого из них, отправляет электронные письма согласно сценарию и переводит сессию на следующий этап. Каждая дочерняя сессия тарифицируется так же, как в размещённом сценарии. Черновики расходуются. Повторный вызов после успешной отправки ничего не меняет и возвращает ответ `200` с `already_submitted: true` и уже существующими сторонами. Сессия должна находиться на шаге «Ключевые лица». Отправьте каждому человеку его `kyc_session_url` или встройте его. Требуется разрешение `write:businesses`.", "operationId": "post_v3_session_kyb_parties_submit", "x-didit-sdk": { "resource": "sessions", "method": "submit_kyb_parties", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID сессии Верификации бизнеса (KYB). Он должен принадлежать приложению используемого API-ключа.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "node_id", "in": "query", "required": false, "description": "Узел сценария для шага KYB. Требуется, только если в сценарии несколько KYB-узлов; по умолчанию Didit использует собственный узел сессии.", "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "locale": { "type": "string", "maxLength": 10, "description": "Локаль (locale), используемая для перевода ответа шага, к которому переходит сессия." } } }, "example": { "locale": "es" } } } }, "responses": { "200": { "description": "Стороны, заявленные (или уже заявленные).", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "next_step": { "type": "string", "nullable": true, "description": "Шаг, на котором находится сессия." }, "status": { "type": "string", "description": "Статус сессии компании." }, "advanced": { "type": "boolean", "description": "`true`, если этот вызов объявил стороны и перевёл сессию на следующий этап." }, "already_submitted": { "type": "boolean", "description": "`true`, если стороны были объявлены ранее в рамках другого вызова." }, "kyb_key_people_status": { "type": "string" }, "parties": { "type": "array", "items": { "$ref": "#/components/schemas/KYBKeyPeopleParty" } } } }, "example": { "valid": true, "next_step": "FINISHED", "status": "In Progress", "advanced": true, "already_submitted": false, "kyb_key_people_status": "In Progress", "parties": [] } } } }, "402": { "description": "У организации не осталось кредитов для дочерних сессий верификации.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "example": { "detail": "Insufficient credits." } } } }, "401": { "description": "Срок действия API-ключа с ограниченной областью действия истёк. Это единственный случай, возвращающий `401`: отсутствующий, недействительный или отозванный ключ возвращает `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Expired key": { "summary": "Срок действия ключа истёк", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Ошибка аутентификации или авторизации. Отсутствующий ключ возвращает `403`, как и ключ другого приложения, ключ с ограниченной областью действия без необходимого для этого endpoint разрешения, а также запрос не из разрешённого списка IP-адресов ключа; неверный, отозванный или истекший ключ возвращает `401`. Различайте их по полю `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Missing or invalid credentials": { "summary": "Заголовок x-api-key отсутствует, либо ключ не прошёл валидацию", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Действительный ключ, принадлежащий приложению, отличному от приложения сессии", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "У ключа с ограниченной областью действия отсутствует разрешение decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Запрос с IP-адреса вне списка разрешённых IP ключа", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "Сессия не существует, была удалена, принадлежит другому приложению или находится за пределами ограничений ключа с ограниченным доступом; подробности не позволяют различить эти случаи.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "example": { "detail": "Session not found." } } } }, "409": { "description": "`kyb_no_party_drafts`: нечего отправлять. `kyb_parties_already_submitted`: черновики были добавлены после объявления сторон. `kyb_step_mismatch`: сессия находится не на шаге «Ключевые лица» (`next_step` указывает текущий шаг). `kyb_session_not_writable`: сессия завершена.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." }, "code": { "type": "string" }, "next_step": { "type": "string" } } }, "example": { "detail": "There are no draft parties to submit.", "code": "kyb_no_party_drafts" } } } }, "429": { "description": "Превышен лимит запросов: 300 запросов на запись (POST, PATCH, DELETE) в минуту на один API-ключ. Подождите указанное в `Retry-After` количество секунд перед повторной попыткой; заголовки `X-RateLimit-*` показывают доступный лимит.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение об ошибке." } } }, "examples": { "Rate limited": { "summary": "Бюджет на текущую минуту исчерпан", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной попыткой.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.submit_kyb_parties(\n \"33333333-4444-5555-6666-777777777777\",\n locale=\"es\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.submitKybParties(\"33333333-4444-5555-6666-777777777777\", {\n locale: \"es\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.SubmitKYBParties(ctx, \"33333333-4444-5555-6666-777777777777\", didit.SessionsSubmitKYBPartiesParams{\n\tLocale: didit.String(\"es\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsSubmitKybPartiesParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().submitKybParties(\"33333333-4444-5555-6666-777777777777\", SessionsSubmitKybPartiesParams.builder()\n .locale(\"es\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->submitKybParties('33333333-4444-5555-6666-777777777777', [\n 'locale' => 'es',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.submit_kyb_parties(\n \"33333333-4444-5555-6666-777777777777\",\n locale: \"es\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.SubmitKybPartiesAsync(\"33333333-4444-5555-6666-777777777777\", new SessionsSubmitKybPartiesParams\n{\n Locale = \"es\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/files-export/": { "post": { "summary": "Экспорт всех файлов сессии", "description": "Запустить подготовку одного ZIP-архива со всеми изображениями, видео и документами сессии Проверки пользователей (KYC) или Верификации бизнеса (KYB) в исходном качестве: файлы сохраняются в ZIP-архиве так, как они были получены, без повторного сжатия. Возвращает ответ `202` с объектом экспорта; считывайте его с помощью `GET /v3/session/{sessionId}/files-export/{exportId}/`, пока `status` не станет `READY`, после чего скачайте по `download_url`. Пока готовится экспорт той же сессии, возвращается этот существующий экспорт вместо создания нового.\n\nZIP-архив удаляется через 24 часа после готовности и сразу же при удалении сессии. Удалённую сессию невозможно экспортировать. Каждый экспорт и каждая выданная ссылка на скачивание записываются в журнал аудита сессии. Для API-ключа с ограниченными правами требуются разрешения `media: read` и `decisions: read`; пользователю консоли требуется привилегия на чтение сессий.", "operationId": "post_v3_session_files_export", "x-didit-sdk": { "resource": "sessions", "method": "export_files", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID сессии верификации (`session_id`, возвращённый `POST /v3/session/`). Принимает ID сессий как Проверки пользователей (KYC), так и Верификации бизнеса (KYB). Для удалённой сессии возвращается `404`.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/files-export/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.export_files(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.exportFiles(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.ExportFiles(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().exportFiles(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->exportFiles('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.export_files(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.ExportFilesAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "202": { "description": "Экспорт подготавливается.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionFilesExport" }, "example": { "export_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "session_id": "11111111-2222-3333-4444-555555555555", "status": "PENDING", "file_count": null, "size_bytes": null, "download_url": null, "expires_at": null, "error": null, "created_at": "2026-10-29T12:00:03Z", "completed_at": null } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/files-export/{exportId}/": { "get": { "summary": "Получить экспорт файлов сессии", "description": "Прогресс экспорта, запущенного с помощью `POST /v3/session/{sessionId}/files-export/`. Как только `status` принимает значение `READY`, поле `download_url` содержит подписанный URL для скачивания ZIP-архива, который остаётся действительным в течение короткого времени; запросите экспорт повторно для получения новой ссылки вплоть до наступления `expires_at`. Каждое чтение, возвращающее ссылку на скачивание, записывается в журнал аудита сессии. Экспорт удалённой сессии возвращает `404`.", "operationId": "get_v3_session_files_export", "x-didit-sdk": { "resource": "sessions", "method": "get_files_export", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID сессии верификации (`session_id`, возвращённый `POST /v3/session/`). Принимает ID сессий как Проверки пользователей (KYC), так и Верификации бизнеса (KYB). Для удалённой сессии возвращается `404`.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "exportId", "in": "path", "required": true, "description": "Параметр `export_id`, возвращённый `POST /v3/session/{sessionId}/files-export/`.", "schema": { "type": "string", "format": "uuid", "example": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/files-export/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.get_files_export(\n \"11111111-2222-3333-4444-555555555555\",\n \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.getFilesExport(\n \"11111111-2222-3333-4444-555555555555\",\n \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.GetFilesExport(ctx, \"11111111-2222-3333-4444-555555555555\", \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().getFilesExport(\"11111111-2222-3333-4444-555555555555\", \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->getFilesExport('11111111-2222-3333-4444-555555555555', 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.get_files_export(\n \"11111111-2222-3333-4444-555555555555\",\n \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.GetFilesExportAsync(\"11111111-2222-3333-4444-555555555555\", \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Экспорт.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionFilesExport" }, "example": { "export_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "session_id": "11111111-2222-3333-4444-555555555555", "status": "READY", "file_count": 9, "size_bytes": 18734120, "download_url": "https://storage.example.com/session/11111111-2222-3333-4444-555555555555/files-export/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/session-42-files.zip?X-Amz-Signature=...", "expires_at": "2026-10-30T12:00:41Z", "error": null, "created_at": "2026-10-29T12:00:03Z", "completed_at": "2026-10-29T12:00:41Z" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/travel-rule/unmatched/": { "get": { "summary": "Получить список несопоставленных депозитов Travel Rule", "description": "Входящие депозиты, всё ещё ожидающие данных Travel Rule от исходного VASP: их перевод находится в статусе `AWAITING_COUNTERPARTY`, `NOT_ENOUGH_COUNTERPARTY_DATA` или `COUNTERPARTY_VASP_NOT_FOUND`, с ними не сопоставлено ни одно полученное сообщение, и никто не сопоставил их вручную. Строки и фильтры такие же, как в `GET /v3/travel-rule/transfers/`, сначала новые, с пагинацией через `limit` (по умолчанию 50) и `offset`. Сопоставьте депозит с сообщением, отправленным исходным VASP, с помощью `POST /v3/travel-rule/unmatched/{transaction_uuid}/match/`.", "operationId": "listUnmatchedTravelRuleDeposits", "x-didit-sdk": { "resource": "travel_rule.unmatched_deposits", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "direction", "in": "query", "required": false, "schema": { "type": "string" }, "description": "INBOUND, OUTBOUND или оба значения через запятую. С учетом регистра." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Один или несколько статусов перевода через запятую." }, { "name": "rail", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Одно или несколько значений из INTERNAL, TRP, GTR, TRUST, VERIFYVASP, SYGNA, EMAIL, TEST_VASP через запятую." }, { "name": "kind", "in": "query", "required": false, "schema": { "type": "string" }, "description": "withdrawal, deposit или message, разделённые запятыми." }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Валюта транзакции, без учета регистра." }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Переводы, созданные в этот день или позже (UTC), ГГГГ-ММ-ДД." }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Переводы, созданные в этот день или раньше (UTC), ГГГГ-ММ-ДД." }, { "name": "counterparty", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Параметр `id` записи каталога или участника сети Didit из GET /v3/travel-rule/vasps/: ваши переводы с этим контрагентом. Если передан некорректный id, возвращается 400." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 1000000 }, "description": "Размер страницы, по умолчанию 50." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000000 }, "description": "Строки, которые нужно пропустить." } ], "responses": { "200": { "description": "Страница несопоставленных депозитов.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleTransferRow" } } } }, "example": { "count": 1, "next": null, "previous": null, "results": [ { "id": "7d3a1c55-0b9e-4d52-8a3c-1f6e2b9d4a08", "transaction_id": "c41f9b2e-5a8d-4e0c-9f17-3b6d8a2e5c91", "txn_id": "dep-2026-10-20-0007", "txn_date": "2026-10-19T08:41:12Z", "kind": "deposit", "direction": "INBOUND", "status": "AWAITING_COUNTERPARTY", "rail": "TRP", "asset": "ETH", "amount": "1.25", "originator_vasp": "", "beneficiary_vasp": "Example Counterparty VASP", "originator_wallet": "0x77ccff0cc624a53cd8b8d8703ced826710211ec7", "beneficiary_wallet": "0xede2d7e4f5b097e6391ab6bbcf2f47a53f4778cb", "originator_memo": "", "beneficiary_memo": "", "originator_wallet_type": "vasp", "beneficiary_wallet_type": "vasp", "matched_transaction_id": null, "deadline_at": null, "created_at": "2026-10-19T08:41:13Z" } ] } } } }, "400": { "description": "Недопустимое значение фильтра.", "content": { "application/json": { "example": { "start_date": [ "Use the YYYY-MM-DD format." ] } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.travel_rule.unmatched_deposits.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.travelRule.unmatchedDeposits.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.TravelRule.UnmatchedDeposits.ListAutoPaging(ctx, didit.TravelRuleUnmatchedDepositsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.travelRule().unmatchedDeposits().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "travelRule->unmatchedDeposits->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.travel_rule.unmatched_deposits.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.TravelRule.UnmatchedDeposits.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] } }, "/v3/travel-rule/unmatched/{transaction_uuid}/match/": { "post": { "summary": "Сопоставить депозит Travel Rule с полученным сообщением", "operationId": "matchUnmatchedTravelRuleDeposit", "x-didit-sdk": { "resource": "travel_rule.unmatched_deposits", "method": "match", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Связать входящий депозит, ожидающий данных отправителя, с сообщением Travel Rule, которое отправил для него VASP отправителя. Депозит принимает данные отправителя из сообщения, VASP контрагента и платежный канал, а обе транзакции фиксируют сопоставление на своих таймлайнах. Параметр `transaction_uuid` является `transaction_id` депозита из `GET /v3/travel-rule/unmatched/`. Поле `transaction_id` в теле запроса является `transaction_id` полученного сообщения из строки `GET /v3/travel-rule/transfers/?kind=message`; собственный `id` транзакции не найден. Сообщение должно относиться к тому же активу, что и депозит. Если депозит или сообщение удалены из Console, возвращается `404`; если статус уже изменился (сопоставлен или больше не ожидает), возвращается `409`.", "parameters": [ { "name": "transaction_uuid", "in": "path", "required": true, "description": "`transaction_id` несопоставленного депозита.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleManualMatchRequest" }, "example": { "transaction_id": "e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24" } } } }, "responses": { "200": { "description": "Оба перевода после сопоставления.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleManualMatchResponse" }, "example": { "deposit": { "id": "7d3a1c55-0b9e-4d52-8a3c-1f6e2b9d4a08", "transaction_id": "c41f9b2e-5a8d-4e0c-9f17-3b6d8a2e5c91", "txn_id": "dep-2026-10-20-0007", "txn_date": "2026-10-19T08:41:12Z", "kind": "deposit", "direction": "INBOUND", "status": "AWAITING_COUNTERPARTY", "rail": "TRP", "asset": "ETH", "amount": "1.25", "originator_vasp": "Example Counterparty VASP", "beneficiary_vasp": "Example Counterparty VASP", "originator_wallet": "0x77ccff0cc624a53cd8b8d8703ced826710211ec7", "beneficiary_wallet": "0xede2d7e4f5b097e6391ab6bbcf2f47a53f4778cb", "originator_memo": "", "beneficiary_memo": "", "originator_wallet_type": "vasp", "beneficiary_wallet_type": "vasp", "matched_transaction_id": "e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24", "deadline_at": null, "created_at": "2026-10-19T08:41:13Z" }, "message": { "id": "2b8e6f10-9c3a-47d1-b5e2-0a4c7d9f3e66", "transaction_id": "e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24", "txn_id": "msg-2026-10-20-0003", "txn_date": "2026-10-19T08:41:12Z", "kind": "message", "direction": "INBOUND", "status": "COMPLETED", "rail": "TRP", "asset": "ETH", "amount": "1.25", "originator_vasp": "Origin CASP SL", "beneficiary_vasp": "Example Counterparty VASP", "originator_wallet": "0x77ccff0cc624a53cd8b8d8703ced826710211ec7", "beneficiary_wallet": "0xede2d7e4f5b097e6391ab6bbcf2f47a53f4778cb", "originator_memo": "", "beneficiary_memo": "", "originator_wallet_type": "vasp", "beneficiary_wallet_type": "vasp", "matched_transaction_id": null, "deadline_at": "2026-10-21T08:41:13Z", "created_at": "2026-10-19T08:41:13Z" } } } } }, "400": { "description": "Ошибка валидации: `transaction_id` отсутствует, совпадает с самим депозитом, не является полученным сообщением Travel Rule или относится к активу, отличному от актива депозита; либо транзакция в пути не является входящим депозитом.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Error": { "value": { "transaction_id": [ "The travel rule message is for a different asset than the deposit." ] } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "description": "Неизвестный депозит или сообщение, либо одно из них было удалено.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No TravelRuleTransfer matches the given query." } } } }, "409": { "description": "Депозит больше не ожидает данных отправителя, либо сообщение уже сопоставлено с депозитом.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Error": { "value": { "detail": "This deposit is no longer waiting for originator data." } } } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.unmatched_deposits.match(\n \"11111111-2222-3333-4444-555555555555\",\n transaction_id=\"e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.unmatchedDeposits.match(\"11111111-2222-3333-4444-555555555555\", {\n transaction_id: \"e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.UnmatchedDeposits.Match(ctx, \"11111111-2222-3333-4444-555555555555\", didit.TravelRuleManualMatchRequest{\n\tTransactionID: \"e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleManualMatchRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().unmatchedDeposits().match(\"11111111-2222-3333-4444-555555555555\", TravelRuleManualMatchRequest.builder()\n .transactionId(\"e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->unmatchedDeposits->match('11111111-2222-3333-4444-555555555555', [\n 'transaction_id' => 'e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.unmatched_deposits.match(\n \"11111111-2222-3333-4444-555555555555\",\n transaction_id: \"e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.UnmatchedDeposits.MatchAsync(\"11111111-2222-3333-4444-555555555555\", new TravelRuleManualMatchRequest\n{\n TransactionId = \"e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } } }, "components": { "schemas": { "DocumentAIDetectedCode": { "type": "object", "required": [ "type", "page_number", "position", "x", "y", "width", "height", "page_width", "page_height", "raw_payload", "parsed_payload" ], "properties": { "type": { "type": "string", "description": "Обнаруженная символика, например `QR_CODE`, `CODE_128`, `EAN_13`, `DATA_MATRIX` или `PDF_417`." }, "page_number": { "type": "integer", "minimum": 1, "description": "Номер страницы (начиная с 1)." }, "position": { "type": "array", "nullable": true, "description": "Обнаруженный многоугольник в пиксельных координатах отрисованной страницы. `null`, если надежные координаты недоступны.", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "integer" } } }, "x": { "type": "integer", "nullable": true, "description": "Левый край ограничивающей рамки в пикселях отрендеренной страницы." }, "y": { "type": "integer", "nullable": true, "description": "Верхний край ограничивающей рамки в пикселях отрендеренной страницы." }, "width": { "type": "integer", "nullable": true, "description": "Ширина ограничивающего прямоугольника в пикселях отображаемой страницы." }, "height": { "type": "integer", "nullable": true, "description": "Высота ограничивающего прямоугольника в пикселях отображаемой страницы." }, "page_width": { "type": "integer", "description": "Ширина отрисованной страницы в пикселях." }, "page_height": { "type": "integer", "description": "Высота отрисованной страницы в пикселях." }, "raw_payload": { "type": "string", "description": "Необработанный payload декодера в виде строки base64 при наличии; в противном случае пустая строка." }, "parsed_payload": { "nullable": true, "description": "Декодированная строка или структурированное значение. `null`, если код был обнаружен, но не смог быть декодирован." } } }, "SessionImportJob": { "type": "object", "required": [ "uuid", "status", "import_type", "source_format", "source_filename", "total_rows", "processed_rows", "created_count", "updated_count", "skipped_count", "failed_count" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Идентификатор задания на импорт. Используйте это значение для отслеживания прогресса и получения ошибок по строкам." }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "COMPLETED", "FAILED", "PAUSED", "CANCELLED", "READY" ] }, "import_type": { "type": "string", "enum": [ "user_verification", "business_verification", "status_rules", "transactions" ] }, "source_format": { "type": "string", "enum": [ "csv", "ndjson" ] }, "source_filename": { "type": "string" }, "total_rows": { "type": "integer", "format": "int64" }, "processed_rows": { "type": "integer", "format": "int64" }, "checkpoint_row": { "type": "integer", "format": "int64" }, "created_count": { "type": "integer", "format": "int64" }, "updated_count": { "type": "integer", "format": "int64" }, "skipped_count": { "type": "integer", "format": "int64" }, "failed_count": { "type": "integer", "format": "int64" }, "total_media_bytes": { "type": "integer", "format": "int64" }, "last_error": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "started_at": { "type": "string", "format": "date-time", "nullable": true }, "completed_at": { "type": "string", "format": "date-time", "nullable": true }, "state": { "type": "string", "enum": [ "ready", "queued", "running", "paused", "completed", "errors", "failed", "cancelled" ], "description": "Состояние задачи, как оно отображается в консоли; `errors` означает завершенную задачу с отклоненными строками." }, "source": { "type": "string", "enum": [ "file", "api", "provider" ] }, "provider": { "type": "string", "description": "Источник миграции; пусто для импорта из файла или через API." }, "provider_options": { "type": "object" }, "credential_hint": { "type": "string", "description": "Первые символы ключа, содержащегося в миграции. Сам ключ никогда не возвращается." }, "credentials_expires_at": { "type": "string", "format": "date-time", "nullable": true }, "resumes_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда задача, приостановленная из-за лимита запросов провайдера, возобновляется автоматически." }, "status_mapping": { "type": "object", "additionalProperties": { "type": "string" } }, "is_dry_run": { "type": "boolean" }, "dry_run_summary": { "type": "object", "description": "Результаты тестового прогона: `total`, `by_status`, `already_in_didit`, `same_person`, `not_finished`, `failed`, `unmapped_statuses`." }, "face_templates_enabled": { "type": "boolean" }, "lawful_basis_confirmed_at": { "type": "string", "format": "date-time", "nullable": true }, "not_finished_count": { "type": "integer", "format": "int64" }, "same_person_count": { "type": "integer", "format": "int64" }, "face_templates_count": { "type": "integer", "format": "int64" }, "face_duplicates_count": { "type": "integer", "format": "int64" }, "face_blocklist_hits_count": { "type": "integer", "format": "int64" }, "created_by_name": { "type": "string", "nullable": true }, "created_by_email": { "type": "string", "nullable": true } } }, "SessionImportError": { "type": "object", "required": [ "uuid", "row_number", "error", "raw_row" ], "properties": { "uuid": { "type": "string", "format": "uuid" }, "row_number": { "type": "integer", "format": "int64" }, "external_id": { "type": "string", "nullable": true }, "error": { "type": "string" }, "raw_row": { "type": "object", "additionalProperties": true }, "created_at": { "type": "string", "format": "date-time" } } }, "BrandingCustomizationUpdate": { "type": "object", "description": "Тело частичного обновления брендинга. Передавайте только те поля, которые хотите изменить. Шестнадцатеричные цвета принимают `#RRGGBB` или `#RRGGBBAA`. Пользовательский домен и email в стиле White label здесь не принимаются.", "properties": { "color_primary": { "type": "string", "description": "Цвет заголовков / основного текста." }, "color_secondary": { "type": "string", "description": "Цвет абзаца / вторичного текста." }, "color_background": { "type": "string", "description": "Цвет фона страницы." }, "color_panel": { "type": "string", "description": "Цвет панели / акцентный цвет." }, "color_panel_10": { "type": "string", "description": "Цвет панели при непрозрачности 10%." }, "color_on_panel_1": { "type": "string", "description": "Цвет вспомогательного текста на панелях." }, "color_on_panel_2": { "type": "string", "description": "Цвет плашки / бейджа на панелях." }, "color_on_background": { "type": "string", "description": "Цвет текста на фоне." }, "color_button_1": { "type": "string", "description": "Основной цвет кнопки." }, "color_button_2": { "type": "string", "description": "Цвет вторичной кнопки." }, "color_button_text_1": { "type": "string", "description": "Цвет текста основной кнопки." }, "color_button_text_2": { "type": "string", "description": "Цвет текста вторичной кнопки." }, "color_pill_text": { "type": "string", "description": "Цвет текста для индикаторов, полей ввода и селекторов." }, "border_radius_panel": { "type": "integer", "minimum": 0, "description": "Радиус скругления углов панели в пикселях." }, "border_radius_buttons": { "type": "integer", "minimum": 0, "description": "Радиус скругления углов кнопки в пикселях." }, "font_family": { "type": "string", "description": "Название семейства шрифтов Google Fonts (например, `Inter`, `AR One Sans`)." }, "font_weight": { "type": "string", "description": "Насыщенность шрифта, доступная для выбранного семейства (например, `regular`, `500`, `700`)." }, "app_public_name": { "type": "string", "nullable": true, "description": "Публичное название, отображаемое в процессе верификации." }, "privacy_policy_url": { "type": "string", "nullable": true, "description": "URL политики конфиденциальности, отображаемый конечному пользователю." }, "skip_welcome_screen": { "type": "boolean", "description": "Пропустить начальный экран приветствия." }, "disable_login_with_didit": { "type": "boolean", "description": "Продолжить как гость вместо отображения экрана входа через Didit. Не может быть переключено обратно на `false`, пока настроен пользовательский домен (400)." }, "hide_progress_bar": { "type": "boolean", "description": "Скрыть индикатор прогресса во время прохождения сценария." }, "callback_seconds": { "type": "integer", "minimum": 0, "description": "Задержка (в секундах) перед перенаправлением на URL обратного вызова." }, "delete_logo_square": { "type": "boolean", "description": "Когда `true`, удаляет текущий квадратный логотип." }, "delete_logo_rectangular": { "type": "boolean", "description": "Когда `true`, удаляет текущий прямоугольный логотип." }, "delete_logo_rectangular_dark": { "type": "boolean", "description": "Когда `true`, удаляет текущий логотип для темной темы, после чего `logo_rectangular_dark` принимает значение `null`. Если в том же multipart-запросе также загружается `image_rectangular_dark`, приоритет отдается загрузке." }, "delete_favicon": { "type": "boolean", "description": "Когда `true`, удаляет текущий favicon." } } }, "BrandingCustomization": { "type": "object", "description": "Брендинг White label для приложения: цвета, шрифты, радиусы скругления, URL-адреса логотипов и параметры UI/UX. URL-адреса логотипов доступны только для чтения (они задаются путём загрузки изображений). Пользовательский домен и email в стиле White label не включены.", "properties": { "color_primary": { "type": "string" }, "color_secondary": { "type": "string" }, "color_background": { "type": "string" }, "color_panel": { "type": "string" }, "color_panel_10": { "type": "string" }, "color_on_panel_1": { "type": "string" }, "color_on_panel_2": { "type": "string" }, "color_on_background": { "type": "string" }, "color_button_1": { "type": "string" }, "color_button_2": { "type": "string" }, "color_button_text_1": { "type": "string" }, "color_button_text_2": { "type": "string" }, "color_pill_text": { "type": "string" }, "border_radius_panel": { "type": "integer" }, "border_radius_buttons": { "type": "integer" }, "font_family": { "type": "string" }, "font_weight": { "type": "string" }, "font_url": { "type": "string", "nullable": true, "description": "Только для чтения. Разрешённый URL таблицы стилей Google Fonts для выбранного семейства шрифтов." }, "logo_square": { "type": "string", "nullable": true, "description": "URL квадратного логотипа только для чтения. Загружается через `image_square`." }, "logo_rectangular": { "type": "string", "nullable": true, "description": "URL прямоугольного логотипа только для чтения. Загружается через `image_rectangular`." }, "logo_rectangular_dark": { "type": "string", "format": "uri", "nullable": true, "description": "Только для чтения. Временный подписанный URL прямоугольного логотипа для тёмной темы, отображаемого на тёмном фоне. `null`, если тёмный логотип не задан или прямоугольные логотипы не отображаются для вашего аккаунта. Загрузите его через `image_rectangular_dark`." }, "favicon": { "type": "string", "nullable": true, "description": "URL фавикона только для чтения. Загружается через `image_favicon`." }, "app_public_name": { "type": "string", "nullable": true }, "privacy_policy_url": { "type": "string", "nullable": true }, "skip_welcome_screen": { "type": "boolean" }, "disable_login_with_didit": { "type": "boolean" }, "hide_progress_bar": { "type": "boolean" }, "callback_seconds": { "type": "integer" } } }, "WebhookEvent": { "type": "string", "description": "Поддерживаемое имя события webhook. Используйте именно эти строки в `subscribed_events`; неподдерживаемые значения отклоняются.", "enum": [ "status.updated", "data.updated", "user.status.updated", "user.data.updated", "business.status.updated", "business.data.updated", "activity.created", "transaction.created", "transaction.status.updated", "travel_rule.status.updated", "workflow.compliance_changed", "transaction_rule_suggestions.created", "auth.signup", "auth.login", "auth.login_failed", "auth.password_reset_requested", "auth.password_reset_completed", "auth.mfa_changed", "auth.new_device", "auth.account_locked", "investigator.report.ready", "investigator.decision.automated", "investigator.decision.overridden", "investigator.decision.contested", "investigator.question.raised", "investigator.automation.paused", "investigator.rfi.answered", "investigator.rfi.overdue", "investigator.drift.detected", "investigator.sla.breached", "investigator.qa.failed", "investigator.external.report.ready" ] }, "WebhookSubscribedEvents": { "type": "array", "description": "Фильтр событий для этого адреса назначения webhook. Didit доставляет только те webhook, чей тип события точно совпадает с одним из этих значений — подписка по маске отсутствует. При отправке список должен содержать как минимум одно допустимое событие (явный пустой массив `[]` отклоняется с кодом 400); адрес назначения с пустым списком (поле пропущено при создании) ничего не получает. При обновлении список заменяется целиком, а не объединяется.", "minItems": 1, "uniqueItems": true, "items": { "$ref": "#/components/schemas/WebhookEvent" }, "example": [ "status.updated", "data.updated" ] }, "PhoneVerificationSendResponse": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID сессии верификации. Отправка с `Retry` возвращает тот же `request_id`, что и исходная отправка. Этот ID отображается в Business Console, возвращается повторно при завершённом `POST /v3/phone/check/` и может быть передан в `GET /v3/session/{sessionId}/decision/`." }, "status": { "type": "string", "enum": [ "Success", "Retry", "Blocked" ], "description": "`Success` — OTP отправлен для новой верификации. `Retry` — OTP отправлен повторно для ожидающей верификации, созданной предыдущей отправкой. `Blocked` — антифрод-система заблокировала отправку; верификация сразу переводится в статус `Declined`, средства не списываются." }, "reason": { "type": "string", "nullable": true, "description": "Причина, по которой отправка получила статус `Blocked` (например, `repeated_attempts`, `suspicious`, `spam`). `null` при `Success` и `Retry`." }, "vendor_data": { "type": "string", "nullable": true, "description": "Эхо-значение `vendor_data`, сохранённого в сессии (из первой отправки)." }, "metadata": { "type": "object", "nullable": true, "description": "Эхо-значение `metadata`, сохранённого в сессии (из первой отправки)." } } }, "PhoneVerificationCheckResponse": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "При `Approved`/`Declined`: id сессии сопоставленной верификации — совпадает с `request_id`, возвращаемым `POST /v3/phone/send/`. При `Failed` и `Expired or Not Found`: случайный разовый UUID, который впоследствии нельзя найти по запросу." }, "status": { "type": "string", "enum": [ "Approved", "Declined", "Failed", "Expired or Not Found" ], "description": "`Approved` — правильный код, отсутствуют отклоняющие риски. `Declined` — терминальный статус: сработал отклоняющий риск или исчерпан лимит попыток (3). `Failed` — неверный код, попытки ещё остались. `Expired or Not Found` — нет ожидающей верификации для этого номера за последние 5 минут." }, "message": { "type": "string", "description": "Понятное объяснение результата, включая количество оставшихся попыток после неверного ввода кода." }, "phone": { "type": "object", "nullable": true, "description": "Полный отчёт по номеру телефона. Присутствует (не null) только при финальных результатах (`Approved`/`Declined`); `null` при `Failed` и отсутствует при `Expired or Not Found`.", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Not Finished", "Expired" ], "description": "Финальный статус проверки телефона. Совпадает со значением `status` верхнего уровня для завершённых проверок." }, "phone_number_prefix": { "type": "string", "description": "Телефонный код страны со знаком `+` в начале (например, `+1`).", "example": "+1" }, "phone_number": { "type": "string", "description": "Национальный номер без телефонного кода страны.", "example": "4155552671" }, "full_number": { "type": "string", "description": "Полный номер в формате E.164.", "example": "+14155552671" }, "country_code": { "type": "string", "nullable": true, "description": "Код страны номера по стандарту ISO 3166-1 alpha-2.", "example": "US" }, "country_name": { "type": "string", "description": "Полное название страны, полученное из `country_code`.", "example": "United States" }, "carrier": { "type": "object", "description": "Текущая сеть, обслуживающая номер, полученная в результате проверки оператора при завершении.", "properties": { "name": { "type": "string", "description": "Название оператора связи. Пустая строка, если при поиске не удалось его определить." }, "type": { "type": "string", "description": "Тип линии, возвращённый поиском: `mobile`, `fixed_line`, `voip`, `isp`, `vpn`, `toll_free`, `premium_rate`, `pager`, `payphone`, `satellite`, `service`, `shared_cost`, `short_codes_commercial`, `calling_cards`, `local_rate`, `universal_access`, `voice_mail`, `other` или `unknown`." } } }, "is_disposable": { "type": "boolean", "description": "`true`, если номер принадлежит сервису временных/одноразовых номеров." }, "is_virtual": { "type": "boolean", "description": "`true`, если тип линии является виртуальным (`voip`, `isp` или `vpn`)." }, "verification_method": { "type": "string", "description": "Канал, через который был фактически доставлен OTP после подтверждения доставки (например, `whatsapp`, `sms`); до этого момента указывается запрошенный канал." }, "verification_attempts": { "type": "integer", "description": "Количество отправок OTP для этой верификации (1 или 2 после повторной попытки)." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда был введён правильный код. `null`, если верификация так и не была одобрена." }, "warnings": { "type": "array", "description": "Предупреждения о рисках, зафиксированные в ходе верификации (дубликат, одноразовый, VoIP, превышение попыток, список блокировки и т. д.). Пустой массив, если предупреждений нет.", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Функция, вызвавшая предупреждение. Здесь всегда `PHONE`." }, "risk": { "type": "string", "description": "Машиночитаемый код риска." }, "additional_data": { "type": "object", "nullable": true, "description": "Контекст конкретного риска (например, ID дублированной сессии для рисков дублирования). `null`, если риск не содержит дополнительных данных." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Уровень серьёзности. Риски со значением `error` отклоняют верификацию, `warning` отправляет её на проверку, `information` фиксируется без влияния на статус." }, "short_description": { "type": "string", "description": "Краткая сводка риска в одну строку в понятном человеку формате." }, "long_description": { "type": "string", "description": "Понятное объяснение риска." } } } }, "lifecycle": { "type": "array", "description": "Хронологический журнал аудита верификации. Значение `type` события является одним из `PHONE_VERIFICATION_MESSAGE_SENT`, `PHONE_VERIFICATION_RETRY_MESSAGE_SENT`, `PHONE_VERIFICATION_BLOCKED`, `PHONE_DELIVERY_DELIVERED`, `PHONE_DELIVERY_UNDELIVERABLE`, `VALID_CODE_ENTERED`, `INVALID_CODE_ENTERED`, `PHONE_VERIFICATION_APPROVED`, `PHONE_VERIFICATION_DECLINED`, `PHONE_VERIFICATION_IN_REVIEW`, `PHONE_VERIFICATION_EXPIRED`.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Тип события." }, "timestamp": { "type": "string", "format": "date-time", "description": "Когда событие произошло." }, "details": { "type": "object", "nullable": true, "description": "payload, специфичный для события. События отправки: `{status, reason, channel, actual_channel}` (`actual_channel` заполняется после подтверждения доставки). События доставки: `{channel, status}`. События ввода кода: `{code_tried, status}`. События финального статуса: `null`, или `{reason}`, если отклонена или на проверке." }, "fee": { "type": "number", "description": "Сумма в USD, списанная за это событие. Отлична от нуля только для событий отправки (цена доставки); 0 для ввода кода, подтверждений доставки и событий статуса." } } } }, "matches": { "type": "array", "description": "Другие сессии вашего приложения (KYC, KYB или API), где тот же номер телефона использовался другим пользователем (другой `vendor_data`). До 5 записей, сначала совпадение со сгенерированной записью из списка блокировки, если оно есть (совпадения на основе сессий сохраняют порядок запроса). Пустой массив при отсутствии совпадений.", "items": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "ID сессии другой верификации, в которой использовался этот номер телефона." }, "session_number": { "type": "integer", "description": "Понятный порядковый номер этой сессии." }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` этой сессии." }, "verification_date": { "type": "string", "description": "Когда была создана эта сессия (`YYYY-MM-DDTHH:MM:SSZ`)." }, "phone_number": { "type": "string", "description": "Совпавший номер телефона." }, "status": { "type": "string", "description": "Статус этой сессии (например, `Approved`, `Declined`, `In Progress`)." }, "is_blocklisted": { "type": "boolean", "description": "Находится ли номер телефона в списке блокировки вашего приложения." }, "api_service": { "type": "string", "nullable": true, "description": "Для сессий типа API: отдельный API, создавший её (например, `PHONE_VERIFICATION`); `null` для обычных сессий верификации." }, "source": { "type": "string", "description": "Где было найдено совпадение. Обычно `session`; попадание в список блокировки через запись в списке организации добавляет в начало синтетическое совпадение с `source: \"list_entry\"` и со значениями null для `session_id`/`session_number`." } } } }, "phone_social": { "$ref": "#/components/schemas/PhoneSocialFootprint" }, "phone_intelligence": { "allOf": [ { "$ref": "#/components/schemas/PhoneIntelligence" } ], "description": "Аналитические сигналы по номеру телефона. Присутствуют только в том случае, если в проверке параметр `enable_enrichment` был равен `true`." } } }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` сессии совпавшей верификации. `null` при `Expired or Not Found`." }, "metadata": { "type": "object", "nullable": true, "description": "`metadata` сессии совпавшей верификации. `null` при `Expired or Not Found`." }, "created_at": { "type": "string", "format": "date-time", "description": "Временная метка ответа на эту проверку." } } }, "EmailVerificationSendResponse": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID сессии верификации. Отправка с `Retry` возвращает тот же `request_id`, что и исходная отправка. Этот ID отображается в Business Console, возвращается повторно при завершённом `POST /v3/email/check/` и может быть передан в `GET /v3/session/{sessionId}/decision/`." }, "status": { "type": "string", "enum": [ "Success", "Retry", "Undeliverable" ], "description": "`Success` — OTP отправлен по электронной почте для новой верификации (платно). `Retry` — отправлен новый OTP для ожидающей верификации, созданной предыдущей отправкой (бесплатно). `Undeliverable` — адрес не прошёл валидацию доставляемости или сообщение не удалось отправить; верификация сразу переводится в статус `Declined`, средства не списываются." }, "reason": { "type": "string", "nullable": true, "enum": [ "email_can_not_be_delivered", null ], "description": "`email_can_not_be_delivered`, когда `status` имеет значение `Undeliverable`; `null` в противном случае." }, "vendor_data": { "type": "string", "nullable": true, "description": "Эхо-значение `vendor_data`, сохранённого в сессии (из первой отправки)." }, "metadata": { "type": "object", "nullable": true, "description": "Эхо-значение `metadata`, сохранённого в сессии (из первой отправки)." } } }, "EmailVerificationCheckResponse": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "При `Approved`/`Declined`: id сессии сопоставленной верификации — совпадает с `request_id`, возвращаемым `POST /v3/email/send/`. При `Failed` и `Expired or Not Found`: случайный разовый UUID, который впоследствии нельзя найти по запросу." }, "status": { "type": "string", "enum": [ "Approved", "Declined", "Failed", "Expired or Not Found" ], "description": "`Approved` — правильный код, отсутствуют отклоняющие риски. `Declined` — терминальный статус: сработал отклоняющий риск или исчерпан лимит попыток (3). `Failed` — неверный код, попытки ещё остались. `Expired or Not Found` — нет ожидающей верификации для этого адреса за последние 5 минут." }, "message": { "type": "string", "description": "Понятное объяснение результата, включая количество оставшихся попыток после неверного ввода кода." }, "email": { "type": "object", "nullable": true, "description": "Полный отчёт по электронной почте. Присутствует (не null) только при окончательных результатах (`Approved`/`Declined`); `null` при `Failed` и отсутствует при `Expired or Not Found`.", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Not Finished", "Expired" ], "description": "Финальный статус проверки электронной почты. Совпадает со значением `status` верхнего уровня для завершённых проверок." }, "email": { "type": "string", "format": "email", "description": "Подтверждённый адрес электронной почты.", "example": "alice@example.com" }, "is_breached": { "type": "boolean", "description": "`true`, когда адрес фигурирует в известных утечках данных (поиск по базам утечек выполняется на этапе финализации)." }, "breaches": { "type": "array", "description": "До 5 последних известных утечек, содержащих этот адрес. Пустой массив (или поле опущено), если `is_breached` имеет значение `false`.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Идентификатор утечки." }, "domain": { "type": "string", "description": "Домен скомпрометированного сервиса." }, "breach_date": { "type": "string", "format": "date", "description": "Дата, когда произошло нарушение." }, "breach_emails_count": { "type": "integer", "description": "Общее количество аккаунтов, данные которых оказались в утечке." }, "description": { "type": "string", "description": "Понятное описание утечки (может содержать HTML-разметку)." }, "logo_path": { "type": "string", "description": "URL логотипа скомпрометированного сервиса." }, "data_classes": { "type": "array", "items": { "type": "string" }, "description": "Категории раскрытых данных в формате snake_case (например, `email_addresses`, `passwords`)." }, "is_verified": { "type": "boolean", "description": "Была ли утечка подтверждена как подлинная." } } } }, "is_disposable": { "type": "boolean", "description": "`true`, если домен принадлежит известному сервису одноразовой или временной почты." }, "is_undeliverable": { "type": "boolean", "description": "`true`, когда адрес не может принимать почту (ошибка синтаксиса или проверки DNS/MX, либо сообщение вернулось с ошибкой доставки)." }, "verification_attempts": { "type": "integer", "description": "Количество отправок OTP для этой верификации (1 или 2 после повторной попытки)." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда был введён правильный код. `null`, если верификация так и не была одобрена." }, "warnings": { "type": "array", "description": "Предупреждения о рисках, зафиксированные в ходе верификации (дубликат, скомпрометированный, одноразовый, недоставляемый, превышение попыток, список блокировки и т. д.). Пустой массив, если предупреждений нет.", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Функция, вызвавшая предупреждение. Здесь всегда `EMAIL`." }, "risk": { "type": "string", "description": "Машиночитаемый код риска." }, "additional_data": { "type": "object", "nullable": true, "description": "Контекст конкретного риска (например, ID дублированной сессии для рисков дублирования). `null`, если риск не содержит дополнительных данных." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Уровень серьёзности. Риски со значением `error` отклоняют верификацию, `warning` отправляет её на проверку, `information` фиксируется без влияния на статус." }, "short_description": { "type": "string", "description": "Краткая сводка риска в одну строку в понятном человеку формате." }, "long_description": { "type": "string", "description": "Понятное объяснение риска." } } } }, "lifecycle": { "type": "array", "description": "Хронологический журнал аудита верификации. Значение `type` события является одним из `EMAIL_VERIFICATION_MESSAGE_SENT`, `EMAIL_VERIFICATION_RETRY_MESSAGE_SENT`, `VALID_CODE_ENTERED`, `INVALID_CODE_ENTERED`, `EMAIL_VERIFICATION_APPROVED`, `EMAIL_VERIFICATION_DECLINED`, `EMAIL_VERIFICATION_IN_REVIEW`, `EMAIL_VERIFICATION_EXPIRED`.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Тип события." }, "timestamp": { "type": "string", "format": "date-time", "description": "Когда событие произошло." }, "details": { "type": "object", "nullable": true, "description": "payload, специфичный для события. События отправки: `{status, reason}`. События ввода кода: `{code_tried, status}`. События финального статуса: `null`, или `{reason}`, если отклонена или на проверке." }, "fee": { "type": "number", "description": "Сумма в USD, списанная за это событие. Отлична от нуля только при первой успешной отправке; 0 для повторных попыток, ввода кода и событий статуса." } } } }, "matches": { "type": "array", "description": "Другие сессии вашего приложения (KYC, KYB или API), где тот же адрес электронной почты использовался другим пользователем (с другим `vendor_data`). До 5 записей; синтетическое совпадение со списком блокировки добавляется в начало при его наличии (и только если нет заблокированного адреса электронной почты, полученного из сессии) — совпадения из сессий сохраняют порядок created_at. Пустой массив, если совпадений нет.", "items": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "ID сессии другой верификации, в которой использовался этот адрес электронной почты." }, "session_number": { "type": "integer", "description": "Понятный порядковый номер этой сессии." }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` этой сессии." }, "verification_date": { "type": "string", "description": "Когда была создана эта сессия (`YYYY-MM-DDTHH:MM:SSZ`)." }, "email": { "type": "string", "description": "Совпавший адрес электронной почты." }, "status": { "type": "string", "description": "Статус этой сессии (например, `Approved`, `Declined`, `In Progress`)." }, "is_blocklisted": { "type": "boolean", "description": "Находится ли адрес электронной почты в списке блокировки вашего приложения." }, "api_service": { "type": "string", "nullable": true, "description": "Для сессий типа API: отдельный API, создавший её (например, `PHONE_VERIFICATION`); `null` для обычных сессий верификации." }, "source": { "type": "string", "description": "Где было найдено совпадение. Обычно `session`; попадание в список блокировки через запись в списке организации добавляет в начало синтетическое совпадение с `source: \"list_entry\"` и со значениями null для `session_id`/`session_number`." } } } }, "email_social": { "$ref": "#/components/schemas/EmailSocialFootprint" }, "email_intelligence": { "allOf": [ { "$ref": "#/components/schemas/EmailIntelligence" } ], "description": "Сигналы аналитики электронной почты. Присутствуют, только если параметр `enable_enrichment` имел значение `true` при проверке." } } }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` сессии совпавшей верификации. `null` при `Expired or Not Found`." }, "metadata": { "type": "object", "nullable": true, "description": "`metadata` сессии совпавшей верификации. `null` при `Expired or Not Found`." }, "created_at": { "type": "string", "format": "date-time", "description": "Временная метка ответа на эту проверку." } } }, "WorkflowListItem": { "type": "object", "description": "Одна версия сценария в представлении списка.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID конкретной версии. Используется как `{settings_uuid}` для получения, обновления и удаления и как `workflow_id` при создании сессий." }, "workflow_id": { "type": "string", "format": "uuid", "description": "Постоянный ID группы, общий для всех версий одного и того же сценария. Равен `uuid` для версии 1." }, "workflow_label": { "type": "string", "description": "Отображаемое имя для сценария." }, "workflow_type": { "type": "string", "nullable": true, "description": "Базовый тип простых сценариев: `kyc`, `kyb`, `adaptive_age_verification`, `biometric_authentication` и т. д. `null` для сценариев на основе графа без функции KYB." }, "is_default": { "type": "boolean", "description": "Является ли этот сценарий сценарием по умолчанию для новых сессий." }, "is_archived": { "type": "boolean" }, "is_white_label_enabled": { "type": "boolean", "description": "Применяется ли кастомизация White label к сессиям, созданным с помощью этого сценария." }, "total_price": { "type": "number", "description": "Фиксированная цена за верификацию в USD (число JSON, исключает функции с переменной ценой, такие как DATABASE_VALIDATION и PHONE_VERIFICATION)." }, "min_price": { "type": "number", "description": "Минимальная фиксированная цена по путям графа сценария, в USD." }, "max_price": { "type": "number", "description": "Самая высокая фиксированная цена среди путей графа сценария, в USD." }, "features": { "type": "string", "description": "Включенные функции в виде единой строки, разделенной `\" + \"`, например `\"OCR + LIVENESS + FACE_MATCH\"`. Разделите по `\" + \"`, чтобы получить список." }, "is_simple_workflow": { "type": "boolean", "description": "True, когда у сценария нет кастомного графа сценария." }, "is_editable": { "type": "boolean", "description": "Имеет значение true, если эта версия является `draft` (черновики можно редактировать на месте; опубликованные версии в Console неизменяемы)." }, "workflow_url": { "type": "string", "format": "uri", "description": "Публичная ссылка на верификацию для этого сценария (`https://verify.didit.me/u/`)." }, "max_retry_attempts": { "type": "integer", "description": "Максимальное количество повторных попыток после отклонения верификации (0-10)." }, "retry_window_days": { "type": "integer", "nullable": true, "description": "Скользящее окно в днях для подсчёта повторных попыток (1-365). `null` = лимит за всё время." }, "session_expiration_time": { "type": "integer", "description": "Количество секунд до истечения срока незавершённой сессии (3600-2419200)." }, "version": { "type": "integer", "description": "Номер версии внутри группы `workflow_id`, начиная с 1." }, "status": { "type": "string", "enum": [ "draft", "published" ], "description": "Статус версии. Новые сессии используют последнюю опубликованную версию (`published`) группы." }, "has_draft": { "type": "boolean", "description": "True, когда любая версия в этой группе `workflow_id` в данный момент является черновиком." }, "created_by": { "type": "object", "nullable": true, "description": "Кто создал эту версию: `{name, email, type}`, где `type` имеет значение `user` (пользователь консоли, поле `email` заполнено) или `api_key` (поле `name` содержит идентификатор клиента, `email` равен null). `null`, если создатель не был зафиксирован.", "properties": { "name": { "type": "string" }, "email": { "type": "string", "nullable": true }, "type": { "type": "string", "enum": [ "user", "api_key" ] } } }, "updated_at": { "type": "string", "format": "date-time" } } }, "SimpleWorkflowRequest": { "type": "object", "description": "Создайте простой линейный сценарий. API преобразует этот список функций во внутренний граф сценария на основе узлов. СТРОГИЙ белый список полей: любой ключ, не указанный здесь (включая `workflow_type`), отклоняется с кодом 400.", "required": [ "features" ], "properties": { "workflow_label": { "type": "string", "maxLength": 50, "default": "ID Verification", "description": "Отображаемое имя для сценария (максимум 50 символов). По умолчанию `\"ID Verification\"`, если параметр опущен — всегда задавайте его, чтобы сценарии оставались различимыми.", "example": "Standard KYC" }, "is_default": { "type": "boolean", "description": "Установить этот сценарий по умолчанию для новых сессий." }, "status": { "type": "string", "enum": [ "draft", "published" ], "description": "Опустите это поле, чтобы создать опубликованный сценарий, готовый к запуску сессий. Используйте `draft`, только если хотите сохранить без публикации." }, "features": { "type": "array", "minItems": 1, "description": "Функции верификации в порядке выполнения. API связывает каждый элемент со следующим и автоматически добавляет один финальный узел статуса.", "items": { "$ref": "#/components/schemas/SimpleWorkflowFeature" } }, "is_white_label_enabled": { "type": "boolean", "description": "Включить кастомизацию White label для сессий, созданных с этим сценарием.", "default": false }, "is_desktop_allowed": { "type": "boolean", "description": "Разрешить запуск сценария верификации в браузерах на десктопе.", "default": false }, "max_retry_attempts": { "type": "integer", "minimum": 0, "maximum": 10, "default": 3, "description": "Максимальное количество повторных попыток после отклонения верификации. `0` блокирует пользователя после первого отклонения." }, "retry_window_days": { "type": "integer", "minimum": 1, "maximum": 365, "nullable": true, "default": 7, "description": "Скользящее окно в днях для подсчёта повторных попыток. `null` устанавливает лимит за всё время." }, "face_liveness_max_attempts": { "type": "integer", "minimum": 1, "maximum": 3, "default": 3, "description": "Максимальное количество попыток проверки живости за сессию. По умолчанию 3: одна начальная попытка плюс две повторные попытки. Это значение также копируется в сгенерированные узлы проверки живости и оценки возраста в сценарии, если только оно не переопределено в конфигурации на уровне функции." }, "face_match_max_attempts": { "type": "integer", "minimum": 1, "maximum": 3, "default": 3, "description": "Максимальное количество попыток сравнения лиц за сессию. По умолчанию 3: одна начальная попытка плюс две повторные попытки. Это значение также копируется в сгенерированные узлы сравнения лиц в сценарии, если только оно не переопределено в конфигурации на уровне функции." }, "session_expiration_time": { "type": "integer", "minimum": 3600, "maximum": 2419200, "default": 604800, "description": "Количество секунд до истечения срока незавершённой сессии. Минимум 1 час (3600), максимум 4 недели (2419200)." } } }, "SimpleWorkflowUpdateRequest": { "type": "object", "description": "Обновить метаданные сценария или заменить полный линейный список функций. СТРОГИЙ белый список полей: любой неуказанный здесь ключ отклоняется с ошибкой 400.", "properties": { "workflow_label": { "type": "string", "maxLength": 50, "description": "Отображаемое имя для сценария (максимум 50 символов)." }, "is_default": { "type": "boolean", "description": "Установить этот сценарий по умолчанию для новых сессий." }, "status": { "type": "string", "enum": [ "draft", "published" ], "description": "Управляет версионированием. Опустите, чтобы обновить текущую версию на месте (черновики публикуются автоматически). Значение `published` для уже опубликованной версии создаёт и возвращает НОВУЮ версию. Значение `draft` допустимо только тогда, когда версия всё ещё является черновиком." }, "features": { "type": "array", "minItems": 1, "description": "Если указано, полностью заменяет порядок и конфигурацию функций.", "items": { "$ref": "#/components/schemas/SimpleWorkflowFeature" } }, "is_white_label_enabled": { "type": "boolean", "description": "Включить кастомизацию White label для сессий, созданных с этим сценарием." }, "is_desktop_allowed": { "type": "boolean", "description": "Разрешить запуск сценария верификации в браузерах на десктопе." }, "max_retry_attempts": { "type": "integer", "minimum": 0, "maximum": 10, "description": "Максимальное количество повторных попыток после отклонения верификации. `0` блокирует пользователя после первого отклонения." }, "retry_window_days": { "type": "integer", "minimum": 1, "maximum": 365, "nullable": true, "description": "Скользящее окно в днях для подсчёта повторных попыток. `null` устанавливает лимит за всё время." }, "face_liveness_max_attempts": { "type": "integer", "minimum": 1, "maximum": 3, "description": "Максимальное количество попыток проверки живости за сессию. Это значение также копируется в сгенерированные узлы проверки живости и оценки возраста в сценарии, если только оно не переопределено в конфигурации на уровне функции." }, "face_match_max_attempts": { "type": "integer", "minimum": 1, "maximum": 3, "description": "Максимальное количество попыток сравнения лиц за сессию. Это значение также копируется в сгенерированные узлы сравнения лиц в сценарии, если только оно не переопределено в конфигурации на уровне функции." }, "session_expiration_time": { "type": "integer", "minimum": 3600, "maximum": 2419200, "description": "Количество секунд до истечения срока незавершённой сессии. Минимум 1 час (3600), максимум 4 недели (2419200)." } } }, "SimpleWorkflowFeature": { "type": "object", "required": [ "feature" ], "properties": { "feature": { "type": "string", "description": "Функция для запуска. Используйте значения в верхнем регистре, приведенные здесь.", "enum": [ "OCR", "NFC", "LIVENESS", "FACE_MATCH", "PROOF_OF_ADDRESS", "QUESTIONNAIRE", "DOCUMENT_AI", "PHONE_VERIFICATION", "EMAIL_VERIFICATION", "DATABASE_VALIDATION", "AML", "IP_ANALYSIS", "AGE_ESTIMATION", "KYB_REGISTRY", "KYB_DOCUMENTS", "KYB_KEY_PEOPLE", "SIGNATURE" ] }, "config": { "type": "object", "description": "Настройки конкретной функции. Для `QUESTIONNAIRE` укажите `questionnaire_uuid` со значением `questionnaire_id`, возвращённым endpoint создания анкеты. Для `SIGNATURE`: сценарию, переводимому в продакшн, требуется документ для подписания: установите `signature_documents_source` в `session` или `both`, чтобы каждая сессия могла передавать свой собственный, либо передайте `status: \"draft\"` и добавьте документы перед публикацией. Значение `signature_level: \"aes\"` отклоняется с ошибкой `aes_not_available`, пока `signature_availability.aes` имеет значение `false` в сценарии. Для `OCR` параметр `methods` определяет, какие методы Верификации личности разрешены для каждой страны (захват документа, проверка без документов по государственным или другим авторитетным источникам и цифровые кошельки удостоверений личности); если его опустить, для всех стран будет использоваться только захват документов. Для `SIGNATURE` см. [Настройки электронной подписи](/ru/management-api/workflows/feature-configs#электронная-подпись): `signature_level` сейчас принимает значения `simple` (по умолчанию, верификация личности, электронная почта или телефон не требуются) и `aes`, а документы сценария и их поля настраиваются в консоли, поэтому через API отправляйте документы и поля для каждой сессии с параметром `signature_documents_source: \"session\"`.", "additionalProperties": true }, "label": { "type": "string", "description": "Необязательная внутренняя метка для этого узла сценария." } } }, "ReviewItem": { "type": "object", "description": "Одна запись в ленте проверки / активности сессии. Изменения статуса содержат `previous_status`, `new_status`, `previous_value`, `new_value` и `changed_fields`; комментарии содержат `comment` и (для комментариев в консоли) `mentioned_emails`; остальные поля содержат `null` или пусты, если они неприменимы к данному типу активности.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Уникальный идентификатор этой записи ленты.", "example": "de0561bc-5583-4409-9171-1a31a4c8a5f4" }, "activity_type": { "type": "string", "enum": [ "COMMENT", "STATUS_UPDATED", "KYC_DATA_UPDATED", "POA_DATA_UPDATED", "FILE_ADDED", "FILE_REMOVED", "AML_ONGOING_MATCH", "AML_STATUS_UPDATED", "AML_HIT_STATUS_UPDATED", "KYB_DATA_UPDATED", "KYB_DOCUMENT_UPLOADED", "TAG_ADDED", "TAG_REMOVED", "FEATURE_OVERRIDE_PENDING", "FEATURE_OVERRIDE_APPLIED", "FEATURE_OVERRIDE_CANCELLED" ], "description": "Какой тип активности фиксирует эта запись. Строки `STATUS_UPDATED` создаются при ручных решениях (`PATCH /v3/session/{session_id}/update-status/`) и при добавлении записей через `POST …/reviews/` (для которых этот тип используется по умолчанию, даже если статус не зафиксирован). Строки `COMMENT` поступают от проверяющих в Console; просмотры страниц сведений в Console также сохраняются как строки `COMMENT` с флагом `metadata.system_event = \"DETAIL_VIEWED\"`. Остальные типы отслеживают редактирование данных, изменения файлов, теги и действия по AML-мониторингу. Строки STATUS_UPDATED также записываются системными акторами (например, постоянным AML-мониторингом с actor_type SYSTEM и автоматическими обновлениями статусов функций), а не только endpoint обновления статуса и записями, добавленными при ручной проверке. `FEATURE_OVERRIDE_PENDING`, `FEATURE_OVERRIDE_APPLIED` и `FEATURE_OVERRIDE_CANCELLED` фиксируют переопределение статуса одной проверки (`PATCH /v3/session/{session_id}/features/{node_id}/update-status/`): запрошено ожидать завершения сценария, применено или отменено. Они содержат статус проверки в `previous_value` / `new_value` (`{\"status\": ...}`), оставляют `previous_status` и `new_status` со значением `null` и указывают переопределение в `metadata` (`feature_override_id`, `node_id`, `feature_model`, `forced`, `state`, `cancel_reason`). Запись для запроса содержит `comment` проверяющего; переопределение, примененное по завершении сценария, записывается с `actor_type` `SYSTEM`.", "example": "STATUS_UPDATED" }, "actor_display": { "type": "string", "description": "Понятная метка автора, определяемая по порядку: полное имя исполнителя → идентификатор аккаунта в Console → локальная часть `actor_email` → `\"API Client\"` (для исполнителей с типом `API_KEY`) → `\"System\"` (для исполнителей с типом `SYSTEM`) → `\"Unknown\"`. Записи, созданные через `POST …/reviews/`, всегда отображают `\"Unknown\"`, поскольку этот endpoint не фиксирует авторство.", "example": "API Client" }, "actor_email": { "type": "string", "nullable": true, "description": "Электронная почта пользователя Console, выполнившего действие. `null` для инициаторов действий через API-ключ и системных инициаторов.", "example": null }, "actor_type": { "type": "string", "enum": [ "API_KEY", "CONSOLE_USER", "SYSTEM" ], "description": "Кто выполнил действие: API-ключ, пользователь консоли или сам Didit (`SYSTEM`, например постоянный AML-мониторинг). Записи, созданные через `POST …/reviews/`, по умолчанию содержат `CONSOLE_USER` независимо от вызывающей стороны.", "example": "API_KEY" }, "new_status": { "type": "string", "nullable": true, "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Статус сессии, зафиксированный этой записью (для обновлений статуса). `null` для комментариев и записей об изменении данных.", "example": "Approved" }, "previous_status": { "type": "string", "nullable": true, "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Статус сессии до изменения. Заполняется в записях `STATUS_UPDATED`, созданных endpoint обновления статуса; `null` в записях, добавленных через `POST …/reviews/`. Также заполняется в строках STATUS_UPDATED, созданных системой.", "example": "In Review" }, "comment": { "type": "string", "nullable": true, "description": "Примечание к записи в виде произвольного текста или `null`.", "example": "Document re-checked manually; address matches." }, "mentioned_emails": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "Пользователи Console, упомянутые через `@email` в комментарии. Всегда пусто для записей, созданных через этот API — обработка упоминаний доступна только в Console.", "example": [] }, "previous_value": { "type": "object", "nullable": true, "description": "Снимок изменённых данных до действия, например `{\"status\": \"In Review\"}` при смене статуса. `null`, если ничего не менялось.", "example": { "status": "In Review" } }, "new_value": { "type": "object", "nullable": true, "description": "Снимок изменённых данных после действия, например `{\"status\": \"Approved\"}`. `null`, если ничего не менялось.", "example": { "status": "Approved" } }, "changed_fields": { "type": "array", "items": { "type": "string" }, "description": "Названия полей, изменённых данным действием (например, `[\"status\"]`). Пусто для комментариев и записей, добавленных через `POST …/reviews/`.", "example": [ "status" ] }, "metadata": { "type": "object", "nullable": true, "description": "Дополнительный контекст для записей, созданных системой. Просмотры страниц с подробными сведениями в Console содержат `{\"system_event\": \"DETAIL_VIEWED\", \"detail_type\": \"verification\"}`, что позволяет отфильтровать их из логики уведомлений. Запись `COMMENT`, отредактированная автором в Console, содержит `edited_at`, время последнего редактирования в формате ISO 8601 (в таком случае `comment` и `mentioned_emails` содержат отредактированный текст и упомянутые в нем адреса). `null` для обычных записей.", "example": null }, "created_at": { "type": "string", "format": "date-time", "description": "Когда запись была внесена, ISO 8601 UTC.", "example": "2026-06-12T00:19:31.918735Z" } } }, "QuestionnaireListItem": { "type": "object", "description": "Одна версия анкеты в представлении списка.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID конкретной версии. Используется как `{questionnaire_uuid}` для получения, обновления и удаления и как `questionnaire_uuid` в конфигурации функции QUESTIONNAIRE сценария." }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "languages": { "type": "array", "items": { "type": "string" } }, "default_language": { "type": "string" }, "is_active": { "type": "boolean" }, "is_simple_questionnaire": { "type": "boolean", "description": "True для линейных анкет, созданных через этот API; false для анкет на основе графа, созданных в консоли." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "question_types": { "type": "array", "items": { "type": "string" }, "description": "Типы элементов вопросов, предполагающих ответ, заглавными буквами в порядке создания (например, `SHORT_TEXT`, `MULTIPLE_CHOICE`, `FILE_UPLOAD`). Структурные элементы `SECTION_HEADER` и `SEPARATOR` исключены. По одной записи на вопрос, поэтому значения могут повторяться." }, "workflow_names": { "type": "array", "items": { "type": "string" }, "description": "Названия сценариев, использующих эту анкету. На этом endpoint значение всегда `[]` (заполняется только в списке Консоли)." }, "questionnaire_group_id": { "type": "string", "format": "uuid", "description": "Постоянный идентификатор, объединяющий все версии одной и той же анкеты." }, "version": { "type": "integer", "description": "Номер версии внутри группы, начиная с 1." }, "status": { "type": "string", "enum": [ "draft", "published" ] }, "published_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда была опубликована эта версия. `null` для черновиков." }, "is_editable": { "type": "boolean", "description": "Имеет значение true, если эта версия является `draft`." } } }, "SimpleQuestionnaireRequest": { "type": "object", "description": "Создайте простую линейную анкету. API преобразует `form_elements` во внутренний граф анкеты.", "required": [ "title", "languages", "form_elements" ], "properties": { "title": { "type": "string", "description": "Внутреннее название анкеты." }, "description": { "type": "string", "nullable": true }, "languages": { "type": "array", "description": "Языки, включённые в каждую метку. Должен включать `en`.", "items": { "type": "string" }, "example": [ "en" ] }, "default_language": { "type": "string", "description": "Язык по умолчанию. Должен быть включён в `languages`.", "example": "en" }, "is_active": { "type": "boolean", "default": true }, "status": { "type": "string", "enum": [ "draft", "published" ], "description": "Опустите это поле, чтобы создать опубликованную анкету, готовую к использованию в сценариях." }, "form_elements": { "type": "array", "minItems": 1, "description": "Вопросы в точном порядке, в котором их должны видеть пользователи. Ветвление и условные поля не поддерживаются.", "items": { "$ref": "#/components/schemas/SimpleQuestionnaireElement" } } } }, "SimpleQuestionnaireUpdateRequest": { "type": "object", "description": "Обновить метаданные анкеты или заменить полный линейный список `form_elements`.", "properties": { "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "languages": { "type": "array", "items": { "type": "string" } }, "default_language": { "type": "string" }, "is_active": { "type": "boolean" }, "status": { "type": "string", "enum": [ "draft", "published" ] }, "form_elements": { "type": "array", "minItems": 1, "description": "Если указано, полностью заменяет весь линейный список вопросов.", "items": { "$ref": "#/components/schemas/SimpleQuestionnaireElement" } } } }, "SimpleQuestionnaireElement": { "type": "object", "required": [ "element_type", "label" ], "properties": { "id": { "type": "string", "description": "Необязательный стабильный идентификатор вопроса. Если опущен, API генерирует `q1`, `q2` и т. д. Для удобства чтения используйте строчные буквы, цифры и символы подчеркивания.", "example": "source_of_funds" }, "element_type": { "type": "string", "description": "Тип вопроса. API принимает эти значения в нижнем регистре, а также их эквиваленты в верхнем регистре.", "enum": [ "short_text", "long_text", "dropdown", "single_choice", "multiple_choice", "number", "image", "file_upload", "time", "email", "address", "phone", "country", "date_picker", "consent", "section_header", "separator", "heading", "paragraph" ] }, "label": { "type": "object", "description": "Метка вопроса по коду языка, например `{ \"en\": \"Source of funds\" }`.", "additionalProperties": { "type": "string" } }, "description": { "type": "object", "nullable": true, "additionalProperties": { "type": "string" } }, "placeholder": { "type": "object", "nullable": true, "additionalProperties": { "type": "string" } }, "is_required": { "type": "boolean", "default": false }, "options": { "type": "array", "description": "Используется для `dropdown`, `single_choice` и `multiple_choice`. Если `value` не указано, API генерирует его на основе метки варианта.", "items": { "type": "object", "required": [ "label" ], "properties": { "value": { "type": "string" }, "label": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "max_files": { "type": "integer", "minimum": 1, "maximum": 5, "description": "Используется с `file_upload` или `image`." }, "validation": { "type": "object", "nullable": true, "description": "Необязательная валидация формата для `short_text`, `long_text` или `number`. Применяется во время заполнения поля пользователем (он не сможет продолжить, пока проверка не будет пройдена) и повторно проверяется API при отправке.", "properties": { "pattern": { "type": "string", "description": "Регулярное выражение (подмножество ECMA-262), которому значение должно полностью соответствовать. Для `short_text` и `long_text`. Не добавляйте символы привязки ^/$; сопоставляется всё значение целиком." }, "min_length": { "type": "integer", "minimum": 0, "description": "Минимальное количество символов. Для `short_text` и `long_text`." }, "max_length": { "type": "integer", "minimum": 0, "description": "Максимальное количество символов. Для `short_text` и `long_text`." }, "min": { "type": "number", "description": "Минимальное числовое значение. Для `number`." }, "max": { "type": "number", "description": "Максимальное числовое значение. Для `number`." }, "error_message": { "type": "object", "description": "Переведённое сообщение, отображаемое при сбое валидации, с ключом, соответствующим коду языка.", "additionalProperties": { "type": "string" } } } } } }, "QuestionnaireDetail": { "type": "object", "description": "Полные сведения об анкете, возвращаемые из endpoint’ов GET, POST (создание) и PATCH (обновление).", "properties": { "questionnaire_id": { "type": "string", "format": "uuid", "description": "Уникальный идентификатор анкеты. Используйте этот id при ссылке на анкету из сценария или в последующих запросах на обновление/удаление." }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "languages": { "type": "array", "items": { "type": "string" } }, "default_language": { "type": "string" }, "is_active": { "type": "boolean" }, "is_simple_questionnaire": { "type": "boolean" }, "graph": { "type": "object", "description": "Структура графа с полем start_node и отображением nodes." }, "sections": { "type": "array", "description": "Содержимое анкеты, сгруппированное по разделам (на основе графа).", "items": { "type": "object" } }, "questionnaire_group_id": { "type": "string", "format": "uuid", "description": "Постоянный идентификатор, объединяющий все версии одной и той же анкеты." }, "version": { "type": "integer" }, "status": { "type": "string", "enum": [ "draft", "published" ] }, "published_at": { "type": "string", "format": "date-time", "nullable": true }, "is_editable": { "type": "boolean", "description": "True, когда анкету всё ещё можно редактировать на месте (черновые версии)." } } }, "UserListItem": { "type": "object", "description": "Верифицированный пользователь.", "properties": { "didit_internal_id": { "type": "string", "format": "uuid", "description": "Стабильный внутренний UUID Didit для этого пользователя." }, "vendor_data": { "type": "string", "nullable": true, "description": "Ваш уникальный идентификатор этого пользователя (передаётся при создании сессий). Может быть равен null, если идентификатор поставщика не был передан." }, "display_name": { "type": "string", "nullable": true, "description": "Пользовательское отображаемое имя, заданное вами" }, "full_name": { "type": "string", "nullable": true, "description": "Полное имя, извлечённое из верифицированных документов" }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "effective_name": { "type": "string", "nullable": true, "description": "Наиболее подходящее имя: display_name, если задано, иначе full_name" }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "description": "Статус жизненного цикла записи пользователя (НЕ статус сессии). `ACTIVE` используется по умолчанию, `FLAGGED` помечает пользователя для ручной проверки, `BLOCKED` запрещает новые сессии для этого `vendor_data`." }, "portrait_image_url": { "type": "string", "nullable": true, "description": "Предварительно подписанный URL портретного фото пользователя (срок действия истекает через несколько часов)" }, "session_count": { "type": "integer", "description": "Общее количество сессий верификации для этого пользователя" }, "approved_count": { "type": "integer", "description": "Количество одобренных сессий" }, "declined_count": { "type": "integer", "description": "Количество отклонённых сессий" }, "in_review_count": { "type": "integer", "description": "Количество сессий на проверке" }, "issuing_states": { "type": "array", "items": { "type": "string" }, "description": "Коды стран выдачи по стандарту ISO 3166-1 alpha-3, указанные в одобренных документах, удостоверяющих личность этого пользователя, например `[\"USA\", \"ESP\"]`. Пустой массив, если таких кодов нет." }, "approved_emails": { "type": "array", "items": { "type": "string" }, "description": "Подтверждённые адреса электронной почты, собранные из одобренных сессий этого пользователя, например `[\"john@example.com\"]`." }, "approved_phones": { "type": "array", "items": { "type": "string" }, "description": "Подтверждённые номера телефонов, собранные из одобренных сессий этого пользователя, например `[\"+14155551234\"]`." }, "features": { "type": "object", "description": "Агрегированный статус по функциям среди всех сессий этого пользователя. Возможные ключи: `ID_VERIFICATION`, `NFC`, `LIVENESS`, `FACE_MATCH`, `POA`, `QUESTIONNAIRE`, `EMAIL_VERIFICATION`, `PHONE`, `AML`, `IP_ANALYSIS`, `AGE_ESTIMATION`, `DATABASE_VALIDATION`. Возможные значения: `Approved`, `Declined`, `In Review`, `Not Finished`, `Resub Requested`." }, "features_list": { "type": "array", "items": { "type": "object", "properties": { "feature": { "type": "string" }, "status": { "type": "string" } } }, "description": "Те же данные, что и `features`, в виде упорядоченного массива объектов `{feature, status}`." }, "last_session_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Временная метка последней сессии" }, "first_session_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Временная метка первой сессии" }, "last_activity_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Временная метка последней активности по этому пользователю (сессия, транзакция, смена статуса, редактирование данных и т. д.)." }, "tags": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "color": { "type": "string" } } }, "description": "Теги, назначенные этому пользователю" }, "created_at": { "type": "string", "format": "date-time" } } }, "BlocklistItem": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "face", "document", "phone", "email" ] }, "session_id": { "type": "string", "format": "uuid" }, "session_number": { "type": "integer" }, "blocklisted_at": { "type": "string", "format": "date-time" }, "face_image": { "type": "string", "nullable": true }, "document_type": { "type": "string", "nullable": true }, "document_number": { "type": "string", "nullable": true }, "phone_number": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } } }, "UserDetailItem": { "type": "object", "description": "Полные сведения о пользователе. Дополняет UserListItem метаданными, комментариями и updated_at.", "allOf": [ { "$ref": "#/components/schemas/UserListItem" }, { "type": "object", "properties": { "metadata": { "type": "object", "description": "JSON с пользовательскими метаданными, прикреплённый вами к этому пользователю. По умолчанию: `{}`." }, "tags": { "type": "array", "description": "Назначения тегов. ПРИМЕЧАНИЕ: в подробных ответах каждая запись представляет собой объект-связку тега (`{uuid, tag: {...}, added_by_email, added_by_name, created_at}`), в отличие от плоской структуры `{uuid, name, color}`, используемой в ответах со списком.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID назначения тега (не самого тега)." }, "tag": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "color": { "type": "string" }, "description": { "type": "string", "nullable": true }, "source": { "type": "string", "enum": [ "didit", "custom" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "added_by_email": { "type": "string", "nullable": true }, "added_by_name": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" } } } }, "comments": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "comment_type": { "type": "string", "enum": [ "COMMENT", "STATUS_CHANGED", "METADATA_UPDATED", "TAG_ADDED", "TAG_REMOVED", "PROFILE_UPDATED" ] }, "comment": { "type": "string", "nullable": true }, "actor_email": { "type": "string", "nullable": true }, "actor_name": { "type": "string", "nullable": true }, "previous_status": { "type": "string", "nullable": true, "enum": [ "ACTIVE", "FLAGGED", "BLOCKED", null ] }, "new_status": { "type": "string", "nullable": true, "enum": [ "ACTIVE", "FLAGGED", "BLOCKED", null ] }, "previous_value": { "type": "object", "nullable": true, "description": "Предыдущие значения полей для записей PROFILE_UPDATED." }, "new_value": { "type": "object", "nullable": true, "description": "Новые значения полей для записей PROFILE_UPDATED." }, "changed_fields": { "type": "array", "items": { "type": "string" }, "description": "Названия полей, изменённых записью PROFILE_UPDATED." }, "metadata": { "type": "object", "nullable": true }, "mentioned_emails": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string", "format": "date-time" } } }, "description": "Журнал действий и комментарии по этому пользователю (изменения статуса, правки профиля, ручные заметки)." }, "updated_at": { "type": "string", "format": "date-time" } } } ] }, "BusinessListItem": { "type": "object", "description": "Верифицированная компания.", "properties": { "didit_internal_id": { "type": "string", "format": "uuid", "description": "Стабильный внутренний UUID Didit для этой компании." }, "vendor_data": { "type": "string", "nullable": true, "description": "Ваш уникальный идентификатор этой компании (передаётся при создании сессий). Может быть равен null, если идентификатор поставщика не был передан." }, "display_name": { "type": "string", "nullable": true, "description": "Пользовательское отображаемое имя, заданное вами" }, "legal_name": { "type": "string", "nullable": true, "description": "Официальное юридическое наименование из реестра или ручного ввода" }, "registration_number": { "type": "string", "nullable": true, "description": "Регистрационный номер или номер инкорпорации компании" }, "country_code": { "type": "string", "nullable": true, "description": "Страна инкорпорации (ISO 3166-1 alpha-2, например, `GB`, `US`)." }, "effective_name": { "type": "string", "nullable": true, "description": "Наиболее подходящее имя: display_name, если задано, иначе legal_name" }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "description": "Статус жизненного цикла записи компании (НЕ статус сессии). `ACTIVE` используется по умолчанию, `FLAGGED` помечает её для ручной проверки, `BLOCKED` запрещает новые сессии для этого `vendor_data`." }, "session_count": { "type": "integer", "description": "Общее количество сессий верификации для этой компании" }, "approved_count": { "type": "integer", "description": "Количество одобренных сессий" }, "declined_count": { "type": "integer", "description": "Количество отклонённых сессий" }, "in_review_count": { "type": "integer", "description": "Количество сессий на проверке" }, "features": { "type": "object", "description": "Агрегированный статус по функциям среди всех KYB-сессий этой компании. В настоящее время единственным ключом является `KYB` (статус проверки компании по реестру). Возможные значения: `Approved`, `Declined`, `In Review`, `Not Finished`, `Resub Requested`." }, "features_list": { "type": "array", "items": { "type": "object", "properties": { "feature": { "type": "string" }, "status": { "type": "string" } } }, "description": "Те же данные, что и `features`, в виде упорядоченного массива объектов `{feature, status}`." }, "last_session_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Временная метка последней сессии" }, "first_session_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Временная метка первой сессии" }, "last_activity_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Временная метка последней активности (смена статуса, обновление сессии и т. д.)" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "color": { "type": "string" } } }, "description": "Теги, назначенные этой компании" }, "created_at": { "type": "string", "format": "date-time" } } }, "BusinessDetailItem": { "type": "object", "description": "Полные сведения о компании. Расширяет BusinessListItem метаданными и updated_at.", "allOf": [ { "$ref": "#/components/schemas/BusinessListItem" }, { "type": "object", "properties": { "metadata": { "type": "object", "description": "JSON с пользовательскими метаданными, прикреплённый вами к этой компании. По умолчанию `{}`." }, "updated_at": { "type": "string", "format": "date-time" } } } ] }, "TransactionDetail": { "type": "object", "description": "Полная запись мониторинга для одной транзакции, возвращаемая `GET /v3/transactions/{transaction_id}/` и `POST /v3/transactions/`.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Стабильный идентификатор транзакции Didit. Используйте как `{transaction_id}` для последующих вызовов." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Среда приложения, которому принадлежит транзакция. Транзакция в `sandbox` сохраняется, но никогда не оценивается, не проверяется скринингом, по ней не отправляются уведомления и не взимается плата, поэтому пустое значение `rule_runs` означает «не оценивалась»." }, "transaction_number": { "type": "integer", "description": "Порядковый номер транзакции в рамках приложения, отображаемый в консоли (например, `4123`)." }, "txn_id": { "type": "string", "description": "`transaction_id`, переданный вами при создании (не более 128 символов). Уникален в рамках приложения." }, "txn_date": { "type": "string", "format": "date-time", "description": "Когда произошла транзакция (из `transaction_at`; по умолчанию используется время отправки)." }, "zone_id": { "type": "string", "nullable": true, "description": "Идентификатор часового пояса IANA, указанный при создании." }, "transaction_type": { "type": "string", "description": "Категория верхнего уровня в том виде, в котором она сохранена: `finance`, `kyc`, `travelRule`, `userPlatformEvent`, `gamblingBet`, `gamblingLimitChange`, `gamblingBonusChange`, `auditTrailEvent`. Обратите внимание, что значения из нескольких слов возвращаются в camelCase, даже если они были переданы в snake_case." }, "action_type": { "type": "string", "description": "Подтип внутри категории (например, `deposit`, `withdrawal`, `transfer`). Если не указан, по умолчанию совпадает с категорией." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Направление относительно субъекта. Сохраняется в верхнем регистре независимо от переданного регистра (на вход принимаются `in`/`out`/`inbound`/`outbound`)." }, "status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Текущий вердикт мониторинга. Транзакции создаются со статусом `APPROVED`; правила могут синхронно изменить его на `IN_REVIEW`/`DECLINED`." }, "source": { "type": "string", "enum": [ "LIVE", "IMPORTED" ], "description": "Происхождение записи: `LIVE` для транзакций, переданных через API или SDK, `IMPORTED` для транзакций, загруженных через импорт в панели управления." }, "amount": { "type": "string", "description": "Сумма транзакции в виде десятичной строки без завершающих нулей (например, `\"1500\"`, `\"0.5\"`, `\"0.123456789012345678\"`). До 18 знаков после запятой." }, "currency": { "type": "string", "description": "Код валюты для `amount`. Принимается любой буквенный код ISO 4217 (например, `EUR`, `USD`, `NGN`), а также символ криптоактива (например, `BTC`). Предпочтительно использовать находящийся в обращении код. Не для каждого принятого кода доступен обменный курс: если для кода курс отсутствует (например, расчетная единица ISO `XSU` или символ криптовалюты, для которого Didit не рассчитывает цену), автоматическая конвертация завершается ошибкой и `preferred_currency_amount` возвращается со значением null, если только в запросе не был передан предварительно сконвертированный `amount_in_default_currency`." }, "currency_type": { "type": "string", "nullable": true, "description": "`fiat` или `crypto`, как передано в `currency_kind`." }, "amount_in_default_currency": { "type": "string", "nullable": true, "description": "Предоставленная вами предварительно сконвертированная сумма в виде десятичной строки с удалёнными замыкающими нулями." }, "default_currency_code": { "type": "string", "nullable": true }, "preferred_currency_amount": { "type": "string", "nullable": true, "description": "Значение `amount`, конвертированное в предпочтительную валюту приложения, если доступно." }, "preferred_currency_code": { "type": "string", "nullable": true }, "payment_details": { "type": "string", "nullable": true, "description": "Назначение платежа или примечание из отправленных данных в виде произвольного текста." }, "payment_txn_id": { "type": "string", "nullable": true, "description": "Внешний идентификатор платёжной системы (например, хэш блокчейн-транзакции) из `payment_reference_id`." }, "score": { "type": "integer", "description": "Оценка риска, накопленная правилами (обычно 0–100). Выше = рискованнее." }, "severity": { "type": "string", "nullable": true, "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "description": "Категориальный уровень риска, установленный правилами/провайдерами (`UNKNOWN`, `LOW`, `MEDIUM`, `HIGH`, `CRITICAL`). `null`, пока он не будет задан." }, "decision_reason_code": { "type": "string", "nullable": true, "description": "Машиночитаемая причина текущего `status`." }, "decision_reason_label": { "type": "string", "nullable": true, "description": "Понятная метка для `decision_reason_code`." }, "vendor_data": { "type": "string", "nullable": true, "description": "Удобная копия `vendor_data` заявителя." }, "metadata": { "type": "object", "description": "Снимок payload `subject` и `counterparty` в том виде, в котором они были отправлены при создании." }, "props": { "type": "object", "description": "Параметры `custom_properties`, переданные вами при создании. К каждому ключу можно обращаться в условиях правил как к `custom_values.`." }, "tags": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "color": { "type": "string" }, "description": { "type": "string", "nullable": true }, "source": { "type": "string", "enum": [ "didit", "custom" ], "description": "Является ли тег предустановленным тегом Didit или пользовательским." } } }, "description": "Теги, прикрепленные к транзакции (вручную или правилами)." }, "parties": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "role": { "type": "string", "enum": [ "APPLICANT", "REMITTER", "BENEFICIARY", "COUNTERPARTY" ], "description": "Роль стороны. Endpoint создания присваивает `APPLICANT` (субъект) и `COUNTERPARTY`." }, "entity_type": { "type": "string", "enum": [ "individual", "company", "external", "unhostedWallet" ] }, "kind": { "type": "string", "enum": [ "USER", "BUSINESS", "EXTERNAL" ], "description": "Стороны с типом `USER`/`BUSINESS` связаны с сущностью в Didit через `vendor_data`. У сторон с типом `EXTERNAL` связанной сущности в Didit нет." }, "vendor_data": { "type": "string", "nullable": true, "description": "Ваш внутренний идентификатор пользователя/бизнеса." }, "full_name": { "type": "string", "nullable": true }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "country_code": { "type": "string", "nullable": true, "description": "Код страны из переданного `address.country` (обычно ISO 3166-1 alpha-3)." }, "dob": { "type": "string", "format": "date", "nullable": true, "description": "Дата рождения из переданного `date_of_birth`." }, "address": { "type": "object", "description": "Объект адреса в отправленном виде. `{}` при отсутствии." }, "institution_info": { "type": "object", "description": "Сведения об учреждении в отправленном виде. `{}` при отсутствии." }, "device": { "type": "object", "description": "Нормализованный контекст устройства, включая обогащение данных об IP на стороне сервера в network_context (геолокация, флаги VPN/дата-центров), если был передан IP.", "properties": { "fingerprint": { "type": "string", "description": "Уникальный цифровой отпечаток устройства." }, "persistent_device_id": { "type": "string", "description": "Постоянный межсессионный идентификатор устройства (схема фингерпринта v2)." }, "user_agent": { "type": "string", "description": "Строка user agent браузера или приложения." }, "browser_family": { "type": "string", "description": "Семейство браузеров (например, Chrome, Firefox, Safari)." }, "browser_version": { "type": "string", "description": "Строка версии браузера." }, "platform": { "type": "string", "description": "Идентификатор платформы (web, ios, android, macos, windows, linux)." }, "os_family": { "type": "string", "description": "Семейство операционной системы (например, iOS, Android, Windows)." }, "os_version": { "type": "string", "description": "Строка версии операционной системы." }, "accept_language": { "type": "string", "description": "Значение заголовка Accept-Language." }, "session_id": { "type": "string", "description": "Идентификатор сессии (сохранённый в метаданных)." }, "session_age_ms": { "type": "number", "description": "Возраст сессии в миллисекундах." }, "network_context": { "type": "object", "description": "Сетевой контекст с IP-адресом и геолокацией.", "properties": { "ip_address": { "type": "string", "description": "IP-адрес клиента." }, "ip_country_code": { "type": "string", "description": "Страна, определённая по IP (ISO 3166-1 alpha-3)." }, "latitude": { "type": "number", "description": "Географическая широта IP-адреса." }, "longitude": { "type": "number", "description": "Географическая долгота IP-адреса." } } } } }, "external_party_snapshot": { "type": "object", "nullable": true, "description": "Зафиксированная копия данных стороны для сторон типа `EXTERNAL`. `null`, пока сторона связана с пользователем или компанией Didit." } } }, "description": "Стороны транзакции (заявитель, контрагент)." }, "payment_methods": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "payment_method_type": { "type": "string", "enum": [ "bank_card", "bank_account", "e_wallet", "crypto_wallet", "unhosted_wallet", "other" ] }, "label": { "type": "string", "nullable": true }, "fingerprint": { "type": "string", "nullable": true, "description": "SHA-256 от `type:account_id:issuing_country` — стабильный идентификатор для отслеживания повторного использования одного и того же инструмента." }, "account_id": { "type": "string", "nullable": true, "description": "Идентификатор счёта (IBAN, адрес, token карты, …)." }, "issuing_country": { "type": "string", "nullable": true }, "owner_kind": { "type": "string", "enum": [ "USER", "BUSINESS", "EXTERNAL" ] }, "vendor_data": { "type": "string", "nullable": true, "description": "Ваш идентификатор пользователя/компании-владельца." }, "owner_name": { "type": "string", "nullable": true }, "institution_info": { "type": "object" }, "details": { "type": "object", "description": "Необработанный объект `payment_method` в переданном виде." }, "external_owner_snapshot": { "type": "object", "nullable": true }, "role": { "type": "string", "enum": [ "SOURCE", "DESTINATION", "FUNDING", "BENEFICIARY" ], "description": "Как этот метод использовался в транзакции. Endpoint создания присваивает `SOURCE`/`DESTINATION` на основе направления (исходящее: субъект = SOURCE; входящее: субъект = DESTINATION)." } } }, "description": "Способы оплаты, привязанные к транзакции." }, "documents": { "type": "array", "description": "Файлы, прикреплённые к транзакции из панели управления. `[]`, если файлы отсутствуют.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "label": { "type": "string", "nullable": true }, "note": { "type": "string", "nullable": true }, "uploaded_by": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "files": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "file_url": { "type": "string", "format": "uri", "nullable": true, "description": "Временный подписанный URL для скачивания; запрашивайте его при необходимости, а не сохраняйте." }, "original_filename": { "type": "string", "nullable": true }, "file_size": { "type": "integer", "nullable": true } } } } } } }, "activities": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "activity_type": { "type": "string", "description": "Например, `TRANSACTION_CREATED`, `TRANSACTION_NOTE_ADDED`, `TRANSACTION_STATUS_CHANGED`." }, "source": { "type": "string" }, "status": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "metadata": { "type": "object" }, "occurred_at": { "type": "string", "format": "date-time" } } }, "description": "Записи журнала действий (создание, заметки, ручные проверки, изменения статуса)." }, "alerts": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "severity": { "type": "string", "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "status": { "type": "string", "enum": [ "OPEN", "INVESTIGATING", "AWAITING_USER", "PENDING_SAR", "SAR_FILED", "RESOLVED", "DISMISSED" ] }, "source": { "type": "string", "enum": [ "RULE", "PROVIDER", "MANUAL" ] }, "metadata": { "type": "object" }, "created_at": { "type": "string", "format": "date-time" }, "due_at": { "type": "string", "format": "date-time", "nullable": true } } }, "description": "В настоящее время всегда пусто. Открытое оповещение представляет собой транзакцию со статусом `IN_REVIEW` или `AWAITING_USER`." }, "rule_runs": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "rule": { "type": "string", "format": "uuid", "description": "UUID правила, которое сработало." }, "rule_title": { "type": "string" }, "rule_description": { "type": "string", "nullable": true }, "rule_category": { "type": "string" }, "matched": { "type": "boolean", "description": "Совпали ли условия правила с этой транзакцией. Запуск фиксируется только для совпавших правил, поэтому при непосредственной оценке всегда возвращается `true`." }, "is_test": { "type": "boolean", "description": "True, когда правило выполнялось в режиме TEST (без влияния на статус или скоринг)." }, "mode": { "type": "string", "enum": [ "ACTIVE", "DISABLED", "TEST" ] }, "severity": { "type": "string", "nullable": true }, "score_delta": { "type": "integer", "description": "Оценка, добавленная действиями `add_score` этого правила." }, "status_target": { "type": "string", "nullable": true, "description": "Статус, установленный действием `change_status`, если оно было." }, "action_summary": { "type": "string", "nullable": true, "description": "Сводка действий, выполненных правилом, объединенных через `; ` (например, `score +30; change_status:IN_REVIEW; add_tag:high_risk_country`). Компоненты: `score +N`, `change_status:`, `add_tag:`, `add_note`, `add_to_list`, `open_case`. `null`, если правило не выполнило никаких действий." }, "metadata": { "type": "object", "description": "Детали оценки: `scope_match`, `conditions[]` и `aggregations[]`. Каждая запись условия содержит `field`, `operator`, `expected_value`, `current_value`, считанное из транзакции, `matched`, `group_index` и `group_logic`. Каждая запись агрегации (скорость / количество / сумма) содержит `metric`, `field`, `operator`, `expected_value`, `computed_value`, вычисленное для агрегата, `window`, `filters`, `matched` и `sample_references`; отложенные асинхронные агрегации содержат `computed_value: null` и `deferred: true`. Вложенная группа условий представляет собой одну запись в `conditions[]` с `operator` `any_of` или `all_of`, `field` со значением null и результатами своих элементов в собственном `conditions`." }, "created_at": { "type": "string", "format": "date-time" } } }, "description": "Результаты выполнения по правилам — какое правило сработало и как оно повлияло на скоринг." }, "provider_results": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "provider": { "type": "string" }, "result_type": { "type": "string", "enum": [ "FIAT_MONITORING", "WALLET_SCREENING", "TRANSACTION_SCREENING", "TRAVEL_RULE", "NETWORK_GRAPH", "CUSTOM" ] }, "status": { "type": "string" }, "severity": { "type": "string", "nullable": true }, "score": { "type": "integer" }, "summary": { "type": "string", "nullable": true }, "payload": { "type": "object", "description": "Необработанный payload ответа провайдера." }, "created_at": { "type": "string", "format": "date-time" } } }, "description": "Необработанные payload от провайдеров (AML-скрининг, блокчейн-аналитика и т. д.)." }, "travel_rule": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/TransactionTravelRule" } ], "description": "Перевод или проверка Travel Rule. Заполняется, если были переданы `travel_rule_details`, а также если включён Travel Rule и транзакция была создана с `transaction_category: travelRule` (Didit инициирует обмен самостоятельно, даже без `travel_rule_details`). Имеет значение `null`, если перевод или проверка отсутствуют. При входящем переводе поля контрагента `originator_data` и `beneficiary_data` остаются маскированными (`data_masked: true`) до подтверждения владения кошельком." }, "network_snapshot": { "type": "object", "nullable": true, "description": "Снимок графа связанных транзакций/сторон, используемый движком правил. Либо `network_snapshot`, переданный вместе с транзакцией, либо граф, который Didit строит на основе успешного AML-скрининга кошелька (заменяющий переданный). `null`, если нет ни того, ни другого.", "properties": { "uuid": { "type": "string", "format": "uuid" }, "nodes": { "type": "array", "items": { "type": "object" } }, "edges": { "type": "array", "items": { "type": "object" } }, "metrics": { "type": "object" } } }, "remediation": { "type": "object", "nullable": true, "description": "Сессия устранения проблемы, предлагаемая пользователю при необходимости повторной верификации. Заменена на `action_required`, являющийся каноническим блоком; сохранена для обратной совместимости.", "properties": { "session_id": { "type": "string" }, "session_token": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "status": { "type": "string" } } }, "action_required": { "type": "object", "nullable": true, "description": "Ожидающее выполнения действие конечного пользователя, необходимое для завершения этой транзакции, или null, если действий нет. Didit SDK автоматически запускают действие по умолчанию и обновляют транзакцию по его завершении. Два варианта, различаемые по полю `type`: `verification_session` (размещённая сессия верификации, созданная действием правила) и `wallet_ownership` (сессия виджета подтверждения владения кошельком, автоматически созданная для перевода Travel Rule, требующего подтверждения контроля над кошельком; управляется настройкой Travel Rule `auto_wallet_verification`). Если применимы оба варианта, приоритет имеет `wallet_ownership`, поскольку оно блокирует обмен данными Travel Rule.", "oneOf": [ { "$ref": "#/components/schemas/TransactionVerificationSessionAction" }, { "$ref": "#/components/schemas/TransactionWalletOwnershipAction" } ], "discriminator": { "propertyName": "type", "mapping": { "verification_session": "#/components/schemas/TransactionVerificationSessionAction", "wallet_ownership": "#/components/schemas/TransactionWalletOwnershipAction" } } }, "cost_breakdown": { "type": "object", "nullable": true, "description": "Стоимость этой транзакции: `total_price` и `items`, по одному на каждое списание, каждый с полями `usage_type`, `price`, `details` и `created_at`. Повторный скрининг той же транзакции формирует новую позицию." } } }, "TravelRuleSettingsDetail": { "type": "object", "properties": { "is_enabled": { "type": "boolean", "description": "Активен ли управляемый сценарий согласования Travel Rule для исходящих транзакций `travelRule` в этом приложении." }, "jurisdiction": { "type": "string", "maxLength": 8, "description": "Код юрисдикции деятельности вашего VASP. По умолчанию `\"EU\"`. Didit сопоставляет его с режимом, который указывается в ваших транзакциях Travel Rule как `travel_rule_regime` (например, `EU` или код страны-участницы ЕС преобразуется в `eu`), на основе которого могут срабатывать правила транзакций. Другие клиенты Didit видят его как вашу юрисдикцию в каталоге VASP после того, как сеть Didit опубликует ваш профиль." }, "name_matching_strictness": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "Насколько строго должны совпадать имена получателей, чтобы перевод мог перейти в статус COMPLETED. `CONTAINS` принимает имя, все слова которого содержатся в другом имени." }, "confirmation_timeout_hours": { "type": "integer", "minimum": 1, "description": "Количество часов, в течение которых перевод со статусом AWAITING_COUNTERPARTY может оставаться неподтверждённым, прежде чем периодический процесс очистки переведёт его в статус истекшего. По умолчанию 48." }, "timeout_outcome": { "type": "string", "enum": [ "HOLD", "REJECT", "PROCEED" ], "description": "Что происходит с базовой транзакцией, когда срок действия перевода истекает. По умолчанию HOLD. sunrise_policy и non_responsive_policy имеют приоритет, если они применимы и заданы." }, "threshold_amount": { "type": "string", "description": "Десятичная строка в валюте по умолчанию вашего приложения. Минимальная сумма перевода, запускающая управляемый обмен; переводы ниже этой суммы сразу получают статус NOT_APPLICABLE. Didit сравнивает сумму транзакции, конвертированную в вашу валюту по умолчанию, или переданное вами значение `amount_in_default_currency`; если конвертированная сумма недоступна, порог не применяется. По умолчанию \"0.00\" (EU TFR не устанавливает минимальную сумму)." }, "ownership_validation_mode": { "type": "string", "enum": [ "FULL", "SIMPLIFIED", "AUTOMATED" ], "description": "Требуемый объём подтверждения владения кошельком. `FULL` всегда требует подтверждения (подписанное сообщение, тестовый депозит или проверенный скриншот), но никогда не слов конечного пользователя. `SIMPLIFIED` принимает самостоятельное декларирование ниже `simplified_validation_threshold` и подтверждение выше него. `AUTOMATED` позволяет адресной книге и более ранним подтверждениям отвечать автоматически, включая самостоятельные декларации при значении `allow_self_declaration`, равном true. По умолчанию `AUTOMATED`." }, "simplified_validation_threshold": { "type": "string", "description": "Десятичная строка, по умолчанию \"0.00\". В режиме `SIMPLIFIED` для перевода ниже этой суммы (в валюте порога) принимается самостоятельное заявление. Перевод без указания суммы в этой валюте считается превышающим её." }, "data_sharing_fields": { "$ref": "#/components/schemas/TravelRuleDataSharingFields" }, "matching_rules": { "$ref": "#/components/schemas/TravelRuleMatchingRules" }, "legal_name": { "type": "string", "description": "Юридическое наименование вашего VASP. Обязательно (не пустое) для установки is_enabled в true." }, "lei": { "type": "string", "description": "Ваш идентификатор юридического лица, отображаемый в каталоге VASP." }, "compliance_email": { "type": "string", "format": "email", "description": "Контактный адрес электронной почты комплаенс-службы для вашего VASP-профиля. Сеть Didit отобразит ваш профиль только после подтверждения этого адреса по ссылке из электронного письма (POST /v3/travel-rule/settings/compliance-email/confirmation/); при его изменении потребуется повторное подтверждение." }, "is_discoverable": { "type": "boolean", "description": "Может ли ваш профиль VASP отображаться в сети Didit: доступен для поиска через GET /v3/travel-rule/vasps/ другими клиентами Didit и достижим по каналу INTERNAL. Для включения в список также требуется приложение в продакшн-среде, включённый Travel Rule, юридическое наименование и подтверждённый email комплаенс-отдела; didit_network указывает, какие из них отсутствуют. По умолчанию true." }, "inbound_auto_accept": { "type": "boolean", "description": "Если true, входящий запрос TRP, в котором кошелек получателя является подтвержденной записью адресной книги с совпадающим именем, одобряется автоматически. Если false, такой запрос остается в статусе ON_HOLD до тех пор, пока вы не одобрите или не отклоните его с помощью endpoint проверки владения. Не влияет на переводы по каналу INTERNAL и переводы после депозита. По умолчанию true." }, "allow_self_declaration": { "type": "boolean", "description": "Если true, виджет подтверждения владения кошельком предлагает самостоятельное декларирование в качестве резервного метода подтверждения. По умолчанию true." }, "allow_screenshot_proof": { "type": "boolean", "description": "Если true, виджет подтверждения владения кошельком предлагает загрузку скриншота в качестве метода подтверждения владения. По умолчанию true." }, "auto_wallet_verification": { "type": "boolean", "description": "Если true, отправка исходящего перевода по Travel Rule, требующего подтверждения контроля над кошельком конечным пользователем, автоматически создает привязанную к транзакции сессию виджета подтверждения владения кошельком и отображает ее в блоке action_required транзакции. По умолчанию true." }, "vasp_attribution_enabled": { "type": "boolean", "description": "Если true, исходящий перевод по Travel Rule, который не может маршрутизировать ни один канал, атрибутируется с помощью блокчейн-аналитики: для кошелька назначения определяется владеющий им VASP, организация фиксируется в переводе и в каталоге VASP, а каналы запускаются повторно один раз с именем, определенным при атрибуции. По умолчанию true." }, "counterparty_screening_enabled": { "type": "boolean", "description": "Подключаемый скрининг контрагентов VASP на санкции и негативные публикации в СМИ, тарифицируемый за каждый скрининг по цене AML-скрининга компаний. При включении Didit выполняет скрининг контрагента, к которому обращается исходящий обмен (повторно используя скрининг давностью менее 30 дней), и вы можете проверить контрагента с помощью POST /v3/travel-rule/vasps/{vasp_id}/screening/. По умолчанию false: скрининг и списание средств не производятся." }, "sunrise_policy": { "type": "string", "enum": [ "", "HOLD", "REJECT", "PROCEED" ], "description": "Действие с транзакцией при истечении срока перевода, когда контрагент является записью каталога в юрисдикции из sunrise_jurisdictions, которая ещё не применяет Travel Rule: HOLD переводит её на проверку, REJECT отклоняет её, PROCEED оставляет статус без изменений. Пустое значение (по умолчанию) следует timeout_outcome. Применяется перед non_responsive_policy." }, "sunrise_jurisdictions": { "type": "array", "items": { "type": "string" }, "readOnly": true, "description": "Только для чтения. Страны (ISO 3166 alpha-2), которые Didit относит к переходному периоду Travel Rule, где применяется sunrise_policy. В настоящее время это CO, KH и VN. Любая другая юрисдикция, а также пустая или неизвестная, использует timeout_outcome." }, "non_responsive_policy": { "type": "string", "enum": [ "", "HOLD", "REJECT", "PROCEED" ], "description": "Действие с транзакцией при истечении срока перевода, когда контрагент является записью каталога со статусом отклика UNRESPONSIVE: HOLD, REJECT или PROCEED, аналогично timeout_outcome. Пустое значение (по умолчанию) следует timeout_outcome. Если подходят оба правила, сначала применяется sunrise_policy." }, "travel_address": { "type": "string", "description": "Только для чтения. Собственный Travel Address вашего VASP - закодированный endpoint входящих запросов TRP, который другие VASP используют для связи с вами. Пусто, пока `is_enabled` имеет значение false." }, "disabled_networks": { "type": "array", "items": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA" ] }, "description": "Сети, отказавшиеся от участия в платформе. Не отключает ваши собственные подключённые членства и не предоставляет недоступные сети.", "default": [] }, "networks": { "type": "object", "readOnly": true, "description": "По каждой сети: как это приложение будет отправлять данные и почему оно не может этого сделать. Ни одна сеть, включая GTR, не подключена по умолчанию: сеть доступна через ваше собственное подключённое членство или через членство Didit, когда членство Didit в этой сети активировано и ваш собственный участник в ней активен. Не является проверкой состояния или доставки в реальном времени.", "properties": { "gtr": { "$ref": "#/components/schemas/TravelRuleNetworkState" }, "trust": { "$ref": "#/components/schemas/TravelRuleNetworkState" }, "verifyvasp": { "$ref": "#/components/schemas/TravelRuleNetworkState" }, "sygna": { "$ref": "#/components/schemas/TravelRuleNetworkState" } } }, "didit_network": { "type": "object", "readOnly": true, "description": "Включён ли ваш профиль VASP в сеть Didit, чтобы другие клиенты Didit могли найти его в каталоге и связаться с ним по каналу INTERNAL, а также каждое условие, которое всё ещё не выполнено.", "properties": { "listed": { "type": "boolean" }, "missing": { "type": "array", "items": { "type": "string", "enum": [ "travel_rule_off", "sandbox_application", "not_discoverable", "legal_name_missing", "compliance_email_missing", "compliance_email_unconfirmed", "excluded_by_staff", "internal_organization" ] }, "description": "Пусто, если включено в список. compliance_email_unconfirmed: отправьте подтверждение с помощью POST /v3/travel-rule/settings/compliance-email/confirmation/ и перейдите по ссылке из письма. excluded_by_staff: Didit пометил приложение как тестовое, демонстрационное или внутреннее." }, "compliance_email_confirmed": { "type": "boolean", "description": "Был ли текущий compliance_email подтверждён по ссылке из электронного письма." } } } } }, "TravelRuleSettingsUpdate": { "type": "object", "properties": { "is_enabled": { "type": "boolean" }, "legal_name": { "type": "string", "maxLength": 255 }, "lei": { "type": "string", "maxLength": 20 }, "jurisdiction": { "type": "string", "maxLength": 8 }, "name_matching_strictness": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "`CONTAINS` принимает имя, все слова которого присутствуют в другом имени." }, "confirmation_timeout_hours": { "type": "integer", "minimum": 1 }, "timeout_outcome": { "type": "string", "enum": [ "HOLD", "REJECT", "PROCEED" ] }, "compliance_email": { "type": "string", "format": "email", "description": "Контактный адрес электронной почты комплаенс-службы для вашего VASP-профиля. Сеть Didit отобразит ваш профиль только после подтверждения этого адреса по ссылке из электронного письма (POST /v3/travel-rule/settings/compliance-email/confirmation/); при его изменении потребуется повторное подтверждение." }, "is_discoverable": { "type": "boolean", "description": "Может ли ваш профиль VASP отображаться в сети Didit: доступен для поиска через GET /v3/travel-rule/vasps/ другими клиентами Didit и достижим по каналу INTERNAL. Для включения в список также требуется приложение в продакшн-среде, включённый Travel Rule, юридическое наименование и подтверждённый email комплаенс-отдела; didit_network указывает, какие из них отсутствуют. По умолчанию true." }, "threshold_amount": { "type": "string", "description": "Десятичная строка, ноль или больше, в валюте по умолчанию вашего приложения. Минимальная сумма перевода, запускающая управляемый обмен." }, "ownership_validation_mode": { "type": "string", "enum": [ "FULL", "SIMPLIFIED", "AUTOMATED" ], "description": "См. одноимённое поле ответа." }, "simplified_validation_threshold": { "type": "string", "description": "Десятичная строка, 0 или больше." }, "data_sharing_fields": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleDataSharingFields" } ], "description": "Объединяется по типу сущности: пропущенный тип сущности сохраняет текущий выбор. Выбор, который не удовлетворяет обязательствам отправителя в рамках режима вашей `jurisdiction` (EU TFR или Рекомендация 16 ФАТФ), включая пустой список, отклоняется с кодом `400`." }, "matching_rules": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleMatchingRules" } ], "description": "Объединяется по типу сущности и по полям внутри него. Поле, которое данный тип сущности не сравнивает (например, `date_of_birth` для `company`), отклоняется с кодом `400`." }, "inbound_auto_accept": { "type": "boolean" }, "allow_self_declaration": { "type": "boolean" }, "allow_screenshot_proof": { "type": "boolean", "description": "Если true, виджет подтверждения владения кошельком предлагает загрузку скриншота в качестве метода подтверждения владения. По умолчанию true." }, "auto_wallet_verification": { "type": "boolean" }, "vasp_attribution_enabled": { "type": "boolean" }, "counterparty_screening_enabled": { "type": "boolean", "description": "Подключаемый скрининг контрагентов VASP на санкции и негативные публикации в СМИ, тарифицируемый за каждый скрининг по цене AML-скрининга компаний. При включении Didit выполняет скрининг контрагента, к которому обращается исходящий обмен (повторно используя скрининг давностью менее 30 дней), и вы можете проверить контрагента с помощью POST /v3/travel-rule/vasps/{vasp_id}/screening/. По умолчанию false: скрининг и списание средств не производятся." }, "sunrise_policy": { "type": "string", "enum": [ "", "HOLD", "REJECT", "PROCEED" ], "description": "HOLD, REJECT, PROCEED или пустое значение, чтобы следовать timeout_outcome. См. одноимённое поле ответа." }, "non_responsive_policy": { "type": "string", "enum": [ "", "HOLD", "REJECT", "PROCEED" ], "description": "HOLD, REJECT, PROCEED или пустое значение, чтобы следовать timeout_outcome. См. одноимённое поле ответа." }, "disabled_networks": { "type": "array", "items": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA" ] }, "description": "Сети, отказавшиеся от участия в платформе. Не отключает ваши собственные подключённые членства и не предоставляет недоступные сети.", "default": [] } }, "description": "Все поля опциональны; PUT применяет частичное обновление." }, "WalletAddressEntry": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "address": { "type": "string", "description": "Адрес кошелька; `\"\"` для записи, импортированной только по её хешу. Уникален для каждого приложения, сети и memo; сравнение адресов выполняется без учёта регистра. После удаления записи вы можете зарегистрировать тот же адрес повторно." }, "chain": { "type": "string", "description": "Токен блокчейна для адреса, например `ETH` или `BTC`. Когда Didit маршрутизирует или регистрирует перевод, сервис сопоставляет записи адресной книги по адресу кошелька и, если перевод содержит блокчейн, также по этому значению без учёта регистра. Блокчейном перевода является `beneficiary_data.chain`, заполняемый из криптовалютного блокчейна транзакции или символа валюты (например, `ETH`), если вы его не передали, либо `chain` регистрации после депозита, поэтому используйте один и тот же токен везде. Запись с пустым блокчейном совпадает с любым блокчейном. Получатель Lightning (идентификатор узла или Lightning Address), зарегистрированный в сети bitcoin, сохраняется в нижнем регистре как `LIGHTNING`, по которому сопоставляются переводы Lightning. Известные блокчейны сохраняются под единым каноническим идентификатором независимо от используемого написания: \"ethereum\", \"Ethereum\" и \"ERC20\" сохраняются как ETH, \"BNB Smart Chain\" и \"BEP20\" сохраняются как BNB, а \"tron\" сохраняется как TRX. Неизвестное название блокчейна сохраняется в исходном виде." }, "holder_vendor_data": { "type": "string", "description": "Ваш внутренний идентификатор владельца." }, "holder_name": { "type": "string", "description": "Имя владельца кошелька, используемое для сопоставления имени получателя." }, "entity_type": { "type": "string", "description": "Текст в свободной форме, по умолчанию \"individual\"." }, "is_ownership_verified": { "type": "boolean", "description": "Только для чтения. Было ли подтверждено владение этим адресом." }, "created_at": { "type": "string", "format": "date-time" }, "travel_address": { "type": "string", "description": "Travel Address VASP контрагента для этого кошелька, если известен. Позволяет Didit маршрутизировать переводы этого получателя через рельс TRP для активов, поддерживаемых TRP (BTC, ETH и USDC в указанной сети)." }, "address_hash": { "type": "string", "description": "Только для чтения. SHA-256 адреса в нижнем регистре, в шестнадцатеричном формате в нижнем регистре. Запись, импортированная только по её хэшу, сопоставляется по нему." }, "memo": { "type": "string", "description": "Destination tag или memo, являющиеся частью кошелька в сети с поддержкой memo (XRP, XLM, EOS, ATOM, HBAR); `\"\"` для всего адреса. Запись с memo совпадает только с переводами, содержащими это memo; запись без memo совпадает со всем адресом целиком." }, "receiving_travel_address": { "type": "string", "readOnly": true, "description": "Ваш Travel Address для этого кошелька: передайте его отправляющему VASP, чтобы его запрос TRP указывал на этот кошелёк. Пусто для кошелька, зарегистрированного как кошелёк другого VASP, пока Travel Rule отключен, а также до сохранения вашего профиля VASP." } } }, "WalletAddressEntryCreate": { "type": "object", "required": [ "address" ], "properties": { "address": { "type": "string", "maxLength": 128, "description": "Адрес кошелька. XRP X-address сохраняется как классический адрес и его тег, поэтому он сопоставляется с переводами, в которых указана любая из этих форм." }, "chain": { "type": "string", "maxLength": 32, "description": "token блокчейна для адреса, например `ETH` или `BTC`. Когда Didit маршрутизирует или регистрирует перевод, сервис сопоставляет записи адресной книги по адресу кошелька, а если перевод содержит блокчейн, также и по этому значению, без учёта регистра. Блокчейн перевода представляет собой `beneficiary_data.chain`, заполняемый из криптовалютного блокчейна транзакции или символа валюты (например, `ETH`), если вы его не передали, либо `chain` регистрации после депозита, поэтому используйте один и тот же token везде. Запись с пустым блокчейном соответствует любому блокчейну. Известные блокчейны сохраняются под одним каноническим идентификатором независимо от переданного написания: \"ethereum\", \"Ethereum\" и \"ERC20\" сохраняются как ETH, \"BNB Smart Chain\" и \"BEP20\" как BNB, \"tron\" как TRX. Неизвестное название блокчейна сохраняется в исходном виде." }, "holder_vendor_data": { "type": "string", "maxLength": 255 }, "holder_name": { "type": "string", "maxLength": 255 }, "entity_type": { "type": "string", "default": "individual", "maxLength": 16 }, "self_declared": { "type": "boolean", "default": false, "description": "Только для записи. Если true, запись создаётся с уже подтверждённым владением с помощью доказательства SELF_DECLARATION. Возвращает 400, когда `allow_self_declaration` отключён в ваших настройках Travel Rule." }, "travel_address": { "type": "string", "description": "Необязательно. Travel Address контрагента VASP для этого кошелька, включающий маршрутизацию TRP для поддерживаемых TRP активов (BTC, ETH и USDC в указанной сети). Недействительный Travel Address возвращает 400.", "maxLength": 512 }, "memo": { "type": "string", "maxLength": 256, "description": "Необязательно. Destination tag или memo, являющийся частью адреса кошелька. XRP: destination tag, целое число от 0 до 4294967295 (принимается как число JSON). XLM: текстовое memo до 28 байт, 64-битный идентификатор или 32-байтный хеш в шестнадцатеричном формате (hex). EOS: до 256 байт. ATOM: до 256 символов. HBAR: до 100 байт. Кошельки Bitcoin, EVM, Solana, Tron, Litecoin, Bitcoin Cash, Dogecoin и Lightning не поддерживают memo: его указание возвращает ошибку `400`. Псевдонимы: `destinationTag` или `destination_tag`." } } }, "WalletAddressEntryUpdate": { "type": "object", "properties": { "holder_name": { "type": "string", "maxLength": 255 }, "holder_vendor_data": { "type": "string", "maxLength": 255 }, "entity_type": { "type": "string", "maxLength": 16 }, "travel_address": { "type": "string", "maxLength": 512 } }, "description": "PATCH выполняет частичное обновление; в ответе возвращаются только holder_name, holder_vendor_data, entity_type, travel_address, receiving_travel_address, label и owner_type." }, "TravelRuleTransferDetail": { "type": "object", "description": "Полный объект перевода, возвращаемый endpoint’ами подтверждения владения и завершения/отмены. Пока владение кошельком для входящего перевода не подтверждено, данные контрагента `originator_data` и `beneficiary_data` возвращаются маскированными (сохраняется первая буква каждого слова; кошелёк, сеть и маршрутизация VASP остаются читаемыми), а флаг `data_masked` равен true.", "properties": { "uuid": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "AWAITING_COUNTERPARTY", "ON_HOLD", "COMPLETED", "FINISHED", "CANCELLED", "EXPIRED", "COUNTERPARTY_MISMATCHED_DATA", "COUNTERPARTY_VASP_NOT_FOUND", "COUNTERPARTY_VASP_NOT_REACHABLE", "UNCONFIRMED_OWNERSHIP", "COUNTERPARTY_VASP_GENERAL_DECLINE", "NOT_ENOUGH_COUNTERPARTY_DATA", "NOT_APPLICABLE" ] }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ] }, "rail": { "type": "string", "nullable": true, "enum": [ "INTERNAL", "TRP", "GTR", "TRUST", "VERIFYVASP", "SYGNA", "EMAIL", "TEST_VASP", null ], "description": "Транспортная сеть (rail), через которую был направлен перевод, или null, если сеть не была выбрана (например, ниже порога, некастодиальный кошелёк контрагента, регистрация после депозита или отсутствие доступного контрагента). INTERNAL означает, что обе стороны являются приложениями Didit; EMAIL означает, что контрагент получил ссылку для получения по электронной почте. TEST_VASP означает, что Didit Test VASP ответил на перевод в песочнице. В сетях GTR, VERIFYVASP и SYGNA Didit считывает ответ контрагента из ответа сети или опрашивает её каждые 5 минут. TRUST работает только на отправку, поэтому перевод через TRUST остаётся в статусе AWAITING_COUNTERPARTY до истечения срока действия. Сетевой rail используется только тогда, когда вы подключили собственное участие (membership) для этой сети. Он выбирается после возврата ответа создания транзакции, поэтому в этом ответе он равен null." }, "protocol": { "type": "string", "nullable": true }, "ivms_version": { "type": "string", "example": "ivms101.2023" }, "required": { "type": "boolean" }, "ownership_confirmed": { "type": "boolean", "nullable": true }, "deadline_at": { "type": "string", "format": "date-time", "nullable": true }, "timeline": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "at": { "type": "string", "format": "date-time" }, "detail": { "type": "string" }, "name_match": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleNameMatch" } ], "nullable": true, "description": "Сравнение имён, на основании которого принято решение в этой записи, рядом с `detail`. Отсутствует в записях, где сравнение имени не проводилось." }, "reason": { "type": "string", "description": "Присутствует только в записи о переходе, вызванном неудачной доставкой: `email_undeliverable` или `delivery_failed`, значение, которое возвращает поле `reason` перевода." } } } }, "counterparty_vasp": { "type": "object", "nullable": true, "properties": { "name": { "type": "string" }, "lei": { "type": "string" }, "dd_score": { "type": "integer", "description": "Оценка дью-дилидженс от 0 до 100, где большее значение лучше. Та же шкала, что и в каталоге VASP." }, "dd_score_breakdown": { "type": "object", "description": "Вклад каждого компонента в dd_score: один объект на компонент в соответствии со справочником VASP (jurisdiction, verification, protocol, lei, history, essentials, responsiveness), каждый со структурой {points, max, reason, detail}. Пустой объект {}, пока контрагент не был оценён.", "additionalProperties": { "type": "object", "properties": { "points": { "type": "number", "description": "Баллы, начисленные за этот компонент." }, "max": { "type": "integer", "description": "Максимальное количество баллов, которое может начислить этот компонент." }, "reason": { "type": "string", "description": "Машиночитаемый код вердикта компонента." }, "detail": { "type": "string", "description": "Понятная человеку причина начисления баллов." } } } }, "dd_assessed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда в последний раз проводилась оценка в рамках комплексной проверки. Null, пока контрагент не был оценён." } } }, "originator_data": { "type": "object", "description": "Сторона-отправитель. Для входящего перевода значения контрагента маскируются до тех пор, пока владение не будет подтверждено." }, "beneficiary_data": { "type": "object", "description": "Сторона-получатель. Для входящего перевода значения контрагента маскируются до подтверждения владения." }, "name_match": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleNameMatch" } ], "nullable": true, "description": "Сравнение имен, на основе которого было принято решение по переводу, или null до выполнения проверки. Пока стороны маскированы, а также в копии транзакции INTERNAL у другого клиента, поля `transfer_name`, `compared_name`, `matched_names` и `mismatched_names` скрыты. Значения `score` и `matched` могут расходиться: `matched` следует уровню строгости, а `score` отражает степень сходства двух полных имен." }, "data_match": { "$ref": "#/components/schemas/TravelRuleDataMatch" }, "mismatched_fields": { "type": "array", "items": { "type": "string" }, "description": "Сокращение для `data_match.mismatched_fields`. Пусто, если различий нет." }, "data_unmasked": { "$ref": "#/components/schemas/TravelRuleDataUnmasked" }, "data_masked": { "type": "boolean", "description": "Имеет значение true, пока персональные данные контрагента маскируются в этом ответе." }, "created_at": { "type": "string", "format": "date-time" }, "delivery": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/TravelRuleDelivery" } ], "description": "Текущий статус последнего сообщения, которое этот перевод должен отправить другой стороне. Null, если перевод не требовал отправки сообщения (например, ниже `threshold_amount`, заявленный некастодиальный кошелёк или регистрация в рамках sunrise-периода)." }, "discovery": { "type": "array", "description": "Как Didit выполнял поиск контрагента: по одной записи на каждый выполненный шаг. Пусто, если поиск не выполнялся, например для входящего перевода.", "items": { "$ref": "#/components/schemas/TravelRuleDiscoveryStep" } }, "reason": { "type": "string", "description": "Причина, по которой перевод со статусом `COUNTERPARTY_VASP_NOT_FOUND` или `COUNTERPARTY_VASP_NOT_REACHABLE` приостановлен; `\"\"` для любого другого статуса. Неудачная доставка определяет её в первую очередь и только при `COUNTERPARTY_VASP_NOT_REACHABLE`: `email_undeliverable` (почтовый провайдер отклонил комплаенс-письмо, и адресов для повторной попытки не осталось: при отправке, при напоминании или в виде постоянного сбоя доставки, о котором сообщено позже) или `delivery_failed` (канал доставки окончательно вышел из строя: сетевой канал отклонил сообщение или исчерпал лимит повторных попыток, хост идентификации `TRP` не ответил либо `TRP`-хост контрагента не принял запрос). В противном случае её определяет трассировка `discovery`: `awaiting_end_user` (ни на одном шаге не указан контрагент, с которым Didit может связаться), `directory_match_no_route` (на шаге указан VASP из каталога, у которого нет маршрута), `picked_member_without_proven_wallet` (конечный пользователь выбрал клиента Didit, который не подтвердил контроль над кошельком) или `no_directory_match`, если трассировка не возвращает иной причины. Повторная отправка продвигает перевод дальше, поэтому причина сбрасывается. См. [Почему перевод приостановлен](/ru/transaction-monitoring/travel-rule#почему-перевод-застрял)." }, "next_actions": { "type": "array", "description": "Действия, продвигающие перевод дальше; `[]` для любого статуса, кроме `COUNTERPARTY_VASP_NOT_FOUND` или `COUNTERPARTY_VASP_NOT_REACHABLE`. `email_undeliverable` предлагает `update_compliance_email`, затем `resend`. `delivery_failed` предлагает `resend`. Причина типа discovery предлагает `select_counterparty_vasp`, `declare_self_hosted`, `add_vasp_hint` и `resend`.", "items": { "$ref": "#/components/schemas/TravelRuleNextAction" } }, "chain_details": { "$ref": "#/components/schemas/TravelRuleChainDetails" } } }, "TravelRuleOwnershipConfirmRequest": { "type": "object", "required": [ "confirmed" ], "properties": { "confirmed": { "type": "boolean", "description": "true для подтверждения владения, false для отклонения." }, "wallet_address": { "type": "string", "default": "", "description": "Входящие переводы TRP: адрес платежа, который Didit возвращает исходному VASP при одобрении. По умолчанию используется адрес из совпадающей записи адресной книги, затем beneficiary_data.wallet_address. Для заявленного перевода с некастодиального кошелька без указания кошелька контрагента: кошелёк, владение которым вы подтвердили; без него запрос отклоняется с кодом 400. Игнорируется для других переводов." } } }, "TravelRuleTransferPatchRequest": { "type": "object", "description": "Укажите ровно один из параметров: payment_txn_id (завершение), action=cancel, action=resend, action=update_compliance_email с compliance_email, action=update_originator_wallet с wallet_address или action=beneficiary_vasp с beneficiary_vasp.", "properties": { "payment_txn_id": { "type": "string", "description": "Хеш ончейн-транзакции. Требуется, чтобы перевод был исходящим и находился в статусе COMPLETED." }, "action": { "type": "string", "enum": [ "cancel", "resend", "update_compliance_email", "update_originator_wallet", "beneficiary_vasp" ], "description": "\"cancel\" отменяет перевод в неконечном статусе. \"resend\" повторно запускает маршрутизацию для исходящего перевода, зависшего в статусе COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE или NOT_ENOUGH_COUNTERPARTY_DATA. \"update_compliance_email\" заменяет комплаенс-email, на который отправляется запрос, для исходящего перевода в одном из этих трёх статусов; после этого отправьте \"resend\". \"update_originator_wallet\" записывает кошелёк, с которого фактически ушли средства (`wallet_address`, `memo`). \"beneficiary_vasp\" позволяет вручную указать VASP контрагента (требуется `beneficiary_vasp`) для исходящего перевода в одном из этих статусов: перевод будет перенаправлен этому VASP и отправлен повторно." }, "compliance_email": { "type": "string", "format": "email", "maxLength": 254, "description": "Обязательно при `action: update_compliance_email`. Сохраняется как `beneficiary_data.counterparty_vasp_email` этого перевода: относится только к этому переводу и не добавляется ни в запись справочника, ни в список контактов." }, "wallet_address": { "type": "string", "maxLength": 128, "description": "С `action: update_originator_wallet`: кошелёк, с которого были отправлены средства. Если UTXO-входы перевода известны, он должен быть одним из них." }, "memo": { "type": "string", "maxLength": 256, "description": "С `action: update_originator_wallet`: memo или тег кошелька в сети с memo. Необязательно." }, "beneficiary_vasp": { "type": "string", "format": "uuid", "description": "Обязательно при action=beneficiary_vasp: `id` VASP из справочника, полученный из `GET /v3/travel-rule/vasps/`. Ваш выбор имеет приоритет над каждым шагом автоматического обнаружения, который никогда его не переопределяет." } } }, "VaspDirectoryEntry": { "type": "object", "description": "VASP из справочника или участник сети Didit с маршрутами, доступными вашему приложению к нему. Клиент является участником сети Didit только тогда, когда его приложение находится в продакшене, Travel Rule включён, его профиль доступен для поиска, указаны юридическое наименование и подтверждённый комплаенс-email, а Didit не пометил приложение как тестовое, демонстрационное или внутреннее. Каждая строка также содержит общую оценку комплексной проверки (dd_score, risk_level, responsiveness, essential_checks) и собственные решение, скрининг сущностей и анкеты вашего приложения, которые не видит ни один другой клиент.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Идентификатор записи для GET /v3/travel-rule/vasps/{vasp_id}/." }, "kind": { "type": "string", "enum": [ "directory", "didit" ], "description": "directory для записи из общего каталога; didit для участника сети Didit." }, "name": { "type": "string" }, "lei": { "type": "string" }, "jurisdiction": { "type": "string", "description": "Код страны ISO 3166 в том виде, в котором его предоставляет источник." }, "domains": { "type": "array", "items": { "type": "string" }, "description": "Веб-домены VASP. Всегда пусто для участников сети Didit." }, "reachable": { "type": "boolean", "description": "Есть ли у вашего приложения доступный маршрут к этому VASP или к одному из его юридических лиц для бренда. Всегда true для участника сети Didit, за исключением приложения в песочнице, где каждая строка равна false." }, "aliases": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "kind": { "type": "string", "enum": [ "trading_name", "other_legal_name", "network_name", "attribution", "merged", "staff" ], "description": "trading_name, other_legal_name (из глобального реестра LEI), network_name (название в сети Travel Rule), attribution (название организации, присвоенное кошелькам VASP блокчейн-аналитикой), merged (название дублирующей записи, объединённой с этой) или staff." } } }, "description": "Другие наименования, по которым можно найти VASP." }, "networks": { "type": "array", "items": { "type": "object", "description": "Текущая запись этого VASP в справочнике участников сети Travel Rule. Запись TRISA указывает, кем является VASP в TRISA; у Didit нет транспорта TRISA, поэтому он никогда не является маршрутом.", "properties": { "network": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA", "TRISA" ] }, "code": { "type": "string", "description": "Идентификатор VASP в этой сети." }, "listed_name": { "type": "string", "description": "Наименование, под которым сеть указывает VASP." }, "country": { "type": "string", "description": "Страна, указанная сетью, если она предоставлена." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда сотрудники Didit верифицировали запись. Null для записей, прочитанных из публичного справочника." }, "last_seen_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Время последнего отображения записи источником. Запись, которую источник не отображает в течение трёх недель, удаляется." }, "source": { "type": "string", "enum": [ "trisa_directory", "staff" ], "description": "Источник записи: публичный каталог TRISA или сотрудники Didit." } } } }, "routes": { "type": "array", "items": { "type": "object", "description": "Один из способов передачи данных Travel Rule этому VASP вашим приложением в порядке попыток отправки. Для сетевого маршрута требуется членство в этой сети: ваше собственное (подключённое в Marketplace) или Didit, когда Didit его получит. Без него маршрут отображается как недоступный с указанием причины и никогда не предлагается как способ связаться с VASP.", "properties": { "rail": { "type": "string", "enum": [ "INTERNAL", "TRP", "GTR", "TRUST", "VERIFYVASP", "SYGNA", "EMAIL" ] }, "status": { "type": "string", "enum": [ "available", "unavailable" ] }, "reason": { "type": "string", "enum": [ "", "no_membership", "network_switched_off", "sandbox_application" ], "description": "Причина, по которой недоступный маршрут не может быть использован: no_membership (ни у вас, ни у Didit нет участия в этой сети), network_switched_off (вы отключили эту сеть в настройках) или sandbox_application (приложение в песочнице отправляет данные только в Didit Test VASP, поэтому маршруты для него недоступны). Пусто, если маршрут доступен." }, "via": { "type": "string", "enum": [ "", "own_membership", "didit_membership", "directory", "contact", "didit_network" ], "description": "Способ достижения доступного маршрута: own_membership или didit_membership для сетевого канала, directory для проверенного каталогом TRP endpoint, contact для EMAIL-канала, didit_network для участника сети Didit. Пусто, если маршрут недоступен." } } } }, "umbrella": { "type": "object", "nullable": true, "description": "Бренд, регулируемым субъектом которого является эта запись. Null, если она не входит в его состав.", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } }, "entities": { "type": "array", "items": { "type": "object", "description": "Регулируемая организация бренда: юридическое лицо, принимающее перевод.", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "lei": { "type": "string" }, "jurisdiction": { "type": "string" }, "reachable": { "type": "boolean", "description": "Есть ли у вашего приложения доступный маршрут к нему." } } }, "description": "Для бренда: регулируемые организации, принимающие его переводы. Перевод с указанием бренда направляется доступной организации в указанной в нём юрисдикции (beneficiary_data.counterparty_vasp_jurisdiction), иначе организации, связанной с кошельком назначения атрибуцией блокчейн-аналитики, иначе единственной доступной организации, если юрисдикция не указана. Выбор между двумя одинаково подходящими организациями никогда не делается наугад." }, "contacts": { "type": "array", "items": { "type": "object", "description": "Комплаенс-контакт, на который может отправлять сообщения транспорт EMAIL.", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" }, "source": { "type": "string", "enum": [ "staff", "application", "learned" ], "description": "staff: курируется Didit; application: добавлен вашим приложением; learned: адрес, ответивший на запрос Travel Rule по ссылке для ответа." }, "scope": { "type": "string", "enum": [ "platform", "application" ], "description": "platform: контакты используются для переводов каждого клиента Didit; application: контакты приватны для вашего приложения, и оно видит только свои." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда кто-либо по этому адресу ответил на запрос. Null, если ответа ещё не было." } } }, "description": "Контакты платформы для этого VASP и контакты вашего приложения." }, "dd_status": { "type": "string", "enum": [ "NOT_STARTED", "IN_PROGRESS", "COMPLETED", "REJECTED" ], "description": "Статус верификации записи в Didit, оцениваемый верификационным компонентом dd_score. Всегда COMPLETED для участника сети Didit." }, "dd_score": { "type": "integer", "nullable": true, "minimum": 0, "maximum": 100, "description": "Общая оценка комплексной проверки благонадёжности записи каталога, от 0 до 100, где более высокое значение означает большую безопасность (см. dd_score_semantic): сумма баллов в dd_score_breakdown. Null для участника сети Didit, который не оценивается. Для записи, которая ещё не была оценена (dd_assessed_at имеет значение null), отображается 0 с пустым risk_level, поэтому ориентируйтесь на risk_level, а не на исходную оценку." }, "reachable_rails": { "type": "array", "items": { "type": "string", "enum": [ "INTERNAL", "TRP", "GTR", "TRUST", "VERIFYVASP", "SYGNA", "EMAIL" ] }, "description": "Каналы, зафиксированные в записи. Прочитайте маршруты, чтобы узнать, что ваше приложение может использовать на сегодняшний день." }, "is_didit_customer": { "type": "boolean", "description": "true для участника сети Didit (для них dd_status всегда равен COMPLETED, dd_score равен null, а risk_level пуст) и для записи справочника, привязанной к клиенту Didit." }, "dd_score_breakdown": { "type": "object", "description": "Один объект на каждый компонент dd_score. Компоненты, их вес (макс.) и коды причин: jurisdiction, 25 (jurisdiction_not_high_risk, jurisdiction_high_risk, jurisdiction_unknown); verification, 15 (dd_status_completed, dd_status_in_progress, dd_status_not_started, dd_status_rejected); protocol, 15 (native_rail, email_only, no_rail); lei, 10 (lei_valid, lei_missing); history, 10 (history, no_history); essentials, 15 (essential_checks, no_essential_checks); responsiveness, 10 (responsive, unresponsive, responsiveness_unknown). Пусто для участника сети Didit.", "additionalProperties": { "type": "object", "properties": { "points": { "type": "number", "description": "Баллы, начисленные за этот компонент, с округлением до одного десятичного знака." }, "max": { "type": "integer", "description": "Вес компонента: баллы, которые он вносит в лучшем случае." }, "reason": { "type": "string", "description": "Машиночитаемый код вердикта компонента." }, "detail": { "type": "string", "description": "Однострочное объяснение на английском языке." } } } }, "dd_assessed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда в последний раз рассчитывались dd_score, risk_level и responsiveness: после того, как обмен с этой записью завершается, оканчивается, истекает, не совпадает или отклоняется, когда Didit обновляет или систематизирует запись, а также при еженедельном обновлении каталога. Null для участника сети Didit." }, "dd_score_semantic": { "type": "string", "enum": [ "higher_is_safer" ], "description": "Направление интерпретации dd_score: всегда higher_is_safer." }, "risk_level": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH", "" ], "description": "Диапазон, в который попадает dd_score: LOW (70 или выше), MEDIUM (от 40 до 69) или HIGH (ниже 40). Не заполнено для участников сети Didit и записей, которые ещё не были оценены. Фильтруйте по нему с помощью risk. Ваша собственная отметка в скрининге никогда не меняет это общее значение: вместо этого она устанавливает counterparty_risk_level в HIGH в ваших правилах." }, "responsiveness": { "type": "object", "description": "Отвечает ли VASP на запросы Travel Rule: доля запросов, инициированных клиентами Didit в его адрес за последние 90 дней, на которые он ответил. Учитываются только запросы, отправленные через сеть или протокольный канал, либо по электронной почте на общий адрес (комплаенс-адрес записи или контакт платформы); запрос, отправленный на адрес, введённый клиентом вручную, или личному контакту клиента, не учитывается никогда. Запрос с истекшим сроком действия считается оставшимся без ответа; завершённый обмен данными, отказ или несоответствие данных считаются ответом; отменённый запрос или недоступный канал не считаются ни тем, ни другим. Всегда UNKNOWN с нулевыми счётчиками для участника сети Didit.", "properties": { "status": { "type": "string", "enum": [ "RESPONSIVE", "UNRESPONSIVE", "UNKNOWN" ], "description": "UNKNOWN при менее чем 5 запросах, по которым принято решение, за период; UNRESPONSIVE, если ответ был дан менее чем на 10 процентов из них; в остальных случаях RESPONSIVE." }, "answered": { "type": "integer", "description": "Решённые запросы за период, на которые VASP ответил." }, "total": { "type": "integer", "description": "Решённые запросы за период: получившие ответ плюс истёкшие." }, "computed_at": { "type": "string", "format": "date-time", "nullable": true } } }, "essential_checks": { "type": "object", "description": "Отчёт об основных проверках записи каталога, сформированный исключительно на основе верифицированных платформой источников: регистрация (официальный реестр содержит VASP: временный реестр MiCA ЕС, публичный каталог TRISA или глобальный реестр LEI), лицензия (авторизация MiCA зафиксирована и действительна), домен (домен записи совпадает с её endpoint TRP или сайтом, указанным в реестре) и LEI (запись LEI активна, выпущена и соответствует наименованиям и стране записи). Компонент essentials в dd_score представляет собой долю успешно пройденных проверок среди завершённых. Поле пусто до тех пор, пока еженедельное обновление каталога впервые не проверит запись, и всегда пусто для участников сети Didit.", "properties": { "level": { "type": "string", "enum": [ "essential" ] }, "checked_at": { "type": "string", "format": "date-time" }, "checks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "enum": [ "registration", "licence", "domain", "lei" ] }, "status": { "type": "string", "enum": [ "pass", "fail", "unknown" ], "description": "unknown, если ни один из зарегистрированных источников не может вынести решение по проверке." }, "reason": { "type": "string", "description": "Машиночитаемый код вердикта." }, "detail": { "type": "string", "description": "Однострочное объяснение на английском языке." } } } }, "passed": { "type": "integer" }, "failed": { "type": "integer" }, "unknown": { "type": "integer" }, "total": { "type": "integer" } } }, "decision": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleCounterpartyDecision" } ], "nullable": true, "description": "Решение вашего приложения по этому VASP или, для сущности без собственного решения, решение её бренда (inherited_from указывает бренд). Null, если решения нет. Доступно только вашему приложению." }, "entity_screening": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleCounterpartyScreening" } ], "nullable": true, "description": "Последний скрининг по санкциям и негативным публикациям в СМИ для этого VASP в вашем приложении. Null, если вы никогда не проводили его скрининг. Доступно только вашему приложению." }, "questionnaires": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleCounterpartyQuestionnaire" }, "description": "Анкеты комплексной проверки вашего приложения с этим VASP, сначала новые. Доступно только вашему приложению." } }, "example": { "id": "0d6f3c2a-6a1e-4c55-9a39-1f2b0c7d8e91", "kind": "directory", "name": "Example Counterparty VASP", "lei": "529900EXAMPLECPTY001", "jurisdiction": "DE", "domains": [ "counterparty.example" ], "reachable": true, "aliases": [ { "name": "Example Counterparty", "kind": "trading_name" } ], "networks": [ { "network": "GTR", "code": "EXAMPLE01", "listed_name": "Example Counterparty VASP", "country": "DE", "verified_at": "2026-10-12T09:30:00Z", "last_seen_at": "2026-10-12T09:30:00Z", "source": "staff" } ], "routes": [ { "rail": "GTR", "status": "unavailable", "reason": "no_membership", "via": "" }, { "rail": "EMAIL", "status": "available", "reason": "", "via": "contact" } ], "umbrella": null, "entities": [], "contacts": [ { "id": "6c1f9b8e-2d4a-4f7e-8b3c-5a9d0e1f2a3b", "email": "travelrule@counterparty.example", "name": "Travel Rule desk", "source": "staff", "scope": "platform", "verified_at": null } ], "dd_status": "NOT_STARTED", "dd_score": 62, "dd_score_breakdown": { "jurisdiction": { "points": 25.0, "max": 25, "reason": "jurisdiction_not_high_risk", "detail": "DEU is not on the high-risk jurisdiction list" }, "verification": { "points": 3.8, "max": 15, "reason": "dd_status_not_started", "detail": "due diligence status NOT_STARTED" }, "protocol": { "points": 6.0, "max": 15, "reason": "email_only", "detail": "reachable over the email fallback only" }, "lei": { "points": 10.0, "max": 10, "reason": "lei_valid", "detail": "valid LEI on record" }, "history": { "points": 5.0, "max": 10, "reason": "no_history", "detail": "no exchange history" }, "essentials": { "points": 7.5, "max": 15, "reason": "no_essential_checks", "detail": "no decided essential check yet" }, "responsiveness": { "points": 5.0, "max": 10, "reason": "responsiveness_unknown", "detail": "0 decided recent requests, too few to judge" } }, "dd_assessed_at": "2026-10-12T09:30:00Z", "dd_score_semantic": "higher_is_safer", "risk_level": "MEDIUM", "responsiveness": { "status": "UNKNOWN", "answered": 0, "total": 0, "computed_at": "2026-10-12T09:30:00Z" }, "essential_checks": {}, "reachable_rails": [ "GTR", "EMAIL" ], "is_didit_customer": false, "decision": { "decision": "APPROVED", "reason": "Licensed in DE, questionnaire reviewed", "decided_by": "", "updated_at": "2026-10-14T10:05:00Z", "inherited_from": null }, "entity_screening": { "id": "7a1d2c3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d", "status": "Approved", "total_hits": 0, "score": null, "screened_at": "2026-10-14T09:58:00Z", "fresh": true, "flagged": false }, "questionnaires": [ { "id": "8b7a6c5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d", "status": "ANSWERED", "form_version": "1", "sent_to": "travelrule@counterparty.example", "sent_at": "2026-09-02T08:00:00Z", "expires_at": "2026-10-02T08:00:00Z", "answered_at": "2026-09-04T15:20:00Z", "valid_until": "2027-09-04T15:20:00Z", "current": true, "answers": { "legal_name": "Example Counterparty VASP, incorporated in the example jurisdiction.", "licensing": "Crypto-asset service provider authorised under MiCA by its national regulator, licence active.", "jurisdictions": "EU and EEA. We do not serve the United States.", "aml_program": "Written AML/CFT policy, annual independent review, last completed in March 2026.", "compliance_officer": "Head of Compliance, reachable at compliance@counterparty.example.", "sanctions_screening": "Customers at onboarding and daily; counterparties on every transfer.", "transaction_monitoring": "Rule-based monitoring with analyst review; suspicious activity reports filed with the FIU.", "travel_rule": "TRP and email; we answer requests within one business day.", "custody": "Segregated customer wallets held with a qualified custodian, insured.", "ownership": "No shareholder holds 25 percent or more; parent company Example Holding Group.", "record_keeping": "Five-year record-keeping for Travel Rule and transaction data, as our regulator requires.", "data_protection": "Encrypted at rest and in transit, stored in the EU." } } ] } }, "TravelRuleCounterpartyDecision": { "type": "object", "description": "Решение вашего приложения по VASP-контрагенту. Доступно только вашему приложению: оно никогда не изменяет общую запись каталога, и другой клиент никогда его не увидит. Оно действует только через ваши правила транзакций (поле правила counterparty_dd_status и пресеты travel-rule-counterparty-blocked и travel-rule-counterparty-restricted); оно никогда не меняет маршрутизацию перевода.", "properties": { "decision": { "type": "string", "enum": [ "APPROVED", "RESTRICTED", "BLOCKED" ], "description": "APPROVED: ваша команда подтвердила контрагента. RESTRICTED: переводы в его адрес могут быть выполнены после проверки. BLOCKED: ваша команда отклонила его." }, "reason": { "type": "string", "maxLength": 255, "description": "Указанная вами причина в виде произвольного текста; пустая строка, если причина не указана." }, "decided_by": { "type": "string", "description": "Пользователь консоли, который принял или последним изменил решение. Пусто, если оно было принято с помощью API-ключа." }, "updated_at": { "type": "string", "format": "date-time" }, "inherited_from": { "type": "object", "nullable": true, "description": "Бренд, решению которого следует эта сущность, поскольку вы не приняли решение по самой сущности. Null, если решение принято самим контрагентом.", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } } } }, "TravelRuleCounterpartyDecisionResponse": { "type": "object", "properties": { "decision": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleCounterpartyDecision" } ], "nullable": true, "description": "Решение, применимое к контрагенту для вашего приложения: собственное или (для сущности бренда) решение бренда. Null, если решение отсутствует." } } }, "TravelRuleCounterpartyDecisionRequest": { "type": "object", "required": [ "decision" ], "properties": { "decision": { "type": "string", "enum": [ "APPROVED", "RESTRICTED", "BLOCKED" ] }, "reason": { "type": "string", "maxLength": 255, "description": "Необязательно. Заменяет предыдущую причину; опустите ее, чтобы очистить значение." } } }, "TravelRuleCounterpartyScreening": { "type": "object", "description": "Один скрининг контрагента на наличие санкций и негативных публикаций в СМИ, выполненный для вашего приложения и выставленный ему в счёт. Конфиденциально для вашего приложения: другой клиент никогда этого не увидит.", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "Одобрена: нет возможных совпадений, требующих внимания. На проверке или Отклонена: возможное совпадение по санкциям или негативным публикациям в СМИ." }, "total_hits": { "type": "integer", "description": "Количество возможных совпадений, возвращённых скринингом." }, "score": { "type": "number", "nullable": true, "description": "Наивысшая оценка риска среди возможных совпадений. Значение null, если совпадений не найдено." }, "screened_at": { "type": "string", "format": "date-time" }, "fresh": { "type": "boolean", "description": "Выполнен ли скрининг менее чем fresh_days (30 дней) назад. Недавний скрининг используется повторно и не оплачивается снова." }, "flagged": { "type": "boolean", "description": "true, пока скрининг актуален и имеет статус In Review или Declined. Пока ваш последний скрининг помечен флагом и скрининг контрагентов остаётся включённым, counterparty_risk_level в ваших правилах имеет значение HIGH." } } }, "TravelRuleCounterpartyScreeningStatus": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Ваша настройка Travel Rule counterparty_screening_enabled. По умолчанию выключена; пока она выключена, скрининг не проводится и плата не взимается." }, "price": { "type": "string", "description": "Десятичная строка в USD: стоимость одного скрининга для вашей организации, цена AML-скрининга для компании." }, "fresh_days": { "type": "integer", "description": "Количество дней, в течение которых скрининг остаётся актуальным и используется повторно." }, "screening": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleCounterpartyScreening" } ], "nullable": true, "description": "Ваш последний скрининг контрагента. Null, если вы никогда не проводили его скрининг." } } }, "TravelRuleCounterpartyScreeningRequest": { "type": "object", "properties": { "refresh": { "type": "boolean", "default": false, "description": "true выполняет скрининг повторно (и тарифицирует его снова), даже если существует актуальный скрининг." } } }, "TravelRuleCounterpartyScreeningResult": { "type": "object", "properties": { "outcome": { "type": "string", "enum": [ "screened", "reused" ], "description": "screened: был выполнен и тарифицирован новый скрининг (201). reused: возвращён актуальный скрининг, списаний не производилось (200)." }, "screening": { "$ref": "#/components/schemas/TravelRuleCounterpartyScreening" } } }, "TravelRuleCounterpartyQuestionnaire": { "type": "object", "description": "Одна анкета надлежащей проверки, отправленная вашим приложением контрагенту: стандартная анкета Didit, направленная на зарегистрированный комплаенс-адрес электронной почты с одноразовой ссылкой для ответа. Доступна только вашему приложению.", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "SENT", "ANSWERED", "EXPIRED" ], "description": "SENT: ожидание ответов. ANSWERED: контрагент ответил на все вопросы. EXPIRED: ссылка на ответ закрыта без ответа (истёк срок её действия или её заменила более новая анкета), либо срок действия ответов истёк согласно valid_until." }, "form_version": { "type": "string", "description": "Версия стандартной анкеты Didit, к которой относятся ответы. В настоящее время 1." }, "sent_to": { "type": "string", "format": "email" }, "sent_at": { "type": "string", "format": "date-time", "nullable": true }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Срок для ответа составляет 30 дней после отправки. После этого ссылка перестаёт действовать." }, "answered_at": { "type": "string", "format": "date-time", "nullable": true }, "valid_until": { "type": "string", "format": "date-time", "nullable": true, "description": "Срок актуальности ответов: 365 дней после ответа. Null до предоставления ответов." }, "current": { "type": "boolean", "description": "true, пока анкета находится в статусе ANSWERED и срок valid_until не истёк." }, "answers": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Ответы, сгруппированные по id вопроса: legal_name, licensing, jurisdictions, aml_program, compliance_officer, sanctions_screening, transaction_monitoring, travel_rule, custody, ownership, record_keeping, data_protection. Длина каждого ответа составляет до 2 000 символов. Поле пустое, пока ответы не даны." } } }, "TravelRuleCounterpartyQuestionnaireRequest": { "type": "object", "properties": { "sent_to": { "type": "string", "format": "email", "description": "Необязательно. Зарегистрированный комплаенс-адрес контрагента: для записи в справочнике это его комплаенс-адрес или контакт, доступный вашему приложению; для участника сети Didit это подтвержденный адрес электронной почты для комплаенса. По умолчанию: адрес, на который отправляется email по Travel Rule контрагенту (сначала ваш собственный контакт, затем контакт платформы, затем комплаенс-адрес записи)." } } }, "TravelRuleCounterpartyQuestionnaireList": { "type": "object", "properties": { "questionnaires": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleCounterpartyQuestionnaire" }, "description": "Сначала самые новые." } } }, "TravelRulePickupInfo": { "type": "object", "description": "Обмен в ожидании по ссылке для получения из письма, как он отображается на странице ответа контрагента.", "properties": { "reference": { "type": "string", "format": "uuid", "description": "UUID перевода в том виде, в каком он отображается в консоли отправляющего VASP." }, "requested_at": { "type": "string", "format": "date-time" }, "originator_vasp_name": { "type": "string" }, "originator_vasp_lei": { "type": "string" }, "recipient_vasp_name": { "type": "string", "description": "VASP контрагента, которому адресован запрос." }, "language": { "type": "string", "description": "Язык письма с запросом и страницы ответа, определяемый по юрисдикции контрагента." }, "amount": { "type": "string" }, "currency": { "type": "string" }, "fiat_amount": { "type": "string", "description": "Конвертированное значение, указанное отправителем, или пусто." }, "fiat_currency": { "type": "string" }, "chain": { "type": "string" }, "beneficiary_wallet": { "type": "string" }, "status": { "type": "string" }, "ivms_version": { "type": "string" }, "deadline_at": { "type": "string", "format": "date-time", "description": "Время, когда ссылка перестает отвечать." }, "reminders_sent": { "type": "integer" }, "contact": { "type": "string", "description": "Значение `?contact=` из ссылки, возвращаемое обратно; пусто, если в ссылке его нет." }, "decline_reasons": { "type": "array", "items": { "type": "string", "enum": [ "data_mismatch", "not_our_customer", "wallet_not_hosted", "sanctions", "risk_appetite", "jurisdiction", "insufficient_data", "other" ] }, "description": "Значения, принимаемые `decline_reason`." }, "join_invitation": { "type": "object", "description": "Имеет ли контрагент действующее приглашение бесплатно присоединиться к Didit. Ссылка на приглашение передаётся только в электронном письме на приглашённый адрес, поэтому `url` здесь пуст.", "properties": { "eligible": { "type": "boolean" }, "url": { "type": "string" } } }, "originator_data": { "type": "object", "description": "Поля отправителя, которыми делится VASP отправителя (`data_sharing_fields`). Имя и кошелек включаются всегда." }, "beneficiary_data": { "type": "object" }, "ivms_request": { "type": "object", "description": "Тот же запрос в виде объекта IVMS 101. Опускается, если `data_masked` имеет значение true." }, "data_masked": { "type": "boolean", "description": "Всегда false для этого endpoint: запрос электронной почты является исходящим, и собственный пользователь отправителя никогда не маскируется." } } }, "TravelRulePickupRespondRequest": { "type": "object", "required": [ "decision" ], "properties": { "decision": { "type": "string", "enum": [ "accept", "decline" ] }, "beneficiary_name": { "type": "string", "description": "Имя получателя согласно вашим записям после применения правила обработки имён отправляющего VASP. `ivms_response` имеет приоритет, если в нём указан получатель.", "maxLength": 255 }, "decline_reason": { "type": "string", "enum": [ "", "data_mismatch", "not_our_customer", "wallet_not_hosted", "sanctions", "risk_appetite", "jurisdiction", "insufficient_data", "other" ], "description": "Причина отклонения. Записывается в таймлайн перевода отправляющего VASP. Пусто (по умолчанию), если причина не указана." }, "decline_detail": { "type": "string", "maxLength": 512, "description": "Текст в свободной форме; обязателен, если `decision` имеет значение `decline`, а `decline_reason` имеет значение `other`." }, "ivms_response": { "type": "object", "description": "Ваш полный ответ IVMS 101. Имя получателя из него имеет приоритет перед `beneficiary_name`." }, "contact": { "type": "string", "format": "uuid", "description": "Контакт, которому была отправлена ссылка, из значения `?contact=` ссылки. Если в теле оно опущено, используется query-параметр `contact`." } } }, "TravelRuleInboundRequest": { "type": "object", "required": [ "chain", "txid", "wallet_address", "amount", "currency" ], "properties": { "chain": { "type": "string", "description": "Блокчейн, в котором был обработан депозит, например `ETH`. Сохраняется в нижнем регистре и сравнивается без учёта регистра с записями в адресной книге ваших кошельков, поэтому используйте там тот же token блокчейна.", "maxLength": 32 }, "txid": { "type": "string", "description": "Ончейн-хеш транзакции. Дедуплицируется вместе с wallet_address.", "maxLength": 128 }, "wallet_address": { "type": "string", "description": "Кошелёк назначения, на который вы получили депозит. XRP X-address разделяется на классический адрес и тег.", "maxLength": 128 }, "amount": { "type": "string", "description": "Сумма депозита в виде десятичной строки, ноль или больше, до 18 знаков после запятой." }, "currency": { "type": "string", "description": "Актив депозита, например, \"USDC\".", "maxLength": 16 }, "originator_data": { "type": "object", "description": "Данные об отправителе от отправляющего VASP, если они известны, в виде плоского объекта, такого как `{\"name\": \"...\"}`. Didit считывает из него name (или full_name), first_name, last_name и vendor_data.", "additionalProperties": true }, "beneficiary_data": { "type": "object", "description": "Данные получателя (вашего клиента) в виде плоского объекта, например `{\"name\": \"...\"}`. Didit сопоставляет имя с holder_name соответствующей записи адресной книги и устанавливает wallet_address и chain из запроса.", "additionalProperties": true }, "originating_vasp": { "type": "object", "description": "Необязательное описание отправляющего VASP. Оно остаётся только в этом переводе (`metadata.originating_vasp` и VASP отправителя перевода в GET /v3/travel-rule/transfers/); оно никогда не создаёт, не редактирует и не связывает общую запись в справочнике VASP.", "properties": { "name": { "type": "string", "maxLength": 255 }, "lei": { "type": "string", "maxLength": 20, "description": "Необязательно. Действительный 20-значный LEI по стандарту ISO 17442 или пустое значение." }, "travel_address": { "type": "string", "description": "Travel Address отправителя, зафиксированный для этого перевода.", "maxLength": 512 } } }, "memo": { "type": "string", "maxLength": 256, "description": "Необязательно. Тег назначения (destination tag) или memo депозита в сети с поддержкой memo: на общем адресе депозита он позволяет различать ваших клиентов, и запись в адресной книге для этого memo сопоставляется. XRP: destination tag, целое число от 0 до 4294967295 (принимается число JSON). XLM: текстовое memo длиной до 28 байт, 64-битный идентификатор или 32-байтный хэш в шестнадцатеричном формате. EOS: до 256 байт. ATOM: до 256 символов. HBAR: до 100 байт. Кошельки Bitcoin, EVM, Solana, Tron, Litecoin, Bitcoin Cash, Dogecoin и Lightning не принимают memo: его наличие возвращает `400`. Псевдоним: `destinationTag` или `destination_tag`." }, "utxo": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleUtxo" } ], "description": "Необязательно, только для сетей UTXO. Входы и выходы транзакции депозита: кошельком отправителя является объявленный `originator_data.wallet_address`, иначе наибольший вход." } } }, "TravelRuleInboundResponse": { "type": "object", "properties": { "transaction_id": { "type": "string", "format": "uuid", "description": "UUID транзакции Didit для входящего депозита." }, "txn_id": { "type": "string", "description": "txn_id входящей транзакции: сгенерированный Didit, если транзакцию создала Didit, или ваш собственный, если был повторно использован невостребованный депозит." }, "created": { "type": "boolean", "description": "true, если этот вызов зарегистрировал перевод (HTTP 201); false, если перевод с теми же txid и wallet_address уже существовал (HTTP 200)." }, "travel_rule": { "$ref": "#/components/schemas/TravelRuleTransferDetail" } } }, "TravelRuleTestVaspInboundRequest": { "type": "object", "required": [ "beneficiary_wallet_address" ], "properties": { "beneficiary_wallet_address": { "type": "string", "description": "Адрес кошелька назначения. Didit Test VASP отправляет на него средства, сопоставляя его с вашей адресной книгой кошельков в блокчейне актива. Кошелёк без соответствующей записи принимается, а входящая транзакция регистрируется со статусом ON_HOLD." }, "scenario": { "type": "string", "enum": [ "accept", "name_mismatch" ], "default": "accept", "description": "Что Didit Test VASP заявляет о получателе. `accept` указывает собственное имя владельца; `name_mismatch` указывает имя, с которым не согласен ни один владелец. Само решение всегда остаётся за вами." }, "chain": { "type": "string", "default": "ETH", "description": "Блокчейн актива." }, "amount": { "type": "string", "default": "1", "description": "Сумма в виде десятичной строки." }, "currency": { "type": "string", "default": "ETH", "description": "Код актива." }, "reference": { "type": "string", "description": "Необязательный ключ идемпотентности. Повторный запрос с тем же значением возвращает перевод, зафиксированный первым вызовом." } } }, "TravelRuleTestVaspInboundResponse": { "type": "object", "properties": { "transaction_id": { "type": "string", "format": "uuid", "description": "UUID транзакции Didit входящего перевода." }, "txn_id": { "type": "string", "description": "txn_id, сгенерированный Didit." }, "scenario": { "type": "string", "description": "Сценарий, который был выполнен." }, "travel_rule_status": { "type": "string", "description": "Статус, полученный в результате собственного решения вашего приложения." }, "detail": { "type": "string", "description": "Почему перевод получил такой статус." }, "test_vasp": { "type": "boolean", "description": "Всегда true: отправителем был Didit Test VASP." }, "travel_rule": { "$ref": "#/components/schemas/TravelRuleTransferDetail" } } }, "TravelRuleWidgetSessionCreate": { "type": "object", "properties": { "wallet_address": { "type": "string", "description": "Адрес кошелька для верификации. Необязательно; если поле пустое, адрес необходимо указать при запуске подтверждения.", "maxLength": 128 }, "chain": { "type": "string", "description": "Token блокчейна для адреса, например `ETH`, `BTC` или `SOL`. Используйте тот же token, что и в адресной книге кошельков. Подписание сообщения и тест Сатоши доступны только для поддерживаемого блокчейна. В записи адресной книги, которую проверяет доказательство, он хранится под каноническим идентификатором (ETH, BTC, SOL, TRX).", "maxLength": 32 }, "holder_name": { "type": "string", "description": "Имя владельца кошелька, используемое для сопоставления имени получателя.", "maxLength": 255 }, "vendor_data": { "type": "string", "description": "Ваш внутренний идентификатор владельца, переносимый в созданную запись адресной книги.", "maxLength": 255 }, "transaction_id": { "type": "string", "format": "uuid", "description": "Необязательно. UUID транзакции Didit для перевода Travel Rule, который необходимо перевести на следующий этап при успешной проверке подтверждения.", "nullable": true }, "satoshi_deposit_address": { "type": "string", "description": "Необязательно. Контролируемый вами адрес депозита; его указание включает метод подтверждения SATOSHI_TEST.", "maxLength": 128 }, "callback_url": { "type": "string", "description": "Необязательно. Абсолютный URL http(s), на который виджет возвращает клиента после завершения.", "maxLength": 512 }, "expires_in_minutes": { "type": "integer", "description": "Необязательно. Срок действия созданной ссылки в минутах. Автоматически продлевается, чтобы покрыть окно теста Сатоши, если предложен SATOSHI_TEST.", "default": 60, "minimum": 5, "maximum": 10080 } } }, "TravelRuleWidgetSessionResponse": { "type": "object", "properties": { "widget_session_id": { "type": "string", "format": "uuid" }, "token": { "type": "string", "description": "Непрозрачный токен сессии, встроенный в URL виджета." }, "url": { "type": "string", "description": "URL размещённого виджета подтверждения владения кошельком. Открывайте его без изменений в системном браузере (ни в коем случае не внутри webview мобильного SDK)." }, "expires_at": { "type": "string", "format": "date-time" } } }, "TravelRuleWidgetContext": { "type": "object", "properties": { "vasp_name": { "type": "string", "description": "Юридическое наименование из вашего профиля VASP, отображаемое клиенту в виджете. Пусто, если профиль отсутствует." }, "wallet_address": { "type": "string" }, "chain": { "type": "string", "description": "Сеть, с которой была выпущена сессия, в том виде, в котором вы её отправили." }, "chain_family": { "type": "string", "nullable": true, "enum": [ "EVM", "BTC", "SOL", "TRON", null ], "description": "Семейство ключей, стоящее за сетью: EVM (Ethereum, BNB Chain, Polygon, Arbitrum, Base, Optimism, Avalanche, Linea и другие EVM-сети), BTC, SOL или TRON. Один EVM-ключ управляет одним и тем же адресом во всех EVM-сетях. Null, если подпись невозможно проверить в сети." }, "holder_name": { "type": "string" }, "allowed_methods": { "type": "array", "items": { "type": "string", "enum": [ "MESSAGE_SIGNING", "SCREENSHOT", "SATOSHI_TEST", "SELF_DECLARATION" ] }, "description": "Методы подтверждения, доступные для этой сессии. Для MESSAGE_SIGNING требуется сеть с chain_family, для SATOSHI_TEST требуется satoshi_deposit_address в сессии и сеть, депозиты в которой Didit может считывать, для SCREENSHOT требуется настройка allow_screenshot_proof, а для SELF_DECLARATION требуется настройка allow_self_declaration." }, "transfer_status": { "type": "string", "nullable": true, "description": "Статус связанного перевода Travel Rule. Null, если сессия была создана без transaction_id." }, "callback_url": { "type": "string", "description": "Куда виджет перенаправляет клиента после завершения. Пустое значение, если не задано." }, "expires_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Имеет значение, отличное от null, после того как подтверждение было верифицировано." }, "proofs": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleWidgetProofSummary" } }, "max_attempts": { "type": "integer", "description": "Отклонённые подтверждения кошелька, допустимые в этой сессии." }, "attempts_used": { "type": "integer", "description": "Отклонённые подтверждения на данный момент." }, "attempts_remaining": { "type": "integer", "description": "Если 0, начало другой проверки возвращает 409, и вы создаете новую сессию виджета." }, "customization": { "type": "object", "nullable": true, "description": "Кастомизация White label приложения (цвета, логотип, семейство шрифтов), если включён White label: виджет отображается с тем же брендингом, что и сценарий верификации. В противном случае null." } } }, "TravelRuleWidgetProofSummary": { "type": "object", "properties": { "proof_id": { "type": "string", "format": "uuid" }, "method": { "type": "string", "enum": [ "MESSAGE_SIGNING", "SATOSHI_TEST", "SCREENSHOT", "SELF_DECLARATION" ] }, "status": { "type": "string", "enum": [ "PENDING", "VERIFIED", "REJECTED", "EXPIRED" ], "description": "PENDING: конечный пользователь выбрал этот метод, и решение по подтверждению ещё не принято. Неудачная подпись или тестовый депозит, который ещё не удаётся прочитать или подтвердить, сохраняет подтверждение в статусе PENDING с указанием failure_reason, чтобы конечный пользователь мог повторить попытку; отправленный депозит SATOSHI_TEST перепроверяется автоматически до закрытия временного окна, а отправленный SCREENSHOT ожидает вашей проверки. VERIFIED: владение доказано. REJECTED: тестовый депозит явно некорректен (другой отправитель, сумма на адрес депозита отличается от ожидаемой, дата раньше челленджа или транзакция, которая уже подтвердила другой кошелёк) либо ваш проверяющий отклонил скриншот; failure_reason указывает причину. Отклонённое подтверждение окончательно и расходует одну из попыток сессии. EXPIRED: решение по подтверждению больше не может быть принято (окно закрылось, конечный пользователь сменил метод, время сессии виджета истекло или изменился владелец кошелька); failure_reason указывает причину." }, "wallet_address": { "type": "string" }, "chain": { "type": "string", "description": "Канонический идентификатор сети записи адресной книги, для которой предоставлено подтверждение, например ETH, BTC, SOL, TRX." }, "deposit_address": { "type": "string", "nullable": true, "description": "Адрес депозита, на который клиент должен отправить тестовую сумму Сатоши. Присутствует только в подтверждении SATOSHI_TEST." }, "expected_amount": { "type": "string", "nullable": true, "description": "Точная сумма ончейн в нативной валюте депозита, которой должен соответствовать тестовый депозит Satoshi. Присутствует только в доказательстве SATOSHI_TEST." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Крайний срок для окна проверки Satoshi test этого подтверждения. Присутствует только для подтверждения SATOSHI_TEST; собственный expires_at сессии виджета продлевается на этот срок, если предлагается SATOSHI_TEST." }, "challenge": { "type": "string", "nullable": true, "description": "Выпущенное Didit сообщение, которое клиент подписывает своим кошельком. Присутствует только в подтверждении MESSAGE_SIGNING." }, "rejection_reason": { "type": "string", "description": "Причина, по которой подтверждение было отклонено, в виде предложения на английском языке для конечного пользователя. Присутствует, только если `status` равен REJECTED; пусто, если ваш проверяющий отклонил скриншот (ваша заметка остаётся у вас)." }, "created_at": { "type": "string", "format": "date-time" }, "attempts": { "type": "integer", "description": "Сколько раз отправлялись доказательства для этого подтверждения (подписи, ID транзакций, загрузки)." }, "failure_reason": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleWalletProofFailureReason" } ], "description": "Почему последняя попытка не удалась или почему подтверждение было закрыто. Пусто, если сбоев не было." } } }, "CaseSubject": { "type": "object", "nullable": true, "description": "Единственный пользователь или компания, к которым привязан кейс.", "properties": { "type": { "type": "string", "enum": [ "user", "business" ] }, "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "external_id": { "type": "string", "nullable": true, "description": "Значение vendor_data субъекта." }, "country": { "type": "string", "nullable": true, "description": "Трёхбуквенный код страны субъекта (ISO 3166-1 alpha-3) или null, если он неизвестен. Для компании это страна регистрации. Для физического лица это страна выдачи документа, удостоверяющего личность, из его верификаций; для лица с документами из нескольких стран отображается одна из них, также могут встречаться коды документов ICAO, например `XXA`.", "example": "ESP" }, "portrait": { "type": "string", "format": "uri", "nullable": true, "description": "Временный подписанный URL портретного фото лица. Всегда null для компании и null для физического лица без портретного фото. Срок действия URL истекает, поэтому скачивайте изображение при чтении кейса, а не сохраняйте URL." } } }, "CaseAssignee": { "type": "object", "nullable": true, "properties": { "uuid": { "type": "string", "format": "uuid" }, "full_name": { "type": "string" }, "email": { "type": "string", "format": "email" } } }, "CaseBlueprintSummary": { "type": "object", "nullable": true, "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 24 } } }, "CaseContentConfig": { "type": "object", "description": "Шесть переключаемых разделов, которые определяют, какие вкладки и поля отображаются на странице кейса. Неизвестные разделы или ключи отклоняются.", "properties": { "checklist": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "optional": { "type": "boolean", "description": "Если true, кейс можно разрешить с незавершенными пунктами чек-листа." }, "items": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 255 }, "order": { "type": "integer" } } } } } }, "aml_control": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "financial": { "type": "boolean" }, "identity": { "type": "boolean" } } }, "identity": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "personal_information": { "type": "boolean" }, "applicant_tags": { "type": "boolean" }, "contact_information": { "type": "boolean" }, "risk_overview": { "type": "boolean" }, "poi_documents": { "type": "boolean" }, "poa_documents": { "type": "boolean" } } }, "verifications": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "summary": { "type": "boolean" } } }, "reporting": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "fiu_reports": { "type": "boolean" } } }, "financial": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "payment_methods": { "type": "boolean" }, "transactions": { "type": "boolean" } } } } }, "CaseNote": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "comment": { "type": "string" }, "actor_email": { "type": "string", "format": "email", "nullable": true }, "actor_name": { "type": "string", "nullable": true }, "mentioned_emails": { "type": "array", "items": { "type": "string", "format": "email" } }, "is_internal": { "type": "boolean" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "s3_key": { "type": "string" }, "filename": { "type": "string" }, "file_size": { "type": "integer" }, "url": { "type": "string", "format": "uri" } } } }, "tags": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string", "format": "date-time" } } }, "CaseEvent": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "event_type": { "type": "string", "enum": [ "CREATED", "STATUS_CHANGED", "ASSIGNED", "UNASSIGNED", "RESOLVED", "REOPENED", "LINK_ADDED", "LINK_REMOVED", "NOTE_ADDED", "NOTE_PINNED", "NOTE_UNPINNED", "PRIORITY_CHANGED", "DUE_DATE_CHANGED", "TAG_ADDED", "TAG_REMOVED", "ESCALATED", "TRANSFERRED", "CHECKLIST_COMPLETED", "REPORT_CREATED", "REPORT_FINALIZED", "SUBMITTED_FOR_APPROVAL", "APPROVAL_GRANTED", "APPROVAL_REJECTED", "ENTITY_ACTION", "APPROVAL_INVALIDATED", "CUSTOMER_REQUEST", "STAGE_CHANGED", "TEAM_CHANGED", "CHECKER_ASSIGNED", "CHECKER_UNASSIGNED" ] }, "actor_email": { "type": "string", "format": "email", "nullable": true }, "actor_name": { "type": "string", "nullable": true }, "previous_status": { "type": "string", "enum": [ "OPEN", "AWAITING_USER", "RESOLVED" ], "nullable": true }, "new_status": { "type": "string", "enum": [ "OPEN", "AWAITING_USER", "RESOLVED" ], "nullable": true }, "metadata": { "type": "object" }, "created_at": { "type": "string", "format": "date-time" } } }, "CaseLink": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "linked_entity_type": { "type": "string", "enum": [ "session", "business_session", "transaction" ], "nullable": true }, "linked_entity_uuid": { "type": "string", "format": "uuid", "nullable": true }, "linked_entity_summary": { "type": "object", "nullable": true, "description": "session_id/session_number/status для ссылок session и business_session; uuid/txn_id/status для ссылок transaction." }, "created_at": { "type": "string", "format": "date-time" } } }, "CaseChecklistItem": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "label": { "type": "string", "maxLength": 255 }, "is_completed": { "type": "boolean" }, "completed_by": { "type": "string", "format": "email", "nullable": true }, "completed_at": { "type": "string", "format": "date-time", "nullable": true }, "order": { "type": "integer" } } }, "CaseBlueprintListItem": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 24 }, "description": { "type": "string", "nullable": true }, "assignment_method": { "type": "string", "enum": [ "MANUAL", "AUTOMATIC" ] }, "assignee_pool": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "max_active_cases": { "type": "integer", "nullable": true }, "escalation_enabled": { "type": "boolean" }, "transfer_enabled": { "type": "boolean" }, "require_resolution_note": { "type": "boolean" }, "is_active": { "type": "boolean" }, "preset_key": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "version": { "type": "integer", "readOnly": true }, "default_deadline_hours": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 8760 } } }, "CaseBlueprintDetail": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 24 }, "description": { "type": "string", "nullable": true }, "assignment_method": { "type": "string", "enum": [ "MANUAL", "AUTOMATIC" ] }, "assignee_pool": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "max_active_cases": { "type": "integer", "nullable": true }, "escalation_enabled": { "type": "boolean" }, "transfer_enabled": { "type": "boolean" }, "require_resolution_note": { "type": "boolean" }, "is_active": { "type": "boolean" }, "preset_key": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "escalation_blueprint": { "type": "string", "format": "uuid", "nullable": true }, "escalation_blueprint_name": { "type": "string", "nullable": true }, "four_eyes_checker_blueprint": { "type": "string", "format": "uuid", "nullable": true }, "four_eyes_checker_blueprint_name": { "type": "string", "nullable": true }, "content_config": { "type": "object", "description": "Шесть переключаемых разделов, которые определяют, какие вкладки и поля отображаются на странице кейса. Неизвестные разделы или ключи отклоняются.", "properties": { "checklist": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "optional": { "type": "boolean", "description": "Если true, кейс можно разрешить с незавершенными пунктами чек-листа." }, "items": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 255 }, "order": { "type": "integer" } } } } } }, "aml_control": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "financial": { "type": "boolean" }, "identity": { "type": "boolean" } } }, "identity": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "personal_information": { "type": "boolean" }, "applicant_tags": { "type": "boolean" }, "contact_information": { "type": "boolean" }, "risk_overview": { "type": "boolean" }, "poi_documents": { "type": "boolean" }, "poa_documents": { "type": "boolean" } } }, "verifications": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "summary": { "type": "boolean" } } }, "reporting": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "fiu_reports": { "type": "boolean" } } }, "financial": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "payment_methods": { "type": "boolean" }, "transactions": { "type": "boolean" } } } } }, "creation_sources": { "type": "array", "description": "Коннекторы, которые в данный момент направляют новые кейсы в эту схему.", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "aml", "rule", "workflow" ] }, "id": { "type": "string" }, "name": { "type": "string" } } } }, "receives_escalation_from": { "type": "array", "description": "Другие схемы (blueprints), цель эскалации (Escalation) которых указывает на эту схему.", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } }, "updated_at": { "type": "string", "format": "date-time" }, "version": { "type": "integer", "readOnly": true }, "default_deadline_hours": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 8760 } } }, "CaseListItem": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "case_number": { "type": "string", "nullable": true, "description": "Назначается автоматически, например, CS-0001." }, "title": { "type": "string" }, "status": { "type": "string", "enum": [ "OPEN", "AWAITING_USER", "RESOLVED" ] }, "resolution": { "type": "string", "enum": [ "FALSE_POSITIVE", "VALID_THREAT", "INCONCLUSIVE", "REQUIREMENTS_NOT_MET", "REQUIREMENTS_SATISFIED" ], "nullable": true }, "pending_resolution": { "type": "object", "nullable": true, "description": "Устанавливается только тогда, когда решение по принципу четырёх глаз подготовлено в шаблоне проверяющего и ожидает одобрения или отклонения одобрения.", "properties": { "resolution": { "type": "string", "enum": [ "FALSE_POSITIVE", "VALID_THREAT", "INCONCLUSIVE", "REQUIREMENTS_NOT_MET", "REQUIREMENTS_SATISFIED" ] }, "resolution_notes": { "type": "string", "nullable": true }, "maker_email": { "type": "string", "format": "email", "nullable": true, "description": "Электронная почта офицера, отправившего резолюцию. Null, если она отправлена с помощью API-ключа: у такой резолюции нет зафиксированного создателя, поэтому approve и reject-approval возвращают 403 для любого вызывающего." }, "maker_name": { "type": "string", "nullable": true }, "maker_user_id": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID пользователя-участника сотрудника, отправившего решение. null, если запрос отправлен с использованием API-ключа. Этот участник не может быть указан в качестве `checker`." }, "maker_blueprint_id": { "type": "string", "format": "uuid" }, "staged_at": { "type": "string", "format": "date-time" } } }, "checker": { "$ref": "#/components/schemas/CaseChecker" }, "priority": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "source": { "type": "string", "enum": [ "MANUAL", "AML_SCREENING", "TRANSACTION_RULE", "WORKFLOW_BUILDER" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "subject": { "$ref": "#/components/schemas/CaseSubject" }, "assigned_to": { "$ref": "#/components/schemas/CaseAssignee" }, "assigned_at": { "type": "string", "format": "date-time", "nullable": true }, "team": { "$ref": "#/components/schemas/CaseTeamSummary" }, "due_at": { "type": "string", "format": "date-time", "nullable": true }, "resolved_at": { "type": "string", "format": "date-time", "nullable": true }, "created_by_email": { "type": "string", "nullable": true }, "created_by_name": { "type": "string", "nullable": true }, "blueprint": { "$ref": "#/components/schemas/CaseBlueprintSummary" }, "links_count": { "type": "integer" }, "notes_count": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "application_id": { "type": "string", "format": "uuid" }, "application_name": { "type": "string" }, "organization_id": { "type": "string", "format": "uuid" }, "organization_name": { "type": "string" } } }, "CaseDetail": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "case_number": { "type": "string", "nullable": true }, "title": { "type": "string" }, "status": { "type": "string", "enum": [ "OPEN", "AWAITING_USER", "RESOLVED" ] }, "resolution": { "type": "string", "enum": [ "FALSE_POSITIVE", "VALID_THREAT", "INCONCLUSIVE", "REQUIREMENTS_NOT_MET", "REQUIREMENTS_SATISFIED" ], "nullable": true }, "resolution_notes": { "type": "string", "nullable": true }, "priority": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "source": { "type": "string", "enum": [ "MANUAL", "AML_SCREENING", "TRANSACTION_RULE", "WORKFLOW_BUILDER" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "subject": { "$ref": "#/components/schemas/CaseSubject" }, "assigned_to": { "$ref": "#/components/schemas/CaseAssignee" }, "assigned_at": { "type": "string", "format": "date-time", "nullable": true }, "team": { "$ref": "#/components/schemas/CaseTeamSummary" }, "due_at": { "type": "string", "format": "date-time", "nullable": true }, "resolved_at": { "type": "string", "format": "date-time", "nullable": true }, "resolved_by_email": { "type": "string", "nullable": true }, "pending_resolution": { "type": "object", "nullable": true, "description": "Устанавливается только тогда, когда решение по принципу четырёх глаз подготовлено в шаблоне проверяющего и ожидает одобрения или отклонения одобрения.", "properties": { "resolution": { "type": "string", "enum": [ "FALSE_POSITIVE", "VALID_THREAT", "INCONCLUSIVE", "REQUIREMENTS_NOT_MET", "REQUIREMENTS_SATISFIED" ] }, "resolution_notes": { "type": "string", "nullable": true }, "maker_email": { "type": "string", "format": "email", "nullable": true, "description": "Электронная почта офицера, отправившего резолюцию. Null, если она отправлена с помощью API-ключа: у такой резолюции нет зафиксированного создателя, поэтому approve и reject-approval возвращают 403 для любого вызывающего." }, "maker_name": { "type": "string", "nullable": true }, "maker_user_id": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID пользователя-участника сотрудника, отправившего решение. null, если запрос отправлен с использованием API-ключа. Этот участник не может быть указан в качестве `checker`." }, "maker_blueprint_id": { "type": "string", "format": "uuid" }, "staged_at": { "type": "string", "format": "date-time" } } }, "checker": { "$ref": "#/components/schemas/CaseChecker" }, "metadata": { "type": "object" }, "blueprint": { "$ref": "#/components/schemas/CaseBlueprintDetail" }, "notes": { "type": "array", "items": { "$ref": "#/components/schemas/CaseNote" }, "description": "50 самых новых заметок." }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/CaseEvent" }, "description": "100 самых новых событий." }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/CaseLink" } }, "links_count": { "type": "integer" }, "notes_count": { "type": "integer" }, "checklist_items": { "type": "array", "items": { "$ref": "#/components/schemas/CaseChecklistItem" } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "ReportTemplateDetail": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Двухбуквенный код страны ISO 3166-1 alpha-2." }, "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ] }, "report_type_display": { "type": "string" }, "field_config": { "type": "object", "description": "Значения по умолчанию для заголовка goAML многократного использования. Обязательные поля на уровне шаблона: rentity_id, submission_code и currency_code_local (3 буквы). Необязательные: enabled_fields (какие опциональные блоки отчёта включать), а также значения по умолчанию для reporting_person, location, reason и action. Поля заголовка для конкретного отчёта (action, submission_date, transactions, jurisdiction) проверяются при валидации или финализации отчёта, а не в шаблоне." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "RegulatoryReportDetail": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "case_uuid": { "type": "string", "format": "uuid" }, "case_number": { "type": "string", "nullable": true }, "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ] }, "report_type_display": { "type": "string" }, "report_code": { "type": "string", "description": "код отчёта goAML, сформированный на основе report_type, например STR, CTR, BCR." }, "report_number": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "DRAFT", "VALIDATED", "FINALIZED" ] }, "status_display": { "type": "string" }, "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2 }, "rentity_id": { "type": "string", "nullable": true, "description": "Идентификатор отчитывающейся организации, выданный FIU." }, "rentity_branch": { "type": "string", "nullable": true }, "submission_code": { "type": "string", "enum": [ "E", "M" ] }, "entity_reference": { "type": "string", "nullable": true }, "fiu_ref_number": { "type": "string", "nullable": true }, "currency_code_local": { "type": "string", "minLength": 3, "maxLength": 3, "nullable": true }, "submission_date": { "type": "string", "format": "date-time", "nullable": true }, "reporting_person": { "type": "object" }, "location": { "type": "object" }, "reason": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "activity": { "type": "string", "nullable": true }, "narrative": { "type": "object", "description": "Повествовательные разделы «пяти W».", "properties": { "who": { "type": "string" }, "what": { "type": "string" }, "when": { "type": "string" }, "where": { "type": "string" }, "why": { "type": "string" }, "how": { "type": "string" } } }, "report_indicators": { "type": "array", "items": { "type": "string" } }, "included_fields": { "type": "array", "items": { "type": "string" } }, "transactions": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "validation_errors": { "type": "array", "description": "Результат последней валидации; каждый элемент представляет собой объект {field, message}.", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } } } }, "validated_at": { "type": "string", "format": "date-time", "nullable": true }, "finalized_at": { "type": "string", "format": "date-time", "nullable": true }, "created_by_email": { "type": "string", "nullable": true }, "created_by_name": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "TransactionRuleCondition": { "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "Путь к полю транзакции для вычисления. Основные поля: amount, currency, direction, action_type, score, severity, transaction_type, payment_details, preferred_currency_amount (по умолчанию amount_in_default_currency), default_currency_code, subject_country, counterparty_country, subject_vendor_data, counterparty_vendor_data, subject_device_fingerprint, counterparty_device_fingerprint, subject_browser_family, subject_browser_version, subject_platform, subject_accept_language, subject_session_age_ms, subject_ip_country, counterparty_ip_country, subject_ip_address, counterparty_ip_address, subject_payment_method_type, subject_payment_method_country, subject_payment_method_fingerprint, subject_payment_method_account_id (и эквиваленты counterparty_payment_method_*), travel_rule_status, travel_rule_required, travel_rule_obligations_count, counterparty_dd_status (ваше решение по контрагенту Travel Rule: APPROVED, RESTRICTED или BLOCKED; сущность наследует статус своего бренда), counterparty_risk_level (LOW, MEDIUM или HIGH; HIGH, пока по вашему собственному скринингу контрагента выставлен флаг), counterparty_jurisdiction (страна VASP контрагента), counterparty_responsiveness (RESPONSIVE, UNRESPONSIVE или UNKNOWN), subject_days_since_previous_transaction, tags, а также custom_values. для любого ключа, переданного в custom_properties при создании транзакции. Поля с кодами стран принимают ISO-2 или ISO-3; обе стороны нормализуются до ISO-3 перед сравнением." }, "operator": { "type": "string", "enum": [ "eq", "ne", "gt", "gte", "lt", "lte", "in", "not_in", "contains", "not_contains", "contains_any", "regex", "fuzzy_match", "exists", "is_not_empty", "is_not_null", "not_exists", "is_empty", "is_null" ], "description": "Оператор сравнения. in/not_in проверяют принадлежность (значение может быть списком или отдельным скалярным значением). contains/not_contains представляют собой нечувствительные к регистру проверки подстроки для строкового значения. contains_any принимает список строк и срабатывает, если любая из них является нечувствительной к регистру подстрокой значения поля. regex сопоставляет шаблон значения с полем. fuzzy_match сравнивает со строковым значением с требуемым порогом `score` (0-100). gt/gte/lt/lte никогда не срабатывают, если одна из сторон отсутствует. exists/is_not_empty/is_not_null (псевдонимы) и not_exists/is_empty/is_null (псевдонимы) являются проверками наличия, которые игнорируют `value`." }, "value": { "description": "Значение для сравнения. Его формат зависит от оператора и value_type; опустите его для операторов проверки наличия. Для всех остальных операторов требуется значение, отличное от `null` или пустого списка, иначе правило будет отклонено с ошибкой `400`. Для `contains_any` требуется список строк, а для `contains`, `not_contains` и `regex` требуется одна строка." }, "value_type": { "type": "string", "enum": [ "list", "field", "relative_date" ], "description": "Необязательная интерпретация значения. `list`: значение является UUID списка, и элементы списка становятся значением для сравнения. `field`: значение является путём к другому полю, сравниваемое с другим полем. `relative_date`: значение является объектом относительной даты, например {\"direction\": \"past\", \"unit\": \"days\", \"amount\": 30}." }, "score": { "type": "number", "minimum": 0, "maximum": 100, "description": "Обязательно, когда operator имеет значение fuzzy_match: порог сходства от 0 до 100." }, "group_index": { "type": "integer", "description": "Необязательная групповая логика. Если какое-либо условие содержит group_index, условия с одинаковым индексом образуют группу, а групповая оценка заменяет evaluation_mode." }, "group_logic": { "type": "string", "enum": [ "AND", "OR" ], "default": "AND", "description": "Как объединяются условия ВНУТРИ группы." }, "groups_logic": { "type": "string", "enum": [ "AND", "OR" ], "default": "OR", "description": "Как объединяются результаты групп МЕЖДУ группами. Считывается из первого условия." } }, "description": "Условие считывает только оцениваемую транзакцию: оно никогда не фильтрует окно агрегации." }, "TransactionRuleAggregation": { "type": "object", "required": [ "value" ], "properties": { "metric": { "type": "string", "enum": [ "count", "sum", "max", "min", "avg", "distinct_count" ], "default": "count", "description": "Как агрегируются подходящие исторические транзакции. unique_count принимается как псевдоним distinct_count." }, "field": { "type": "string", "default": "amount", "description": "Поле, агрегированное с помощью sum/max/min/avg/distinct_count. Игнорируется для count." }, "operator": { "type": "string", "enum": [ "eq", "ne", "gt", "gte", "lt", "lte" ], "default": "eq", "description": "Сравнение, применяемое к вычисленной метрике." }, "value": { "type": "number", "description": "Порог, с которым сравнивается вычисленная метрика." }, "window": { "type": "string", "pattern": "^\\d+(m|h|d)$", "default": "1d", "description": "Окно ретроспективного анализа, заканчивающееся на txn_date транзакции: m (МИНУТЫ, не месяцы), h (часы) или d (дни), например 30m, 24h, 7d, 30d." }, "filters": { "type": "object", "additionalProperties": true, "description": "Ограничивает круг исторических транзакций для агрегации. Ключи представляют собой пути к полям из каталога полей условий; значение \"__current__\" разрешается в значение того же поля оцениваемой транзакции (например, {\"subject_vendor_data\": \"__current__\"} ограничивает окно тем же субъектом), а значение в виде списка означает принадлежность к множеству. Записи без группируемого значения никогда не объединяются в одну группу: если в оцениваемой транзакции нет значения для поля \"__current__\" (нет контрагента, нет цифрового отпечатка устройства), агрегация не срабатывает независимо от её оператора. Фильтры сравнивают ТОЛЬКО по равенству или принадлежности к множеству: фильтров lt/gte нет, поэтому диапазон вроде «исторические транзакции менее 10 000» здесь выразить нельзя. Задайте диапазон в метрике (метрика max с оператором lt оставляет в окне только транзакции ниже порога)." } }, "description": "Проверка скорости операций (velocity check) по историческим транзакциям приложения в пределах окна. Каждая запись агрегации должна совпадать для срабатывания правила, независимо от evaluation_mode. Агрегация ограничивает только окно; оцениваемая транзакция ограничивается областью (scope) и условиями, поэтому дублируйте direction, currency или transaction_type в обеих частях, когда правило их предусматривает." }, "TransactionRuleScope": { "type": "object", "properties": { "transaction_types": { "type": "array", "items": { "type": "string" }, "description": "Ограничить типами транзакций, например finance, kyc, travel_rule, user_event. Пустое или отсутствующее значение = без ограничений." }, "directions": { "type": "array", "items": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ] }, "description": "Ограничить направлениями транзакций (нечувствительно к регистру при записи)." }, "action_types": { "type": "array", "items": { "type": "string" }, "description": "Ограничить вашими значениями action_type, например withdrawal, deposit." } }, "description": "К каким транзакциям применяется правило. Принимаются только эти три ключа." }, "TransactionRuleAction": { "oneOf": [ { "$ref": "#/components/schemas/TransactionRuleActionAddScore" }, { "$ref": "#/components/schemas/TransactionRuleActionChangeStatus" }, { "$ref": "#/components/schemas/TransactionRuleActionAddTags" }, { "$ref": "#/components/schemas/TransactionRuleActionAddNote" }, { "$ref": "#/components/schemas/TransactionRuleActionAddToList" }, { "$ref": "#/components/schemas/TransactionRuleActionOpenCase" } ], "discriminator": { "propertyName": "type", "mapping": { "add_score": "#/components/schemas/TransactionRuleActionAddScore", "change_status": "#/components/schemas/TransactionRuleActionChangeStatus", "add_tags": "#/components/schemas/TransactionRuleActionAddTags", "add_note": "#/components/schemas/TransactionRuleActionAddNote", "add_to_list": "#/components/schemas/TransactionRuleActionAddToList", "open_case": "#/components/schemas/TransactionRuleActionOpenCase" } }, "description": "Одно действие правила. Правило может содержать несколько действий; все они применяются одновременно при срабатывании правила. Правила в режиме TEST фиксируют, что они бы сделали, не применяя ни одного действия." }, "TransactionRuleCreateRequest": { "type": "object", "required": [ "title", "category", "mode" ], "properties": { "title": { "type": "string", "description": "Название правила. Уникально для приложения среди неудалённых правил; дубликаты возвращают 400." }, "description": { "type": "string", "nullable": true }, "category": { "type": "string", "description": "Тематика риска, используемая для группировки и отчётов, например finance, aml_ctf, anomaly_detection, fatf, device_intelligence, crypto_monitoring, travel_rule, responsible_gaming, e_commerce." }, "mode": { "type": "string", "enum": [ "ACTIVE", "DISABLED", "TEST" ], "description": "ACTIVE оценивает в реальном времени. TEST оценивает и записывает запуски правил, но никогда не влияет на оценку или статус - рекомендуемый режим для начала работы. DISABLED пропускается." }, "evaluation_mode": { "type": "string", "enum": [ "ALL", "ANY" ], "default": "ALL", "description": "Должны ли совпадать все условия (ALL) или хотя бы одно (ANY). Игнорируется, если в условиях используется group_index." }, "scope": { "$ref": "#/components/schemas/TransactionRuleScope" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleCondition" } }, "aggregation": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleAggregation" } }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleAction" } }, "metadata": { "type": "object", "description": "Метаданные в свободной форме, сохранённые в правиле." } }, "description": "Создаёт правило типа CUSTOM. Правила в режиме ACTIVE вступают в силу немедленно для новых транзакций: создавайте их в режиме TEST и сначала проводите бэктестинг." }, "TransactionRuleUpdateRequest": { "type": "object", "properties": { "title": { "type": "string", "description": "Название правила. Уникально для приложения среди неудалённых правил; дубликаты возвращают 400." }, "description": { "type": "string", "nullable": true }, "category": { "type": "string", "description": "Тематика риска, используемая для группировки и отчётов, например finance, aml_ctf, anomaly_detection, fatf, device_intelligence, crypto_monitoring, travel_rule, responsible_gaming, e_commerce." }, "mode": { "type": "string", "enum": [ "ACTIVE", "DISABLED", "TEST" ], "description": "ACTIVE оценивает в реальном времени. TEST оценивает и записывает запуски правил, но никогда не влияет на оценку или статус - рекомендуемый режим для начала работы. DISABLED пропускается." }, "evaluation_mode": { "type": "string", "enum": [ "ALL", "ANY" ], "default": "ALL", "description": "Должны ли совпадать все условия (ALL) или хотя бы одно (ANY). Игнорируется, если в условиях используется group_index." }, "scope": { "$ref": "#/components/schemas/TransactionRuleScope" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleCondition" } }, "aggregation": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleAggregation" } }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleAction" } }, "metadata": { "type": "object", "description": "Метаданные в свободной форме, сохранённые в правиле." } }, "description": "Частичное обновление. Пользовательские правила принимают любые поля; правила из библиотеки (PRESET) принимают только mode - любые другие параметры возвращают 400." }, "TransactionRuleDetail": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "title": { "type": "string", "description": "Название правила. Уникально для приложения среди неудалённых правил; дубликаты возвращают 400." }, "description": { "type": "string", "nullable": true }, "category": { "type": "string", "description": "Тематика риска, используемая для группировки и отчётов, например finance, aml_ctf, anomaly_detection, fatf, device_intelligence, crypto_monitoring, travel_rule, responsible_gaming, e_commerce." }, "mode": { "type": "string", "enum": [ "ACTIVE", "DISABLED", "TEST" ], "description": "ACTIVE оценивает в реальном времени. TEST оценивает и записывает запуски правил, но никогда не влияет на оценку или статус - рекомендуемый режим для начала работы. DISABLED пропускается." }, "evaluation_mode": { "type": "string", "enum": [ "ALL", "ANY" ], "default": "ALL", "description": "Должны ли совпадать все условия (ALL) или хотя бы одно (ANY). Игнорируется, если в условиях используется group_index." }, "scope": { "$ref": "#/components/schemas/TransactionRuleScope" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleCondition" } }, "aggregation": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleAggregation" } }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleAction" } }, "metadata": { "type": "object", "description": "Метаданные в свободной форме, сохранённые в правиле." }, "severity": { "type": "string", "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "nullable": true, "description": "Информационный уровень серьёзности, присваиваемый библиотечными правилами; недоступен для настройки в пользовательских правилах." }, "source": { "type": "string", "enum": [ "PRESET", "CUSTOM" ], "description": "Правила PRESET берутся из библиотеки (установка/удаление, редактирование только режима); правила CUSTOM полностью настраиваются вами." }, "library_key": { "type": "string", "nullable": true, "description": "Постоянный идентификатор библиотеки; null для пользовательских правил." }, "latest_triggered_at": { "type": "string", "format": "date-time", "nullable": true }, "run_count": { "type": "integer", "description": "Количество транзакций, подошедших под это правило." }, "approved_count": { "type": "integer" }, "reviewed_count": { "type": "integer" }, "declined_count": { "type": "integer" }, "awaiting_user_count": { "type": "integer" }, "approved_pct": { "type": "number" }, "reviewed_pct": { "type": "number" }, "declined_pct": { "type": "number" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "TransactionRuleBacktestRequest": { "type": "object", "properties": { "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleCondition" }, "default": [] }, "aggregation": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleAggregation" }, "default": [] }, "evaluation_mode": { "type": "string", "enum": [ "ALL", "ANY" ], "default": "ALL" }, "scope": { "$ref": "#/components/schemas/TransactionRuleScope" }, "period_days": { "type": "integer", "minimum": 1, "maximum": 365, "default": 90 } }, "description": "Гипотетическая конфигурация правила для оценки по недавним транзакциям. Только для чтения и бесплатно: ничего не создается и не изменяется. Передайте те же conditions, aggregation, evaluation_mode И scope, что и для правила, которое вы намерены активировать. Пропущенные conditions, aggregation и scope не добавляют собственных ограничений; удаление scope может включить направления или типы транзакций, которые сохраненное правило пропускает. Пропущенный evaluation_mode по умолчанию равен ALL (что может уменьшить количество совпадений для правила со значением ANY), а пропущенный period_days по умолчанию равен 90 дням, а не неограниченной истории." }, "TransactionRuleBacktestResult": { "type": "object", "properties": { "evaluated": { "type": "integer", "description": "Оценённые транзакции (сначала самые недавние, с ограничением по количеству)." }, "matched": { "type": "integer", "description": "Транзакции, которым соответствовала бы конфигурация." }, "affected_entities": { "type": "integer", "description": "Уникальные субъекты (по vendor_data) среди совпадений." }, "period_days": { "type": "integer" } } }, "TransactionRuleLibraryEntry": { "type": "object", "properties": { "library_key": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "category": { "type": "string" }, "evaluation_mode": { "type": "string", "enum": [ "ALL", "ANY" ] }, "scope": { "$ref": "#/components/schemas/TransactionRuleScope" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleCondition" } }, "aggregation": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleAggregation" } }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleAction" } }, "metadata": { "type": "object" }, "bundle": { "type": "string", "nullable": true, "description": "Функциональное семейство, например finance, aml_ctf, crypto_monitoring, travel_rule, responsible_gaming." }, "tags": { "type": "array", "items": { "type": "string" } }, "industries": { "type": "array", "items": { "type": "string" } }, "source": { "type": "string" }, "is_installed": { "type": "boolean", "description": "Установлен ли этот пресет в приложении в данный момент." } } }, "TransactionRuleInstallRequest": { "type": "object", "properties": { "library_keys": { "type": "array", "items": { "type": "string" }, "description": "Конкретные пресеты для установки или удаления." }, "bundle": { "type": "string", "description": "Вместо этого установить или удалить все пресеты из этого набора." } }, "description": "Укажите library_keys ИЛИ bundle." }, "TransactionRuleInstallResult": { "type": "object", "properties": { "installed_library_keys": { "type": "array", "items": { "type": "string" }, "description": "Только POST (установка): пресеты, установленные этим вызовом." }, "installed_count": { "type": "integer", "description": "Только POST (установка)." }, "uninstalled_count": { "type": "integer", "description": "Только для DELETE (удаление): пресеты, удалённые этим вызовом." } } }, "WalletScreeningResult": { "type": "object", "properties": { "provider": { "type": "string", "description": "Провайдер, выполнивший скрининг (например, `merklescience`, `crystal`)." }, "screening_type": { "type": "string", "enum": [ "WALLET_SCREENING" ], "description": "Всегда `WALLET_SCREENING` для этого endpoint." }, "risk_score": { "type": "integer", "description": "Нормализованная оценка риска от 0 до 100. Чем выше значение, тем выше подверженность взаимодействию с рискованными сущностями. Merkle Science оценивает адрес от 0 до 5, что соответствует значениям 0, 15, 35, 55, 75 или 95." }, "severity": { "type": "string", "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "description": "Категория риска, рассчитываемая на основе `risk_score`: `0-9` UNKNOWN, `10-39` LOW, `40-69` MEDIUM, `70-89` HIGH, `90-100` CRITICAL. `UNKNOWN` представляет собой самый низкий диапазон, а не отдельный статус отсутствия данных: `risk_score` 0 (типичный случай чистого адреса) означает отсутствие негативной оценки, тогда как ненулевая оценка в диапазоне 1-9 является реальным сигналом ниже уровня LOW; оценивайте `risk_score`, а не только диапазон. Никогда не трактуйте `UNKNOWN` как подтверждённый низкий риск или статус «чисто»; не отображайте его как успешное прохождение." }, "status": { "type": "string", "enum": [ "SCREENED", "PENDING", "ERROR" ], "description": "Статус результата скрининга." }, "summary": { "type": "string", "description": "Понятная человеку сводка результатов скрининга." }, "wallet_address": { "type": "string", "description": "Проверенный адрес, возвращённый в ответе." }, "transaction_hash": { "type": "string", "nullable": true, "description": "Поле скрининга транзакций, общее со структурой результата. Всегда `null` в результатах скрининга кошельков." }, "blockchain": { "type": "string", "description": "Блокчейн, по которому проводился скрининг." }, "block_timestamp": { "type": "string", "nullable": true, "description": "Поле скрининга транзакций, общее со структурой результата. Всегда `null` в результатах скрининга кошельков." }, "total_value_usd": { "type": "number", "nullable": true, "description": "Поле скрининга транзакций, общее со структурой результата. Всегда `null` в результатах скрининга кошельков." }, "fee_usd": { "type": "number", "nullable": true, "description": "Поле скрининга транзакций, общее со структурой результата. Всегда `null` в результатах скрининга кошельков." }, "sender_rows": { "type": "array", "items": { "type": "object" }, "description": "Поле скрининга транзакций, общее со структурой результата. Всегда пустое в результатах скрининга кошельков." }, "receiver_rows": { "type": "array", "items": { "type": "object" }, "description": "Поле скрининга транзакций, общее со структурой результата. Всегда пустое в результатах скрининга кошельков." }, "transaction_flows": { "type": "array", "items": { "type": "object" }, "description": "Поле скрининга транзакций, общее со структурой результата. Всегда пустое в результатах скрининга кошельков." }, "transaction_flows_status": { "type": "string", "nullable": true, "description": "Поле скрининга транзакций, общее со структурой результата. Всегда `null` в результатах скрининга кошельков." }, "transaction_flows_error": { "type": "string", "nullable": true, "description": "Поле скрининга транзакций, общее со структурой результата. Всегда `null` в результатах скрининга кошельков." }, "source_of_funds": { "type": "array", "description": "Откуда адрес получал средства с атрибуцией по сущностям. Каждая запись представляет собой детализацию экспозиции.", "items": { "type": "object", "properties": { "category": { "type": "string", "description": "Нормализованная категория риска, например `exchange_licensed`, `dex`, `defi`, `payment_processor`, `mixer`, `darknet_market`, `sanctioned`, `stolen_funds`, `high_risk_exchange`." }, "percentage": { "type": "number", "description": "Доля от общей экспозиции в данном направлении, 0-100." }, "amount_usd": { "type": "number", "nullable": true, "description": "Сумма в USD, приписанная этому субъекту." }, "entity_name": { "type": "string", "nullable": true, "description": "Название атрибутированной сущности, например биржи, миксера или подсанкционной группы." }, "entity_type": { "type": "string", "nullable": true, "description": "Тип сущности провайдера (например, `Exchange`, `DeFi`, `Sanctions`, `Theft`)." }, "entity_subtype": { "type": "string", "nullable": true, "description": "Более детализированный подтип (например, `Mandatory KYC and AML`, `OFAC`, `Yield Aggregator`)." }, "hops": { "type": "integer", "nullable": true, "description": "Количество переходов до сущности (1 для прямого контрагента), если провайдер его возвращает. Всегда `null` для Merkle Science, который сообщает только о том, является ли экспозиция прямой или косвенной: используйте `exposure_type`." }, "description": { "type": "string", "nullable": true, "description": "`entity_type / entity_subtype`, как сущность помечена провайдером." }, "is_direct": { "type": "boolean", "description": "True, когда `exposure_type` имеет значение `direct`." }, "exposure_direction": { "type": "string", "enum": [ "incoming", "outgoing", "connected" ], "description": "Поступили ли средства от этой сущности (`incoming`) или были отправлены этой сущности (`outgoing`)." }, "exposure_type": { "type": "string", "enum": [ "direct", "indirect" ], "description": "`direct` (1 переход) или `indirect` (несколько переходов) экспозиция." }, "provider_entity_id": { "type": "string", "nullable": true, "description": "Собственный идентификатор провайдера для сущности." }, "provider_entity_type_id": { "type": "string", "nullable": true, "description": "Собственный идентификатор провайдера для `entity_type`." }, "provider_entity_subtype_id": { "type": "string", "nullable": true, "description": "Собственный идентификатор провайдера для `entity_subtype`." }, "country": { "type": "string", "nullable": true, "description": "Основная страна субъекта в формате ISO 3166-1 alpha-2. Пусто или `null`, если поставщик её не знает." }, "raw_amount": { "type": "number", "nullable": true, "description": "Сумма в собственной единице измерения актива, когда поставщик сообщает её." }, "raw_currency": { "type": "string", "nullable": true, "description": "Единица измерения `raw_amount`, если провайдер сообщает её." } } } }, "destination_of_funds": { "type": "array", "description": "Куда адрес отправлял средства, с атрибуцией по сущностям. Та же структура элементов, что и у `source_of_funds`, с `exposure_direction` = `outgoing`.", "items": { "type": "object", "properties": { "category": { "type": "string", "description": "Нормализованная категория риска, например `exchange_licensed`, `dex`, `defi`, `payment_processor`, `mixer`, `darknet_market`, `sanctioned`, `stolen_funds`, `high_risk_exchange`." }, "percentage": { "type": "number", "description": "Доля от общей экспозиции в данном направлении, 0-100." }, "amount_usd": { "type": "number", "nullable": true, "description": "Сумма в USD, приписанная этому субъекту." }, "entity_name": { "type": "string", "nullable": true, "description": "Название атрибутированной сущности, например биржи, миксера или подсанкционной группы." }, "entity_type": { "type": "string", "nullable": true, "description": "Тип сущности провайдера (например, `Exchange`, `DeFi`, `Sanctions`, `Theft`)." }, "entity_subtype": { "type": "string", "nullable": true, "description": "Более детализированный подтип (например, `Mandatory KYC and AML`, `OFAC`, `Yield Aggregator`)." }, "hops": { "type": "integer", "nullable": true, "description": "Количество переходов до сущности (1 для прямого контрагента), если провайдер его возвращает. Всегда `null` для Merkle Science, который сообщает только о том, является ли экспозиция прямой или косвенной: используйте `exposure_type`." }, "description": { "type": "string", "nullable": true, "description": "`entity_type / entity_subtype`, как сущность помечена провайдером." }, "is_direct": { "type": "boolean", "description": "True, когда `exposure_type` имеет значение `direct`." }, "exposure_direction": { "type": "string", "enum": [ "incoming", "outgoing", "connected" ], "description": "Поступили ли средства от этой сущности (`incoming`) или были отправлены этой сущности (`outgoing`)." }, "exposure_type": { "type": "string", "enum": [ "direct", "indirect" ], "description": "`direct` (1 переход) или `indirect` (несколько переходов) экспозиция." }, "provider_entity_id": { "type": "string", "nullable": true, "description": "Собственный идентификатор провайдера для сущности." }, "provider_entity_type_id": { "type": "string", "nullable": true, "description": "Собственный идентификатор провайдера для `entity_type`." }, "provider_entity_subtype_id": { "type": "string", "nullable": true, "description": "Собственный идентификатор провайдера для `entity_subtype`." }, "country": { "type": "string", "nullable": true, "description": "Основная страна субъекта в формате ISO 3166-1 alpha-2. Пусто или `null`, если поставщик её не знает." }, "raw_amount": { "type": "number", "nullable": true, "description": "Сумма в собственной единице измерения актива, когда поставщик сообщает её." }, "raw_currency": { "type": "string", "nullable": true, "description": "Единица измерения `raw_amount`, если провайдер сообщает её." } } } }, "counterparty_connections": { "type": "array", "description": "Сущности, которым провайдер приписывает проверяемый адрес. Для Merkle Science они берутся из собственных тегов владельца и пользователя адреса, поэтому одна и та же сущность может появляться дважды, и они не содержат потоков средств: поля `received_usd`, `sent_usd`, `received_hops` и `sent_hops` имеют значение `null`, а `percentage` равен 0. Не принимайте решений на основе `risk_level` или `is_direct` здесь: используйте `sanctions_hit`, `dominant_risk_category` и `risk_factors[].is_high_risk` для итогового решения, а `exposure_type` в `source_of_funds`/`destination_of_funds` для определения прямого характера транзакции.", "items": { "type": "object", "properties": { "entity_name": { "type": "string", "nullable": true, "description": "Название связанной сущности." }, "entity_type": { "type": "string", "nullable": true, "description": "Тип сущности провайдера." }, "entity_subtype": { "type": "string", "nullable": true, "description": "Подтип сущности провайдера." }, "risk_level": { "type": "string", "description": "В нижнем регистре и зависит от провайдера. Для Merkle Science это собственная степень риска адреса от 0 до 5 (`no_risk`, `low`, `medium_low`, `medium`, `high`, `critical`), повышаемая до `high`, если категория сущности относится к высокому риску; это не отдельная оценка самой сущности." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Нормализованные категории риска сущности." }, "received_usd": { "type": "number", "nullable": true, "description": "Сумма в USD, полученная от субъекта, если провайдер сообщает эти данные." }, "sent_usd": { "type": "number", "nullable": true, "description": "Сумма в USD, отправленная субъекту, если провайдер сообщает эти данные." }, "received_hops": { "type": "integer", "nullable": true, "description": "Количество переходов (hops) до сущности на стороне получателя, если провайдер передаёт эти данные." }, "sent_hops": { "type": "integer", "nullable": true, "description": "Количество переходов (hops) до сущности на стороне отправителя, если провайдер передаёт эти данные." }, "percentage": { "type": "number", "description": "Доля экспозиции адреса, если поставщик сообщает это значение; в противном случае 0." }, "is_direct": { "type": "boolean", "description": "Всегда `true` для Merkle Science, чьи связи являются атрибуциями, а не контрагентами." }, "country": { "type": "string", "nullable": true, "description": "Страна юридического лица, если известна." }, "provider_entity_id": { "type": "string", "nullable": true, "description": "Собственный идентификатор провайдера для сущности." } } } }, "network_nodes": { "type": "array", "items": { "type": "object" }, "description": "Узлы графа экспозиции для скрининга транзакций. Пусто для результата скрининга кошелька." }, "network_edges": { "type": "array", "items": { "type": "object" }, "description": "Рёбра графа экспозиции для скрининга транзакций. Пусто для результата скрининга кошелька." }, "sanctions_hit": { "type": "boolean", "description": "True, если адрес подвержен прямому или косвенному санкционному воздействию." }, "pep_counterparty": { "type": "boolean", "description": "Статус политически значимого лица (PEP). `null`, если данных о PEP нет (что относится ко всем текущим результатам, так как ни один провайдер их не возвращает); `false` только при явном отрицательном результате скрининга. Не интерпретируйте `null` как завершённую проверку PEP.", "nullable": true }, "dominant_risk_category": { "type": "string", "nullable": true, "description": "Категория высокого риска с наибольшим весом или `null`, если ни одна не доминирует (например, `sanctioned`, `mixer`, `stolen_funds`)." }, "risk_factors": { "type": "array", "description": "Ранжированное объяснение `risk_score`: что привело к этому вердикту. Провайдеры оценивают адрес по собственной модели и возвращают только вердикт (Merkle Science возвращает целое число 0-5), поэтому сама по себе оценка не дает практического понимания. Отсортировано: сначала с высоким риском, затем по значению, прошедшему через каждый драйвер, и ограничено пятью наиболее значимыми; `source_of_funds` и `destination_of_funds` всегда содержат полную детализацию. Высокий `risk_score` без записей с флагом `is_high_risk` означает, что провайдер не обнаружил совпадений по санкциям или атрибутированным сущностям и оценил адрес исключительно на основе своей собственной модели подверженности риску, и `summary` указывает на это явно.", "items": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "attribution", "exposure" ], "description": "`attribution` показывает, чем, по данным провайдера, является сам адрес (его собственный тег или кластер); `exposure` показывает, куда фактически переместились его средства." }, "category": { "type": "string", "description": "Нормализованная категория риска, тот же словарь, что и в детализации подверженности рискам." }, "label": { "type": "string", "description": "Собственная формулировка фактора от провайдера (например, `Gambling / Crypto only`), которую вы также увидите в панели управления провайдера." }, "entity_name": { "type": "string", "nullable": true, "description": "Связанная с драйвером сущность, например игорный сайт или биржа." }, "direction": { "type": "string", "enum": [ "incoming", "outgoing", "connected", "unknown", "attribution" ], "description": "Направление движения средств, `attribution`, если триггером является собственный тег адреса, или `unknown`, если провайдер не сообщил направление." }, "exposure_type": { "type": "string", "enum": [ "direct", "indirect", "unknown", "attribution" ], "description": "`direct` (1 переход) или `indirect` (несколько переходов), `attribution` для собственного тега адреса или `unknown`, когда провайдер не указал, на скольких переходах находится контрагент. Считайте `unknown` неклассифицированным, а не `direct`." }, "amount_usd": { "type": "number", "format": "float", "nullable": true, "description": "Сумма в USD, относящаяся к этому драйверу." }, "percentage": { "type": "number", "format": "float", "description": "Доля от ОБЩЕГО проверенного объёма адреса в обоих направлениях суммарно, в отличие от `percentage` внутри `source_of_funds`/`destination_of_funds`, который нормализуется по каждому направлению отдельно. Сопоставима и суммируема по всему списку." }, "is_high_risk": { "type": "boolean", "description": "Относится ли категория к тем, которые Didit считает высокорисковыми (`sanctioned`, `mixer`, `stolen_funds`, `ransomware`, `scam`, `darknet_market`, `terrorist_financing`, `child_exploitation`, `hacked_exchange`, `high_risk_exchange`, `seized_funds`)." }, "description": { "type": "string", "description": "Однострочное представление фактора, например: `9.01% indirect outgoing exposure to Gambling / Crypto only (Example Gambling)`." } } } }, "raw_response": { "type": "object", "additionalProperties": true, "description": "Собственный payload провайдера. Его формат зависит от провайдера и может изменяться без предупреждения: считывайте нормализованные поля вместо его парсинга." }, "report_signature": { "type": "string", "description": "Непрозрачная подпись HMAC-SHA256 для этого точного результата, ограниченная областью вашего приложения. Сама по себе не имеет значения — отправьте повторно полное тело ответа без изменений и включая это поле в `POST /v3/wallet-screening/pdf/`, чтобы сгенерировать его в виде PDF. Endpoint для PDF отклоняет запрос с ошибкой `400`, если `report_signature` отсутствует или если какое-либо подписанное поле (например, `risk_score`, `severity`, `sanctions_hit`) было изменено перед повторной отправкой." } }, "required": [ "provider", "screening_type", "risk_score", "severity", "status", "summary", "wallet_address", "blockchain", "sanctions_hit", "dominant_risk_category", "source_of_funds", "destination_of_funds", "counterparty_connections", "report_signature" ] }, "NetworkRiskDisplay": { "type": "object", "properties": { "score": { "type": "integer", "description": "Оценка риска, 0-100." }, "band": { "type": "string", "enum": [ "low", "medium", "high" ], "description": "Диапазон, в котором отображается оценка. high >= 70, medium >= 40, иначе low." }, "bar": { "type": "number", "format": "float", "description": "Нормализованное значение от 0 до 1 для отображения шкалы риска." } } }, "NetworkNodeTag": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string", "nullable": true, "description": "Null для guard-тегов, токеном цвета которых управляет рендерер." }, "source": { "type": "string", "enum": [ "subject_tag", "session_tag", "transaction_tag", "signal_guard" ], "description": "Источник тега: тег пользователя/компании, тег сессии в этой сети, тег транзакции, к которой относится сторона, или условие защитного сигнала (например, узел, IP-адрес дата-центра)." }, "category": { "type": "string", "enum": [ "customer", "quality" ], "nullable": true, "description": "customer для тегов, определённых клиентом, quality для тегов контроля качества сигналов. Null, если неприменимо." } } }, "NetworkListItem": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "network_id": { "type": "string", "description": "Понятный человеку порядковый идентификатор в рамках организации, например N-0001." }, "name": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "active", "in_review", "resolved", "dismissed" ], "description": "Статус жизненного цикла сети. Отличается от outcome_status по заявителям внутри сети (approved/in_review/declined/not_completed)." }, "risk": { "$ref": "#/components/schemas/NetworkRiskDisplay" }, "pattern_types": { "type": "array", "items": { "type": "string", "enum": [ "exact_same_device", "similar_device", "same_ip_address", "same_address", "similar_selfie_backgrounds", "similar_poa_documents", "same_document_number", "same_phone_number", "same_email" ] }, "description": "Паттерны кластеризации, обнаруженные в этой сети." }, "signal_types": { "type": "array", "items": { "type": "string", "enum": [ "ip_address", "device", "face", "document_number", "phone", "email", "address" ] }, "description": "Уникальные типы сигналов, присутствующие в этой сети." }, "member_counts": { "type": "object", "description": "Количество участников по категориям (например, всего, по outcome_status)." }, "member_status": { "type": "object", "description": "Разбивка участников по outcome_status." }, "signal_coverage": { "type": "object", "description": "Охват участников этой сети по signal_type." }, "first_activity_at": { "type": "string", "format": "date-time", "nullable": true }, "last_activity_at": { "type": "string", "format": "date-time", "nullable": true } } }, "NetworkDetail": { "allOf": [ { "$ref": "#/components/schemas/NetworkListItem" }, { "type": "object", "properties": { "stats": { "type": "object", "description": "Агрегированная статистика по сети (например, общее количество участников)." }, "fraud_tags": { "type": "array", "items": { "type": "object" }, "description": "Теги паттернов мошенничества, выявленные в сети." }, "risk_signals": { "type": "object", "description": "Сводка сигналов риска: residential_proxy_reuse, email_intelligence, phone_intelligence." }, "reviewed_at": { "type": "string", "format": "date-time", "nullable": true }, "reviewed_by": { "type": "string", "nullable": true }, "review_reason": { "type": "string", "nullable": true } } } ], "properties": { "notes_count": { "type": "integer", "minimum": 0, "readOnly": true, "description": "Количество приватных заметок аналитика в этом расследовании." } } }, "NetworkGraphNode": { "type": "object", "description": "Узел субъекта или узел сигнала, различаемые по типу (kind). Узлы субъектов (kind: vendor_user | vendor_business | transaction_party) содержат id, kind, subject, node_status (approved | in_review | declined | not_completed) и tags. Узлы сигналов (kind: signal) содержат id, kind, uuid, signal_type, subject_count, coverage, is_hub, is_datacenter_ip, is_high_collision_device, node_status (signal_active | signal_guarded), tags, risk_evidence, first_seen_at и last_seen_at.", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "vendor_user", "vendor_business", "transaction_party", "signal" ] } } }, "NetworkGraphEdge": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "source": { "type": "string", "description": "ID узла субъекта." }, "target": { "type": "string", "description": "ID узла сигнала." }, "subject_kind": { "type": "string", "enum": [ "vendor_user", "vendor_business", "transaction_party" ] }, "signal_type": { "type": "string", "enum": [ "ip_address", "device", "face", "document_number", "phone", "email", "address" ] }, "confidence": { "type": "number", "format": "float", "description": "1.0 для точного совпадения." }, "observation_count": { "type": "integer" }, "first_seen_at": { "type": "string", "format": "date-time", "nullable": true }, "last_seen_at": { "type": "string", "format": "date-time", "nullable": true } } }, "NetworkGraph": { "type": "object", "properties": { "network": { "$ref": "#/components/schemas/NetworkDetail" }, "depth": { "type": "integer", "nullable": true, "description": "Фактическая применённая глубина или null, если глубина не ограничена (depth=all)." }, "truncated": { "type": "boolean", "description": "True, если окружение было ограничено по глубине." }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkGraphNode" } }, "edges": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkGraphEdge" } }, "metrics": { "type": "object", "properties": { "node_count": { "type": "integer" }, "edge_count": { "type": "integer" }, "hub_signal_count": { "type": "integer" } } } } }, "NetworkMember": { "type": "object", "properties": { "subject": { "type": "object", "description": "vendor_user, vendor_business или transaction_party, которых представляет этот участник." }, "outcome_status": { "type": "string", "description": "Результат верификации/решения по субъекту." }, "node_status": { "type": "string", "enum": [ "approved", "in_review", "declined", "not_completed", "signal_active", "signal_guarded" ], "description": "Для строки участника это всегда одно из значений результата проверки субъекта: approved, in_review, declined или not_completed." }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkNodeTag" } }, "risk": { "$ref": "#/components/schemas/NetworkRiskDisplay" }, "signal_coverage": { "type": "object" }, "shared_infrastructure": { "type": "object" }, "joined_at": { "type": "string", "format": "date-time", "nullable": true }, "last_seen_at": { "type": "string", "format": "date-time", "nullable": true }, "provenance": { "type": "object", "properties": { "session_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "business_session_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "transaction_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } }, "NetworkSignal": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "signal_type": { "type": "string", "enum": [ "ip_address", "device", "face", "document_number", "phone", "email", "address" ] }, "subject_count": { "type": "integer" }, "coverage": { "type": "number", "format": "float" }, "is_hub": { "type": "boolean", "description": "Имеет значение true, если этот сигнал связывает необычно большое количество субъектов." }, "is_datacenter_ip": { "type": "boolean" }, "is_high_collision_device": { "type": "boolean" }, "node_status": { "type": "string", "enum": [ "signal_active", "signal_guarded" ] }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkNodeTag" } }, "risk_evidence": { "type": "object" }, "first_seen_at": { "type": "string", "format": "date-time", "nullable": true }, "last_seen_at": { "type": "string", "format": "date-time", "nullable": true } } }, "NetworkTimelineEvent": { "type": "object", "properties": { "event_type": { "type": "string", "description": "например, network_detected, signal_observed, network_in_review, network_resolved, network_dismissed." }, "occurred_at": { "type": "string", "format": "date-time", "nullable": true }, "label": { "type": "string" }, "metadata": { "type": "object" } } }, "NetworkMap": { "type": "object", "properties": { "network": { "$ref": "#/components/schemas/NetworkDetail" }, "convergence_count": { "type": "integer", "description": "Количество различных адресов или точек местоположения, в которых сходятся участники." }, "countries": { "type": "array", "items": { "type": "string" } }, "points": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "country": { "type": "string", "nullable": true }, "country_code": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "latitude": { "type": "number", "format": "float", "nullable": true }, "longitude": { "type": "number", "format": "float", "nullable": true }, "observed_at": { "type": "string", "format": "date-time", "nullable": true } } } } } }, "EntityNetworkMembership": { "type": "object", "properties": { "network": { "$ref": "#/components/schemas/NetworkListItem" }, "subject": { "type": "object" }, "signal_types": { "type": "array", "items": { "type": "string", "enum": [ "ip_address", "device", "face", "document_number", "phone", "email", "address" ] } }, "signal_count": { "type": "integer" }, "joined_at": { "type": "string", "format": "date-time", "nullable": true }, "last_seen_at": { "type": "string", "format": "date-time", "nullable": true } } }, "RiskSignals": { "type": "object", "description": "Необязательный контекст устройства и сети, зафиксированный вашим приложением. Все поля необязательны. Их передача обеспечивает обнаружение межсессионных совпадений в Networks.", "properties": { "ip": { "type": "string", "format": "ip", "description": "Адрес IPv4 или IPv6, зафиксированный для конечного пользователя.", "example": "192.0.2.1" }, "device_id": { "type": "string", "maxLength": 255, "description": "Постоянный идентификатор устройства, собранный вашим приложением (Android `ANDROID_ID`, iOS `identifierForVendor`)." }, "device_platform": { "type": "string", "enum": [ "android", "ios", "ipados", "tvos", "web" ], "description": "Платформа устройства конечного пользователя." }, "device_model": { "type": "string", "maxLength": 255, "description": "Модель устройства, переданная вашим приложением." }, "os_version": { "type": "string", "maxLength": 64, "description": "Версия операционной системы." }, "app_version": { "type": "string", "maxLength": 64, "description": "Версия вашего приложения." }, "user_agent": { "type": "string", "maxLength": 512, "description": "Идентификатор браузера или приложения." } } }, "PhoneRiskRequest": { "type": "object", "required": [ "phone_number" ], "properties": { "phone_number": { "type": "string", "maxLength": 20, "description": "Номер телефона для скоринга. Проходит валидацию и нормализуется до формата E.164.", "example": "+14155552671" }, "country_code": { "type": "string", "maxLength": 3, "description": "Необязательная подсказка страны ISO 3166-1 alpha-2 или alpha-3 для аналитического покрытия.", "example": "US" }, "signals": { "$ref": "#/components/schemas/RiskSignals" }, "vendor_data": { "type": "string", "description": "Ваш постоянный идентификатор для этого запроса. Сохраняется в API-сессии и возвращается в ответе." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Ваши неконфиденциальные метаданные JSON. Сохраняются в сессии API и возвращаются в ответе." }, "enable_social": { "type": "boolean", "default": false, "description": "Если true, также запрашивает цифровой след номера: мессенджеры, социальные сети, площадки электронной коммерции и профессиональные платформы, где он зарегистрирован. Тарифицируется как одна единица `phone_social` за запрос дополнительно к цене самого endpoint.", "example": true } } }, "EmailRiskRequest": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "description": "Адрес электронной почты для скоринга.", "example": "alice@example.com" }, "country_code": { "type": "string", "maxLength": 3, "description": "Необязательная подсказка страны ISO 3166-1 alpha-2 или alpha-3 для аналитического покрытия.", "example": "US" }, "signals": { "$ref": "#/components/schemas/RiskSignals" }, "vendor_data": { "type": "string", "description": "Ваш постоянный идентификатор для этого запроса. Сохраняется в API-сессии и возвращается в ответе." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Ваши неконфиденциальные метаданные JSON. Сохраняются в сессии API и возвращаются в ответе." }, "enable_social": { "type": "boolean", "default": false, "description": "Если true, также запрашивает цифровой след адреса: платформы электронной почты, социальные, профессиональные сети, площадки электронной коммерции и развлекательные сервисы, где он зарегистрирован. Тарифицируется как одна единица `email_social` за запрос дополнительно к цене самого endpoint.", "example": true } } }, "IPRiskRequest": { "type": "object", "required": [ "ip_address" ], "properties": { "ip_address": { "type": "string", "format": "ip", "description": "Адрес IPv4 или IPv6 для оценки.", "example": "8.8.8.8" }, "claimed_country": { "type": "string", "maxLength": 3, "description": "Необязательный код страны ISO 3166-1 alpha-2 или alpha-3, заявленный пользователем или сессией. Используется для вычисления `country_mismatch`.", "example": "ESP" }, "user_agent": { "type": "string", "maxLength": 512, "description": "User-Agent, зафиксированный вашим бэкендом. Сохраняется как контекст запроса; не обеспечивает фингерпринтинг устройства." }, "vendor_data": { "type": "string", "description": "Ваш постоянный идентификатор для этого запроса. Сохраняется в API-сессии и возвращается в ответе." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Ваши неконфиденциальные метаданные JSON. Сохраняются в сессии API и возвращаются в ответе." } } }, "RiskWarning": { "type": "object", "required": [ "feature", "risk", "log_type", "short_description", "long_description" ], "properties": { "feature": { "type": "string", "description": "Функция, вызвавшая предупреждение." }, "risk": { "type": "string", "description": "Машиночитаемый код риска. Со временем могут добавляться новые значения." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Контекст конкретного риска или `null`." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Уровень серьёзности, используемый правилами принятия решений." }, "short_description": { "type": "string", "description": "Краткая сводка в одну строку в понятном человеку формате." }, "long_description": { "type": "string", "description": "Понятное объяснение." } } }, "RiskLifecycleEvent": { "type": "object", "required": [ "type", "timestamp", "details", "fee" ], "properties": { "type": { "type": "string", "description": "Машиночитаемый тип события. Со временем могут добавляться новые значения." }, "timestamp": { "type": "string", "format": "date-time", "description": "Когда событие произошло." }, "details": { "type": "object", "nullable": true, "additionalProperties": true, "description": "payload, специфичный для события, или `null`." }, "fee": { "type": "number", "description": "Сумма в USD, списанная за это событие." } } }, "PhoneMatchItem": { "type": "object", "description": "Другая сессия вашего приложения, в которой использовался тот же номер телефона с другим `vendor_data`.", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "ID сессии другой верификации, в которой использовался этот номер телефона." }, "session_number": { "type": "integer", "description": "Понятный порядковый номер этой сессии." }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` этой сессии." }, "verification_date": { "type": "string", "description": "Когда была создана эта сессия (`YYYY-MM-DDTHH:MM:SSZ`)." }, "phone_number": { "type": "string", "description": "Совпавший номер телефона." }, "status": { "type": "string", "description": "Статус этой сессии (например, `Approved`, `Declined`, `In Progress`)." }, "is_blocklisted": { "type": "boolean", "description": "Находится ли номер телефона в списке блокировки вашего приложения." }, "api_service": { "type": "string", "nullable": true, "description": "Для сессий типа API это отдельный API, создавший её; `null` для обычных сессий верификации." }, "source": { "type": "string", "description": "Где было найдено совпадение. Обычно `session`; при попадании в список блокировки через запись в списке организации используется `list_entry`." } } }, "EmailMatchItem": { "type": "object", "description": "Другая сессия вашего приложения, в которой использовался тот же адрес электронной почты с другим `vendor_data`.", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "ID сессии другой верификации, в которой использовался этот адрес электронной почты." }, "session_number": { "type": "integer", "description": "Понятный порядковый номер этой сессии." }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` этой сессии." }, "verification_date": { "type": "string", "description": "Когда была создана эта сессия (`YYYY-MM-DDTHH:MM:SSZ`)." }, "email": { "type": "string", "description": "Совпавший адрес электронной почты." }, "status": { "type": "string", "description": "Статус этой сессии (например, `Approved`, `Declined`, `In Progress`)." }, "is_blocklisted": { "type": "boolean", "description": "Находится ли адрес электронной почты в списке блокировки вашего приложения." }, "api_service": { "type": "string", "nullable": true, "description": "Для сессий типа API это отдельный API, создавший её; `null` для обычных сессий верификации." }, "source": { "type": "string", "description": "Где было найдено совпадение. Обычно `session`; при попадании в список блокировки через запись в списке организации используется `list_entry`." } } }, "PhoneIntelligence": { "type": "object", "description": "Нормализованный блок аналитики телефона. Присутствует только в том случае, если для этого поиска запускалось дополнение для аналитики; если он присутствует, то также доступен под псевдонимом `enrichment` с идентичными значениями.", "properties": { "score": { "type": "number", "nullable": true, "description": "Нормализованная оценка риска от 0 до 100. Чем выше, тем выше риск." }, "phone_type_risk": { "type": "string", "nullable": true, "description": "`Low`, `Medium` или `High`, вычисляется на основе оценки." }, "phone_trust_index": { "type": "number", "nullable": true, "description": "Обратная оценка, для панелей управления, где предпочтительнее принцип «чем выше, тем лучше»." }, "network_stability_index": { "type": "number", "nullable": true, "description": "Стабильность сети телефонной линии." }, "is_disposable": { "type": "boolean", "nullable": true, "description": "`true`, если номер выглядит одноразовым или виртуальным." }, "is_ported": { "type": "boolean", "nullable": true, "description": "`true`, если номер был перенесён к другому оператору связи." }, "is_recently_ported": { "type": "boolean", "nullable": true, "description": "`true`, если перенос номера произошёл недавно." }, "carrier_type": { "type": "string", "nullable": true, "description": "Классификация линии, возвращённая поиском (например, `mobile`)." }, "reason_codes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Постоянный идентификатор сигнала Didit, например `IR-5AC67A32`. Непрозрачный: группируйте и фильтруйте по нему, не парсите его." }, "value": { "nullable": true, "description": "Для флага риска (например, `voip`, `leaked`, `disposable`, `spam_trap`), его значение: логическое значение, уровень или дата. Null для скорингового кода причины." }, "direction": { "type": "string", "enum": [ "risk", "trust" ], "description": "Повысил ли сигнал риск или повысил уровень доверия." }, "message": { "type": "string", "description": "Понятное объяснение сигнала на английском языке." }, "impact_level": { "type": "string", "nullable": true, "description": "Насколько сильно сигнал повлиял на скоринг, например `low`, `medium` или `high`." } } }, "description": "Сигналы, объясняющие оценку, каждый с фиксированным кодом Didit, направлением, сообщением и уровнем влияния. Со временем могут появляться новые коды, поэтому не отклоняйте неизвестные коды." } } }, "EmailIntelligence": { "type": "object", "description": "Нормализованный блок аналитики электронной почты. Присутствует только в том случае, если для этого адреса электронной почты запускалось дополнение для аналитики; если он присутствует, то также доступен через псевдоним `enrichment` с идентичными значениями.", "properties": { "score": { "type": "number", "nullable": true, "description": "Нормализованная оценка риска от 0 до 100. Чем выше, тем выше риск." }, "deliverable": { "type": "string", "nullable": true, "description": "Диапазон доставляемости (например, `high`)." }, "breach_risk_level": { "type": "string", "nullable": true, "description": "`Low`, `Medium` или `High`." }, "breach_risk_index": { "type": "number", "nullable": true, "description": "Числовой индекс риска утечки данных." }, "is_recent_breach": { "type": "boolean", "nullable": true, "description": "`true`, когда адрес фигурирует в недавней утечке данных." }, "is_frequent_breached": { "type": "boolean", "nullable": true, "description": "`true`, когда адрес фигурирует во множестве утечек данных." }, "is_disposable": { "type": "boolean", "nullable": true, "description": "`true`, если домен принадлежит сервису одноразовой почты." }, "is_free_domain": { "type": "boolean", "nullable": true, "description": "`true`, если домен принадлежит бесплатному почтовому сервису." }, "is_breached": { "type": "boolean", "nullable": true, "description": "`true`, когда адрес фигурирует в известных утечках данных." }, "no_of_breaches": { "type": "number", "nullable": true, "description": "Количество известных утечек, содержащих этот адрес." }, "reason_codes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Постоянный идентификатор сигнала Didit, например `IR-5AC67A32`. Непрозрачный: группируйте и фильтруйте по нему, не парсите его." }, "value": { "nullable": true, "description": "Для флага риска (например, `voip`, `leaked`, `disposable`, `spam_trap`), его значение: логическое значение, уровень или дата. Null для скорингового кода причины." }, "direction": { "type": "string", "enum": [ "risk", "trust" ], "description": "Повысил ли сигнал риск или повысил уровень доверия." }, "message": { "type": "string", "description": "Понятное объяснение сигнала на английском языке." }, "impact_level": { "type": "string", "nullable": true, "description": "Насколько сильно сигнал повлиял на скоринг, например `low`, `medium` или `high`." } } }, "description": "Сигналы, объясняющие оценку, каждый с фиксированным кодом Didit, направлением, сообщением и уровнем влияния. Со временем могут появляться новые коды, поэтому не отклоняйте неизвестные коды." } } }, "IPRiskResult": { "type": "object", "description": "Результат оценки риска IP-адреса. Отдельные поля обогащения данных могут иметь значение `null`, если при поиске не было получено пригодных данных.", "required": [ "status", "threat" ], "properties": { "status": { "type": "string", "enum": [ "Approved", "In Review" ], "description": "`In Review`, если определённая страна конфликтует с `claimed_country`, или если адрес связан с VPN, Tor или инфраструктурой центров обработки данных. В противном случае `Approved`." }, "ip_address": { "type": "string", "nullable": true, "description": "Оценённый адрес. `null`, если ни один источник обогащения данных не вернул пригодных данных." }, "ip_country": { "type": "string", "nullable": true, "description": "Определенное название страны." }, "ip_country_code": { "type": "string", "nullable": true, "description": "Определенный код страны. Сравнивайте страны с помощью `country_mismatch` вместо самостоятельного сравнения исходных строк стран." }, "ip_state": { "type": "string", "nullable": true, "description": "Определенный штат или регион." }, "ip_city": { "type": "string", "nullable": true, "description": "Определенный город." }, "latitude": { "type": "number", "nullable": true, "description": "Приблизительная геолокация по сети, а не точное местоположение устройства." }, "longitude": { "type": "number", "nullable": true, "description": "Приблизительная геолокация по сети, а не точное местоположение устройства." }, "isp": { "type": "string", "nullable": true, "description": "Интернет-провайдер, предоставляющий услуги по этому адресу." }, "organization": { "type": "string", "nullable": true, "description": "Организация, владеющая блоком адресов." }, "is_vpn_or_tor": { "type": "boolean", "nullable": true, "description": "`true`, когда адрес связан с инфраструктурой VPN или Tor." }, "is_data_center": { "type": "boolean", "nullable": true, "description": "`true`, когда адрес принадлежит сети хостинга или дата-центра." }, "time_zone": { "type": "string", "nullable": true, "description": "Часовой пояс определённого местоположения." }, "time_zone_offset": { "type": "string", "nullable": true, "description": "Смещение по UTC для определённого местоположения." }, "asn_number": { "type": "number", "nullable": true, "description": "Номер автономной системы (ASN)." }, "asn_organization": { "type": "string", "nullable": true, "description": "Организация, управляющая автономной системой." }, "connection_type": { "type": "string", "nullable": true, "description": "Классификация соединения (например, `cellular`, `hosting`)." }, "carrier": { "type": "string", "nullable": true, "description": "Оператор мобильной связи, если адрес находится в мобильной сети." }, "proxy_type": { "type": "string", "nullable": true, "description": "Классификация прокси, если адрес находится за прокси." }, "claimed_country": { "type": "string", "nullable": true, "description": "Эхо-значение переданного вами `claimed_country`." }, "country_mismatch": { "type": "boolean", "nullable": true, "description": "`true`, если определённая страна отличается от `claimed_country`. `null`, если нет данных обогащения или заявленная страна недоступна." }, "threat": { "type": "object", "additionalProperties": true, "description": "Данные о сетевых угрозах в свободной форме от источника обогащения (например, `is_proxy`, `is_tor`). Пустой объект, если данные обогащения отсутствуют. Рассматривайте как диагностические подробности, а не как стабильный контракт." } } }, "PhoneRiskResponse": { "type": "object", "required": [ "request_id", "status", "created_at" ], "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Идентификатор API-сессии, созданной для этого запроса. Сохраняйте его вместе с `vendor_data`, если нужно сопоставлять результат с последующими событиями webhook или действиями в консоли." }, "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "Окончательное решение для этой сессии API. Обычно `Approved`; оценка риска может дать `In Review` или `Declined`." }, "vendor_data": { "type": "string", "nullable": true, "description": "Эхо-значение переданного вами `vendor_data`, либо `null`, если вы его не передавали." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Эхо-значение переданного вами `metadata`, либо `null`, если вы его не передавали." }, "created_at": { "type": "string", "format": "date-time", "description": "Временная метка этого ответа." }, "phone": { "type": "object", "description": "Нормализованный отчёт по телефону, аналогичный блоку, используемому в ответах Проверки телефона.", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "Решение для этого номера телефона. Дублирует верхнеуровневый `status`." }, "phone_number_prefix": { "type": "string", "description": "Телефонный код страны со знаком `+` в начале (например, `+1`).", "example": "+1" }, "phone_number": { "type": "string", "description": "Национальный номер без телефонного кода страны.", "example": "4155552671" }, "full_number": { "type": "string", "description": "Полный номер в формате E.164.", "example": "+14155552671" }, "country_code": { "type": "string", "nullable": true, "description": "Код страны номера по стандарту ISO 3166-1 alpha-2.", "example": "US" }, "country_name": { "type": "string", "description": "Полное название страны, полученное из `country_code`.", "example": "United States" }, "carrier": { "type": "object", "nullable": true, "description": "Текущая сеть, обслуживающая номер. `null`, если при проверке не удалось определить оператора.", "properties": { "name": { "type": "string", "description": "Название оператора связи. Пустая строка, если при поиске не удалось его определить." }, "type": { "type": "string", "description": "Тип линии, возвращённый поиском: `mobile`, `fixed_line`, `voip`, `isp`, `vpn`, `toll_free`, `premium_rate` или аналогичный." } } }, "is_disposable": { "type": "boolean", "description": "`true`, если номер принадлежит сервису временных или одноразовых номеров." }, "is_virtual": { "type": "boolean", "description": "`true`, если тип линии является виртуальным (`voip`, `isp` или `vpn`)." }, "verification_method": { "type": "string", "nullable": true, "description": "Канал OTP для основной верификации. `null` для проверок риска, которые никогда не отправляют код." }, "verification_attempts": { "type": "integer", "description": "Количество отправок одноразового кода для этого номера. `0` для проверок риска." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Время последней верификации номера с помощью OTP. `null` для проверок риска." }, "warnings": { "type": "array", "description": "Предупреждения о рисках, зафиксированные для этого запроса. Пустой массив, если предупреждений нет.", "items": { "$ref": "#/components/schemas/RiskWarning" } }, "lifecycle": { "type": "array", "description": "Хронологический журнал аудита запроса. Пустой массив для проверок риска без событий отправки.", "items": { "$ref": "#/components/schemas/RiskLifecycleEvent" } }, "matches": { "type": "array", "description": "Другие сессии вашего приложения, где тот же номер телефона использовался другим пользователем (другой `vendor_data`). До 5 записей. Пустой массив при отсутствии совпадений.", "items": { "$ref": "#/components/schemas/PhoneMatchItem" } }, "phone_intelligence": { "$ref": "#/components/schemas/PhoneIntelligence" }, "enrichment": { "$ref": "#/components/schemas/PhoneIntelligence" }, "phone_social": { "$ref": "#/components/schemas/PhoneSocialFootprint" } } } } }, "EmailRiskResponse": { "type": "object", "required": [ "request_id", "status", "created_at" ], "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Идентификатор API-сессии, созданной для этого запроса. Сохраняйте его вместе с `vendor_data`, если нужно сопоставлять результат с последующими событиями webhook или действиями в консоли." }, "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "Окончательное решение для этой сессии API. Обычно `Approved`; оценка риска может дать `In Review` или `Declined`." }, "vendor_data": { "type": "string", "nullable": true, "description": "Эхо-значение переданного вами `vendor_data`, либо `null`, если вы его не передавали." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Эхо-значение переданного вами `metadata`, либо `null`, если вы его не передавали." }, "created_at": { "type": "string", "format": "date-time", "description": "Временная метка этого ответа." }, "email": { "type": "object", "description": "Нормализованный отчёт по электронной почте, аналогичный блоку, используемому в ответах Проверки электронной почты.", "required": [ "status", "email", "is_breached", "breaches", "is_disposable", "is_undeliverable" ], "properties": { "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "Решение для этого адреса электронной почты. Дублирует верхнеуровневый `status`." }, "email": { "type": "string", "description": "Оценённый адрес.", "example": "alice@example.com" }, "is_breached": { "type": "boolean", "description": "Фигурирует ли адрес в известной утечке учетных данных." }, "breaches": { "type": "array", "description": "До 5 последних известных утечек, содержащих этот адрес. Пустой массив, если `is_breached` имеет значение `false`.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Идентификатор утечки." }, "domain": { "type": "string", "description": "Домен скомпрометированного сервиса." }, "breach_date": { "type": "string", "format": "date", "description": "Дата, когда произошло нарушение." }, "breach_emails_count": { "type": "integer", "description": "Общее количество аккаунтов, данные которых оказались в утечке." }, "description": { "type": "string", "description": "Понятное описание утечки (может содержать HTML-разметку)." }, "logo_path": { "type": "string", "description": "URL логотипа скомпрометированного сервиса." }, "data_classes": { "type": "array", "items": { "type": "string" }, "description": "Категории раскрытых данных в формате snake_case (например, `email_addresses`, `passwords`)." }, "is_verified": { "type": "boolean", "description": "Была ли утечка подтверждена как подлинная." } } } }, "is_disposable": { "type": "boolean", "description": "Принадлежит ли домен провайдеру одноразовой почты." }, "is_undeliverable": { "type": "boolean", "description": "Был ли адрес признан недоставляемым." }, "verification_attempts": { "type": "integer", "description": "Количество отправок одноразового кода для этого адреса. `0` для проверок риска." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда адрес в последний раз верифицировался с помощью OTP. `null` для проверок риска." }, "warnings": { "type": "array", "description": "Предупреждения о рисках, зафиксированные для этого запроса. Пустой массив, если предупреждений нет.", "items": { "$ref": "#/components/schemas/RiskWarning" } }, "lifecycle": { "type": "array", "description": "Хронологический журнал аудита запроса. Пустой массив для проверок риска без отправок.", "items": { "$ref": "#/components/schemas/RiskLifecycleEvent" } }, "matches": { "type": "array", "description": "Другие сессии вашего приложения, где тот же адрес электронной почты использовался другим пользователем (другой `vendor_data`). До 5 записей. Пустой массив при отсутствии совпадений.", "items": { "$ref": "#/components/schemas/EmailMatchItem" } }, "email_intelligence": { "$ref": "#/components/schemas/EmailIntelligence" }, "enrichment": { "$ref": "#/components/schemas/EmailIntelligence" }, "email_social": { "$ref": "#/components/schemas/EmailSocialFootprint" } } } } }, "IPRiskResponse": { "type": "object", "required": [ "request_id", "status", "created_at" ], "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Идентификатор API-сессии, созданной для этого запроса. Сохраняйте его вместе с `vendor_data`, если нужно сопоставлять результат с последующими событиями webhook или действиями в консоли." }, "status": { "type": "string", "enum": [ "Approved", "In Review" ], "description": "Решение для этой API-сессии: `In Review` при риске сети или несовпадении стран, иначе `Approved`." }, "vendor_data": { "type": "string", "nullable": true, "description": "Эхо-значение переданного вами `vendor_data`, либо `null`, если вы его не передавали." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Эхо-значение переданного вами `metadata`, либо `null`, если вы его не передавали." }, "created_at": { "type": "string", "format": "date-time", "description": "Временная метка этого ответа." }, "ip": { "type": "object", "description": "Результат оценки риска IP-адреса. Отдельные поля обогащения данных могут иметь значение `null`, если при поиске не было получено пригодных данных.", "required": [ "status", "threat" ], "properties": { "status": { "type": "string", "enum": [ "Approved", "In Review" ], "description": "`In Review`, если определённая страна конфликтует с `claimed_country`, или если адрес связан с VPN, Tor или инфраструктурой центров обработки данных. В противном случае `Approved`." }, "ip_address": { "type": "string", "nullable": true, "description": "Оценённый адрес. `null`, если ни один источник обогащения данных не вернул пригодных данных." }, "ip_country": { "type": "string", "nullable": true, "description": "Определенное название страны." }, "ip_country_code": { "type": "string", "nullable": true, "description": "Определенный код страны. Сравнивайте страны с помощью `country_mismatch` вместо самостоятельного сравнения исходных строк стран." }, "ip_state": { "type": "string", "nullable": true, "description": "Определенный штат или регион." }, "ip_city": { "type": "string", "nullable": true, "description": "Определенный город." }, "latitude": { "type": "number", "nullable": true, "description": "Приблизительная геолокация по сети, а не точное местоположение устройства." }, "longitude": { "type": "number", "nullable": true, "description": "Приблизительная геолокация по сети, а не точное местоположение устройства." }, "isp": { "type": "string", "nullable": true, "description": "Интернет-провайдер, предоставляющий услуги по этому адресу." }, "organization": { "type": "string", "nullable": true, "description": "Организация, владеющая блоком адресов." }, "is_vpn_or_tor": { "type": "boolean", "nullable": true, "description": "`true`, когда адрес связан с инфраструктурой VPN или Tor." }, "is_data_center": { "type": "boolean", "nullable": true, "description": "`true`, когда адрес принадлежит сети хостинга или дата-центра." }, "time_zone": { "type": "string", "nullable": true, "description": "Часовой пояс определённого местоположения." }, "time_zone_offset": { "type": "string", "nullable": true, "description": "Смещение по UTC для определённого местоположения." }, "asn_number": { "type": "number", "nullable": true, "description": "Номер автономной системы (ASN)." }, "asn_organization": { "type": "string", "nullable": true, "description": "Организация, управляющая автономной системой." }, "connection_type": { "type": "string", "nullable": true, "description": "Классификация соединения (например, `cellular`, `hosting`)." }, "carrier": { "type": "string", "nullable": true, "description": "Оператор мобильной связи, если адрес находится в мобильной сети." }, "proxy_type": { "type": "string", "nullable": true, "description": "Классификация прокси, если адрес находится за прокси." }, "claimed_country": { "type": "string", "nullable": true, "description": "Эхо-значение переданного вами `claimed_country`." }, "country_mismatch": { "type": "boolean", "nullable": true, "description": "`true`, если определённая страна отличается от `claimed_country`. `null`, если нет данных обогащения или заявленная страна недоступна." }, "threat": { "type": "object", "additionalProperties": true, "description": "Данные о сетевых угрозах в свободной форме от источника обогащения (например, `is_proxy`, `is_tor`). Пустой объект, если данные обогащения отсутствуют. Рассматривайте как диагностические подробности, а не как стабильный контракт." } } } } }, "SocialFootprintPlatform": { "type": "object", "properties": { "platform": { "type": "string", "description": "Идентификатор платформы.", "example": "whatsapp" }, "category": { "type": "string", "description": "Категория платформы, например: MESSAGING, SOCIAL_MEDIA, ECOMMERCE, PROFESSIONAL, EMAIL_PROVIDER.", "example": "MESSAGING" }, "scope": { "type": "string", "enum": [ "global", "local" ], "description": "`global` для глобальных платформ, `local` для региональных.", "example": "global" } } }, "SocialFootprintCategorySummary": { "type": "object", "properties": { "registered": { "type": "integer", "nullable": true, "description": "Платформы этой категории, где подтверждена регистрация.", "example": 2 }, "ratio": { "type": "number", "format": "float", "nullable": true, "description": "Доля проверенных платформ категории с наличием регистрации, от 0.0 до 1.0.", "example": 0.6667 } } }, "SocialFootprintProfile": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "Имя профиля, если платформа его предоставляет." }, "photo": { "type": "string", "nullable": true, "description": "URL фотографии профиля, если платформа её предоставляет." }, "about": { "type": "string", "nullable": true, "description": "Текст «о себе»/биография профиля, если платформа его предоставляет." }, "privacy_status": { "type": "string", "nullable": true, "enum": [ "PUBLIC", "PRIVATE", null ], "description": "Видимость профиля, если платформа её предоставляет." }, "business_account": { "type": "boolean", "nullable": true, "description": "Является ли профиль бизнес-аккаунтом, если платформа раскрывает эту информацию." } } }, "PhoneSocialFootprint": { "type": "object", "nullable": true, "description": "Цифровой след номера телефона: онлайн-платформы, на которых он зарегистрирован. Присутствует, только если был задан параметр `enable_social` и проверка завершилась. Любое количество может быть null, если данные по нему не были возвращены. `profiles_registered: 0` означает, что платформы были проверены и номер телефона не найден ни на одной из них: это валидный, тарифицируемый ответ и частый признак синтетической личности.", "properties": { "profiles_registered": { "type": "integer", "nullable": true, "description": "Платформы, где подтверждена регистрация номера телефона.", "example": 5 }, "profiles_checked": { "type": "integer", "nullable": true, "description": "Платформы, проверенные на наличие регистрации.", "example": 14 }, "names_found": { "type": "integer", "nullable": true, "description": "Платформы, вернувшие связанное имя.", "example": 0 }, "photos_found": { "type": "integer", "nullable": true, "description": "Платформы, вернувшие фото профиля.", "example": 0 }, "communication_breadth": { "type": "integer", "nullable": true, "description": "Коммуникационные платформы с обнаруженным присутствием.", "example": 2 }, "digital_footprint_diversity": { "type": "integer", "nullable": true, "description": "Уникальные категории платформ с обнаруженным присутствием.", "example": 5 }, "digital_sophistication_index": { "type": "integer", "nullable": true, "description": "Составной индикатор цифровой зрелости, 0-10.", "example": 5 }, "engagement_depth_index": { "type": "integer", "nullable": true, "description": "Индикатор заполненности профиля, 0-10.", "example": 3 }, "subscription_affordability_index": { "type": "integer", "nullable": true, "description": "Соотношение бесплатных и платных платформ, 0-10.", "example": 2 }, "free_platforms": { "type": "integer", "nullable": true, "description": "Регистрации на бесплатных платформах.", "example": 4 }, "full_paid_platforms": { "type": "integer", "nullable": true, "description": "Регистрации на полностью платных платформах.", "example": 0 }, "partial_paid_platforms": { "type": "integer", "nullable": true, "description": "Регистрации на freemium-платформах.", "example": 1 }, "whatsapp_profile_completeness": { "type": "string", "nullable": true, "enum": [ "Basic", "Partial", "Complete", "Not Present", null ], "description": "Полнота профиля WhatsApp. Только для телефона; null для электронной почты.", "example": "Partial" }, "registered_platforms": { "type": "array", "description": "Платформы, где подтверждена регистрация.", "items": { "$ref": "#/components/schemas/SocialFootprintPlatform" } }, "not_registered_platforms": { "type": "array", "description": "Платформы, проверенные с отрицательным результатом.", "items": { "$ref": "#/components/schemas/SocialFootprintPlatform" } }, "categories": { "type": "object", "description": "Количество регистраций и их соотношение по категориям платформ.", "additionalProperties": { "$ref": "#/components/schemas/SocialFootprintCategorySummary" } }, "profiles": { "type": "object", "description": "Сведения о профиле на платформе, сгруппированные по платформам, если платформа их предоставляет.", "additionalProperties": { "$ref": "#/components/schemas/SocialFootprintProfile" } } } }, "EmailSocialFootprint": { "type": "object", "nullable": true, "description": "Цифровой след адреса электронной почты: онлайн-платформы, на которых он зарегистрирован. Присутствует, только если был задан параметр `enable_social` и проверка завершилась. Любое количество может быть null, если данные по нему не были возвращены. `profiles_registered: 0` означает, что платформы были проверены и адрес электронной почты не найден ни на одной из них - это валидный, тарифицируемый ответ и частый признак синтетической личности.", "properties": { "profiles_registered": { "type": "integer", "nullable": true, "description": "Платформы, где подтверждена регистрация адреса электронной почты.", "example": 5 }, "profiles_checked": { "type": "integer", "nullable": true, "description": "Платформы, проверенные на наличие регистрации.", "example": 14 }, "names_found": { "type": "integer", "nullable": true, "description": "Платформы, вернувшие связанное имя.", "example": 0 }, "photos_found": { "type": "integer", "nullable": true, "description": "Платформы, вернувшие фото профиля.", "example": 0 }, "communication_breadth": { "type": "integer", "nullable": true, "description": "Коммуникационные платформы с обнаруженным присутствием.", "example": 2 }, "digital_footprint_diversity": { "type": "integer", "nullable": true, "description": "Уникальные категории платформ с обнаруженным присутствием.", "example": 5 }, "digital_sophistication_index": { "type": "integer", "nullable": true, "description": "Составной индикатор цифровой зрелости, 0-10.", "example": 5 }, "engagement_depth_index": { "type": "integer", "nullable": true, "description": "Индикатор заполненности профиля, 0-10.", "example": 3 }, "subscription_affordability_index": { "type": "integer", "nullable": true, "description": "Соотношение бесплатных и платных платформ, 0-10.", "example": 2 }, "free_platforms": { "type": "integer", "nullable": true, "description": "Регистрации на бесплатных платформах.", "example": 4 }, "full_paid_platforms": { "type": "integer", "nullable": true, "description": "Регистрации на полностью платных платформах.", "example": 0 }, "partial_paid_platforms": { "type": "integer", "nullable": true, "description": "Регистрации на freemium-платформах.", "example": 1 }, "whatsapp_profile_completeness": { "type": "string", "nullable": true, "enum": [ "Basic", "Partial", "Complete", "Not Present", null ], "description": "Полнота профиля WhatsApp. Только для телефона; null для электронной почты.", "example": "Partial" }, "registered_platforms": { "type": "array", "description": "Платформы, где подтверждена регистрация.", "items": { "$ref": "#/components/schemas/SocialFootprintPlatform" } }, "not_registered_platforms": { "type": "array", "description": "Платформы, проверенные с отрицательным результатом.", "items": { "$ref": "#/components/schemas/SocialFootprintPlatform" } }, "categories": { "type": "object", "description": "Количество регистраций и их соотношение по категориям платформ.", "additionalProperties": { "$ref": "#/components/schemas/SocialFootprintCategorySummary" } }, "profiles": { "type": "object", "description": "Сведения о профиле на платформе, сгруппированные по платформам, если платформа их предоставляет.", "additionalProperties": { "$ref": "#/components/schemas/SocialFootprintProfile" } } } }, "KYBRegistryAddress": { "type": "object", "description": "Адрес, указанный реестром, в едином формате для всех стран и источников реестров. Каждый ключ присутствует всегда; часть, которую реестр не публикует, имеет значение null.", "properties": { "type": { "type": "string", "nullable": true, "description": "Тип адреса в нижнем регистре: `registered` для юридического адреса; другие типы указываются так, как их называет реестр (например, `postal`, `office`). `null`, когда реестр не указывает назначение адреса." }, "address": { "type": "string", "description": "Полный адрес одной строкой. Всегда присутствует в каждом адресе." }, "street": { "type": "string", "nullable": true, "description": "Улица и номер дома." }, "city": { "type": "string", "nullable": true, "description": "Город или населённый пункт." }, "postal_code": { "type": "string", "nullable": true, "description": "Почтовый индекс." }, "region": { "type": "string", "nullable": true, "description": "Регион, штат или провинция." }, "country_code": { "type": "string", "nullable": true, "description": "Двухбуквенный код страны ISO 3166-1 alpha-2." }, "description": { "type": "string", "nullable": true, "description": "Собственное обозначение адреса в реестре, если оно предоставлено." } }, "required": [ "type", "address", "street", "city", "postal_code", "region", "country_code", "description" ] }, "KYBRegistryIndustry": { "type": "object", "description": "Вид деятельности, к которому реестр относит компанию, в едином формате для всех стран и источников реестров.", "properties": { "code": { "type": "string", "nullable": true, "description": "Код деятельности в том виде, в каком он указан в реестре (например, `73110`)." }, "description": { "type": "string", "nullable": true, "description": "Название вида деятельности, если оно публикуется реестром." }, "scheme": { "type": "string", "nullable": true, "description": "Система классификации, одно название на систему независимо от сообщившего её источника: `UK SIC 2007`, `US SIC`, `NACE Rev. 2`, `NACE Rev. 2.1`, `NAF Rev. 2`, `CNAE`, `SBI`, `NOGA 2008`, `CAE Rev. 4`, `Canada SIC 1977`; другие национальные системы сохраняют собственное название реестра. Null, если реестр не указывает систему." }, "is_primary": { "type": "boolean", "description": "True для основного вида деятельности компании. Ровно одна запись является основной, если список не пуст." } }, "required": [ "code", "description", "scheme", "is_primary" ] }, "KYBRegistryShareholding": { "type": "object", "nullable": true, "description": "Информация о владении владельца в едином формате для любой страны и источника реестра. Null, если в реестре нет сведений о владении. Диапазон (например, 25-50% для британского PSC) не считается долей: `percentage` равен null, а диапазон сохраняется в `ownership_min_shares` / `ownership_max_shares`.", "properties": { "share_class": { "type": "string", "nullable": true, "description": "Класс или тип акций в том виде, как он указан в реестре." }, "number_of_shares": { "type": "number", "nullable": true, "description": "Количество акций во владении." }, "currency": { "type": "string", "nullable": true, "description": "Валюта по стандарту ISO 4217 для приведённых ниже значений." }, "nominal_value": { "type": "number", "nullable": true, "description": "Номинальная стоимость одной акции." }, "total_value": { "type": "number", "nullable": true, "description": "Общая стоимость актива." }, "percentage": { "type": "number", "nullable": true, "description": "Точная доля в процентах с точностью до четырёх знаков после запятой." } }, "required": [ "share_class", "number_of_shares", "currency", "nominal_value", "total_value", "percentage" ] }, "KYBRegistryOwnership": { "type": "object", "description": "Результат уровня структуры владения (акционеры / UBO) в едином формате для любой страны и любого реестра.", "properties": { "status": { "type": "string", "nullable": true, "enum": [ "not_requested", "pending", "delivered", "not_held", "unavailable", null ], "description": "`delivered`, когда реестр опубликовал структуру владения; `not_held`, когда реестр структуры владения ответил и в нём вовсе нет этой компании (см. `unavailable_reason`); `unavailable`, когда он не предоставил данные о структуре владения по любой другой причине (см. `unavailable_reason`); `pending`, пока реестр всё ещё запрашивает их; `not_requested` для уровня Basic." }, "tier_requested": { "type": "string", "nullable": true, "enum": [ "basic", "shareholders", "ubo", null ], "description": "Уровень, заказанный сценарием." }, "tier_delivered": { "type": "string", "nullable": true, "enum": [ "basic", "shareholders", "ubo", null ], "description": "Уровень, предоставленный реестром (и включенный в счёт). Запрос UBO, на который получены данные только о прямых акционерах, имеет значение `shareholders`." }, "unavailable_reason": { "type": "string", "nullable": true, "enum": [ "no_owners_on_record", "no_natural_person_owner", "ownership_section_unavailable", "company_not_found", "ambiguous_company_match", "missing_registration_number", "entity_type_not_covered", "provider_unavailable", "other", null ], "description": "Причина, по которой запрошенный уровень структуры владения не был предоставлен. Имеет значение null, если `status` не равен `unavailable` или `pending`." }, "direct_ownership_complete": { "type": "boolean", "nullable": true, "description": "True, когда заявленные доли прямых акционеров в сумме составляют 100% (с точностью до одного процентного пункта из-за округления); false, если нет; null, если структура владения не была передана или доля не указана." }, "unresolved": { "type": "array", "description": "Части структуры владения, которые реестр не смог определить, например отсутствие сведений о структуре группы выше прямых владельцев.", "items": { "type": "object", "properties": { "reason": { "type": "string" }, "section": { "type": "string", "nullable": true } } } } }, "required": [ "status", "tier_requested", "tier_delivered", "unavailable_reason", "direct_ownership_complete", "unresolved" ] }, "KYBRegistryData": { "type": "object", "nullable": true, "description": "Нормализованные данные реестра Didit по компании: результат проверки структуры владения (`ownership_error`, `section_errors`, `ubo_resolution`, `lite_enrichment`), исправления, внесённые с помощью update-data, и факты реестра, для которых нет отдельного поля. Никогда не содержит исходную запись источника реестра. Каждый ключ опционален и присутствует только тогда, когда у компании есть для него значение; могут добавляться новые ключи. Используйте канонические поля (`addresses`, `industries`, `ownership`, `beneficial_owners[].shareholding`) для всего, что они охватывают.", "properties": { "company_name": { "type": "string", "description": "Название компании, исправленное в панели управления." }, "registration_number": { "type": "string", "description": "Регистрационный номер, указанный в реестре или в исправлении через консоль." }, "country_code": { "type": "string", "description": "Страна регистрации, указанная в реестре или при корректировке в консоли." }, "region": { "type": "string", "description": "Регион или штат регистрации." }, "incorporation_date": { "type": "string", "description": "Дата регистрации (ISO 8601)." }, "registration_date": { "type": "string", "description": "Дата регистрации (ISO 8601), если реестр указывает её отдельно от даты инкорпорации." }, "dissolution_date": { "type": "string", "description": "Дата ликвидации (ISO 8601), если она указана в реестре." }, "tax_number": { "type": "string", "description": "Налоговый номер." }, "vat_number": { "type": "string", "description": "Номер плательщика НДС." }, "legal_address": { "type": "string", "description": "Юридический адрес с исправлениями из консоли." }, "registered_address": { "type": "string", "description": "Зарегистрированный адрес согласно данным реестра." }, "company_type": { "type": "string", "description": "Организационно-правовая форма." }, "registry_status": { "type": "string", "description": "Статус компании в реестре." }, "verification_status": { "type": "string", "description": "Статус верификации." }, "alternative_names": { "type": "string", "description": "Другие наименования, под которыми компания ведет или вела коммерческую деятельность." }, "nature_of_business": { "type": "string", "description": "Описание деятельности." }, "registered_capital": { "type": "string", "description": "Зарегистрированный капитал в том виде, как он напечатан." }, "registered_capital_amount": { "type": "string", "description": "Размер зарегистрированного капитала в виде десятичной строки." }, "registered_capital_currency": { "type": "string", "description": "Валюта зарегистрированного капитала (ISO 4217)." }, "website": { "type": "string", "description": "Веб-сайт." }, "email": { "type": "string", "description": "Контактный email." }, "phone": { "type": "string", "description": "Контактный телефон." }, "legal_entity_identifier": { "type": "string", "description": "Идентификатор юридического лица (LEI)." }, "location_of_registration": { "type": "string", "description": "Место регистрации." }, "control_scheme": { "type": "string", "description": "Схема корпоративного управления, если она раскрывается реестром." }, "ownership_error": { "type": "string", "enum": [ "no_owners_on_record", "no_natural_person_owner", "ownership_section_unavailable", "company_not_found", "ambiguous_company_match", "missing_registration_number", "entity_type_not_covered", "provider_unavailable", "other" ], "description": "Причина, по которой запрошенный уровень структуры владения не был предоставлен, в тех же кодах, что и `ownership.unavailable_reason`. `no_owners_on_record` (реестр ответил и не указал ни одного владельца) и `ownership_section_unavailable` (реестр не вернул раздел структуры владения) представляют собой разные результаты проверки." }, "section_errors": { "type": "object", "description": "Разделы, которые реестр не вернул, с ключами, соответствующими разделам (`officers`, `shareholders`, `group_structure`). Указанный здесь раздел не был возвращён: пустой список рядом с ним ничего не сообщает о компании.", "additionalProperties": { "$ref": "#/components/schemas/KYBRegistrySectionError" } }, "ubo_resolution": { "$ref": "#/components/schemas/KYBRegistryUboResolution" }, "lite_enrichment": { "$ref": "#/components/schemas/KYBRegistryLiteEnrichment" }, "registry_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Собственные поля реестра для компании с ключами, как они названы в реестре, в виде простых значений (устаревшие записи). Включены только поля, проверенные как факты из реестра." }, "registry_sources": { "type": "array", "description": "Официальные реестры, из которых была получена запись (устаревшие записи). Другие источники не указываются.", "items": { "$ref": "#/components/schemas/KYBRegistrySource" } }, "previous_names": { "type": "array", "items": { "type": "string" }, "description": "Названия, под которыми компания была зарегистрирована ранее (исторические записи)." }, "parent_companies": { "type": "array", "items": { "type": "string" }, "description": "Материнские компании, указанные в реестре (устаревшие записи)." }, "documents_available": { "type": "integer", "description": "Количество документов компании, доступных в реестре (устаревшие записи)." } } }, "KYBRegistryGroupCompany": { "type": "object", "description": "Компания корпоративной группы по её идентификатору в реестре.", "properties": { "name": { "type": "string", "nullable": true, "description": "Название компании." }, "country_code": { "type": "string", "nullable": true, "description": "Страна регистрации." }, "registration_number": { "type": "string", "nullable": true, "description": "Регистрационный номер." } }, "required": [ "name", "country_code", "registration_number" ] }, "KYBRegistryUboResolution": { "type": "object", "description": "Как уровень UBO обходил цепочку владения выше компании.", "properties": { "parent_chain": { "type": "array", "description": "Корпоративные материнские структуры от конечной материнской компании до самой компании.", "items": { "$ref": "#/components/schemas/KYBRegistryGroupCompany" } }, "subsidiaries": { "type": "array", "description": "Компании, находящиеся непосредственно под компанией в её корпоративной группе.", "items": { "$ref": "#/components/schemas/KYBRegistryGroupCompany" } }, "unresolved": { "type": "array", "description": "Части цепочки, которые реестр не смог определить (те же записи, что и в `ownership.unresolved`).", "items": { "type": "object", "properties": { "reason": { "type": "string", "description": "Причина, например `no_group_structure_on_record`, `selected_company_not_in_group_structure` или `section_error`." }, "section": { "type": "string", "nullable": true, "description": "Соответствующий раздел, например `group_structure`." } }, "required": [ "reason", "section" ] } } }, "required": [ "parent_chain", "subsidiaries", "unresolved" ] }, "KYBRegistrySectionError": { "type": "object", "description": "Раздел, который реестр не вернул.", "properties": { "status_code": { "type": "integer", "nullable": true, "description": "Статус, возвращённый реестром для данного раздела." } }, "required": [ "status_code" ] }, "KYBRegistryLiteEnrichment": { "type": "object", "description": "Пустые поля профиля Lite, заполненные другим источником реестра страны. Источник не указан.", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "Поля компании, которые были заполнены." }, "people_added": { "type": "integer", "description": "Количество добавленных должностных лиц или владельцев." } }, "required": [ "fields", "people_added" ] }, "KYBRegistrySource": { "type": "object", "description": "Официальный реестр, из которого была прочитана запись. Указываются только официальные государственные реестры, регуляторы и официальная система идентификаторов; любые другие источники опускаются.", "properties": { "name": { "type": "string", "description": "Название реестра, например `UK Companies House`." }, "source_type": { "type": "string", "enum": [ "official" ], "description": "Всегда `official`." } }, "required": [ "name", "source_type" ] }, "KYBOwnershipStructure": { "type": "object", "nullable": true, "description": "Структура владения (cap table), подтверждённая реестром на момент предоставления уровня структуры владения: прямые `shareholders` и `beneficial_owners`. Null, если реестр не подтвердил структуру владения. Она никогда не содержит собственные строки источника реестра; актуальную запись см. в `company.beneficial_owners` и `company.ownership`.", "properties": { "shareholders": { "type": "array", "items": { "$ref": "#/components/schemas/KYBOwnershipStructureOwner" } }, "beneficial_owners": { "type": "array", "items": { "$ref": "#/components/schemas/KYBOwnershipStructureOwner" } } }, "required": [ "shareholders", "beneficial_owners" ] }, "KYBOwnershipStructureOwner": { "type": "object", "description": "Один владелец из снимка структуры владения: те же идентификационные данные из реестра и доля, что и в `company.beneficial_owners[]`, а также его канонический `shareholding`.", "properties": { "name": { "type": "string", "nullable": true, "description": "Имя владельца, как указано в реестре." }, "first_name": { "type": "string", "nullable": true, "description": "Имя физического лица, если оно указано в реестре." }, "last_name": { "type": "string", "nullable": true, "description": "Фамилия физического лица, если она указана в реестре." }, "date_of_birth": { "type": "string", "nullable": true, "description": "Дата рождения (ISO 8601), если реестр её публикует." }, "country_of_birth": { "type": "string", "nullable": true, "description": "Страна рождения, если она опубликована в реестре." }, "company_name": { "type": "string", "nullable": true, "description": "Название компании (для корпоративного владельца)." }, "registration_number": { "type": "string", "nullable": true, "description": "Регистрационный номер корпоративного владельца." }, "entity_type": { "type": "string", "nullable": true, "enum": [ "person", "company", null ], "description": "Является ли владелец физическим лицом или компанией." }, "nationality": { "type": "string", "nullable": true, "description": "Гражданство, если оно указано в реестре." }, "designation": { "type": "string", "nullable": true, "description": "Должность или роль владельца в том виде, как она указана в реестре." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "`shareholder` для прямого владельца, `ubo` для бенефициарного владельца." }, "ownership_min_shares": { "type": "string", "nullable": true, "description": "Нижняя граница доли в процентах (равна верхней границе в случае точной доли)." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Верхняя граница доли владения в процентах." }, "voting_min_shares": { "type": "string", "nullable": true, "description": "Нижняя граница прав голоса в процентах." }, "voting_max_shares": { "type": "string", "nullable": true, "description": "Верхняя граница прав голоса в процентах." }, "appointment_date": { "type": "string", "nullable": true, "description": "Дата начала пребывания в должности или назначения (ISO 8601)." }, "is_active": { "type": "boolean", "nullable": true, "description": "False для бывшего владельца." }, "shareholding": { "$ref": "#/components/schemas/KYBRegistryShareholding" } }, "required": [ "name", "first_name", "last_name", "date_of_birth", "country_of_birth", "company_name", "registration_number", "entity_type", "nationality", "designation", "roles", "ownership_min_shares", "ownership_max_shares", "voting_min_shares", "voting_max_shares", "appointment_date", "is_active", "shareholding" ] }, "DigitalIdWalletApiWalletVerificationError": { "type": "object", "properties": { "error": { "type": "string", "description": "Постоянный машиночитаемый код, например wallet_unavailable." }, "detail": { "type": "string" } }, "required": [ "detail", "error" ] }, "DigitalIdWalletApiWalletVerificationStartForbidden": { "oneOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiClientCredentialsForbiddenErrorMessage" }, { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } ] }, "DigitalIdWalletApiClientCredentialsForbiddenErrorMessage": { "type": "object", "properties": { "detail": { "type": "string", "default": "Forbidden - User doesn't have permission" } } }, "DigitalIdWalletApiWalletVerificationStartBadRequest": { "oneOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" }, { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationFieldErrors" } ] }, "DigitalIdWalletApiWalletVerificationFieldErrors": { "type": "object", "description": "Ошибки валидации запроса: каждое отклонённое поле с соответствующими сообщениями.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "DigitalIdWalletApiWalletVerificationResponse": { "type": "object", "description": "Одна отдельная верификация кошелька в том виде, в котором её возвращает каждый endpoint для кошельков.", "properties": { "request_id": { "type": "string", "format": "uuid" }, "wallet_verification": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResult" }, "vendor_data": { "type": "string", "nullable": true }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Объект метаданных, переданный при запуске, или null." }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "created_at", "metadata", "request_id", "vendor_data", "wallet_verification" ] }, "DigitalIdWalletApiWalletVerificationResult": { "type": "object", "properties": { "wallet": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiWallet" } ], "readOnly": true }, "country": { "type": "string" }, "status": { "type": "string", "description": "Не завершена (Not Finished), пока находится в ожидании, затем Одобрена (Approved / верифицирована) или Отклонена (Declined)." }, "outcome": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResultOutcomeEnum" }, "error": { "type": "string", "nullable": true, "readOnly": true }, "interaction": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiInteractionEnum" } ], "readOnly": true }, "simulated": { "type": "boolean", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time" }, "next_action": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiWalletNextAction" } ], "nullable": true, "readOnly": true }, "identity": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiWalletIdentity" } ], "nullable": true, "readOnly": true }, "attributes": { "type": "object", "additionalProperties": {}, "nullable": true, "readOnly": true }, "level_of_assurance": { "type": "string", "nullable": true }, "verified_at": { "type": "string", "format": "date-time", "nullable": true }, "signature_valid": { "type": "boolean", "nullable": true, "description": "True, если подпись учётных данных была подтверждена; null для имитированных учётных данных." }, "credential_type": { "type": "string", "nullable": true } }, "required": [ "attributes", "country", "credential_type", "error", "expires_at", "identity", "interaction", "level_of_assurance", "next_action", "outcome", "signature_valid", "simulated", "status", "verified_at", "wallet" ] }, "DigitalIdWalletApiWalletIdentity": { "type": "object", "properties": { "full_name": { "type": "string", "nullable": true }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "nationality": { "type": "string", "nullable": true, "description": "Гражданство по ISO3, только если оно прямо заявлено кошельком (никогда не определяется косвенно)." }, "issuing_state": { "type": "string", "description": "Страна по ISO3, схема которой выдала удостоверение." } }, "required": [ "date_of_birth", "first_name", "full_name", "issuing_state", "last_name", "nationality" ] }, "DigitalIdWalletApiWalletNextAction": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiWalletNextActionTypeEnum" } ], "description": "redirect: перенаправьте браузер пользователя на url. confirm_in_app: покажите verification_code пользователю, который сверяет его с кодом в приложении своего кошелька и подтверждает там; затем выполняйте опрос. request_digital_credential: при взаимодействии пользователя в исходном источнике запросите кошелёк с помощью digital_credentials.request, затем отправьте возвращённый результат в POST .../verifications/{request_id}/response/.\n\n* `redirect` - redirect\n* `confirm_in_app` - confirm_in_app\n* `request_digital_credential` - request_digital_credential" }, "url": { "type": "string", "format": "uri", "description": "Только для redirect: адрес, по которому пользователь входит в систему с помощью кошелька." }, "digital_credentials": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiWalletDigitalCredentialsRequest" } ], "description": "Только для request_digital_credential: запрос для передачи в кошелёк." }, "verification_code": { "type": "string", "description": "Только для confirm_in_app: 4-значный код сравнения, который также отображается в приложении кошелька." }, "poll_interval_seconds": { "type": "integer", "description": "Только для confirm_in_app: как часто вызывать POST .../verifications/{request_id}/poll/ для быстрого получения статуса. Didit также выполняет фоновые опросы незавершённых входов, поэтому webhook сообщит о результате, даже если вы не выполняете опросы." } }, "required": [ "type" ] }, "DigitalIdWalletApiWalletNextActionTypeEnum": { "enum": [ "redirect", "confirm_in_app", "request_digital_credential" ], "type": "string", "description": "* `redirect` - redirect\n* `confirm_in_app` - confirm_in_app\n* `request_digital_credential` - request_digital_credential" }, "DigitalIdWalletApiInteractionEnum": { "enum": [ "redirect", "in_app", "digital_credentials" ], "type": "string", "description": "* `redirect` - redirect\n* `in_app` - in_app\n* `digital_credentials` - digital_credentials" }, "DigitalIdWalletApiWalletVerificationResultOutcomeEnum": { "enum": [ "pending", "verified", "cancelled", "timeout", "failed" ], "type": "string", "description": "* `pending` - В ожидании\n* `verified` - Подтверждено\n* `cancelled` - Отменено пользователем\n* `timeout` - Время ожидания истекло\n* `failed` - Не удалось" }, "DigitalIdWalletApiWallet": { "type": "object", "properties": { "id": { "type": "string", "description": "Каталожный идентификатор кошелька, например bankid_se." }, "name": { "type": "string" }, "issuing_authority": { "type": "string", "nullable": true } }, "required": [ "id", "issuing_authority", "name" ] }, "DigitalIdWalletApiEudiWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию через EUDI Wallet (AUT, BEL, BGR, HRV, CYP, CZE, DNK, EST, FIN, FRA, DEU, GRC, HUN, IRL, ITA, LVA, LTU, LUX, MLT, NLD, POL, PRT, ROU, SVK, SVN, ESP, SWE, ISL, LIE, NOR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiEudiWalletVerificationStartCountryEnum" } ], "description": "Код страны по стандарту ISO 3166-1 alpha-3 для идентификатора EUDI Wallet.\n\n* `AUT` - AUT\n* `BEL` - BEL\n* `BGR` - BGR\n* `HRV` - HRV\n* `CYP` - CYP\n* `CZE` - CZE\n* `DNK` - DNK\n* `EST` - EST\n* `FIN` - FIN\n* `FRA` - FRA\n* `DEU` - DEU\n* `GRC` - GRC\n* `HUN` - HUN\n* `IRL` - IRL\n* `ITA` - ITA\n* `LVA` - LVA\n* `LTU` - LTU\n* `LUX` - LUX\n* `MLT` - MLT\n* `NLD` - NLD\n* `POL` - POL\n* `PRT` - PRT\n* `ROU` - ROU\n* `SVK` - SVK\n* `SVN` - SVN\n* `ESP` - ESP\n* `SWE` - SWE\n* `ISL` - ISL\n* `LIE` - LIE\n* `NOR` - NOR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "country", "return_url" ] }, "DigitalIdWalletApiDeviceEnum": { "enum": [ "same_device", "cross_device" ], "type": "string", "description": "* `same_device` - same_device\n* `cross_device` - cross_device" }, "DigitalIdWalletApiEudiWalletVerificationStartCountryEnum": { "enum": [ "AUT", "BEL", "BGR", "HRV", "CYP", "CZE", "DNK", "EST", "FIN", "FRA", "DEU", "GRC", "HUN", "IRL", "ITA", "LVA", "LTU", "LUX", "MLT", "NLD", "POL", "PRT", "ROU", "SVK", "SVN", "ESP", "SWE", "ISL", "LIE", "NOR" ], "type": "string", "description": "* `AUT` - AUT\n* `BEL` - BEL\n* `BGR` - BGR\n* `HRV` - HRV\n* `CYP` - CYP\n* `CZE` - CZE\n* `DNK` - DNK\n* `EST` - EST\n* `FIN` - FIN\n* `FRA` - FRA\n* `DEU` - DEU\n* `GRC` - GRC\n* `HUN` - HUN\n* `IRL` - IRL\n* `ITA` - ITA\n* `LVA` - LVA\n* `LTU` - LTU\n* `LUX` - LUX\n* `MLT` - MLT\n* `NLD` - NLD\n* `POL` - POL\n* `PRT` - PRT\n* `ROU` - ROU\n* `SVK` - SVK\n* `SVN` - SVN\n* `ESP` - ESP\n* `SWE` - SWE\n* `ISL` - ISL\n* `LIE` - LIE\n* `NOR` - NOR" }, "DigitalIdWalletApiConnectidWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию через ConnectID (AUS).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiConnectidWalletVerificationStartCountryEnum" } ], "default": "AUS", "description": "Код страны по стандарту ISO 3166-1 alpha-3 для идентификатора ConnectID. По умолчанию используется AUS, единственная страна, которую он обслуживает.\n\n* `AUS` - AUS" }, "authorisation_server_id": { "type": "string", "minLength": 1, "description": "Идентификатор сервера авторизации, выбранный с помощью селектора банка ConnectID. В песочнице по умолчанию используется Mock Bank A.", "maxLength": 36 }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiConnectidWalletVerificationStartCountryEnum": { "enum": [ "AUS" ], "type": "string", "description": "* `AUS` - AUS" }, "DigitalIdWalletApiAudkenniWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию через Auðkenni (ISL).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiAudkenniWalletVerificationStartCountryEnum" } ], "default": "ISL", "description": "Код страны по стандарту ISO 3166-1 alpha-3 для идентификатора Auðkenni. По умолчанию ISL, единственная страна, которую он обслуживает.\n\n* `ISL` - ISL" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiAudkenniWalletVerificationStartCountryEnum": { "enum": [ "ISL" ], "type": "string", "description": "* `ISL` - ISL" }, "DigitalIdWalletApiFranceconnectWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию через FranceConnect (FRA).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiFranceconnectWalletVerificationStartCountryEnum" } ], "default": "FRA", "description": "Код страны по стандарту ISO 3166-1 alpha-3 для идентификатора FranceConnect. По умолчанию используется FRA, единственная обслуживаемая страна.\n\n* `FRA` - FRA" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiFranceconnectWalletVerificationStartCountryEnum": { "enum": [ "FRA" ], "type": "string", "description": "* `FRA` - FRA" }, "DigitalIdWalletApiDiiaWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию через Diia (UKR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDiiaWalletVerificationStartCountryEnum" } ], "default": "UKR", "description": "Код страны по стандарту ISO 3166-1 alpha-3 для идентификатора Diia. По умолчанию UKR, единственная страна, которую он обслуживает.\n\n* `UKR` - UKR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiDiiaWalletVerificationStartCountryEnum": { "enum": [ "UKR" ], "type": "string", "description": "* `UKR` - UKR" }, "DigitalIdWalletApiMojeidWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию MojeID (CZE).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryE2dEnum" } ], "default": "CZE", "description": "Код страны ISO 3166-1 alpha-3 для удостоверения MojeID. По умолчанию CZE, единственная обслуживаемая страна.\n\n* `CZE` - CZE" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiCountryE2dEnum": { "enum": [ "CZE" ], "type": "string", "description": "* `CZE` - CZE" }, "DigitalIdWalletApiBankidCzWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию через Bank iD (CZE).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryE2dEnum" } ], "default": "CZE", "description": "Код страны по стандарту ISO 3166-1 alpha-3 для идентификатора Bank iD. По умолчанию CZE, единственная страна, которую он обслуживает.\n\n* `CZE` - CZE" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiEparakstsMobileWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию eParaksts mobile (LVA).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiEparakstsMobileWalletVerificationStartCountryEnum" } ], "default": "LVA", "description": "Код страны ISO 3166-1 alpha-3 для удостоверения eParaksts mobile. По умолчанию LVA, единственная обслуживаемая страна.\n\n* `LVA` - LVA" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiEparakstsMobileWalletVerificationStartCountryEnum": { "enum": [ "LVA" ], "type": "string", "description": "* `LVA` - LVA" }, "DigitalIdWalletApiIdcardEeWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию через эстонскую ID-карту (EST).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiIdcardEeWalletVerificationStartCountryEnum" } ], "default": "EST", "description": "Код страны по стандарту ISO 3166-1 alpha-3 для удостоверения Estonian ID-card. По умолчанию EST, единственная поддерживаемая страна.\n\n* `EST` - EST" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiIdcardEeWalletVerificationStartCountryEnum": { "enum": [ "EST" ], "type": "string", "description": "* `EST` - EST" }, "DigitalIdWalletApiMobileIdWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию через Mobile-ID (EST, LTU).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiMobileIdWalletVerificationStartCountryEnum" } ], "description": "Код страны ISO 3166-1 alpha-3 для удостоверения Mobile-ID.\n\n* `EST` - EST\n* `LTU` - LTU" }, "personal_code": { "type": "string", "minLength": 1, "description": "Государственный личный идентификационный код пользователя. Он используется для обращения к приложению Mobile-ID пользователя; пользователь подтверждает код сопоставления и вводит свой PIN-код в приложении. Никогда не запрашивайте PIN-код.", "pattern": "^[0-9-]{6,20}$" }, "phone_number": { "type": "string", "minLength": 1, "description": "Номер телефона Mobile-ID в формате E.164 (+372... или +370...).", "maxLength": 16 } }, "required": [ "country", "personal_code", "phone_number" ] }, "DigitalIdWalletApiMobileIdWalletVerificationStartCountryEnum": { "enum": [ "EST", "LTU" ], "type": "string", "description": "* `EST` - EST\n* `LTU` - LTU" }, "DigitalIdWalletApiSmartIdWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию Smart-ID (EST, LVA, LTU, BEL).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiSmartIdWalletVerificationStartCountryEnum" } ], "description": "Код страны ISO 3166-1 alpha-3 для удостоверения Smart-ID.\n\n* `EST` - EST\n* `LVA` - LVA\n* `LTU` - LTU\n* `BEL` - BEL" }, "personal_code": { "type": "string", "minLength": 1, "description": "Государственный личный идентификационный код пользователя. Он используется для обращения к приложению Smart-ID пользователя; пользователь подтверждает код сопоставления и вводит свой PIN-код в приложении. Никогда не запрашивайте PIN-код.", "pattern": "^[0-9-]{6,20}$" } }, "required": [ "country", "personal_code" ] }, "DigitalIdWalletApiSmartIdWalletVerificationStartCountryEnum": { "enum": [ "EST", "LVA", "LTU", "BEL" ], "type": "string", "description": "* `EST` - EST\n* `LVA` - LVA\n* `LTU` - LTU\n* `BEL` - BEL" }, "DigitalIdWalletApiGovukWalletWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию через GOV.UK Wallet (GBR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountry520Enum" } ], "default": "GBR", "description": "Код страны ISO 3166-1 alpha-3 для удостоверения GOV.UK Wallet. По умолчанию GBR, единственная обслуживаемая страна.\n\n* `GBR` - GBR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiCountry520Enum": { "enum": [ "GBR" ], "type": "string", "description": "* `GBR` - GBR" }, "DigitalIdWalletApiOneidWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию OneID (GBR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountry520Enum" } ], "default": "GBR", "description": "Код страны ISO 3166-1 alpha-3 для удостоверения OneID. По умолчанию используется GBR, единственная обслуживаемая страна.\n\n* `GBR` - GBR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiGovbrWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию gov.br (BRA).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiGovbrWalletVerificationStartCountryEnum" } ], "default": "BRA", "description": "Код страны ISO 3166-1 alpha-3 для удостоверения gov.br. По умолчанию используется BRA, единственная обслуживаемая страна.\n\n* `BRA` - BRA" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiGovbrWalletVerificationStartCountryEnum": { "enum": [ "BRA" ], "type": "string", "description": "* `BRA` - BRA" }, "DigitalIdWalletApiUaePassWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию UAE PASS (ARE).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum" } ], "default": "ARE", "description": "Код страны ISO 3166-1 alpha-3 для удостоверения UAE PASS. По умолчанию ARE, единственная обслуживаемая страна.\n\n* `ARE` - ARE" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum": { "enum": [ "ARE" ], "type": "string", "description": "* `ARE` - ARE" }, "DigitalIdWalletApiFrejaidWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию через Freja eID (SWE).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryEe9Enum" } ], "default": "SWE", "description": "Код страны ISO 3166-1 alpha-3 для удостоверения Freja eID. По умолчанию SWE, единственная обслуживаемая страна.\n\n* `SWE` - SWE" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiCountryEe9Enum": { "enum": [ "SWE" ], "type": "string", "description": "* `SWE` - SWE" }, "DigitalIdWalletApiPersonalausweisWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию Personalausweis (DEU).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiPersonalausweisWalletVerificationStartCountryEnum" } ], "default": "DEU", "description": "Код страны ISO 3166-1 alpha-3 для удостоверения Personalausweis. По умолчанию используется DEU, единственная обслуживаемая страна.\n\n* `DEU` - DEU" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiPersonalausweisWalletVerificationStartCountryEnum": { "enum": [ "DEU" ], "type": "string", "description": "* `DEU` - DEU" }, "DigitalIdWalletApiFtnWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию через Finnish Trust Network (FIN).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiFtnWalletVerificationStartCountryEnum" } ], "default": "FIN", "description": "Код страны по стандарту ISO 3166-1 alpha-3 для идентификатора Finnish Trust Network. По умолчанию используется FIN, единственная обслуживаемая страна.\n\n* `FIN` - FIN" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiFtnWalletVerificationStartCountryEnum": { "enum": [ "FIN" ], "type": "string", "description": "* `FIN` - FIN" }, "DigitalIdWalletApiIdinWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию iDIN (NLD).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiIdinWalletVerificationStartCountryEnum" } ], "default": "NLD", "description": "Код страны ISO 3166-1 alpha-3 для удостоверения iDIN. По умолчанию NLD, единственная обслуживаемая страна.\n\n* `NLD` - NLD" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiIdinWalletVerificationStartCountryEnum": { "enum": [ "NLD" ], "type": "string", "description": "* `NLD` - NLD" }, "DigitalIdWalletApiItsmeWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию itsme (BEL, LUX, NLD).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiItsmeWalletVerificationStartCountryEnum" } ], "description": "Код страны ISO 3166-1 alpha-3 для удостоверения itsme.\n\n* `BEL` - BEL\n* `LUX` - LUX\n* `NLD` - NLD" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "country", "return_url" ] }, "DigitalIdWalletApiItsmeWalletVerificationStartCountryEnum": { "enum": [ "BEL", "LUX", "NLD" ], "type": "string", "description": "* `BEL` - BEL\n* `LUX` - LUX\n* `NLD` - NLD" }, "DigitalIdWalletApiBuypassWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию через Buypass ID (NOR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryAfcEnum" } ], "default": "NOR", "description": "Код страны по стандарту ISO 3166-1 alpha-3 для удостоверения Buypass ID. По умолчанию используется NOR, единственная страна, которую оно обслуживает.\n\n* `NOR` - NOR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiCountryAfcEnum": { "enum": [ "NOR" ], "type": "string", "description": "* `NOR` - NOR" }, "DigitalIdWalletApiVippsWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию Vipps (NOR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryAfcEnum" } ], "default": "NOR", "description": "Код страны ISO 3166-1 alpha-3 для удостоверения Vipps. По умолчанию используется NOR, единственная обслуживаемая страна.\n\n* `NOR` - NOR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiBankidNoWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию через BankID (NOR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryAfcEnum" } ], "default": "NOR", "description": "Код страны по стандарту ISO 3166-1 alpha-3 для идентификатора BankID. По умолчанию NOR, единственная страна, которую он обслуживает.\n\n* `NOR` - NOR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiBankidSeWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию через BankID (SWE).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryEe9Enum" } ], "default": "SWE", "description": "Код страны по стандарту ISO 3166-1 alpha-3 для идентификатора BankID. По умолчанию используется SWE, единственная страна, которую он обслуживает.\n\n* `SWE` - SWE" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiMitidWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию через MitID (DNK).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiMitidWalletVerificationStartCountryEnum" } ], "default": "DNK", "description": "Код страны ISO 3166-1 alpha-3 для удостоверения MitID. По умолчанию используется DNK, единственная обслуживаемая страна.\n\n* `DNK` - DNK" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiMitidWalletVerificationStartCountryEnum": { "enum": [ "DNK" ], "type": "string", "description": "* `DNK` - DNK" }, "DigitalIdWalletApiWalletCatalogResponse": { "type": "object", "properties": { "wallets": { "type": "array", "items": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletCatalogEntry" } } }, "required": [ "wallets" ] }, "DigitalIdWalletApiWalletCatalogEntry": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string", "description": "Собственный начальный endpoint кошелька." }, "countries": { "type": "array", "items": { "type": "string" } }, "issuing_authority": { "type": "string" }, "level_of_assurance": { "type": "string", "nullable": true }, "interaction": { "$ref": "#/components/schemas/DigitalIdWalletApiInteractionEnum" }, "required_fields": { "type": "array", "items": { "type": "string" } }, "available": { "type": "boolean", "description": "Может ли это приложение запустить его в этой среде прямо сейчас. Наличие в списке не означает, что оно активно." } }, "required": [ "available", "countries", "id", "interaction", "issuing_authority", "level_of_assurance", "name", "path", "required_fields" ] }, "CaseDuplicateCaseDuplicate": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "readOnly": true }, "case_number": { "type": "string", "nullable": true, "maxLength": 32 }, "title": { "type": "string", "maxLength": 255 }, "status": { "$ref": "#/components/schemas/CaseDuplicateStatusEnum" }, "priority": { "$ref": "#/components/schemas/CaseDuplicatePriorityEnum" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "title", "uuid" ] }, "CaseDuplicateCaseDuplicatePage": { "type": "object", "properties": { "count": { "type": "integer" }, "next_offset": { "type": "integer", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseDuplicateCaseDuplicate" } } }, "required": [ "count", "next_offset", "results" ] }, "RoutingPublicationPolicyDraftResponse": { "type": "object", "properties": { "draft": { "allOf": [ { "$ref": "#/components/schemas/RoutingPublicationPolicyDraft" } ], "nullable": true } }, "required": [ "draft" ] }, "RoutingPublicationPolicyDraftWriteRequest": { "type": "object", "properties": { "expected_version": { "type": "integer", "minimum": 0 }, "expected_revision": { "type": "string", "format": "uuid", "nullable": true }, "changes": { "type": "object", "additionalProperties": {} } }, "required": [ "changes", "expected_revision", "expected_version" ] }, "CasePublicationPolicyDraft": { "type": "object", "properties": { "revision": { "type": "string", "format": "uuid" }, "base_version": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "changes": {}, "actor_email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "base_version", "updated_at" ] }, "CasePublicationPolicyDraftPreconditionRequest": { "type": "object", "properties": { "expected_version": { "type": "integer", "minimum": 0 }, "expected_revision": { "type": "string", "format": "uuid", "nullable": true } }, "required": [ "expected_revision", "expected_version" ] }, "CaseCollaborationCaseNote": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "readOnly": true }, "comment": { "type": "string" }, "actor_email": { "type": "string", "format": "email", "nullable": true, "maxLength": 255 }, "actor_name": { "type": "string", "nullable": true, "maxLength": 255 }, "mentioned_emails": {}, "is_internal": { "type": "boolean" }, "attachments": {}, "tags": {}, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "reply_to": { "allOf": [ { "$ref": "#/components/schemas/CaseCollaborationCaseNoteReply" } ], "nullable": true, "readOnly": true }, "is_pinned": { "type": "boolean" }, "client_reference": { "type": "string", "format": "uuid", "nullable": true } }, "required": [ "comment", "created_at", "reply_to", "uuid" ] }, "CustomerMessagingPaginatedCaseRequestList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?offset=400&limit=100" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?offset=200&limit=100" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerMessagingCaseRequest" } } } }, "FraudCheckResponse": { "type": "object", "properties": { "check_id": { "type": "string", "format": "uuid" }, "request_id": { "type": "string", "format": "uuid", "description": "Нативная сессия верификации, созданная для этой проверки." }, "client_reference": { "type": "string", "nullable": true }, "processing_status": { "$ref": "#/components/schemas/FraudProcessingStatusEnum" }, "profile_id": { "type": "string" }, "profile_version": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time", "nullable": true }, "inputs": { "type": "array", "items": { "$ref": "#/components/schemas/FraudCheckInput" } }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/FraudCheckModuleReport" } }, "attribute_evidence": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "compound_evidence": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "risk": { "type": "array", "items": { "$ref": "#/components/schemas/FraudCheckRisk" } }, "network": { "type": "object", "additionalProperties": {} }, "enrichment": { "type": "object", "additionalProperties": {} }, "identity_relationship": { "allOf": [ { "$ref": "#/components/schemas/FraudCheckIdentityRelationship" } ], "nullable": true }, "recommendation": { "$ref": "#/components/schemas/FraudRecommendationEnum" }, "next_action": { "$ref": "#/components/schemas/FraudNextActionEnum" }, "decision_reasons": { "type": "array", "items": { "type": "string" } }, "coverage": { "type": "object", "additionalProperties": {} }, "usage": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "vendor_data": { "type": "string", "nullable": true }, "metadata": { "nullable": true } }, "required": [ "attribute_evidence", "check_id", "client_reference", "completed_at", "compound_evidence", "coverage", "created_at", "decision_reasons", "inputs", "modules", "network", "next_action", "processing_status", "profile_id", "profile_version", "recommendation", "risk", "usage" ] }, "CaseReviewTeam": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 500 }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/CaseReviewTeamMember" }, "maxItems": 250 }, "is_active": { "type": "boolean" }, "uuid": { "type": "string", "format": "uuid", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } } }, "CaseActionCaseEntityActionRequest": { "type": "object", "properties": { "client_reference": { "type": "string", "format": "uuid" }, "retry": { "type": "boolean", "default": false }, "action": { "$ref": "#/components/schemas/CaseActionActionEnum" }, "status": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "note": { "type": "string", "nullable": true } }, "required": [ "action" ] }, "RoutingPublicationPaginatedPolicyRevisionList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?offset=400&limit=100" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?offset=200&limit=100" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/RoutingPublicationPolicyRevision" } } } }, "FraudRecommendationEnum": { "enum": [ "approve", "review", "reject" ], "type": "string", "description": "* `approve` - Одобрить\n* `review` - На проверку\n* `reject` - Отклонить" }, "CustomerMessagingCaseRequestPreviewResponse": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "expires_at": { "type": "string", "format": "date-time" }, "recipient": { "type": "string", "format": "email" }, "sender": { "type": "string" }, "subject": { "type": "string" }, "html": { "type": "string" }, "requires_user_action": { "type": "boolean" }, "preview_token": { "type": "string" } }, "required": [ "expires_at", "html", "preview_token", "recipient", "request_id", "requires_user_action", "sender", "subject" ] }, "CustomerMessagingCaseCustomerResponseRequest": { "type": "object", "properties": { "full_name": { "type": "string", "minLength": 1, "maxLength": 512 }, "date_of_birth": { "type": "string", "format": "date" }, "file": { "type": "string", "format": "binary", "writeOnly": true } } }, "CaseCollaborationCaseNoteReply": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "actor_name": { "type": "string", "nullable": true }, "actor_email": { "type": "string", "format": "email", "nullable": true }, "comment": { "type": "string", "maxLength": 300 } }, "required": [ "actor_email", "actor_name", "comment", "uuid" ] }, "FraudCheckModuleReport": { "type": "object", "properties": { "module": { "$ref": "#/components/schemas/FraudExcludeEnum" }, "status": { "$ref": "#/components/schemas/FraudStatusEnum" }, "reason": { "type": "string", "nullable": true }, "latency_ms": { "type": "integer" }, "freshness": { "type": "string", "nullable": true }, "billable_units": { "type": "integer" } }, "required": [ "billable_units", "freshness", "latency_ms", "module", "reason", "status" ] }, "CaseDuplicateEntityTypeEnum": { "enum": [ "session", "business_session", "transaction" ], "type": "string", "description": "* `session` - Сессия\n* `business_session` - Сессия компании\n* `transaction` - Транзакция" }, "FraudClientCredentialsErrorMessage": { "type": "object", "properties": { "detail": { "type": "string", "default": "Authentication failed: Invalid client access token." } } }, "FraudAvailabilityEnum": { "enum": [ "available", "not_requested", "no_reference", "insufficient_history", "unsupported_region", "source_unavailable" ], "type": "string", "description": "* `available` - Доступно\n* `not_requested` - Не запрашивалось\n* `no_reference` - Нет эталонных данных\n* `insufficient_history` - Недостаточно истории\n* `unsupported_region` - Регион не поддерживается\n* `source_unavailable` - Источник недоступен" }, "CasePublicationPolicyDraftResponse": { "type": "object", "properties": { "draft": { "allOf": [ { "$ref": "#/components/schemas/CasePublicationPolicyDraft" } ], "nullable": true } }, "required": [ "draft" ] }, "FraudCheckAttributesRequest": { "type": "object", "description": "Подтверждающие атрибуты. Все опциональны; они расширяют охват модулей.", "properties": { "first_name": { "type": "string", "maxLength": 128 }, "last_name": { "type": "string", "maxLength": 128 }, "full_name": { "type": "string", "maxLength": 256 }, "date_of_birth": { "type": "string", "format": "date" }, "nationality": { "type": "string", "maxLength": 3 }, "gender": { "type": "string", "maxLength": 16 }, "address": { "type": "string", "maxLength": 512 }, "city": { "type": "string", "maxLength": 128 }, "state": { "type": "string", "maxLength": 128 }, "postal_code": { "type": "string", "maxLength": 32 } } }, "NetworkNote": { "type": "object", "required": [ "uuid", "actor_email", "comment", "client_reference", "created_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "readOnly": true }, "actor_email": { "type": "string", "format": "email", "readOnly": true, "description": "Аутентифицированный автор, назначаемый сервером." }, "comment": { "type": "string", "minLength": 1, "maxLength": 10000 }, "client_reference": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true } } }, "CaseActionEntityTypeEnum": { "enum": [ "user", "business" ], "type": "string", "description": "* `user` - user\n* `business` - business" }, "CaseRoutingCondition": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "source", "priority", "tags" ] }, "operator": { "type": "string", "enum": [ "equals", "in", "contains" ] }, "value": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "field", "operator", "value" ], "description": "Поля source и priority поддерживают equals или in с допустимыми значениями. Поле tags поддерживает contains с одним непустым тегом." }, "RoutingPublicationPolicyRevision": { "type": "object", "properties": { "version": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "snapshot": {}, "actor_email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "published_at": { "type": "string", "format": "date-time" } }, "required": [ "published_at", "snapshot", "version" ] }, "CasePublicationPolicyRevision": { "type": "object", "properties": { "version": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "snapshot": {}, "actor_email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "published_at": { "type": "string", "format": "date-time" } }, "required": [ "published_at", "snapshot", "version" ] }, "FraudCheckIdentityRelationship": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/FraudResultEnum" }, "reference_type": { "type": "string" }, "country": { "type": "string" }, "availability": { "$ref": "#/components/schemas/FraudAvailabilityEnum" }, "reason_codes": { "type": "array", "items": { "type": "string" } } }, "required": [ "availability", "country", "reason_codes", "reference_type", "result" ] }, "CasePublicationPaginatedPolicyRevisionList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?offset=400&limit=100" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?offset=200&limit=100" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CasePublicationPolicyRevision" } } } }, "CaseDuplicateBlankEnum": { "enum": [ "" ] }, "FraudCheckPlan": { "type": "object", "properties": { "profile_id": { "type": "string" }, "profile_version": { "type": "string" }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/FraudCheckPlannedModule" } }, "estimated_price": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "is_sandbox": { "type": "boolean" }, "can_afford": { "type": "boolean" } }, "required": [ "can_afford", "currency", "estimated_price", "is_sandbox", "modules", "profile_id", "profile_version" ] }, "CaseReviewTeamUpdate": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 500 }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/CaseReviewTeamMember" }, "maxItems": 250 }, "is_active": { "type": "boolean" } } }, "RoutingPublicationPolicyDraft": { "type": "object", "properties": { "revision": { "type": "string", "format": "uuid" }, "base_version": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "changes": {}, "actor_email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "base_version", "updated_at" ] }, "FraudCheckRequestRequest": { "type": "object", "properties": { "client_reference": { "type": "string", "minLength": 1, "description": "Ваш собственный идентификатор этой проверки. Также служит ключом идемпотентности: повторное использование с тем же телом запроса возвращает исходную проверку без повторного запуска или списания средств за модули; повторное использование с другим телом запроса возвращает 409.", "maxLength": 255 }, "profile": { "type": "string", "minLength": 1, "default": "standard", "description": "Идентификатор профиля оркестрации. По умолчанию используется профиль Didit `standard`.", "maxLength": 64 }, "profile_version": { "type": "string", "minLength": 1, "description": "Закрепить зафиксированную версию профиля. По умолчанию используется текущая версия профиля.", "maxLength": 32 }, "subject": { "$ref": "#/components/schemas/FraudCheckSubjectRequest" }, "context": { "$ref": "#/components/schemas/FraudCheckContextRequest" }, "checks": { "$ref": "#/components/schemas/FraudCheckModuleSelectionRequest" }, "vendor_data": { "type": "string", "maxLength": 1000 }, "metadata": {} }, "required": [ "subject" ] }, "CaseDuplicateCaseSubjectInputRequest": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CaseDuplicateTypeEnum" }, "uuid": { "type": "string", "format": "uuid" } }, "required": [ "type", "uuid" ] }, "CaseReviewTeamMember": { "type": "object", "properties": { "user_id": { "type": "string", "format": "uuid" }, "availability": { "type": "string", "enum": [ "available", "unavailable" ], "default": "available" }, "capacity": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 10 }, "skills": { "type": "array", "items": { "type": "string", "maxLength": 64 }, "maxItems": 25 }, "available_from": { "type": "string", "format": "date-time", "nullable": true }, "available_until": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "user_id" ] }, "CaseRoutingPreviewRequest": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "MANUAL", "AML_SCREENING", "TRANSACTION_RULE", "WORKFLOW_BUILDER" ] }, "priority": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ], "default": "MEDIUM" }, "tags": { "type": "array", "items": { "type": "string", "maxLength": 64 }, "maxItems": 50 }, "rule_uuid": { "type": "string", "format": "uuid" }, "draft": { "$ref": "#/components/schemas/CaseRoutingRuleCreate" } }, "required": [ "source" ] }, "FraudExcludeEnum": { "enum": [ "normalization", "email_risk", "email_social", "phone_social", "phone_risk", "ip_risk", "database_validation", "networks_same_org", "networks_cross_org", "biometric_identity" ], "type": "string", "description": "* `normalization` - Нормализация\n* `email_risk` - Риск электронной почты\n* `email_social` - Социальные профили электронной почты\n* `phone_social` - Социальные профили телефона\n* `phone_risk` - Риск телефона\n* `ip_risk` - Риск IP\n* `database_validation` - Проверка по базам данных\n* `networks_same_org` - Сети внутри организации\n* `networks_cross_org` - Межорганизационные сети\n* `biometric_identity` - Биометрическая идентификация" }, "CaseDuplicateCaseLinkCreateRequest": { "type": "object", "properties": { "entity_type": { "$ref": "#/components/schemas/CaseDuplicateEntityTypeEnum" }, "entity_uuid": { "type": "string", "format": "uuid" } }, "required": [ "entity_type", "entity_uuid" ] }, "CaseDuplicateStatusEnum": { "enum": [ "OPEN", "AWAITING_USER", "RESOLVED" ], "type": "string", "description": "* `OPEN` - Открыт\n* `AWAITING_USER` - Ожидает пользователя\n* `RESOLVED` - Решён" }, "FraudBandEnum": { "enum": [ "low", "medium", "high", "unknown" ], "type": "string", "description": "* `low` - Низкий\n* `medium` - Средний\n* `high` - Высокий\n* `unknown` - Неизвестно" }, "CaseDuplicatePriorityEnum": { "enum": [ "LOW", "MEDIUM", "HIGH" ], "type": "string", "description": "* `LOW` - Низкий\n* `MEDIUM` - Средний\n* `HIGH` - Высокий" }, "FraudStatusEnum": { "enum": [ "planned", "completed", "skipped", "failed" ], "type": "string", "description": "* `planned` - Запланировано\n* `completed` - Завершено\n* `skipped` - Пропущено\n* `failed` - Не удалось" }, "FraudCheckInput": { "type": "object", "properties": { "reference": { "type": "string", "description": "Замаскированное значение переданного идентификатора." }, "type": { "$ref": "#/components/schemas/FraudTypeEnum" }, "namespace": { "type": "object", "additionalProperties": {} }, "quality": { "type": "string" }, "normalization": { "type": "object", "additionalProperties": {} }, "availability": { "$ref": "#/components/schemas/FraudAvailabilityEnum" } }, "required": [ "availability", "namespace", "normalization", "quality", "reference", "type" ] }, "CustomerMessagingPurposesEnum": { "enum": [ "identity_document", "proof_of_address", "business_document", "confirm_details", "review_in_progress" ], "type": "string", "description": "* `identity_document` - identity_document\n* `proof_of_address` - proof_of_address\n* `business_document` - business_document\n* `confirm_details` - confirm_details\n* `review_in_progress` - review_in_progress" }, "FraudTypeEnum": { "enum": [ "email", "phone", "national_id", "tax_number", "passport_number", "driving_licence_number", "residence_permit_number", "voter_id", "external_id" ], "type": "string", "description": "* `email` - Электронная почта\n* `phone` - Телефон\n* `national_id` - Национальный идентификатор\n* `tax_number` - Налоговый номер\n* `passport_number` - Номер паспорта\n* `driving_licence_number` - Номер водительского удостоверения\n* `residence_permit_number` - Номер вида на жительство\n* `voter_id` - Удостоверение избирателя\n* `external_id` - Внешний идентификатор" }, "CaseDuplicateCaseSubjectInput": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CaseDuplicateTypeEnum" }, "uuid": { "type": "string", "format": "uuid" } }, "required": [ "type", "uuid" ] }, "CaseReviewTeamCreate": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 500 }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/CaseReviewTeamMember" }, "maxItems": 250 }, "is_active": { "type": "boolean" } }, "required": [ "name", "members" ] }, "CaseDuplicateCaseDuplicateQueryRequest": { "type": "object", "properties": { "subject": { "$ref": "#/components/schemas/CaseDuplicateCaseSubjectInputRequest" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/CaseDuplicateCaseLinkCreateRequest" } }, "offset": { "type": "integer", "maximum": 1000000, "minimum": 0, "default": 0 } } }, "CaseDuplicateResolutionEnum": { "enum": [ "FALSE_POSITIVE", "VALID_THREAT" ], "type": "string", "description": "* `FALSE_POSITIVE` - Ложное срабатывание\n* `VALID_THREAT` - Реальная угроза" }, "CasePublicationPolicyDraftWriteRequest": { "type": "object", "properties": { "expected_version": { "type": "integer", "minimum": 0 }, "expected_revision": { "type": "string", "format": "uuid", "nullable": true }, "changes": { "type": "object", "additionalProperties": {} } }, "required": [ "changes", "expected_revision", "expected_version" ] }, "FraudCheckSubjectRequest": { "type": "object", "properties": { "selfie": { "type": "string", "minLength": 1, "description": "Селфи в формате Base64 JPEG, PNG или WebP размером до 6 МБ. Без эталонного изображения или URL.", "maxLength": 8388672 }, "identifiers": { "type": "array", "items": { "$ref": "#/components/schemas/FraudCheckIdentifierRequest" }, "description": "Один или несколько типизированных идентификаторов. Достаточно одного.", "maxItems": 10, "minItems": 1 }, "attributes": { "$ref": "#/components/schemas/FraudCheckAttributesRequest" } }, "required": [ "identifiers" ] }, "RoutingPublicationRoutingCondition": { "type": "object", "properties": { "field": { "$ref": "#/components/schemas/RoutingPublicationFieldEnum" }, "operator": { "$ref": "#/components/schemas/RoutingPublicationOperatorEnum" }, "value": {} }, "required": [ "field", "operator", "value" ] }, "CaseActionCaseActionReceipt": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "readOnly": true }, "client_reference": { "type": "string", "format": "uuid" }, "action": { "type": "string", "maxLength": 32 }, "status": { "$ref": "#/components/schemas/CaseActionStatusEnum" }, "result": {}, "error": { "type": "string", "maxLength": 255 }, "actor_email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "attempts": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "action", "client_reference", "created_at", "status", "updated_at", "uuid" ] }, "FraudCheckContextRequest": { "type": "object", "properties": { "ip_address": { "type": "string", "minLength": 1 }, "user_agent": { "type": "string", "maxLength": 512 }, "country": { "type": "string", "description": "Страна, в которой субъект заявляет о своём нахождении. Используется только как контекст и никогда не является доказательством того, что эта личность принадлежит данному субъекту.", "maxLength": 3 }, "purpose": { "type": "string", "maxLength": 128 }, "consent_obtained": { "type": "boolean" } } }, "CustomerMessagingCaseCustomerResponseResult": { "type": "object", "properties": { "responded_at": { "type": "string", "format": "date-time" } }, "required": [ "responded_at" ] }, "CustomerMessagingCaseRequestContact": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "email": { "type": "string", "format": "email" }, "verified_at": { "type": "string", "format": "date-time" } }, "required": [ "email", "uuid", "verified_at" ] }, "FraudClientCredentialsForbiddenErrorMessage": { "type": "object", "properties": { "detail": { "type": "string", "default": "Forbidden - User doesn't have permission" } } }, "CasePublicationAssignmentMethodEnum": { "enum": [ "MANUAL", "AUTOMATIC" ], "type": "string", "description": "* `MANUAL` - Вручную\n* `AUTOMATIC` - Автоматически" }, "CaseDuplicateNullEnum": { "enum": [ null ] }, "CustomerMessagingLanguageEnum": { "enum": [ "en", "es", "pt" ], "type": "string", "description": "* `en` - en\n* `es` - es\n* `pt` - pt" }, "CaseDuplicateCaseFraudSourceContextRequest": { "type": "object", "properties": { "check_id": { "type": "string", "format": "uuid" }, "request_id": { "type": "string", "format": "uuid" }, "source_section": { "type": "string", "minLength": 1, "pattern": "^[A-Z][A-Z0-9_:-]{0,63}$" } }, "required": [ "check_id", "request_id", "source_section" ] }, "FraudCheckPlannedModule": { "type": "object", "properties": { "module": { "$ref": "#/components/schemas/FraudExcludeEnum" }, "available": { "type": "boolean" }, "availability_reason": { "type": "string", "nullable": true }, "will_run": { "type": "boolean" }, "selection_reason": { "type": "string", "nullable": true }, "estimated_price": { "type": "string", "nullable": true } }, "required": [ "availability_reason", "available", "estimated_price", "module", "selection_reason", "will_run" ] }, "CustomerMessagingCaseRequestOptions": { "type": "object", "properties": { "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerMessagingCaseRequestContact" } }, "purposes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerMessagingPurposesEnum" } }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerMessagingLanguagesEnum" } } }, "required": [ "contacts", "languages", "purposes" ] }, "CaseCollaborationPaginatedCaseNoteList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?offset=400&limit=100" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?offset=200&limit=100" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseCollaborationCaseNote" } } } }, "FraudProcessingStatusEnum": { "enum": [ "pending", "running", "completed", "failed" ], "type": "string", "description": "* `pending` - В ожидании\n* `running` - Выполняется\n* `completed` - Завершено\n* `failed` - Не выполнено" }, "CasePublicationCaseBlueprint": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "maxLength": 24 }, "description": { "type": "string", "nullable": true }, "assignment_method": { "$ref": "#/components/schemas/CasePublicationAssignmentMethodEnum" }, "assignee_pool": {}, "max_active_cases": { "type": "integer", "maximum": 2147483647, "minimum": 0, "nullable": true }, "escalation_enabled": { "type": "boolean" }, "escalation_blueprint": { "type": "string", "format": "uuid", "nullable": true }, "escalation_blueprint_name": { "type": "string", "readOnly": true }, "transfer_enabled": { "type": "boolean" }, "four_eyes_checker_blueprint": { "type": "string", "format": "uuid", "nullable": true }, "four_eyes_checker_blueprint_name": { "type": "string", "readOnly": true }, "require_resolution_note": { "type": "boolean" }, "content_config": {}, "version": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "default_deadline_hours": { "type": "integer", "maximum": 2147483647, "minimum": 0, "nullable": true }, "is_active": { "type": "boolean" }, "preset_key": { "type": "string", "nullable": true, "maxLength": 64 }, "creation_sources": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "readOnly": true }, "receives_escalation_from": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "creation_sources", "escalation_blueprint_name", "four_eyes_checker_blueprint_name", "name", "receives_escalation_from", "updated_at", "uuid" ] }, "CaseRoutingRuleUpdate": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 500 }, "priority": { "type": "integer", "minimum": 0 }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/CaseRoutingCondition" }, "maxItems": 20 }, "required_skills": { "type": "array", "items": { "type": "string", "maxLength": 64 }, "maxItems": 25 }, "blueprint": { "type": "string", "format": "uuid" }, "team": { "type": "string", "format": "uuid", "nullable": true }, "is_active": { "type": "boolean" }, "expected_version": { "type": "integer", "minimum": 1, "writeOnly": true, "description": "Версия, открытая в редакторе. Если указана, устаревшие операции записи возвращают 409 без изменения правила." } } }, "CustomerMessagingCaseRequestPreviewRequest": { "type": "object", "properties": { "contact_id": { "type": "string", "format": "uuid" }, "purpose": { "$ref": "#/components/schemas/CustomerMessagingPurposeEnum" }, "language": { "allOf": [ { "$ref": "#/components/schemas/CustomerMessagingLanguageEnum" } ], "default": "en" } }, "required": [ "contact_id", "purpose" ] }, "CaseDuplicateCaseFraudSourceContext": { "type": "object", "properties": { "check_id": { "type": "string", "format": "uuid" }, "request_id": { "type": "string", "format": "uuid" }, "source_section": { "type": "string", "pattern": "^[A-Z][A-Z0-9_:-]{0,63}$" } }, "required": [ "check_id", "request_id", "source_section" ] }, "RoutingPublicationOperatorEnum": { "enum": [ "equals", "in", "contains" ], "type": "string", "description": "* `equals` - равно\n* `in` - входит в\n* `contains` - содержит" }, "CaseRoutingPreview": { "type": "object", "properties": { "rule_uuid": { "type": "string", "format": "uuid", "nullable": true }, "rule_name": { "type": "string", "nullable": true }, "rule_version": { "type": "integer", "nullable": true }, "blueprint_uuid": { "type": "string", "format": "uuid", "nullable": true }, "team_uuid": { "type": "string", "format": "uuid", "nullable": true }, "assignee_user_id": { "type": "string", "format": "uuid", "nullable": true }, "reason": { "type": "string" }, "candidates": { "type": "array", "items": { "type": "object", "properties": { "user_id": { "type": "string", "format": "uuid" }, "eligible": { "type": "boolean" }, "active_cases": { "type": "integer", "nullable": true }, "reason": { "type": "string", "nullable": true } } } }, "matched_rules": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "priority": { "type": "integer" } } } } } }, "FraudDimensionEnum": { "enum": [ "identity", "contact", "device_network", "behavioral", "fraud_network" ], "type": "string", "description": "* `identity` - Личность\n* `contact` - Контактные данные\n* `device_network` - Сеть и устройство\n* `behavioral` - Поведенческие факторы\n* `fraud_network` - Мошенническая сеть" }, "FraudBadRequestErrorMessage": { "type": "object", "properties": { "detail": { "type": "string", "default": "Bad Request - Invalid request data" } } }, "FraudNextActionEnum": { "enum": [ "none", "manual_review", "step_up", "resubmit_capture" ], "type": "string", "description": "* `none` - Нет\n* `manual_review` - Ручная проверка\n* `step_up` - Дополнительная проверка\n* `resubmit_capture` - Повторная отправка снимка" }, "RoutingPublicationPolicyDraftPreconditionRequest": { "type": "object", "properties": { "expected_version": { "type": "integer", "minimum": 0 }, "expected_revision": { "type": "string", "format": "uuid", "nullable": true } }, "required": [ "expected_revision", "expected_version" ] }, "FraudCheckRisk": { "type": "object", "properties": { "dimension": { "$ref": "#/components/schemas/FraudDimensionEnum" }, "score": { "type": "integer", "nullable": true }, "band": { "$ref": "#/components/schemas/FraudBandEnum" }, "availability": { "$ref": "#/components/schemas/FraudAvailabilityEnum" }, "requested_but_unavailable": { "type": "boolean", "description": "True, когда в запросе было передано всё необходимое для данного измерения, но платформа всё равно не смогла предоставить ответ. Такая проверка никогда не рекомендуется к одобрению только на основании тех измерений, по которым был получен ответ." }, "reason_codes": { "type": "array", "items": { "type": "string" } }, "evidence_indexes": { "type": "array", "items": { "type": "integer" } } }, "required": [ "availability", "band", "dimension", "evidence_indexes", "reason_codes", "requested_but_unavailable", "score" ] }, "CaseDuplicateSourceEnum": { "enum": [ "MANUAL", "AML_SCREENING", "TRANSACTION_RULE", "WORKFLOW_BUILDER" ], "type": "string", "description": "* `MANUAL` - Вручную\n* `AML_SCREENING` - AML-скрининг\n* `TRANSACTION_RULE` - Правило транзакции\n* `WORKFLOW_BUILDER` - Конструктор сценариев" }, "CaseCollaborationPatchedCaseNoteUpdateRequest": { "type": "object", "properties": { "is_pinned": { "type": "boolean" } } }, "CustomerMessagingPurposeEnum": { "enum": [ "identity_document", "proof_of_address", "business_document", "confirm_details", "review_in_progress" ], "type": "string", "description": "* `identity_document` - identity_document\n* `proof_of_address` - proof_of_address\n* `business_document` - business_document\n* `confirm_details` - confirm_details\n* `review_in_progress` - review_in_progress" }, "CaseDuplicateTypeEnum": { "enum": [ "user", "business" ], "type": "string", "description": "* `user` - user\n* `business` - business" }, "CaseCollaborationCaseNoteCreateRequest": { "type": "object", "properties": { "comment": { "type": "string", "minLength": 1, "maxLength": 10000 }, "reply_to": { "type": "string", "format": "uuid", "nullable": true }, "client_reference": { "type": "string", "format": "uuid", "nullable": true }, "mentioned_emails": { "type": "array", "items": { "type": "string", "format": "email", "minLength": 1 } }, "is_internal": { "type": "boolean", "default": false }, "attachments": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "comment" ] }, "CustomerMessagingLanguagesEnum": { "enum": [ "en", "es", "pt" ], "type": "string", "description": "* `en` - en\n* `es` - es\n* `pt` - pt" }, "CustomerMessagingCaseRequestConfirmRequest": { "type": "object", "properties": { "contact_id": { "type": "string", "format": "uuid" }, "purpose": { "$ref": "#/components/schemas/CustomerMessagingPurposeEnum" }, "language": { "allOf": [ { "$ref": "#/components/schemas/CustomerMessagingLanguageEnum" } ], "default": "en" }, "request_id": { "type": "string", "format": "uuid" }, "expires_at": { "type": "string", "format": "date-time" }, "preview_token": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": [ "contact_id", "expires_at", "preview_token", "purpose", "request_id" ] }, "CaseRoutingRule": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 500 }, "priority": { "type": "integer", "minimum": 0 }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/CaseRoutingCondition" }, "maxItems": 20 }, "required_skills": { "type": "array", "items": { "type": "string", "maxLength": 64 }, "maxItems": 25 }, "blueprint": { "type": "string", "format": "uuid" }, "team": { "type": "string", "format": "uuid", "nullable": true }, "is_active": { "type": "boolean" }, "uuid": { "type": "string", "format": "uuid", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true }, "version": { "type": "integer", "readOnly": true }, "blueprint_name": { "type": "string", "readOnly": true }, "team_name": { "type": "string", "nullable": true, "readOnly": true } } }, "FraudResultEnum": { "enum": [ "match", "mismatch", "inconclusive", "no_reference" ], "type": "string", "description": "* `match` - Совпадение\n* `mismatch` - Несовпадение\n* `inconclusive` - Неопределённый результат\n* `no_reference` - Нет эталонных данных" }, "CaseRoutingRuleCreate": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 500 }, "priority": { "type": "integer", "minimum": 0 }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/CaseRoutingCondition" }, "maxItems": 20 }, "required_skills": { "type": "array", "items": { "type": "string", "maxLength": 64 }, "maxItems": 25 }, "blueprint": { "type": "string", "format": "uuid" }, "team": { "type": "string", "format": "uuid", "nullable": true }, "is_active": { "type": "boolean" }, "publish": { "type": "boolean", "writeOnly": true, "description": "Укажите false, чтобы сохранить черновик, который никогда не публиковался. Запись остаётся неактивной в версии 0 до тех пор, пока черновик не будет явно опубликован. Если опустить это поле, сохранится немедленное создание для существующих интеграций." } }, "required": [ "name", "conditions", "blueprint" ] }, "FraudCheckIdentifierRequest": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/FraudTypeEnum" } ], "description": "Тип идентификатора. Определяет, какие поля пространства имён являются обязательными.\n\n* `email` - Электронная почта\n* `phone` - Телефон\n* `national_id` - Национальный идентификатор\n* `tax_number` - Налоговый номер\n* `passport_number` - Номер паспорта\n* `driving_licence_number` - Номер водительского удостоверения\n* `residence_permit_number` - Номер вида на жительство\n* `voter_id` - Идентификатор избирателя\n* `external_id` - Внешний идентификатор" }, "value": { "type": "string", "minLength": 1, "description": "Значение идентификатора в любом привычном формате.", "maxLength": 255 }, "country": { "type": "string", "description": "Страна выдачи в формате ISO-3166 alpha-2 или alpha-3. Обязательно для государственных идентификаторов: одинаковые цифры соответствуют разным людям в разных странах.", "maxLength": 3 }, "issuer": { "type": "string", "description": "Необязательный орган выдачи или субнациональный эмитент, если одной страны недостаточно для однозначной идентификации.", "maxLength": 128 } }, "required": [ "type", "value" ] }, "CaseActionActionEnum": { "enum": [ "set_status", "add_tags", "add_note", "add_to_blocklist" ], "type": "string", "description": "* `set_status` - set_status\n* `add_tags` - add_tags\n* `add_note` - add_note\n* `add_to_blocklist` - add_to_blocklist" }, "CaseActionCaseActionReceiptPage": { "type": "object", "properties": { "count": { "type": "integer" }, "next_offset": { "type": "integer", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseActionCaseActionReceipt" } } }, "required": [ "count", "next_offset", "results" ] }, "CaseActionCaseEntityActionResult": { "type": "object", "properties": { "receipt": { "$ref": "#/components/schemas/CaseActionCaseActionReceipt" }, "entity_type": { "$ref": "#/components/schemas/CaseActionEntityTypeEnum" }, "entity_uuid": { "type": "string", "format": "uuid" }, "action": { "type": "string" }, "previous_status": { "type": "string" }, "new_status": { "type": "string" }, "tags_added": { "type": "array", "items": { "type": "string" } }, "comment_uuid": { "type": "string", "format": "uuid" }, "blocklisted": { "type": "array", "items": { "type": "string" } } } }, "CustomerMessagingCaseRequest": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "readOnly": true }, "purpose": { "type": "string", "readOnly": true }, "language": { "type": "string", "readOnly": true }, "recipient": { "type": "string", "format": "email", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "readOnly": true }, "actor_email": { "type": "string", "format": "email", "readOnly": true, "nullable": true }, "delivery_status": { "type": "string", "readOnly": true }, "delivered_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "cancelled_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "responded_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "response": { "readOnly": true, "nullable": true }, "has_attachment": { "type": "boolean", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "actor_email", "cancelled_at", "created_at", "delivered_at", "delivery_status", "expires_at", "has_attachment", "language", "purpose", "recipient", "responded_at", "response", "uuid" ] }, "CustomerMessagingCaseRequestPublic": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "purpose": { "$ref": "#/components/schemas/CustomerMessagingPurposeEnum" }, "language": { "$ref": "#/components/schemas/CustomerMessagingLanguageEnum" }, "expires_at": { "type": "string", "format": "date-time" }, "responded_at": { "type": "string", "format": "date-time", "nullable": true }, "copy": { "type": "object", "additionalProperties": {} }, "organization_name": { "type": "string" }, "is_white_label": { "type": "boolean" }, "customization": { "type": "object", "additionalProperties": {}, "nullable": true } }, "required": [ "copy", "customization", "expires_at", "is_white_label", "language", "organization_name", "purpose", "request_id", "responded_at" ] }, "RoutingPublicationFieldEnum": { "enum": [ "source", "priority", "tags" ], "type": "string", "description": "* `source` - source\n* `priority` - priority\n* `tags` - tags" }, "RoutingPublicationCaseRoutingRule": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 500 }, "priority": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/RoutingPublicationRoutingCondition" } }, "required_skills": { "type": "array", "items": { "type": "string", "maxLength": 64 }, "maxItems": 25 }, "blueprint": { "type": "string", "format": "uuid" }, "blueprint_name": { "type": "string", "readOnly": true }, "team": { "type": "string", "format": "uuid", "nullable": true }, "team_name": { "type": "string", "readOnly": true }, "is_active": { "type": "boolean" }, "version": { "type": "integer", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "blueprint", "blueprint_name", "conditions", "created_at", "name", "team_name", "updated_at", "uuid", "version" ] }, "CaseActionStatusEnum": { "enum": [ "APPLIED", "FAILED" ], "type": "string", "description": "* `APPLIED` - Применено\n* `FAILED` - Не удалось" }, "FraudCheckModuleSelectionRequest": { "type": "object", "properties": { "include": { "type": "array", "items": { "$ref": "#/components/schemas/FraudExcludeEnum" } }, "exclude": { "type": "array", "items": { "$ref": "#/components/schemas/FraudExcludeEnum" } } } }, "SignatureField": { "type": "object", "description": "Поле для размещения в документе сессии: кто из подписантов его заполняет, как и где. Укажите либо позицию (`page`, `x`, `y`, `width` и `height`), либо `anchor`. Позиции представляют собой доли отображаемой страницы от её верхнего левого угла, округлённые до 4 десятичных знаков, и поле должно полностью помещаться в пределах страницы. Документ вмещает до 200 полей, а один подписант может иметь до 500 полей, и для каждой роли с полями в документе там требуется поле `signature` или `initials`. См. [Поля в документе](/ru/core-technology/electronic-signature/overview#поля-на-документе).", "required": [ "key", "type" ], "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$", "description": "Задаёт имя поля в результатах и в `sign.field_values`. Уникально в пределах документа." }, "type": { "type": "string", "enum": [ "signature", "initials", "full_name", "date_signed", "text", "checkbox", "email", "data" ], "description": "Что содержит поле. Подписант ставит свою принятую `signature` и `initials`, вводит `text`, отмечает `checkbox` и вводит `email`, если в сессии нет подтвержденной электронной почты. Didit заполняет `full_name` (подтвержденное имя), `date_signed` (дату подписания в часовом поясе подписанта), `data` (из `prefill`) и подтвержденный `email`, отображая их только для чтения. Тип для выбора даты отсутствует: используйте `text`." }, "role": { "type": "string", "enum": [ "verified_person", "legal_representative", "key_people" ], "description": "Кто заполняет поле (со значениями `signature_signer`). Шаг заполняет и подписывает только поля своего подписанта. По умолчанию используется подписант шага." }, "page": { "type": "integer", "minimum": 1, "description": "Номер страницы, от 1 до общего количества страниц документа. Для документа Word это страница сконвертированного PDF." }, "x": { "type": "number", "minimum": 0, "maximum": 1, "description": "Левый край, в виде доли ширины страницы." }, "y": { "type": "number", "minimum": 0, "maximum": 1, "description": "Верхний край в виде доли от высоты страницы." }, "width": { "type": "number", "minimum": 0.02, "maximum": 1, "description": "Ширина в виде доли от ширины страницы. Подпись имеет ширину не менее `0.12`." }, "height": { "type": "number", "minimum": 0.012, "maximum": 1, "description": "Высота в виде доли от высоты страницы. Высота подписи составляет не менее `0.035`." }, "anchor": { "$ref": "#/components/schemas/SignatureFieldAnchor" }, "required": { "type": "boolean", "description": "`signature` and `initials` are required unless you set `false`. `full_name`, `date_signed` and `data` are always required. The signer can't finish a document until its required fields have a value, and a required checkbox must be ticked." }, "label": { "type": "string", "minLength": 1, "maxLength": 80, "description": "Отображается подписывающему лицу и в результатах. По умолчанию определяется типом." }, "placeholder": { "type": "string", "nullable": true, "maxLength": 80, "description": "Только `text` и `email`." }, "validation": { "$ref": "#/components/schemas/SignatureFieldValidation" }, "prefill": { "type": "string", "nullable": true, "description": "Откуда поступает значение: `identity.full_name`, `identity.first_name`, `identity.last_name`, `identity.date_of_birth` (`DD/MM/YYYY`), `identity.nationality`, `identity.document_number`, `identity.document_type`, `identity.issuing_country`, `identity.address`, `contact.email`, `contact.phone`, `company.name`, `company.registration_number`, `company.address`, `company.country` (KYB), `session.vendor_data`, `metadata.` (ключ из `metadata` сессии) или `api.` (ключ из `sign.field_values`). Обязательно для `data`. `full_name` всегда использует `identity.full_name`, а `email` использует `contact.email`. Значения полей `data`, `full_name` и верифицированного `email` фиксируются в момент, когда подписант начинает подписание." }, "editable_when_prefilled": { "type": "boolean", "default": false, "description": "Только `text` и `email`: подписант может изменить предзаполненное значение." }, "checked_by_default": { "type": "boolean", "default": false, "description": "Только для `checkbox`: флажок изначально установлен." }, "date_format": { "type": "string", "enum": [ "DD/MM/YYYY", "MM/DD/YYYY", "YYYY-MM-DD", "D MMMM YYYY" ], "default": "DD/MM/YYYY", "description": "Только `date_signed`." } } }, "SessionSignDocument": { "type": "object", "required": [ "file_name", "content_base64" ], "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Название, отображаемое подписывающему лицу. По умолчанию `file_name`." }, "file_name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Имя файла, оканчивающееся на `.pdf` или `.docx`." }, "content_base64": { "type": "string", "format": "byte", "description": "Файл в кодировке base64. PDF-файл может иметь размер до 20 МБ и до 100 страниц, без пароля, скриптов или прикреплённых файлов. Файл Word (`.docx`) может иметь размер до 20 МБ и конвертируется в PDF во время выполнения запроса максимум за 25 секунд; к полученному PDF применяются те же ограничения. До 5 файлов Word за сессию. Файл Word с макросами, отслеживанием исправлений, ссылками на внешний контент или внедрёнными объектами отклоняется с ошибкой `signature_document_not_supported`, а для файла, который не удалось сконвертировать, возвращается `signature_document_conversion_failed`, в каждом случае с указанием `reason`." }, "fields": { "type": "array", "description": "Необязательные поля для размещения в этом документе, до 200. Номера страниц и координаты позиций относятся к PDF (или к сконвертированному PDF для файла Word). Без полей подписант просто читает документ и соглашается с ним.", "items": { "$ref": "#/components/schemas/SignatureField" }, "maxItems": 200 } } }, "SignatureResult": { "type": "object", "description": "Результат одного подписанта для одного шага электронной подписи. См. [отчёт об электронной подписи](/ru/core-technology/electronic-signature/report-electronic-signature).", "properties": { "id": { "type": "string", "format": "uuid", "description": "Передайте это значение как `signature_id`, чтобы скачать подтверждающие материалы этого подписанта или проверить его подпись." }, "node_id": { "type": "string", "description": "Шаг сценария, сформировавший его." }, "status": { "type": "string", "enum": [ "intro", "review", "code", "signing", "signed", "declined" ], "description": "Каков статус подписанта на этом шаге. Только значение `signed` означает, что документы подписаны." }, "verdict": { "type": "string", "enum": [ "Not Finished", "Approved", "In Review", "Declined" ], "description": "Результат шага. Предупреждение задаёт его через своё правило; пользовательские правила статуса применяются после." }, "level": { "type": "string", "enum": [ "simple", "aes", "qes" ], "description": "`simple` (по умолчанию) или `aes`. `qes` (квалифицированная электронная подпись, QES) является надстройкой, которая пока недоступна." }, "format": { "type": "string", "enum": [ "pdf", "pades" ], "description": "`pdf` для простой подписи (Simple), `pades` для усиленной (AES)." }, "profile": { "type": "string", "nullable": true, "description": "`PAdES-B-LT` после подписания усиленной подписью (AES), иначе null." }, "signer": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "Имя подписанта. Верифицировано (на основе одобренной верификации личности или сессии), за исключением уровня Simple без верифицированного имени сессии, где используется имя, введённое подписантом вручную, и оно не проверяется." }, "capacity": { "type": "string", "enum": [ "self", "company" ] }, "company": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true, "description": "Должность ключевого лица, как заявлено." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Структурированные роли ключевого лица, заявленные для компании." }, "identity_session_id": { "type": "string", "format": "uuid", "description": "KYC-сессия, верифицировавшая подписанта." } } }, "identity_used": { "type": "object", "description": "Подтверждённая личность, на которую опирается подпись. Пусто для простой подписи без подтверждённой личности.", "properties": { "session_id": { "type": "string", "format": "uuid" }, "kyc_id": { "type": "string", "format": "uuid", "nullable": true }, "verified": { "type": "boolean" }, "expected_name": { "type": "string", "nullable": true, "description": "Имя, которому должен был соответствовать подписант." } } }, "certificate": { "type": "object", "nullable": true, "description": "Сертификат, которым были подписаны документы. `null` до подписания и всегда `null` для простой подписи.", "properties": { "issuer": { "type": "string" }, "issued_to": { "type": "string" }, "serial": { "type": "string", "description": "Серийный номер, шестнадцатеричный." }, "valid_from": { "type": "string", "format": "date-time" }, "valid_until": { "type": "string", "format": "date-time" } } }, "confirmation": { "type": "object", "properties": { "channel": { "type": "string", "nullable": true, "enum": [ "email", "sms" ], "description": "`null` для простой подписи (Simple signature), у которой нет кода." }, "destination": { "type": "string", "nullable": true, "description": "Маскированный контакт, на который был отправлен код." }, "confirmed_at": { "type": "string", "format": "date-time", "nullable": true }, "attempts": { "type": "integer", "description": "Введённые коды, включая правильный." } } }, "timestamp": { "type": "object", "nullable": true, "description": "Метка времени RFC 3161 в подписи, выпущенная Didit. Имеет значение `null` до подписания и всегда `null` для простой подписи (Simple).", "properties": { "time": { "type": "string", "format": "date-time" }, "qualified": { "type": "boolean", "description": "Всегда `false` для AES." }, "valid": { "type": "boolean" } } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Документ в экземпляре этого подписанта. Используйте его для скачивания подписанного файла." }, "uuid": { "type": "string", "format": "uuid", "description": "То же, что и `id`." }, "title": { "type": "string" }, "file_name": { "type": "string" }, "pages": { "type": "integer", "description": "Подписанные страницы документа. Для Word это страницы сконвертированного PDF." }, "size_bytes": { "type": "integer" }, "sha256_original": { "type": "string", "description": "SHA-256 документа в том виде, в котором он был показан подписывающей стороне." }, "sha256_signed": { "type": "string", "nullable": true, "description": "SHA-256 подписанного PDF после подписания." }, "status": { "type": "string", "enum": [ "signed", "declined", "not_signed", "not_reached" ], "description": "`not_signed`: открыт, но не подписан. `not_reached`: ни разу не открывался." }, "opened_at": { "type": "string", "format": "date-time", "nullable": true }, "read_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Время, когда подписант дошёл до конца документа без полей, если этого требует шаг." }, "read_to_end": { "type": "boolean" }, "consented_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Время, когда подписант выразил согласие с документом без полей или заполнил поля документа с полями." }, "consent": { "type": "boolean" }, "signed_file": { "type": "string", "nullable": true, "description": "Путь к подписанному PDF после подписания. См. [Скачать подписанный документ](/ru/sessions-api/electronic-signature/download-signed-document)." }, "mode": { "type": "string", "enum": [ "fields", "read_and_agree" ], "description": "`fields` для документа с полями, `read_and_agree` для документа без них." }, "source_format": { "type": "string", "enum": [ "pdf", "docx" ], "description": "`pdf`, или `docx` для документа Word, который Didit конвертировал в PDF." }, "conversion": { "type": "object", "nullable": true, "description": "`null` для PDF. Для документа Word: исходный файл и конвертация.", "properties": { "from": { "type": "string", "enum": [ "docx" ] }, "file_name": { "type": "string", "description": "Исходное имя файла Word." }, "sha256": { "type": "string", "description": "SHA-256 вашего исходного файла Word." }, "size_bytes": { "type": "integer", "description": "Размер вашего исходного файла Word." }, "converter": { "type": "string", "description": "Версия конвертера, создавшего PDF." } } }, "fields": { "type": "array", "description": "Поля документа с их значениями. Пусто для документа без полей.", "items": { "$ref": "#/components/schemas/SignatureFieldResult" } } } } }, "adopted_signature": { "type": "object", "nullable": true, "description": "Подпись и инициалы, выбранные подписантом для полей подписи и инициалов. `null`, пока подписант их не примет.", "properties": { "method": { "type": "string", "enum": [ "typed", "drawn" ], "description": "`typed`: верифицированное имя в рукописном стиле. `drawn`: нарисовано пальцем или мышью." }, "font": { "type": "string", "nullable": true, "description": "Стиль рукописного шрифта для введенной подписи. `null`, если нарисована." }, "adopted_at": { "type": "string", "format": "date-time" } } }, "electronic_signature_consent_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Время, когда подписант на экране проверки согласился подписать документы в электронном виде. Устанавливается, если какой-либо документ содержит поля." }, "evidence_file": { "type": "string", "nullable": true, "description": "Путь к PDF-файлу с подтверждающими материалами после подписания. См. [Скачивание подтверждающих материалов подписи](/ru/sessions-api/electronic-signature/download-evidence)." }, "warnings": { "type": "array", "description": "Предупреждения, сформированные для этого подписанта. См. [Предупреждения электронной подписи](/ru/core-technology/electronic-signature/warnings-electronic-signature).", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "SIGNATURE_DECLINED", "SIGNATURE_OTP_FAILED", "SIGNATURE_NAME_MISMATCH", "SIGNATURE_IDENTITY_NOT_VERIFIED", "SIGNATURE_DOCUMENT_CHANGED", "SIGNATURE_FIELD_DATA_MISSING" ] }, "node_id": { "type": "string" } } } }, "validation": { "type": "object", "nullable": true, "description": "Последняя криптографическая проверка подписанных документов. `null` до момента подписания документов. Если Didit не может подтвердить результат подписания, возвращается `{\"valid\": null, \"reason\": \"signature_provider_outcome_unknown\", \"checked_at\": ...}`, а `status` остаётся `signing`: считайте документ неподписанным.", "properties": { "valid": { "type": "boolean", "nullable": true, "description": "`true`, когда каждый документ действителен. `null`, когда результат подписания не удалось подтвердить." }, "reason": { "type": "string", "description": "Задаётся, когда `valid` равен `null`: `signature_provider_outcome_unknown`." }, "checked_at": { "type": "string", "format": "date-time" }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "checked_at": { "type": "string", "format": "date-time" }, "valid": { "type": "boolean", "description": "`true`, если и подпись, и метка времени действительны и доверены." }, "integrity": { "type": "boolean", "description": "`true`, если документ не изменялся с момента подписания." }, "trusted": { "type": "boolean", "description": "`true`, если сертификат подписи восходит к доверенному корневому сертификату." }, "revoked": { "type": "boolean" }, "trusted_list": { "type": "object", "description": "Проверка по доверенному списку ЕС (EU Trusted List). Для AES: `{\"status\": \"not_applicable\", \"reason\": \"aes_not_qualified\"}`.", "properties": { "status": { "type": "string" }, "reason": { "type": "string" } } }, "certificate": { "type": "object", "nullable": true, "description": "Сертификат, которым были подписаны документы. `null` до подписания и всегда `null` для простой подписи.", "properties": { "issuer": { "type": "string" }, "issued_to": { "type": "string" }, "serial": { "type": "string", "description": "Серийный номер, шестнадцатеричный." }, "valid_from": { "type": "string", "format": "date-time" }, "valid_until": { "type": "string", "format": "date-time" } } }, "timestamp": { "type": "object", "nullable": true, "description": "Метка времени RFC 3161 в подписи, выпущенная Didit. Имеет значение `null` до подписания и всегда `null` для простой подписи (Simple).", "properties": { "time": { "type": "string", "format": "date-time" }, "qualified": { "type": "boolean", "description": "Всегда `false` для AES." }, "valid": { "type": "boolean" } } } } } } } }, "declined_at": { "type": "string", "format": "date-time", "nullable": true }, "declined_action": { "type": "string", "enum": [ "DECLINE", "REVIEW", "NO_ACTION" ] }, "signed_at": { "type": "string", "format": "date-time", "nullable": true }, "expires_at": { "type": "string", "format": "date-time", "description": "Время, когда ссылка для подписания перестает работать." }, "email_sent_at": { "type": "string", "format": "date-time", "nullable": true }, "email_unavailable_reason": { "type": "string", "nullable": true }, "ip_address": { "type": "string", "nullable": true, "description": "IP-адрес подписанта на момент запроса кода." }, "place": { "type": "string", "nullable": true, "description": "Не собирается: всегда `null`." }, "place_unavailable_reason": { "type": "string", "nullable": true, "enum": [ "not_collected" ] } } }, "SignatureFieldValidation": { "type": "object", "nullable": true, "description": "Правила для значения поля `text`. Предпросмотр в панели управления, процесс подписания и API применяют одни и те же правила.", "properties": { "kind": { "type": "string", "enum": [ "any", "letters", "number", "email", "pattern" ], "description": "`letters`: буквы в любой системе письма, пробелы, дефисы и апострофы. `number`: цифры с необязательным десятичным разделителем. `pattern`: значение должно соответствовать шаблону `pattern`." }, "min_length": { "type": "integer", "minimum": 0, "maximum": 500, "description": "От `0` до `max_length`." }, "max_length": { "type": "integer", "minimum": 1, "maximum": 500, "default": 120 }, "pattern": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 200, "description": "Обязательно при `kind: \"pattern\"`. Регулярное выражение, которому должно соответствовать значение целиком. Lookaround-проверки и обратные ссылки не поддерживаются." }, "message": { "type": "string", "nullable": true, "maxLength": 120, "description": "Отображается подписывающему лицу вместо стандартной ошибки." } } }, "SignatureFieldAnchor": { "type": "object", "description": "Размещает поле по фрагменту текста в документе вместо позиции. Didit не удаляет этот текст из PDF, поэтому задайте для него тот же цвет, что и у фона страницы. Если текст не найден, вызов возвращает `400` с `field_anchor_not_found`. См. [Размещение полей по якорному тексту](/ru/sessions-api/create-session#размещение-полей-по-тексту-якорю).", "required": [ "text" ], "properties": { "text": { "type": "string", "minLength": 1, "maxLength": 64, "description": "Текст, искомый в документе. Для файла Word поиск выполняется в преобразованном PDF." }, "occurrence": { "type": "string", "enum": [ "first", "all" ], "default": "first", "description": "`all` размещает по одному полю на каждое совпадение; ключи после первого получают суффиксы `_2`, `_3` и так далее." }, "offset_x": { "type": "number", "description": "Добавляется к левому краю текста в виде доли от ширины страницы." }, "offset_y": { "type": "number", "description": "Добавляется к верхнему краю текста в виде доли от высоты страницы." }, "width": { "type": "number", "minimum": 0.02, "maximum": 1, "description": "Ширина поля в виде доли от ширины страницы." }, "height": { "type": "number", "minimum": 0.012, "maximum": 1, "description": "Высота поля в виде доли от высоты страницы." } } }, "SignatureFieldResult": { "type": "object", "description": "Поле подписанного документа с его значением в экземпляре этого подписанта. См. [Поля](/ru/core-technology/electronic-signature/report-electronic-signature#поля).", "properties": { "key": { "type": "string", "description": "Ключ поля, используемый в `sign.field_values`." }, "type": { "type": "string", "enum": [ "signature", "initials", "full_name", "date_signed", "text", "checkbox", "email", "data" ] }, "role": { "type": "string", "enum": [ "verified_person", "legal_representative", "key_people" ] }, "label": { "type": "string" }, "page": { "type": "integer", "description": "Номер страницы, начиная с 1. Для документа Word это страница сконвертированного PDF." }, "x": { "type": "number", "description": "Левый край, в виде доли ширины страницы." }, "y": { "type": "number", "description": "Верхний край в виде доли от высоты страницы." }, "width": { "type": "number", "description": "Ширина в виде доли от ширины страницы." }, "height": { "type": "number", "description": "Высота в виде доли от высоты страницы." }, "required": { "type": "boolean" }, "value": { "nullable": true, "description": "Строка для `text`, `email`, `full_name`, `date_signed` и `data`, булево значение для `checkbox`, и `true` для проставленной подписи или инициалов. `null`, если поле пустое." }, "display_value": { "type": "string", "nullable": true, "description": "Значение в том виде, в каком оно проставлено на странице: даты в формате поля `date_format`, `Yes` или `No` для чекбокса, `Signed` для подписи или инициалов." }, "value_source": { "type": "string", "nullable": true, "enum": [ "signer", "identity", "contact", "company", "session", "metadata", "api", "signing_time", null ], "description": "Источник значения: `signer` (введено, отмечено или применено подписантом), `identity` (верифицированное удостоверение личности), `contact` (верифицированный email или телефон), `company` (верифицированная компания), `session` (`vendor_data`), `metadata`, `api` (`sign.field_values`) или `signing_time` (дата подписания)." }, "filled_at": { "type": "string", "format": "date-time", "nullable": true }, "image_url": { "type": "string", "nullable": true, "description": "Только для подписи и инициалов: путь к применённому изображению. См. [Скачивание изображения подписи](/ru/sessions-api/electronic-signature/download-field-image)." }, "value_unavailable_reason": { "type": "string", "nullable": true, "enum": [ "source_empty", null ], "description": "`source_empty`, когда предзаполненное поле не имело значения в сессии, а `signature_field_data_missing_action` разрешил подписанту всё равно поставить подпись." } } }, "VaspDirectoryWidgetEntry": { "type": "object", "description": "Что отображается в окне выбора VASP для конечного пользователя: какой это VASP и доступен ли он.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Идентификатор записи для GET /v3/travel-rule/vasps/{vasp_id}/." }, "kind": { "type": "string", "enum": [ "directory", "didit" ], "description": "directory для записи из общего каталога; didit для участника сети Didit." }, "name": { "type": "string" }, "lei": { "type": "string" }, "jurisdiction": { "type": "string", "description": "Код страны ISO 3166 в том виде, в котором его предоставляет источник." }, "domains": { "type": "array", "items": { "type": "string" }, "description": "Веб-домены VASP. Всегда пусто для участников сети Didit." }, "reachable": { "type": "boolean", "description": "Есть ли у вашего приложения доступный маршрут к этому VASP или к одному из его юридических лиц для бренда. Всегда true для участника сети Didit." } } }, "TravelRuleDataSharingFields": { "type": "object", "description": "Поля, которые Didit отправляет VASP контрагента о ваших пользователях, для каждого типа сущности. Поля `name` и `wallet_address` отправляются всегда, независимо от содержимого списка. Для типа сущности, который вы не настроили, передаются все поля. Пустой список тоже является выбором: в этом случае передаются только имя и кошелёк.", "properties": { "individual": { "type": "array", "items": { "type": "string", "enum": [ "name", "wallet_address", "address", "national_id", "customer_identification", "date_of_birth", "place_of_birth" ] }, "description": "Переданные поля физического лица." }, "company": { "type": "array", "items": { "type": "string", "enum": [ "name", "wallet_address", "address", "national_id", "customer_identification" ] }, "description": "Переданные поля юридического лица." } } }, "TravelRuleMatchingRules": { "type": "object", "description": "Насколько строго сравнивается каждое поле данных контрагента с имеющимися у вас данными в зависимости от типа субъекта. Поле, которое вы пропускаете, сохраняет значение по умолчанию. `NONE` пропускает сравнение, `STRICT` требует абсолютно одинаковых слов, `CONTAINS` допускает значение, все слова которого присутствуют в другом, `DEFAULT` выполняет стандартное сопоставление подмножеств, а `FUZZY` допускает близкое написание (а для дат рождения допускает перестановку дня и месяца).", "properties": { "individual": { "type": "object", "description": "Правила для физического лица.", "properties": { "name": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "По умолчанию: соответствует `name_matching_strictness`." }, "date_of_birth": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "По умолчанию `NONE`." }, "address": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "По умолчанию `NONE`." }, "account": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "Кошелёк, через который был маршрутизирован обмен. По умолчанию `STRICT`." } } }, "company": { "type": "object", "description": "Правила для юридического лица.", "properties": { "name": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "По умолчанию: соответствует `name_matching_strictness`." }, "address": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "По умолчанию `NONE`." }, "account": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "Кошелёк, через который был маршрутизирован обмен. По умолчанию `STRICT`." } } } } }, "TravelRuleDataMatch": { "type": "object", "nullable": true, "description": "Сравнение по каждому полю данных стороны перевода с тем, что известно другой стороне о владельце кошелька. Указывает поля и результаты, но никогда значения, сохраняя читаемость при маскировании данных контрагента. Имеет значение null до запуска сравнения.", "properties": { "matched": { "type": "boolean", "description": "True, когда ни одно из сравниваемых полей не отличается." }, "mismatched_fields": { "type": "array", "items": { "type": "string", "enum": [ "name", "date_of_birth", "address", "account" ] }, "description": "Поля, которые различаются." }, "fields": { "type": "object", "description": "Одна запись на каждое сравниваемое поле для типа стороны (`name`, `date_of_birth`, `address`, `account`; у компании нет поля `date_of_birth`).", "additionalProperties": { "type": "object", "properties": { "result": { "type": "string", "enum": [ "matched", "mismatched", "not_compared" ], "description": "`not_compared`, если правило имеет значение `NONE` или на одной из сторон отсутствует значение для поля." }, "strictness": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ] } } } } } }, "TravelRuleDataUnmasked": { "type": "object", "nullable": true, "description": "Запись аудита момента, когда данные контрагента были демаскированы. Имеет значение null, пока данные всё ещё замаскированы, а также для исходящих переводов.", "properties": { "at": { "type": "string", "format": "date-time" }, "reason": { "type": "string", "enum": [ "ownership_confirmed", "wallet_proof", "address_book_match", "own_verified_wallet", "inquiry_approved", "known_payment_method", "travel_address" ], "description": "Что подтвердило владение: ownership_confirmed (ваше подтверждение через консоль или API), wallet_proof (подтверждение кошелька в виджете или входящий перевод INTERNAL, устанавливается при его создании), address_book_match (верифицированный кошелёк из адресной книги), own_verified_wallet (собственный верифицированный кошелёк вашего пользователя), inquiry_approved (ваше одобрение входящего TRP-запроса или сообщения GTR либо Sygna), known_payment_method (кошелёк, с которого ваш пользователь уже совершал оплату) или travel_address (Travel Address конкретного кошелька, обозначающий этот кошелёк)." }, "actor": { "type": "string", "description": "Кто подтвердил решение: email пользователя консоли или метка API-ключа. Пусто для автоматического решения." } } }, "TravelRuleMessageAttachment": { "type": "object", "nullable": true, "description": "Документ, прикреплённый к сообщению, хранящийся как любой другой документ транзакции.", "properties": { "uuid": { "type": "string", "format": "uuid" }, "label": { "type": "string", "nullable": true }, "note": { "type": "string", "nullable": true }, "uploaded_by": { "type": "string", "nullable": true, "description": "Кто прикрепил файл. На портале получения для отправленного вами файла отображается название вашего VASP, но ни в коем случае не пользователь или API-ключ, стоящие за ним." }, "created_at": { "type": "string", "format": "date-time" }, "files": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "file_url": { "type": "string", "nullable": true, "description": "URL для скачивания с ограниченным сроком действия." }, "original_filename": { "type": "string" }, "file_size": { "type": "integer" } } } } } }, "TravelRuleMessage": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "MESSAGE", "DOCUMENT_REQUEST" ] }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "`OUTBOUND` означает то, что отправила сторона читателя. На портале получения направление указано со стороны контрагента." }, "author": { "type": "string", "description": "Кто создал запись со своей стороны: email пользователя консоли, метка API-ключа или название другого VASP." }, "body": { "type": "string" }, "requested_documents": { "type": "array", "items": { "type": "string" }, "description": "Что запрашивает DOCUMENT_REQUEST со слов автора запроса." }, "reply_to": { "type": "string", "format": "uuid", "nullable": true }, "fulfilled_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Устанавливается для DOCUMENT_REQUEST, как только ответ на него содержит документ." }, "attachment": { "$ref": "#/components/schemas/TravelRuleMessageAttachment" }, "created_at": { "type": "string", "format": "date-time" } } }, "TravelRuleMessageCreateRequest": { "type": "object", "description": "Отправьте в формате JSON или как multipart/form-data со вложениями в `files`.", "properties": { "kind": { "type": "string", "enum": [ "MESSAGE", "DOCUMENT_REQUEST" ], "default": "MESSAGE" }, "body": { "type": "string", "maxLength": 5000, "description": "Обязательно для MESSAGE, если не прикреплён файл." }, "requested_documents": { "type": "array", "items": { "type": "string", "maxLength": 255 }, "maxItems": 10, "description": "Обязательно (как минимум одно) для DOCUMENT_REQUEST и разрешено только там." }, "reply_to": { "type": "string", "format": "uuid", "nullable": true, "description": "Сообщение того же перевода. Ответ, содержащий документ, удовлетворяет запрос документа, на который отвечает." }, "files": { "type": "array", "items": { "type": "string", "format": "binary" }, "maxItems": 5, "description": "Только multipart. До 5 файлов размером до 10 МБ каждый." } } }, "SessionDeletionJob": { "type": "object", "description": "Массовое удаление сессий, выполняющееся в фоновом режиме: прогресс и количество по результатам, без указания того, какие именно сессии были удалены.", "properties": { "job_id": { "type": "string", "format": "uuid", "description": "Опрашивайте `GET /v3/sessions/delete/{job_id}/` с этим id." }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "COMPLETED", "FAILED" ], "description": "`PENDING`: принято, ещё не запущено. `PROCESSING`: удаление; `processed` и `outcomes` обновляются. `COMPLETED`: учтена каждая выбранная сессия. `FAILED`: задача завершилась досрочно; см. `error`." }, "total": { "type": "integer", "description": "Сессии, выбранные при запросе удаления." }, "processed": { "type": "integer", "description": "Сессии, обработку которых задание завершило к настоящему моменту." }, "outcomes": { "type": "object", "description": "Сколько сессий завершилось с каждым из исходов. Все ключи присутствуют всегда.", "properties": { "deleted": { "type": "integer", "description": "Сессии, удалённые вместе с их эмбеддингом лица." }, "none": { "type": "integer", "description": "Удалённые сессии, не содержавшие эмбеддинг лица." }, "retained_with_user": { "type": "integer", "description": "Сессии, удалённые с сохранением одного биометрического шаблона без изображения для их пользователя в соответствии с запросом или политикой приложения." }, "ineligible_no_vendor_user": { "type": "integer", "description": "Сессии, удалённые вместе с их эмбеддингом лица из-за того, что было запрошено сохранение, но у них не было привязанного пользователя." }, "failed_retryable": { "type": "integer", "description": "Сессии, о которых сообщено как о неудалённых. Задание повторно пытается удалить группу, которую ему не удалось удалить самостоятельно, вместо того чтобы учитывать её здесь." }, "already_deleted": { "type": "integer", "description": "Выбранные сессии, которые уже были удалены, например другим запросом, когда задача дошла до них." } } }, "deleted_child_verifications": { "type": "integer", "description": "Верификации, созданные удалёнными верификациями бизнеса, удалённые вместе с ними. Всегда `0` для задачи, запущенной через `POST /v3/sessions/delete/`, которая удаляет только сессии KYC." }, "error": { "type": "string", "nullable": true, "description": "`null`, если `status` не равен `FAILED`; в противном случае указана причина остановки удаления. Сессии, до которых задание не дошло, остаются на месте: повторите запрос, чтобы удалить их." }, "created_at": { "type": "string", "format": "date-time", "description": "Когда было запрошено удаление." }, "completed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Время завершения задачи; `null` во время выполнения." } } }, "EntityStatusUpdateRequest": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "description": "Новый статус жизненного цикла. `BLOCKED` также добавляет `vendor_data` в системный список блокировки." } } }, "AMLMonitoringToggleResult": { "oneOf": [ { "type": "object", "required": [ "users_total", "already_enabled", "with_existing_aml", "needing_screening", "skipped_no_identity_data", "skipped_blocked", "estimated_screening_cost_usd", "estimated_annual_monitoring_cost_usd", "balance_sufficient", "unmatched" ], "description": "Предварительный расчёт стоимости. Возвращается напрямую, если estimate_only имеет значение true (ничего не записывается).", "properties": { "users_total": { "type": "integer", "description": "Профили, соответствующие выборке." }, "already_enabled": { "type": "integer", "description": "Профили, которые уже находятся на мониторинге (при включении действий не требуется; это профили, которые отключаются при деактивации)." }, "with_existing_aml": { "type": "integer", "description": "Профили, для которых существующий AML-скрининг будет переведён в статус постоянного мониторинга (новый скрининг не проводится)." }, "needing_screening": { "type": "integer", "description": "Профили без AML-скрининга, для которых скрининг будет проведён впервые (оплачивается как обычный AML-скрининг)." }, "skipped_no_identity_data": { "type": "integer", "description": "Профили, для которых невозможно провести скрининг из-за отсутствия идентификационных данных." }, "skipped_blocked": { "type": "integer", "description": "Заблокированные пользователи, которые будут пропущены (всегда 0 для компаний)." }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2, "description": "Разовая стоимость новых проверок." }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07, "description": "Ежегодная стоимость мониторинга профилей, которые будут отслеживаться." }, "balance_sufficient": { "type": "boolean", "description": "Покрывает ли баланс организации скрининг плюс первый год мониторинга." }, "unmatched": { "type": "array", "items": { "type": "string" }, "description": "Идентификаторы из запроса, которым не подошёл ни один профиль в этом приложении, в точности так, как они были отправлены." } } }, { "type": "object", "required": [ "job_id", "status", "is_enabled", "target_type", "total", "processed", "outcomes", "results", "error", "created_at", "completed_at", "estimate", "unmatched" ], "properties": { "job_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "COMPLETED", "FAILED" ] }, "is_enabled": { "type": "boolean", "description": "true, если задача включает мониторинг; false, если отключает его." }, "target_type": { "type": "string", "enum": [ "user", "business" ], "description": "Какое семейство профилей переключает задача." }, "total": { "type": "integer", "description": "Профили, обрабатываемые задачей." }, "processed": { "type": "integer", "description": "Профили, обработанные к настоящему моменту." }, "outcomes": { "type": "object", "description": "Счётчики результатов по записям. Каждый выбранный профиль относится ровно к одному счётчику; ничто не пропускается незаметно.", "properties": { "enabled": { "type": "integer", "description": "Мониторинг включен для существующего AML-скрининга." }, "screened_and_enabled": { "type": "integer", "description": "Новый AML-скрининг был создан (списана оплата) и на нём включён мониторинг." }, "already_enabled": { "type": "integer", "description": "Мониторинг уже был активен; ничего не изменилось, средства не списывались." }, "disabled": { "type": "integer", "description": "Мониторинг отключен для каждого AML-скрининга профиля." }, "skipped_no_identity_data": { "type": "integer", "description": "Пропущено: в профиле отсутствуют полное имя, дата рождения и страна (для пользователей) или наименование (для компаний), необходимые для проведения проверки." }, "skipped_blocked": { "type": "integer", "description": "Пропущено: пользователь заблокирован." }, "skipped_sandbox": { "type": "integer", "description": "Пропущено: приложение песочницы, скрининг не создается." }, "failed_provider": { "type": "integer", "description": "Скрининг не удалось завершить; повторите попытку позже." }, "failed_insufficient_balance": { "type": "integer", "description": "Баланс исчерпан во время выполнения задания." } } }, "results": { "type": "array", "description": "Одна запись на каждый обработанный профиль в порядке обработки. Пополняется во время выполнения задания; заполняется полностью после перехода статуса в COMPLETED. Фиксируется для заданий, запущенных через API.", "items": { "type": "object", "properties": { "didit_internal_id": { "type": "string", "format": "uuid", "description": "Внутренний идентификатор профиля в Didit." }, "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный идентификатор профиля." }, "outcome": { "type": "string", "enum": [ "enabled", "screened_and_enabled", "already_enabled", "disabled", "skipped_no_identity_data", "skipped_blocked", "skipped_sandbox", "failed_provider", "failed_insufficient_balance" ] } } } }, "error": { "type": "string", "nullable": true, "description": "Общее сообщение об ошибке, когда статус FAILED; подробная причина сохраняется на стороне платформы." }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time", "nullable": true }, "estimate": { "type": "object", "description": "Предварительный расчёт стоимости. Возвращается напрямую, если estimate_only имеет значение true (ничего не записывается).", "properties": { "users_total": { "type": "integer", "description": "Профили, соответствующие выборке." }, "already_enabled": { "type": "integer", "description": "Профили, которые уже находятся на мониторинге (при включении действий не требуется; это профили, которые отключаются при деактивации)." }, "with_existing_aml": { "type": "integer", "description": "Профили, для которых существующий AML-скрининг будет переведён в статус постоянного мониторинга (новый скрининг не проводится)." }, "needing_screening": { "type": "integer", "description": "Профили без AML-скрининга, для которых скрининг будет проведён впервые (оплачивается как обычный AML-скрининг)." }, "skipped_no_identity_data": { "type": "integer", "description": "Профили, для которых невозможно провести скрининг из-за отсутствия идентификационных данных." }, "skipped_blocked": { "type": "integer", "description": "Заблокированные пользователи, которые будут пропущены (всегда 0 для компаний)." }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2, "description": "Разовая стоимость новых проверок." }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07, "description": "Ежегодная стоимость мониторинга профилей, которые будут отслеживаться." }, "balance_sufficient": { "type": "boolean", "description": "Покрывает ли баланс организации скрининг плюс первый год мониторинга." } } }, "unmatched": { "type": "array", "items": { "type": "string" }, "description": "Идентификаторы из запроса, которым не подошёл ни один профиль в этом приложении, в точности так, как они были отправлены. Они не являются частью задачи." } } } ] }, "AMLMonitoringJob": { "type": "object", "properties": { "job_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "COMPLETED", "FAILED" ] }, "is_enabled": { "type": "boolean", "description": "true, если задача включает мониторинг; false, если отключает его." }, "target_type": { "type": "string", "enum": [ "user", "business" ], "description": "Какое семейство профилей переключает задача." }, "total": { "type": "integer", "description": "Профили, обрабатываемые задачей." }, "processed": { "type": "integer", "description": "Профили, обработанные к настоящему моменту." }, "outcomes": { "type": "object", "description": "Счётчики результатов по записям. Каждый выбранный профиль относится ровно к одному счётчику; ничто не пропускается незаметно.", "properties": { "enabled": { "type": "integer", "description": "Мониторинг включен для существующего AML-скрининга." }, "screened_and_enabled": { "type": "integer", "description": "Новый AML-скрининг был создан (списана оплата) и на нём включён мониторинг." }, "already_enabled": { "type": "integer", "description": "Мониторинг уже был активен; ничего не изменилось, средства не списывались." }, "disabled": { "type": "integer", "description": "Мониторинг отключен для каждого AML-скрининга профиля." }, "skipped_no_identity_data": { "type": "integer", "description": "Пропущено: в профиле отсутствуют полное имя, дата рождения и страна (для пользователей) или наименование (для компаний), необходимые для проведения проверки." }, "skipped_blocked": { "type": "integer", "description": "Пропущено: пользователь заблокирован." }, "skipped_sandbox": { "type": "integer", "description": "Пропущено: приложение песочницы, скрининг не создается." }, "failed_provider": { "type": "integer", "description": "Скрининг не удалось завершить; повторите попытку позже." }, "failed_insufficient_balance": { "type": "integer", "description": "Баланс исчерпан во время выполнения задания." } } }, "results": { "type": "array", "description": "Одна запись на каждый обработанный профиль в порядке обработки. Пополняется во время выполнения задания; заполняется полностью после перехода статуса в COMPLETED. Фиксируется для заданий, запущенных через API.", "items": { "type": "object", "properties": { "didit_internal_id": { "type": "string", "format": "uuid", "description": "Внутренний идентификатор профиля в Didit." }, "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный идентификатор профиля." }, "outcome": { "type": "string", "enum": [ "enabled", "screened_and_enabled", "already_enabled", "disabled", "skipped_no_identity_data", "skipped_blocked", "skipped_sandbox", "failed_provider", "failed_insufficient_balance" ] } } } }, "error": { "type": "string", "nullable": true, "description": "Общее сообщение об ошибке, когда статус FAILED; подробная причина сохраняется на стороне платформы." }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time", "nullable": true }, "estimate": { "type": "object", "description": "Предварительный расчёт стоимости. Возвращается напрямую, если estimate_only имеет значение true (ничего не записывается).", "properties": { "users_total": { "type": "integer", "description": "Профили, соответствующие выборке." }, "already_enabled": { "type": "integer", "description": "Профили, которые уже находятся на мониторинге (при включении действий не требуется; это профили, которые отключаются при деактивации)." }, "with_existing_aml": { "type": "integer", "description": "Профили, для которых существующий AML-скрининг будет переведён в статус постоянного мониторинга (новый скрининг не проводится)." }, "needing_screening": { "type": "integer", "description": "Профили без AML-скрининга, для которых скрининг будет проведён впервые (оплачивается как обычный AML-скрининг)." }, "skipped_no_identity_data": { "type": "integer", "description": "Профили, для которых невозможно провести скрининг из-за отсутствия идентификационных данных." }, "skipped_blocked": { "type": "integer", "description": "Заблокированные пользователи, которые будут пропущены (всегда 0 для компаний)." }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2, "description": "Разовая стоимость новых проверок." }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07, "description": "Ежегодная стоимость мониторинга профилей, которые будут отслеживаться." }, "balance_sufficient": { "type": "boolean", "description": "Покрывает ли баланс организации скрининг плюс первый год мониторинга." } } }, "unmatched": { "type": "array", "items": { "type": "string" }, "description": "Идентификаторы из запроса, которым не подошёл ни один профиль в этом приложении, в точности так, как они были отправлены. Они не являются частью задачи." } } }, "OngoingMonitoringToggleRequest": { "type": "object", "required": [ "is_enabled" ], "properties": { "is_enabled": { "type": "boolean", "description": "true для включения мониторинга, false для его отключения." }, "estimate_only": { "type": "boolean", "default": false, "description": "Если true, возвращает предварительную оценку стоимости и не выполняет операций записи." }, "update_all": { "type": "boolean", "default": false, "description": "Применить ко всем сущностям приложения (с учётом параметров filter_*, если они переданы)." }, "filter_search": { "type": "string" }, "filter_status": { "type": "array", "items": { "type": "string" } }, "filter_country": { "type": "string" }, "filter_date_from": { "type": "string", "format": "date" }, "filter_date_to": { "type": "string", "format": "date" }, "didit_internal_id_list": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Сущности для переключения. Обязательно, если update_all не равен true." } } }, "OngoingMonitoringJob": { "type": "object", "properties": { "job_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "COMPLETED", "FAILED" ] }, "is_enabled": { "type": "boolean" }, "total": { "type": "integer" }, "processed": { "type": "integer" }, "outcomes": { "type": "object", "description": "Счётчики результатов по каждой сущности. Ничто не пропускается незаметно: каждая запрошенная сущность относится ровно к одному счётчику.", "properties": { "enabled": { "type": "integer", "description": "Мониторинг включен для существующего AML-скрининга." }, "screened_and_enabled": { "type": "integer", "description": "Новый AML-скрининг был создан (списана оплата) и мониторинг включён." }, "already_enabled": { "type": "integer", "description": "Мониторинг уже был активен (устаревшие дублирующиеся записи объединены)." }, "disabled": { "type": "integer", "description": "Мониторинг отключен для каждой AML-записи сущности." }, "skipped_no_identity_data": { "type": "integer", "description": "Пропущено: отсутствуют полное имя, дата рождения и страна для проведения проверки." }, "skipped_blocked": { "type": "integer", "description": "Пропущено: пользователь заблокирован." }, "skipped_sandbox": { "type": "integer", "description": "Пропущено: приложение песочницы." }, "failed_provider": { "type": "integer", "description": "Вызов провайдера скрининга завершился сбоем." }, "failed_insufficient_balance": { "type": "integer", "description": "Баланс исчерпан во время выполнения задания." } } }, "error": { "type": "string", "nullable": true }, "estimate": { "type": "object", "description": "Предварительный расчёт стоимости. Возвращается напрямую, если estimate_only имеет значение true (запись не выполняется).", "properties": { "users_total": { "type": "integer", "description": "Сущности в выборке." }, "already_enabled": { "type": "integer" }, "with_existing_aml": { "type": "integer", "description": "Сущности, чей существующий AML-скрининг будет переведен в режим мониторинга." }, "needing_screening": { "type": "integer", "description": "Сущности без какого-либо AML-скрининга, которые будут подвергнуты AML-скринингу в первую очередь (тарифицируются)." }, "skipped_no_identity_data": { "type": "integer" }, "skipped_blocked": { "type": "integer" }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2 }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07 }, "balance_sufficient": { "type": "boolean" } } } } }, "OngoingMonitoringToggleResult": { "oneOf": [ { "type": "object", "description": "Предварительный расчёт стоимости. Возвращается напрямую, если estimate_only имеет значение true (запись не выполняется).", "properties": { "users_total": { "type": "integer", "description": "Сущности в выборке." }, "already_enabled": { "type": "integer" }, "with_existing_aml": { "type": "integer", "description": "Сущности, чей существующий AML-скрининг будет переведен в режим мониторинга." }, "needing_screening": { "type": "integer", "description": "Сущности без какого-либо AML-скрининга, которые будут подвергнуты AML-скринингу в первую очередь (тарифицируются)." }, "skipped_no_identity_data": { "type": "integer" }, "skipped_blocked": { "type": "integer" }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2 }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07 }, "balance_sufficient": { "type": "boolean" } } }, { "$ref": "#/components/schemas/OngoingMonitoringJob" } ] }, "CaseBlueprintPresetInstallResult": { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "string" } } } }, "CaseBulkUpdateResult": { "type": "object", "properties": { "updated": { "type": "integer" }, "failures": { "type": "array", "items": { "type": "object", "properties": { "case_uuid": { "type": "string", "format": "uuid" }, "detail": { "type": "string" } } } } } }, "RegulatoryReportList": { "type": "object", "properties": { "count": { "type": "integer", "description": "Количество подходящих строк, ограниченное 100 для повышения производительности." }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/RegulatoryReportDetail" } } } }, "EntityNetworkMembershipList": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/EntityNetworkMembership" } } } }, "SessionDecision": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "Уникальный идентификатор сессии." }, "session_kind": { "type": "string", "enum": [ "user", "business" ], "description": "Дискриминатор, указывающий, является ли эта сессия сессией проверки пользователей (KYC) или верификации бизнеса (KYB). При значении `user` применяются массивы функций KYC (`id_verifications`, `nfc_verifications`, `liveness_checks`, `face_matches`, `poa_verifications`, `document_ai_documents`, `database_validations`, ...), а массивы для бизнеса отсутствуют. При значении `business` payload вместо этого содержит `registry_checks`, `document_verifications`, `key_people_checks`, а также общие массивы (`aml_screenings`, `phone_verifications`, `email_verifications`, `ip_analyses`, `questionnaire_responses`). **Опускается при передаче `include=events`** — формат событий существует только для сессий пользователей, поэтому дискриминатор удаляется из этого варианта." }, "shared_from_session": { "type": "string", "format": "uuid", "nullable": true, "description": "Для сессии, клонированной с помощью `POST /v3/session/import-shared/`: `session_id` исходной сессии в исходном приложении. `null` для всех остальных сессий. Опускается при передаче `include=events`." }, "shared_from_session_number": { "type": "integer", "nullable": true, "description": "`session_number` исходной сессии, если эта сессия была импортирована из другого приложения вашей организации. В противном случае `null`." }, "session_number": { "type": "integer", "description": "Номер сессии.", "nullable": true }, "session_url": { "type": "string", "format": "uri", "description": "URL сессии.", "nullable": true }, "status": { "type": "string", "enum": [ "Not Started", "In Progress", "Awaiting User", "In Review", "Approved", "Declined", "Resubmitted", "Expired", "Kyc Expired", "Abandoned" ], "description": "Общий статус жизненного цикла сессии — суммарный результат сценария. Конечные значения: `Approved`, `Declined`, `In Review`, `Expired`, `Kyc Expired` и `Abandoned`; статусы `Not Started`, `In Progress`, `Awaiting User` и `Resubmitted` указывают на то, что сессия всё ещё проходит сценарий." }, "status_override": { "type": "object", "nullable": true, "description": "Присутствует, если проверяющий установил `status` вручную. `null`, когда статус был присвоен автоматически. Используйте это поле, чтобы отличить ручное одобрение от автоматического.", "properties": { "overridden_at": { "type": "string", "format": "date-time", "nullable": true }, "automatic_status": { "type": "string", "nullable": true, "description": "Статус по результатам собственных проверок платформы." } } }, "decision_trace": { "type": "object", "description": "Как был получен статус: кто его установил и какие предупреждения к этому привели.", "properties": { "status": { "type": "string", "description": "Статус сессии." }, "decided_by": { "type": "string", "nullable": true, "enum": [ "manual", "automatic", "investigator", null ], "description": "Кто установил статус. `null`, пока решение по сессии не принято." }, "decided_at": { "type": "string", "format": "date-time", "nullable": true }, "automatic_status": { "type": "string", "nullable": true, "description": "К какому выводу пришли собственные проверки платформы; отличается от `status` после ручного решения." }, "terminal_node_id": { "type": "string", "nullable": true, "description": "Узел статуса сценария, завершивший сессию, если таковой был." }, "actor": { "type": "object", "nullable": true, "description": "Проверяющий, принявший ручное решение.", "properties": { "user": { "type": "string", "nullable": true }, "actor_type": { "type": "string", "nullable": true } } }, "warning_counts": { "type": "object", "description": "Предупреждения по `log_type` (`error`, `warning`, `information`) и `total`.", "additionalProperties": { "type": "integer" } }, "status_warnings": { "type": "array", "description": "Предупреждения, установившие статус `Declined` или `In Review`.", "items": { "type": "object", "properties": { "risk": { "type": "string" }, "feature": { "type": "string", "nullable": true }, "node_id": { "type": "string", "nullable": true }, "log_type": { "type": "string", "nullable": true }, "check_status": { "type": "string", "nullable": true }, "source": { "type": "string", "description": "Список в payload, из которого поступило предупреждение, например `id_verifications`." }, "short_description": { "type": "string", "nullable": true } } } } } }, "linked_records": { "type": "object", "nullable": true, "description": "Сводка других записей, связанных с сессией. `null`, если отображать нечего, а также для сценариев, декларирующих стандарт подтверждения возраста.", "properties": { "same_face": { "type": "object", "nullable": true, "description": "Другие люди, чьи лица совпали в рамках одного из поисков по лицу в этой сессии.", "properties": { "count": { "type": "integer" }, "best_match": { "type": "object", "nullable": true, "properties": { "session_id": { "type": "string", "format": "uuid", "nullable": true }, "session_number": { "type": "integer", "nullable": true }, "vendor_user_id": { "type": "string", "format": "uuid", "nullable": true }, "similarity_percentage": { "type": "number", "nullable": true } } } } }, "earlier_verifications": { "type": "object", "nullable": true, "properties": { "count": { "type": "integer" }, "vendor_user_id": { "type": "string", "format": "uuid", "nullable": true } } }, "networks": { "type": "object", "nullable": true, "properties": { "count": { "type": "integer" }, "open": { "type": "integer" }, "dismissed": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "network_id": { "type": "string", "format": "uuid" }, "display_number": { "type": "integer", "nullable": true }, "name": { "type": "string" }, "status": { "type": "string" }, "risk_score": { "type": "number", "nullable": true } } } } } } } }, "workflow_id": { "type": "string", "format": "uuid", "description": "Постоянный идентификатор группы сценариев, создавшей эту сессию. Сценарии версионируются — это значение определяет сам сценарий, а не конкретную версию.", "nullable": true }, "features": { "type": "array", "items": { "type": "string", "description": "Функция сессии." }, "description": "Список функций верификации, настроенных для этой сессии, в виде отображаемых имён: `ID_VERIFICATION`, `NFC`, `LIVENESS`, `FACE_MATCH`, `POA`, `PHONE`, `EMAIL_VERIFICATION`, `AML`, `IP_ANALYSIS`, `DATABASE_VALIDATION`, `QUESTIONNAIRE`, `AGE_ESTIMATION`, `FACE_SEARCH`, `GEOLOCATION` (проверка местоположения) (сессии Верификации бизнеса используют набор функций KYB: `KYB_REGISTRY`, `KYB_DOCUMENTS`, `KYB_KEY_PEOPLE`, `AML`, `PHONE`, `EMAIL_VERIFICATION`, `IP_ANALYSIS`, `QUESTIONNAIRE`). При `include=events` каждая запись становится объектом `{feature, node_id}` вместо простой строки, а функция электронной почты переименовывается: в режиме событий она отображается как `EMAIL` вместо используемого здесь `EMAIL_VERIFICATION`." }, "vendor_data": { "type": "string", "description": "Данные вендора сессии.", "nullable": true }, "metadata": { "type": "object", "description": "Метаданные сессии.", "nullable": true }, "expected_details": { "type": "object", "description": "Ожидаемые данные, переданные при создании сессии — используются для перекрёстной проверки с извлечёнными данными (KYC) или для автозаполнения поиска в реестре компаний (KYB). Возвращает в точности те ключи, которые были предоставлены; `null`, если данные не передавались. Сессии KYC содержат поля физического лица; сессии верификации бизнеса (KYB) содержат `company_name`, `registry_country` и `registration_number`.", "properties": { "first_name": { "type": "string", "description": "Имя пользователя. Например, `John`." }, "last_name": { "type": "string", "description": "Фамилия пользователя. Например, `Doe`." }, "date_of_birth": { "type": "string", "format": "date", "description": "Дата рождения пользователя в формате YYYY-MM-DD. Например, `1990-05-15`." }, "gender": { "type": "string", "nullable": true, "enum": [ "M", "F" ], "default": null, "description": "Пол пользователя. Должен быть 'M', 'F' или null." }, "nationality": { "type": "string", "description": "Код страны по стандарту ISO 3166-1 alpha-3, представляющий страну происхождения заявителя. Например, `USA`." }, "country": { "type": "string", "description": "Код страны по стандарту ISO 3166-1 alpha-3, представляющий страну документа подтверждения адреса или страну документа, удостоверяющего личность заявителя, которая может отличаться от гражданства. Например, `GBR`." }, "address": { "type": "string", "description": "Адрес в удобочитаемом для человека формате, содержащий как можно больше информации. Например, `123 Main St, San Francisco, CA 94105, USA`." }, "identification_number": { "type": "string", "description": "Номер документа, личный номер или налоговый номер пользователя. Например, `123456789`." }, "ip_address": { "type": "string", "format": "ipv4", "description": "Ожидаемый IP-адрес для сессии. Если фактический IP-адрес отличается от этого значения, в журнал будет записано предупреждение. Например, `192.168.1.100`." }, "expected_document_types": { "type": "array", "description": "Типы документов, которыми был ограничен шаг верификации личности при создании сессии. Пустое или незаданное значение означает отсутствие ограничений. Коды: `P` (паспорт), `ID` (национальное удостоверение личности), `DL` (водительские права), `RP` (вид на жительство), `HIC` (медицинская страховая карта), `TC` (налоговая карта), `SSC` (карта социального страхования).", "items": { "type": "string", "enum": [ "P", "ID", "DL", "RP", "HIC", "TC", "SSC" ] } }, "id_country": { "type": "string", "nullable": true, "description": "Ожидаемая страна выдачи документа, удостоверяющего личность (ISO 3166-1 alpha-3), если она была ограничена при создании.", "example": "ESP" }, "poa_country": { "type": "string", "nullable": true, "description": "Ожидаемая страна документа «Подтверждение адреса» (ISO 3166-1 alpha-3), если она была ограничена при создании.", "example": "ESP" }, "company_name": { "type": "string", "description": "Ожидаемое юридическое наименование компании. Только для сессий верификации бизнеса (KYB)." }, "registry_country": { "type": "string", "description": "Ожидаемая страна реестра в формате `XX` или `XX-YY` (ISO 3166-1 alpha-2, при необходимости с подразделом ISO 3166-2 для реестров уровня штата/региона, например `US-CA`). Только для сессий верификации бизнеса (KYB)." }, "registration_number": { "type": "string", "description": "Ожидаемый регистрационный номер компании. Только для сессий верификации бизнеса (KYB)." } }, "nullable": true }, "contact_details": { "type": "object", "description": "Контактные данные, указанные при создании сессии (используются для уведомлений по email, предзаполненной проверки телефона/email и выбора языка коммуникации). Равно `null`, если не были указаны ни email, ни номер телефона.", "properties": { "email": { "type": "string", "description": "Адрес электронной почты пользователя (например, \"john.doe@example.com\"), который будет использоваться на шаге «Проверка электронной почты». Если не указан, пользователь должен ввести его в процессе верификации." }, "email_lang": { "type": "string", "description": "Код языка (ISO 639-1) для email-уведомлений. Определяет язык всех сообщений по электронной почте (например, «en», «es», «fr»)." }, "send_notification_emails": { "type": "boolean", "default": false, "description": "Если true и указан адрес электронной почты, Didit асинхронно отправляет начальное письмо «Подтвердите вашу личность» при создании сессии Проверки пользователей (KYC) или Верификации бизнеса (KYB). Didit также отправляет уведомления о статусе верификации для сессий, требующих ручной проверки, на указанный адрес электронной почты." }, "phone": { "type": "string", "nullable": true, "description": "Номер телефона пользователя в формате E.164 при наличии (например, +14155552671). Возвращает `null`, если при создании сессии был указан только email. Примечание: это поле возвращает исходный номер телефона, указанный при создании сессии. Если номер был некорректным, он может быть не в формате E.164." } }, "nullable": true }, "callback": { "type": "string", "format": "uri", "description": "URL обратного вызова сессии.", "nullable": true }, "id_verifications": { "type": "array", "nullable": true, "description": "**Массив отчётов верификации личности (OCR)**, сформированных шагами проверки документов, удостоверяющих личность, в графе сценария. Всегда JSON-массив — считывайте `id_verifications[0]` и выполняйте итерацию, если ваш сценарий может выполнять более одной проверки документов, удостоверяющих личность (например, основную проверку плюс дополнительную). Имеет значение `null`, пока хотя бы один шаг проверки документов, удостоверяющих личность, не предоставит данные. Каждый элемент представляет собой полный отчёт, включая `node_id`, `status` на уровне функции, извлечённые поля документа, URL-адреса изображений, оценки качества, MRZ, разобранный адрес, совпадения между сессиями и `warnings[]`.", "items": { "type": "object", "description": "Один отчёт о верификации личности - полный отчёт для одного шага Верификации личности. Поле `verification_method` указывает, какой из трёх методов создал его (захват документа, проверка без документов или вход через кошелёк), а блок данных, относящийся к методу, заполняется соответствующим образом.", "properties": { "node_id": { "type": "string", "description": "ID узла графа сценария для шага OCR, создавшего этот отчёт." }, "verification_method": { "type": "string", "enum": [ "document", "id_lookup", "wallet" ], "description": "Какой метод Верификации личности сформировал этот отчёт. `document` - пользователь сфотографировал физический документ (значение по умолчанию и значение для каждой сессии, созданной до появления других методов). `id_lookup` - пользователь ввёл номер своего национального удостоверения личности, и он был проверен по государственному реестру или другому авторитетному источнику для этой страны (в `id_lookup.source` указано, какому именно). `wallet` - пользователь вошёл с помощью государственной или банковской цифровой идентификации." }, "assurance": { "type": "string", "enum": [ "documentary", "data_match", "cryptographic" ], "description": "Уровень надёжности, полученный из `verification_method`: `documentary` для документа, который был захвачен и проверен; `data_match` для данных, совпавших с записью в запрошенном источнике; `cryptographic` для атрибутов, аутентифицированных и подписанных провайдером идентификации." }, "wallet_provider": { "type": "string", "nullable": true, "description": "Каталожный идентификатор кошелька, если `verification_method` имеет значение `wallet` (`mitid`, `bankid_se`, `itsme`, ...). В остальных случаях `null`." }, "fallback_from": { "type": "object", "nullable": true, "description": "Причина, по которой бездокументный метод не завершил шаг проверки личности. Устанавливается при сбое поиска или входа через кошелёк: в отчёте о верификации документа, к которой перешёл пользователь, если переключатель резервного варианта для страны был установлен в `fallback_to_document` (`action` имеет значение `fallback_to_document`), либо в отчёте об отклонении, если он был установлен в `decline`. В противном случае `null`.", "properties": { "method": { "type": "string", "enum": [ "id_lookup", "wallet" ], "description": "Метод, завершившийся ошибкой." }, "reason": { "type": "string", "description": "Результат, завершивший процесс, например `no_match`, `provider_error`, `cancelled`, `timeout`." }, "action": { "type": "string", "enum": [ "fallback_to_document", "decline" ], "description": "Настроенное действие, которое было предпринято: `fallback_to_document` или `decline`." } } }, "id_lookup": { "type": "object", "nullable": true, "description": "Данные из реестра. Присутствуют, только если `verification_method` имеет значение `id_lookup`; в противном случае `null`.", "properties": { "source": { "type": "string", "description": "Отображаемое клиенту название запрошенного источника, например `Department of Home Affairs` (государственный реестр) или `UK credit bureau and financial services records` (не государственный реестр). Это единственное указание на происхождение данных для проверки; не считайте источник по умолчанию государственным." }, "checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Время ответа реестра." }, "attempts": { "type": "integer", "description": "Номер попытки (начиная с 1), к которой относится этот отчёт." }, "max_attempts": { "type": "integer", "description": "Лимит попыток, настроенный для страны (от 1 до 5, по умолчанию 1)." }, "outcome": { "type": "string", "enum": [ "match", "partial_match", "no_match", "provider_error", "format_rejected" ], "nullable": true, "description": "Ответ реестра. Только `match`, `partial_match` и `no_match` списываются с лимита попыток и тарифицируются." }, "comparison": { "type": "array", "description": "Одна строка на каждое сопоставимое поле, по которому источник предоставил ответ, плюс одна строка на каждую ошибку источника. В строках сравнения используются нормализованные имена полей, приведённые ниже, а не ключи полей запроса для конкретной страны, поскольку несколько полей запроса (имя и фамилия или любые псевдонимы идентификаторов) объединяются в одно сравнение. Источник, завершившийся ошибкой, добавляет строку с `field: \"provider\"` и `result: \"error\"`, поэтому проверяйте `result`, прежде чем рассматривать строку как вердикт по полю.", "items": { "type": "object", "required": [ "field", "label", "provided", "record", "result" ], "properties": { "field": { "type": "string", "enum": [ "identification_number", "full_name", "date_of_birth", "address", "provider" ], "description": "Нормализованное поле сравнения. `provider` не является пользовательским полем: оно обозначает строку с ошибкой источника." }, "label": { "type": "string", "description": "Отображаемая метка для строки, например `ID number`, `Full name`, `Provider`." }, "provided": { "type": "string", "nullable": true, "description": "То, что ввёл пользователь. `null` в строке ошибки `provider`." }, "record": { "type": "string", "nullable": true, "description": "Данные, содержавшиеся в источнике. В строке с ошибкой `provider` вместо этого содержится сообщение об ошибке." }, "result": { "type": "string", "enum": [ "match", "partial", "no_match", "error" ], "description": "Результат сравнения по полям. Значение `error` появляется только в строке `provider` и означает, что данный источник не ответил; интерпретируйте это как свидетельство о запросе, а не как несовпадение полей." } } } }, "registry_portrait": { "type": "string", "format": "uri", "nullable": true, "description": "Временный предварительно подписанный URL к портретному фото, возвращённому источником. Только для четырёх государственных реестров, которые его возвращают (Южная Африка, Нигерия, Аргентина, Панама)." }, "face_match_score": { "type": "number", "nullable": true, "description": "Селфи относительно фото из реестра, 0-100. Только если реестр возвращает фотопортрет." } } }, "wallet_verification": { "type": "object", "nullable": true, "description": "Данные, подтверждающие учётные данные. Присутствуют только в том случае, если `verification_method` равен `wallet`; в противном случае `null`.", "properties": { "provider": { "type": "string", "description": "Каталожный идентификатор кошелька, например `mitid`." }, "provider_name": { "type": "string", "nullable": true, "description": "Название кошелька, известное конечному пользователю, например `MitID`." }, "issuing_authority": { "type": "string", "nullable": true, "description": "Организация, стоящая за кошельком, например `Danish Agency for Digital Government`." }, "issuing_country": { "type": "string", "description": "Страна по стандарту ISO 3166-1 alpha-3, в которой был предложен кошелёк." }, "credential_type": { "type": "string", "nullable": true, "description": "Учётные данные, предоставленные кошельком, например `person_identification`." }, "level_of_assurance": { "type": "string", "enum": [ "low", "substantial", "high" ], "nullable": true, "description": "Уровень доверия, заявленный кошельком. Вход в систему с уровнем ниже запрошенного завершается ошибкой вместо понижения уровня." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Момент времени аутентификации кошелька." }, "signature_valid": { "type": "boolean", "nullable": true, "description": "Прошла ли проверку подписанная аттестация, возвращённая кошельком." }, "attributes": { "type": "object", "additionalProperties": true, "description": "Атрибуты, переданные кошельком, с ключами, соответствующими их перечислению в каталоге кошелька." }, "portrait": { "type": "string", "format": "uri", "nullable": true, "description": "Временный предварительно подписанный URL к портретному фото, переданному кошельком, если он его передаёт." }, "face_match_score": { "type": "number", "nullable": true, "description": "Селфи относительно фотопортрета из кошелька, 0-100, если кошелёк его передаёт." } } }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Expired" ], "description": "Статус этого шага верификации личности на уровне функции. Не зависит от общего `status` сессии: сессия может получить итоговое решение, пока отдельная функция остаётся на проверке (`In Review`)." }, "document_type": { "type": "string", "description": "Тип документа, удостоверяющего личность" }, "document_subtype": { "type": "string", "nullable": true, "description": "Принятый код подтипа документа из настроек документов сценария, включая регион документа, если применимо. Примеры: `ID_CARD_GENERIC`, `QUEENSLAND_DRIVER_LICENSE_GENERIC`." }, "document_number": { "type": "string", "description": "Идентификационный номер документа" }, "personal_number": { "type": "string", "description": "Личный идентификационный номер" }, "portrait_image": { "type": "string", "format": "uri", "description": "URL портретного изображения" }, "front_image": { "type": "string", "format": "uri", "description": "URL изображения лицевой стороны документа" }, "front_video": { "type": "string", "format": "uri", "description": "URL видеозаписи лицевой стороны документа" }, "back_image": { "type": "string", "format": "uri", "description": "URL-адрес изображения оборотной стороны документа" }, "back_video": { "type": "string", "format": "uri", "description": "URL видеозаписи оборотной стороны документа" }, "full_front_image": { "type": "string", "format": "uri", "description": "URL полного изображения лицевой стороны документа" }, "full_back_image": { "type": "string", "format": "uri", "description": "URL полного изображения оборотной стороны документа" }, "front_image_camera_front": { "type": "string", "format": "uri", "description": "URL изображения лицевой стороны документа, снятого на фронтальную камеру" }, "back_image_camera_front": { "type": "string", "format": "uri", "description": "URL изображения оборотной стороны документа, снятого на фронтальную камеру" }, "date_of_birth": { "type": "string", "format": "date", "description": "Дата рождения из документа" }, "age": { "type": "integer", "description": "Вычисленный возраст на основе даты рождения" }, "expiration_date": { "type": "string", "format": "date", "description": "Срок действия документа" }, "date_of_issue": { "type": "string", "format": "date", "description": "Дата выдачи документа" }, "issuing_state": { "type": "string", "description": "ISO-код государства выдачи" }, "issuing_state_name": { "type": "string", "description": "Полное название штата выдачи" }, "first_name": { "type": "string", "description": "Имя из документа" }, "last_name": { "type": "string", "description": "Фамилия из документа" }, "full_name": { "type": "string", "description": "Полное имя из документа" }, "gender": { "type": "string", "description": "Пол из документа" }, "address": { "type": "string", "description": "Необработанный адрес из документа" }, "formatted_address": { "type": "string", "description": "Отформатированный полный адрес" }, "place_of_birth": { "type": "string", "description": "Место рождения из документа" }, "marital_status": { "type": "string", "description": "Семейное положение из документа" }, "nationality": { "type": "string", "description": "Код гражданства по стандарту ISO" }, "extra_fields": { "type": "object", "description": "Дополнительные поля документа. Включает атрибуты, специфичные для документа (например, `dl_categories`, `blood_group`, `sponsor`, `employer`, `dl_class_code_b_from`, `dl_class_code_b_to`). Сроки действия классов водительских прав возвращаются как `dl_class_code__from` и `dl_class_code__to`, а коды ограничений или информации по классам (например, колонка 12 прав Великобритании) как `dl_class_code__notes`. Когда документ содержит имена, адрес или место рождения в нескольких системах письма, этот объект также включает версии этих полей в альтернативной системе письма. Настройка сценария `preferred_characters` (`latin` или `non_latin`) определяет, какая система письма заполняет поля верхнего уровня (`first_name`, `last_name`, `full_name`, `address`, `place_of_birth`); противоположная система письма попадает сюда как `first_name_non_latin` / `last_name_non_latin` / `full_name_non_latin` / `middle_name_non_latin` / `address_non_latin` / `place_of_birth_non_latin` (когда `preferred_characters` равно `latin`) или с суффиксом `_latin` (когда `preferred_characters` равно `non_latin`). Ключи появляются только тогда, когда OCR фактически извлекает реальное значение в альтернативной системе письма: поле, чьё альтернативное значение находится в той же системе письма, что и предпочтительный набор (например, поле с кириллической меткой, чьё значение OCR вернулось в виде латинских омоглифов), пропускается. Если `preferred_characters` имеет значение `latin`, но документ содержит только нелатинский текст, Didit транслитерирует извлечённые значения и предоставляет `first_name_latin` / `last_name_latin` / и т. д. в качестве резервного варианта.", "additionalProperties": true, "properties": { "dl_categories": { "type": "array", "items": { "type": "string" } }, "blood_group": { "type": "string", "nullable": true }, "first_name_non_latin": { "type": "string", "description": "Имя в нелатинской системе письма, если `preferred_characters=latin` и на документе присутствует нелатинская версия (например, `Айна` для кыргызского удостоверения личности)." }, "last_name_non_latin": { "type": "string", "description": "Фамилия в нелатинской системе письма, если `preferred_characters=latin` и нелатинская версия присутствует в документе." }, "middle_name_non_latin": { "type": "string", "description": "Второе имя / отчество в нелатинской системе письма, когда `preferred_characters=latin` и нелатинская версия присутствует в документе." }, "full_name_non_latin": { "type": "string", "description": "Составное полное имя в нелатинской системе письма. Формируется из отдельных компонентов, когда доступны и имя, и фамилия." }, "address_non_latin": { "type": "string", "description": "Адрес в нелатинской системе письма, когда `preferred_characters=latin` и нелатинская версия присутствует в документе." }, "place_of_birth_non_latin": { "type": "string", "description": "Место рождения в нелатинской системе письма, когда `preferred_characters=latin` и в документе присутствует нелатинская версия." }, "first_name_latin": { "type": "string", "description": "Имя латиницей. Заполняется, если `preferred_characters=non_latin` и на документе присутствует версия латиницей, либо — в качестве резервной транслитерации — если `preferred_characters=latin`, но документ содержит только нелатинский текст." }, "last_name_latin": { "type": "string", "description": "Фамилия латиницей. Те же правила, что и для `first_name_latin`." }, "middle_name_latin": { "type": "string", "description": "Второе имя / отчество латиницей. Те же правила, что и для `first_name_latin`." }, "full_name_latin": { "type": "string", "description": "Составное полное имя в латинице. Всегда формируется из отдельных компонентов, когда доступны и имя, и фамилия." }, "address_latin": { "type": "string", "description": "Адрес латиницей. Те же правила, что и для `first_name_latin`." }, "place_of_birth_latin": { "type": "string", "description": "Место рождения латиницей. Те же правила, что и для `first_name_latin`." } } }, "mrz": { "type": "object", "nullable": true, "description": "Распознанные поля машиночитаемой зоны (MRZ), извлеченные из документа. `null`, если MRZ не обнаружена.", "properties": { "surname": { "type": "string", "example": "MARTINEZ_families` / `very_high_similarity_plus__families`. Присутствует, только если `match_source` равен `recovered_high`." } } } }, "browser_version": { "type": "string", "nullable": true }, "os_version": { "type": "string", "nullable": true }, "user_agent": { "type": "string", "nullable": true, "description": "Строка User-Agent браузера." }, "accept_language": { "type": "string", "nullable": true, "description": "Заголовок `Accept-Language`, отправленный браузером." }, "session_identifier": { "type": "string", "nullable": true, "description": "Идентификатор сессии браузера, в которой выполнялась верификация." }, "session_age_ms": { "type": "integer", "nullable": true, "description": "Возраст этой сессии браузера в миллисекундах на момент выполнения шага." }, "coords_accuracy": { "type": "number", "nullable": true, "description": "Радиус точности в метрах для координат, переданных устройством." }, "raw_device_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Необработанные сигналы устройства, собранные для этого шага." } } } }, "geolocation_checks": { "type": "array", "nullable": true, "description": "**Массив результатов верификации местоположения**, по одному на каждый шаг верификации местоположения: принятая попытка этого шага. Имеет значение `null`, пока шаг верификации местоположения не предоставит данные. Более ранние попытки того же шага находятся в `geolocation_attempts`.", "items": { "$ref": "#/components/schemas/GeolocationCheck" } }, "geolocation_attempts": { "type": "array", "nullable": true, "description": "Каждая попытка каждого шага проверки местоположения (Location) в этой сессии, начиная с самых старых. Попытки, заменённые повторной отправкой, исключены. Сценарий, который скрывает `geolocation_checks` через свои атрибуты ответа, также скрывает и этот список.", "items": { "$ref": "#/components/schemas/GeolocationAttempt" } }, "database_validations": { "type": "array", "nullable": true, "description": "**Массив отчётов Проверки по базам данных** — всегда массив JSON, а не отдельный объект `database_validation`. Имеет значение `null`, пока хотя бы один шаг проверки по базам данных не вернёт данные. Каждый элемент представляет собой полный отчёт, включая `node_id`, `status` на уровне функции, `screened_data`, массив `validations[]` для каждого сервиса (каждый с данными из реестра `source_data`) и `warnings[]`. Поля `screened_data` и `source_data` различаются в зависимости от страны:\n\n**ARG (Аргентина)**: screened_data: {document_number, selfie, gender, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, date_of_birth, date_of_death, tax_id, tax_id_type, face_match_score, sit_1_since, banks, last_position, highest_position, rejected_checks}. Использует биометрическую валидацию RENAPER со сравнением лиц. Пол определяется автоматически на основе анализа лица или имени, если он отсутствует в документе (например, в водительских удостоверениях)\n\n**BOL (Боливия)**: screened_data: {document_number, date_of_birth, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, date_of_birth, gender}\n\n**BRA (Бразилия)**: screened_data: {tax_number, first_name, last_name, date_of_birth}. source_data всегда включает {identification_number, first_name, last_name, date_of_birth, lgpd_minor, minor_under_18, minor_under_16} при успешных совпадениях по CPF. При успешных запросах по совершеннолетним эти флаги устанавливаются в false. Сервис Receita Federal Consulta CPF может возвращать HTTP 422 (несовершеннолетний до 18 лет) или 451 (до 16 лет) с данными, скрытыми в соответствии с LGPD; в таких случаях source_data устанавливает соответствующие флаги несовершеннолетнего в true, включает HTTP-статус вышестоящего сервиса, а валидация на уровне полей получает значение no_match. Полный список кодов см. в разделе по Бразилии справочника Database Validation Outcome Codes.\n\n**CHL (Чили)**: screened_data: {personal_number, first_name, last_name, date_of_birth}. source_data: {identification_number, first_name, last_name, date_of_birth, gender}\n\n**COL (Колумбия)**: screened_data: {document_number, document_type, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, date_of_birth, document_type}\n\n**CRI (Коста-Рика)**: screened_data: {personal_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}\n\n**DOM (Доминиканская Республика)**: screened_data: {personal_number}. source_data: {identification_number} (возвращает только valid/invalid)\n\n**ECU (Эквадор)**: screened_data: {personal_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, street, formatted_address, gender, nationality, education, marital_status, spouse, mother_name, father_name, profession}\n\n**ESP (Испания)**: screened_data: {personal_number, document_type, expiration_date, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, document_type, expiration_date}\n\n**GTM (Гватемала)**: screened_data: {document_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}\n\n**HND (Гондурас)**: screened_data: {document_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}\n\n**MEX (Мексика)**: screened_data: {personal_number (CURP), first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, date_of_birth, gender, nationality, curp_status, state_of_birth, doc_probatorio, registration_year, registration_state, registration_municipality, num_acta, crip, issuing_state_code, foreign_registry_number, folio_carta, folio_certificado}. Использует реестр актов гражданского состояния RENAPO. Отдельный сервис проверки действительности INE также доступен для MEX в качестве дополнительной поочерёдной валидации.\n\n**PAN (Панама)**: screened_data: {personal_number, selfie}. source_data: {identification_number}. Использует биометрическую валидацию SIB\n\n**PER (Перу)**: screened_data: {personal_number (DNI), first_name, last_name}. source_data: {identification_number, first_name, last_name, paternal_name, maternal_name, verification_number, verification_letter}\n\n**PRY (Парагвай)**: screened_data: {document_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}\n\n**SLV (Сальвадор)**: screened_data: {document_number, date_of_birth, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}\n\n**URY (Уругвай)**: screened_data: {personal_number, date_of_birth, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}\n\n**VEN (Венесуэла)**: screened_data: {document_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, gender, date_of_birth, document_type}", "items": { "type": "object", "properties": { "node_id": { "type": "string", "description": "Уникальный идентификатор этого шага проверки по базам данных в графе сценария." }, "issuing_state": { "type": "string", "description": "Трехбуквенный код ISO 3166-1 alpha-3 страны, государственные/реестровые источники которой опрашивались (например, `BRA`, `MEX`, `ESP`, `NGA`, `IDN`). Проверка по базам данных охватывает 60+ стран в Северной и Южной Америке, Европе, Африке, на Ближнем Востоке и в Азиатско-Тихоокеанском регионе, а также глобальные мультистрановые источники — покрытие регулярно расширяется, поэтому рассматривайте значение как открытый набор, а не как фиксированное перечисление." }, "validation_type": { "type": "string", "enum": [ "one_by_one", "two_by_two", "not_enabled" ], "description": "Как подтверждался результат: `one_by_one` (результат одного сервиса), `two_by_two` (два или более различных сервиса независимо друг от друга полностью сопоставили идентификационный номер) или `not_enabled` (сохраняется, если ни один сервис не выдал применимого совпадения). Значение никогда не бывает `null`. Специальные режимы биометрической валидации 2x2 в настоящее время доступны для `ECU` и `PER`." }, "screened_data": { "type": "object", "description": "Входные данные, используемые для валидации. Поля зависят от страны — форматы для конкретных стран см. в документации по Проверке по базам данных (`/core-technology/database-validation/overview`).", "properties": { "last_name": { "type": "string" }, "first_name": { "type": "string" }, "tax_number": { "type": "string", "description": "Бразилия: CPF (11 цифр)" }, "personal_number": { "type": "string", "description": "Чили: RUT, DOM: Cédula (11 цифр), ECU: Cédula (10 цифр), ESP: DNI/NIE, MEX: CURP (18 символов), PER: DNI (8 цифр), URY: CI" }, "document_number": { "type": "string", "description": "ARG: DNI, BOL: CI, COL: Cédula, GTM: DPI, HND: DNI, PAN: Cédula, PRY: CI, SLV: DUI, VEN: Cédula" }, "date_of_birth": { "type": "string", "format": "date" }, "document_type": { "type": "string", "description": "COL: CC/CE/TI/NIT, ESP: ID/PASSPORT" }, "expiration_date": { "type": "string", "format": "date", "description": "Обязательно для ESP" } } }, "validations": { "type": "array", "description": "Одна запись на каждую службу реестров, вернувшую payload валидации. Каждая запись идентифицирует службу (`service_id`, `service_name`) и содержит сравнение по каждому полю `validation`, код/детали результата службы `outcome_code` / `outcome_detail` (если предоставлены), а также нормализованную запись из реестра в `source_data`.", "items": { "type": "object", "properties": { "service_id": { "type": "string", "description": "Идентификатор сервиса реестра, сформировавшего этот результат проверки.", "example": "bra_cpf" }, "service_name": { "type": "string", "description": "Понятное название сервиса реестра.", "example": "Brazil - CPF status check" }, "validation": { "type": "object", "description": "Результаты проверок полей.", "properties": { "full_name": { "type": "string", "description": "Результат сопоставления полного имени (например, 'full_match', 'partial_match', 'no_match')." }, "date_of_birth": { "type": "string", "description": "Результат сопоставления даты рождения." }, "identification_number": { "type": "string", "description": "Результат сопоставления идентификационного номера." } } }, "outcome_code": { "type": "string", "nullable": true, "description": "Машиночитаемый результат проверки по реестру (например, `MATCH`, `NO_MATCH`, `PARTIAL_MATCH`, `INCONCLUSIVE`, коды конкретных источников). Присутствует, когда сервис сообщает о нём." }, "outcome_detail": { "type": "string", "nullable": true, "description": "Понятное объяснение `outcome_code`, если оно предоставлено сервисом." }, "source_data": { "type": "object", "description": "Данные, полученные из государственной базы данных. Общие поля: identification_number, first_name, last_name, full_name, date_of_birth, gender. Дополнительные поля по странам: BRA всегда включает lgpd_minor, minor_under_18 и minor_under_16 при успешных совпадениях CPF; также включает вышестоящий HTTP-статус, если данные CPF удержаны в рамках LGPD (HTTP 422/451). ECU добавляет street, formatted_address, nationality, education, marital_status, spouse, mother_name, father_name, profession. PER добавляет paternal_name, maternal_name, verification_number, verification_letter. ESP добавляет document_type, expiration_date. VEN/COL добавляют document_type.", "additionalProperties": true } } } }, "errors": { "type": "array", "description": "Ошибки, возвращённые службами реестров при проверке, каждая с указанием `service_id`, который её создал. **Этот ключ полностью опускается, если ошибок нет.**", "items": { "type": "object", "description": "Объект ошибки вышестоящего сервиса, переданный как есть: его ключи зависят от сервиса (обычно сообщение/код и любые сведения от конкретного провайдера), а также `service_id`, определяющий сервис, в котором произошла ошибка.", "properties": { "service_id": { "type": "string", "nullable": true, "description": "Идентификатор сервиса реестра, в котором произошла ошибка." } }, "additionalProperties": true } }, "match_type": { "type": "string", "enum": [ "no_match", "partial_match", "full_match" ], "nullable": true, "description": "Агрегированный результат совпадения по всем запрошенным сервисам. `null` до тех пор, пока проверка не будет оценена." }, "status": { "type": "string", "description": "Статус этой проверки по базам данных на уровне функции. Не зависит от общего `status` сессии — сессия может получить итоговое решение, пока отдельная функция остаётся на проверке (`In Review`).", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ] }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "feature": { "type": "string", "enum": [ "ID_VERIFICATION", "NFC", "LIVENESS", "FACEMATCH", "PROOF_OF_ADDRESS", "PHONE", "EMAIL", "AML", "LOCATION", "DATABASE_VALIDATION", "QUESTIONNAIRE", "DOCUMENT_AI", "KYB_REGISTRY", "KYB_DOCUMENTS", "KYB_KEY_PEOPLE", "GEOLOCATION", "SIGNATURE" ], "description": "Функция, сгенерировавшая это предупреждение. Значение определяет блок функции, к которому относится предупреждение. Массив предупреждений каждого модуля обычно использует значение, соответствующее его модулю (например, `PHONE` внутри `phone_verifications[].warnings`), однако перечисление выше является определяющим для всех предупреждений функций в payload решения." }, "risk": { "type": "string" }, "additional_data": { "type": "object", "nullable": true }, "log_type": { "type": "string" }, "short_description": { "type": "string" }, "long_description": { "type": "string" }, "node_id": { "type": "string", "description": "Идентификатор узла графа сценария, сгенерировавшего это предупреждение" } } }, "description": "Предупреждения, связанные с проверкой по базам данных." } } } }, "database_validation_not_performed_reason": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Причина, по которой настроенная проверка по базам данных не дала результатов, в виде `{code, message}` плюс контекстные поля. Присутствует только в том случае, когда `database_validations` имеет значение `null` для сценария, содержащего данный шаг, что позволяет отличить вариант «реестр подтвердил» от «ничего не выполнялось». В противном случае `null`.", "properties": { "code": { "type": "string", "description": "Постоянная машиночитаемая причина." }, "message": { "type": "string", "description": "Понятное объяснение." } } }, "reviews": { "type": "array", "items": { "type": "object", "properties": { "user": { "type": "string", "description": "Кто выполнил проверку. Обычно это идентификатор проверяющего в консоли (его email), однако значение равно `\"API Client\"` для обновлений статуса с помощью API-ключа и `\"Unknown\"`, когда инициатора не удалось определить — поэтому не следует парсить это поле как адрес электронной почты." }, "new_status": { "type": "string" }, "comment": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } } } }, "assignee": { "type": "object", "nullable": true, "description": "Проверяющий в Консоли, которому назначена сессия, или `null`, если она никому не назначена.", "properties": { "email": { "type": "string", "format": "email" }, "assigned_at": { "type": "string", "format": "date-time", "nullable": true } } }, "waiting_since": { "type": "string", "format": "date-time", "nullable": true, "description": "Время, когда сессия перешла в ожидание проверки. `null`, если сессия не находится в статусе `In Review` или в вашем приложении не задан дедлайн проверки." }, "sla_due_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Срок завершения проверки. `null`, если сессия не находится в статусе `In Review` или в вашем приложении не задан дедлайн проверки." }, "created_at": { "type": "string", "format": "date-time", "description": "Временная метка создания сессии (ISO 8601, UTC)." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Временная метка запланированного истечения срока действия этой сессии. Устанавливается для сессий проверки пользователей (KYC), если срок действия был настроен при создании (или когда статус `Approved` запускает расчёт срока действия KYC). `null` для сессий без настроенного срока действия, а также для типов, не использующих истечение срока (например, сессий верификации бизнеса (KYB), которым никогда не задавался `expires_at`)." }, "registry_checks": { "type": "array", "nullable": true, "description": "Проверки по реестру компаний. Присутствует только в случае, если `session_kind = business`. Каждый элемент содержит полный payload реестра компаний.", "items": { "type": "object", "description": "Одна проверка по реестру компаний — полный payload реестра компаний, дополненный структурой владения и предупреждениями. Присутствует только при `session_kind = business`.", "properties": { "status": { "type": "string", "description": "Статус жизненного цикла функции." }, "node_id": { "type": "string", "nullable": true }, "data_resolved": { "type": "boolean" }, "company": { "type": "object", "description": "Полный payload компании из реестра (запись реестра, объединённая с данными, предоставленными пользователем или отредактированными в консоли).", "properties": { "uuid": { "type": "string", "format": "uuid" }, "node_id": { "type": "string", "nullable": true }, "status": { "type": "string" }, "registry_status": { "type": "string", "nullable": true }, "data_resolved": { "type": "boolean" }, "company_name": { "type": "string" }, "registration_number": { "type": "string", "nullable": true }, "country_code": { "type": "string", "description": "Страна инкорпорации (ISO 3166-1 alpha-2, например, `GB`, `DE`, `US`)." }, "region": { "type": "string", "nullable": true, "description": "Код подразделения ISO 3166-2, если применимо (например, `CA`, `NY` для штатов США)." }, "company_type": { "type": "string", "nullable": true }, "incorporation_date": { "type": "string", "format": "date", "nullable": true }, "registered_address": { "type": "string", "nullable": true }, "tax_number": { "type": "string", "nullable": true }, "risk_level": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ], "nullable": true }, "verification_status": { "type": "string", "nullable": true }, "is_from_registry": { "type": "boolean" }, "fetch_status": { "type": "string", "nullable": true }, "alternative_names": { "type": "string", "nullable": true, "description": "Альтернативные, торговые, прежние или наименования компании на языке оригинала в виде текста, если они указаны." }, "nature_of_business": { "type": "string", "nullable": true }, "registered_capital": { "type": "string", "nullable": true }, "registered_capital_amount": { "type": "string", "format": "decimal", "nullable": true, "description": "Сумма зарегистрированного/уставного капитала в виде десятичной строки (например, `\"100.00\"`), извлечённая из записи в реестре. `null`, если недоступно." }, "registered_capital_currency": { "type": "string", "nullable": true, "description": "Код валюты ISO 4217 для `registered_capital_amount` (например, `\"GBP\"`). `null`, если значение недоступно." }, "website": { "type": "string", "nullable": true }, "email": { "type": "string", "format": "email", "nullable": true }, "phone": { "type": "string", "nullable": true }, "legal_entity_identifier": { "type": "string", "nullable": true }, "location_of_registration": { "type": "string", "nullable": true }, "vat_number": { "type": "string", "nullable": true, "description": "Номер плательщика НДС в ЕС, если он был собран на размещённом шаге реестра или изменён впоследствии." }, "vat_validation_status": { "type": "string", "enum": [ "valid", "invalid", "format_valid", "invalid_format", "could_not_validate", "not_applicable" ], "description": "Результат валидации номера плательщика НДС (VAT) или, при его отсутствии, `tax_number` при отправке в реестр. `valid` / `invalid`: определяется официальным реестром страны (EU VIES, Норвегия, Швейцария, Бразилия, Колумбия, Коста-Рика, Эквадор, Парагвай; Польша также по внутреннему реестру НДС). `format_valid` / `invalid_format`: определяется правилами формата и контрольных цифр страны, если реестр недоступен для запроса. `could_not_validate`: реестр был недоступен. `not_applicable`: номер отсутствует, в стране нет реестра или правил либо это сессия в песочнице." }, "vat_validated_number": { "type": "string", "nullable": true, "description": "Номер, который был проверен, в том виде, в каком он известен источнику (например, номер VAT, полученный из французского SIREN или нидерландского RSIN). `null`, если проверка не выполнялась." }, "vat_validation_source": { "type": "string", "nullable": true, "enum": [ "eu_vies", "pl_vat_white_list", "no_brreg", "ch_uid_register", "br_receita_federal", "co_rues", "cr_hacienda", "ec_sri", "py_dnit", "format_rules", null ], "description": "Источник, определивший `vat_validation_status`: официальный реестр или `format_rules`. `null`, если проверка не проводилась." }, "vat_validated_name": { "type": "string", "nullable": true, "description": "Имя, зарегистрированное в источнике, подтвердившем номер, если источник его раскрывает. Указывается только со статусом `valid`." }, "vat_validated_address": { "type": "string", "nullable": true, "description": "Адрес, зарегистрированный в источнике, выполнившем проверку номера, если он раскрывает его. Заполняется, только когда статус равен `valid`." }, "vat_checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Временная метка проверки. `null`, если проверка не запускалась." }, "financial_summary": { "type": "object", "nullable": true }, "officers": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "designation": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "is_active": { "type": "boolean" }, "kyc_status": { "type": "string", "enum": [ "Approved", "Declined", "Pending" ], "nullable": true }, "kyc_session_url": { "type": "string", "format": "uri", "nullable": true }, "first_name": { "type": "string", "nullable": true, "description": "Имя, если оно явно указано в реестре; не выводится из полного имени." }, "last_name": { "type": "string", "nullable": true, "description": "Фамилия, если она явно указана в реестре." }, "address": { "type": "string", "nullable": true, "description": "Адрес должностного лица, указанный в реестре." }, "appointment_date": { "type": "string", "nullable": true, "description": "Дата назначения должностного лица.", "format": "date" }, "termination_date": { "type": "string", "nullable": true, "description": "Дата окончания полномочий, если указана.", "format": "date" }, "date_of_birth": { "type": "string", "nullable": true, "description": "Полная дата рождения по данным реестра. Null, если известны только год или месяц рождения.", "format": "date" }, "date_of_birth_year": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 9999, "description": "Год рождения по данным реестра, в том числе когда полная дата недоступна." }, "date_of_birth_month": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 12, "description": "Месяц рождения по данным реестра. Null, если известен только год." } } } }, "beneficial_owners": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "entity_type": { "type": "string", "enum": [ "person", "company" ] }, "roles": { "type": "array", "items": { "type": "string" } }, "ownership_min_shares": { "type": "string", "nullable": true, "description": "Нижняя граница процента владения, указанная в реестре. Строка в свободной форме (например, `\"25.00\"`, `\"50\"`); используйте `effective_ownership_percent` для получения обработанного числового значения." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Верхняя граница доли владения по данным реестра. Строка произвольного формата; используйте `effective_ownership_percent` для получения числового значения." }, "is_active": { "type": "boolean" }, "kyc_status": { "type": "string", "enum": [ "Approved", "Declined", "Pending" ], "nullable": true }, "kyc_session_url": { "type": "string", "format": "uri", "nullable": true }, "effective_ownership_percent": { "type": "number", "nullable": true }, "company_name": { "type": "string", "nullable": true }, "registration_number": { "type": "string", "nullable": true }, "country_of_birth": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "designation": { "type": "string", "nullable": true }, "voting_min_shares": { "type": "string", "nullable": true }, "voting_max_shares": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "nullable": true, "description": "Полная дата рождения, если указана.", "format": "date" }, "appointment_date": { "type": "string", "nullable": true, "description": "Дата назначения, если указана.", "format": "date" }, "shareholding": { "$ref": "#/components/schemas/KYBRegistryShareholding" } } } }, "addresses": { "type": "array", "nullable": true, "description": "Каждый адрес, указанный в реестре, в едином каноническом формате. Null, если реестр не указывает ни одного.", "items": { "$ref": "#/components/schemas/KYBRegistryAddress" } }, "industries": { "type": "array", "nullable": true, "description": "Виды деятельности, к которым реестр относит компанию, в единой канонической форме. Null, если ни один вид не указан.", "items": { "$ref": "#/components/schemas/KYBRegistryIndustry" } }, "accounts": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Даты подачи документов в реестр, если доступны. Для годовой отчётности и общих собраний используются last_annual_return_date и last_agm_date; они отличаются от финансовой отчётности." }, "registry_data": { "$ref": "#/components/schemas/KYBRegistryData" }, "user_provided_data": { "type": "object", "description": "Данные, подтверждённые или отредактированные конечным пользователем." }, "confirmed_by_user_at": { "type": "string", "format": "date-time", "nullable": true }, "last_console_edit_at": { "type": "string", "format": "date-time", "nullable": true }, "is_editable": { "type": "boolean" }, "ownership": { "$ref": "#/components/schemas/KYBRegistryOwnership" }, "registry_tier": { "type": "string", "nullable": true, "description": "Уровень реестра, запрошенный сценарием: `basic`, `shareholders` или `ubo`. Также указан в `ownership.tier_requested`." }, "registry_tier_delivered": { "type": "string", "nullable": true, "description": "Уровень, предоставленный реестром и включенный в счёт. Также указывается в `ownership.tier_delivered`." }, "registry_ownership_status": { "type": "string", "nullable": true, "description": "`not_requested`, `pending`, `delivered`, `not_held` или `unavailable`. Также в `ownership.status`." }, "registry_monitoring": { "type": "object", "nullable": true, "description": "Последний мониторинг реестра для компании или `null`, если он отсутствует.", "properties": { "uuid": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "unavailable_reason": { "type": "string", "nullable": true }, "enrolled_at": { "type": "string", "format": "date-time", "nullable": true }, "cancelled_at": { "type": "string", "format": "date-time", "nullable": true }, "last_bill_date": { "type": "string", "format": "date", "nullable": true }, "next_bill_date": { "type": "string", "format": "date", "nullable": true }, "last_event_at": { "type": "string", "format": "date-time", "nullable": true }, "events_count": { "type": "integer" }, "watched_fields": { "description": "Поля компании, отслеживаемые мониторингом." } } } } }, "ownership_structure": { "$ref": "#/components/schemas/KYBOwnershipStructure" }, "warnings": { "type": "array", "items": { "type": "object" } } } } }, "key_people_checks": { "type": "array", "nullable": true, "description": "Агрегированные проверки ключевых лиц. Присутствует только при `session_kind = business`. Каждый элемент использует структуру с двумя категориями (`registry`, `submitted`, `ubo_kyc_summary`).", "items": { "type": "object", "description": "Агрегированная проверка должностных лиц компании и бенефициарных владельцев (UBO). Использует структуру `registry` / `submitted`. Присутствует только при session_kind = business.", "properties": { "status": { "type": "string" }, "node_id": { "type": "string", "nullable": true }, "registry": { "type": "object", "description": "Стороны, обнаруженные в ходе проверки по реестру.", "properties": { "officers": { "type": "array", "description": "Должностные лица, обнаруженные в ходе проверки реестра; для каждого указан статус дочерней сессии KYC и AML-скрининга, запущенных для них.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "Полное имя должностного лица в соответствии с записью в реестре." }, "designation": { "type": "string", "nullable": true, "description": "Должность или статус из реестра в виде произвольного текста (например, `Director`, `Company Secretary`)." }, "role": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ], "description": "Нормализованная роль должностного лица." }, "nationality": { "type": "string", "nullable": true }, "appointment_date": { "type": "string", "nullable": true, "description": "Дата назначения должностного лица.", "format": "date" }, "termination_date": { "type": "string", "nullable": true, "description": "Дата окончания полномочий, если указана.", "format": "date" }, "is_active": { "type": "boolean" }, "address": { "type": "string", "nullable": true, "description": "Адрес должностного лица, указанный в реестре." }, "aml_status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "nullable": true, "description": "Статус AML-скрининга, проведённого для этого должностного лица. `null`, если AML-скрининг не проводился." }, "kyc_status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "nullable": true, "description": "Необработанный статус жизненного цикла дочерней KYC-сессии, созданной для этого должностного лица. Это полный enum статусов сессии (а не сокращённый набор Одобрено/Отклонено/В ожидании). `null`, если дочерняя KYC-сессия отсутствует." }, "kyc_session_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL дочерней сессии KYC для предоставления доступа. `null`, если дочерняя сессия отсутствует." }, "kyc_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID дочерней KYC-сессии. Передайте его в этот же endpoint решения, чтобы получить полный KYC-отчёт по человеку. `null`, если дочерней сессии нет." }, "verification_workflow_type": { "type": "string", "nullable": true, "description": "Базовый тип сценария дочерней сессии (например, `kyc`). `null` для сценариев на основе графа или при отсутствии дочерней сессии." }, "verification_workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID сценария, используемый дочерней сессией. `null`, если дочерней сессии не существует." }, "verification_workflow_label": { "type": "string", "nullable": true, "description": "Понятное название сценария дочерней сессии. `null`, если не задано." }, "verification_workflow_features": { "type": "array", "nullable": true, "description": "Прогресс по функциям дочерней сессии верификации, например `[{\"feature\": \"ID_VERIFICATION\", \"status\": \"Approved\"}]`. `null`, если список функций дочерней сессии не удалось определить.", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Отображаемое имя функции (например, `ID_VERIFICATION`, `LIVENESS`, `AML`)." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Статус на уровне функции внутри дочерней сессии." } } } }, "didit_internal_id": { "type": "string", "nullable": true, "description": "Постоянный внутренний идентификатор верифицированного физического лица, связанного с дочерней сессией, — полезен для связывания между сессиями. `null`, если дочерняя сессия отсутствует или пользователь ещё не сопоставлен." }, "kyc_document_type": { "type": "string", "nullable": true, "description": "Тип документа, предъявленного в дочерней KYC-сессии (например, `P`, `ID`, `DL`). Имеет значение `null` до тех пор, пока в дочерней сессии не появится результат верификации личности." }, "kyc_nationality": { "type": "string", "nullable": true, "description": "Гражданство, извлечённое из документа в дочерней KYC-сессии. `null`, пока недоступно." }, "kyc_liveness_passed": { "type": "boolean", "nullable": true, "description": "Успешно ли пройдена проверка живости в дочерней KYC-сессии. `null`, если проверка живости не запускалась." }, "kyc_verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда дочерняя сессия KYC получила статус `Approved`. `null`, пока дочерняя сессия имеет любой другой статус." }, "kyc_aml_categories": { "type": "object", "nullable": true, "description": "Сводка по категориям на основе совпадений в AML-проверках по персоне. `null`, если совпадений нет.", "properties": { "sanctions": { "type": "string", "enum": [ "match", "clear" ] }, "pep": { "type": "string", "enum": [ "match", "clear" ] }, "adverse_media": { "type": "string", "enum": [ "match", "clear" ] }, "warnings": { "type": "string", "enum": [ "match", "clear" ] } } }, "kyc_notification_sent_at": { "type": "string", "nullable": true, "description": "Временная метка ISO 8601 последней отправки уведомления с приглашением на верификацию для дочерней сессии этого человека. `null`, если отправка не выполнялась." }, "first_name": { "type": "string", "nullable": true, "description": "Имя, если оно явно указано в реестре; не выводится из полного имени." }, "last_name": { "type": "string", "nullable": true, "description": "Фамилия, если она явно указана в реестре." }, "date_of_birth": { "type": "string", "nullable": true, "description": "Полная дата рождения по данным реестра. Null, если известны только год или месяц рождения.", "format": "date" }, "date_of_birth_year": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 9999, "description": "Год рождения по данным реестра, в том числе когда полная дата недоступна." }, "date_of_birth_month": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 12, "description": "Месяц рождения по данным реестра. Null, если известен только год." } } } }, "beneficial_owners": { "type": "array", "description": "Бенефициарные владельцы, обнаруженные в ходе проверки по реестру, каждый дополнен статусом любых дочерних сессий KYC и AML-скрининга, запущенных для него.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "Полное имя бенефициарного владельца (или название компании для корпоративных UBO)." }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "nullable": true, "description": "Полная дата рождения, если указана.", "format": "date" }, "country_of_birth": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "company_name": { "type": "string", "nullable": true }, "registration_number": { "type": "string", "nullable": true }, "entity_type": { "type": "string", "enum": [ "person", "company" ] }, "nationality": { "type": "string", "nullable": true }, "designation": { "type": "string", "nullable": true }, "roles": { "type": "array", "description": "Названия ролей, которые занимает этот владелец, например `[\"ubo\", \"shareholder\"]`.", "items": { "type": "string" } }, "ownership_min_shares": { "type": "string", "nullable": true, "description": "Нижняя граница процента владения, указанная в реестре. Строка в свободной форме (например, `\"25\"`, `\"25-50%\"`); используйте `effective_ownership_percent` для получения обработанного числового значения." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Верхняя граница доли владения по данным реестра. Строка произвольного формата; используйте `effective_ownership_percent` для получения числового значения." }, "is_active": { "type": "boolean" }, "aml_status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "nullable": true, "description": "Статус AML-скрининга, проведённого для этого бенефициарного владельца. `null`, если AML-скрининг не проводился." }, "kyc_status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "nullable": true, "description": "Необработанный статус жизненного цикла дочерней KYC-сессии, созданной для этого бенефициарного владельца. Это полный enum статусов сессии (а не сокращённый набор Одобрено/Отклонено/В ожидании). `null`, если дочерняя KYC-сессия отсутствует." }, "kyc_session_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL дочерней сессии KYC для предоставления доступа. `null`, если дочерняя сессия отсутствует." }, "kyc_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID дочерней KYC-сессии. Передайте его в этот же endpoint решения, чтобы получить полный KYC-отчёт по человеку. `null`, если дочерней сессии нет." }, "verification_workflow_type": { "type": "string", "nullable": true, "description": "Базовый тип сценария дочерней сессии (например, `kyc`). `null` для сценариев на основе графа или при отсутствии дочерней сессии." }, "verification_workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID сценария, используемый дочерней сессией. `null`, если дочерней сессии не существует." }, "verification_workflow_label": { "type": "string", "nullable": true, "description": "Понятное название сценария дочерней сессии. `null`, если не задано." }, "verification_workflow_features": { "type": "array", "nullable": true, "description": "Прогресс по функциям дочерней сессии верификации, например `[{\"feature\": \"ID_VERIFICATION\", \"status\": \"Approved\"}]`. `null`, если список функций дочерней сессии не удалось определить.", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Отображаемое имя функции (например, `ID_VERIFICATION`, `LIVENESS`, `AML`)." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Статус на уровне функции внутри дочерней сессии." } } } }, "didit_internal_id": { "type": "string", "nullable": true, "description": "Постоянный внутренний идентификатор верифицированного физического лица, связанного с дочерней сессией, — полезен для связывания между сессиями. `null`, если дочерняя сессия отсутствует или пользователь ещё не сопоставлен." }, "kyc_document_type": { "type": "string", "nullable": true, "description": "Тип документа, предъявленного в дочерней KYC-сессии (например, `P`, `ID`, `DL`). Имеет значение `null` до тех пор, пока в дочерней сессии не появится результат верификации личности." }, "kyc_nationality": { "type": "string", "nullable": true, "description": "Гражданство, извлечённое из документа в дочерней KYC-сессии. `null`, пока недоступно." }, "kyc_liveness_passed": { "type": "boolean", "nullable": true, "description": "Успешно ли пройдена проверка живости в дочерней KYC-сессии. `null`, если проверка живости не запускалась." }, "kyc_verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда дочерняя сессия KYC получила статус `Approved`. `null`, пока дочерняя сессия имеет любой другой статус." }, "kyc_aml_categories": { "type": "object", "nullable": true, "description": "Сводка по категориям на основе совпадений в AML-проверках по персоне. `null`, если совпадений нет.", "properties": { "sanctions": { "type": "string", "enum": [ "match", "clear" ] }, "pep": { "type": "string", "enum": [ "match", "clear" ] }, "adverse_media": { "type": "string", "enum": [ "match", "clear" ] }, "warnings": { "type": "string", "enum": [ "match", "clear" ] } } }, "kyc_notification_sent_at": { "type": "string", "nullable": true, "description": "Временная метка ISO 8601 последней отправки уведомления с приглашением на верификацию для дочерней сессии этого человека. `null`, если отправка не выполнялась." }, "child_beneficial_owners": { "type": "array", "description": "Для корпоративных UBO: собственные бенефициарные владельцы владеющей компании в виде необработанных объектов, извлечённых из реестра. Пустой массив, если неприменимо.", "items": { "type": "object" } }, "effective_ownership_percent": { "type": "number", "nullable": true, "description": "Распознанный числовой процент владения — верхняя граница, если доступна, иначе нижняя граница. `null`, если ни одну из границ не удалось распознать." }, "voting_min_shares": { "type": "string", "nullable": true }, "voting_max_shares": { "type": "string", "nullable": true }, "appointment_date": { "type": "string", "nullable": true, "description": "Дата назначения, если указана.", "format": "date" } } } } } }, "submitted": { "type": "object", "description": "Стороны, переданные администратором компании в процессе проверки ключевых лиц (строки BusinessParty, где source=USER).", "properties": { "parties": { "type": "array", "items": { "type": "object", "description": "Сторона, переданная администратором компании в процессе проверки ключевых лиц (source=USER).", "properties": { "uuid": { "type": "string", "format": "uuid" }, "entity_type": { "type": "string", "enum": [ "person", "company" ] }, "source": { "type": "string", "enum": [ "USER" ], "description": "Всегда `USER` здесь — эта группа содержит только стороны, введённые или подтверждённые конечным пользователем в сценарии ключевых лиц (люди, найденные в реестре, отображаются в `registry`)." }, "name": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "company_name": { "type": "string", "nullable": true }, "registration_number": { "type": "string", "nullable": true }, "email": { "type": "string", "format": "email", "nullable": true }, "nationality": { "type": "string", "nullable": true, "description": "Гражданство для физических лиц; страна регистрации для компаний, являющихся сторонами." }, "phone_number": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "position": { "type": "string", "nullable": true, "description": "Название должности / позиции в виде произвольного текста (только физические лица)." }, "custom_fields": { "type": "object", "description": "Пользовательские поля, определённые сценарием и собранные для этой стороны; ключи определяются дескрипторами полей ключевых лиц сценария." }, "is_active": { "type": "boolean" }, "is_skipped": { "type": "boolean", "description": "True, когда конечный пользователь пропустил верификацию для этой стороны (возможно, только если роль разрешает пропуск)." }, "requires_verification": { "type": "boolean", "description": "True, когда для этой стороны требуется дочерняя подсессия KYC / KYB на основе настроек роли и порогов структуры владения." }, "roles": { "type": "array", "description": "Все роли, которые занимает эта сторона, каждая со своими процентами владения и прав голоса. У самой стороны нет скалярных полей `role`/`ownership_percent`.", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ] }, "ownership_percent": { "type": "number", "nullable": true }, "voting_percent": { "type": "number", "nullable": true } } } }, "kyc_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID дочерней сессии KYC для сторон, являющихся физическими лицами, требующих верификации. В противном случае `null`." }, "kyc_session_status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "nullable": true, "description": "Статус жизненного цикла дочерней сессии KYC. `null`, если дочерняя сессия KYC отсутствует." }, "kyc_session_url": { "type": "string", "format": "uri", "nullable": true }, "kyb_sub_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID дочерней подсессии KYB для корпоративных сторон, требующих верификации. В противном случае `null`." }, "kyb_sub_session_status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "nullable": true, "description": "Статус жизненного цикла дочерней подсессии KYB. `null`, если подсессия отсутствует." }, "kyb_sub_session_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL дочерней субсессии KYB для предоставления доступа. `null`, если субсессия отсутствует." }, "verification_workflow_type": { "type": "string", "nullable": true, "description": "Базовый тип сценария дочерней сессии (приоритет отдаётся KYC-сессии с откатом к подсессии KYB). `null` для сценариев на основе графа или при отсутствии дочерней сессии." }, "verification_workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID сценария, используемый дочерней сессией. `null`, если дочерней сессии не существует." }, "verification_workflow_label": { "type": "string", "nullable": true, "description": "Понятное название сценария дочерней сессии. `null`, если не задано." }, "verification_workflow_features": { "type": "array", "nullable": true, "description": "Прогресс по функциям дочерней сессии верификации, например `[{\"feature\": \"ID_VERIFICATION\", \"status\": \"Approved\"}]`. `null`, если список функций дочерней сессии не удалось определить.", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Отображаемое имя функции (например, `ID_VERIFICATION`, `LIVENESS`, `AML`)." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Статус на уровне функции внутри дочерней сессии." } } } }, "didit_internal_id": { "type": "string", "nullable": true, "description": "Постоянный внутренний идентификатор верифицированного физического лица, связанного с дочерней сессией. `null`, если не сопоставлен." } } } } } }, "ubo_kyc_summary": { "type": "object", "nullable": true, "description": "Агрегированный прогресс KYC бенефициарных владельцев (UBO) или null, если у бенефициарных владельцев нет привязанных KYC-сессий.", "properties": { "total": { "type": "integer" }, "approved": { "type": "integer" }, "flagged": { "type": "integer", "description": "UBO, чей KYC находится в статусе «отклонена» или «на проверке»." }, "pending": { "type": "integer" } } }, "warnings": { "type": "array", "items": { "type": "object" } } } } }, "document_verifications": { "type": "array", "nullable": true, "description": "Проверки верификации документов, сгруппированные по узлам сценария. Присутствует, только если `session_kind = business`.", "items": { "type": "object", "description": "Документы, сгруппированные по узлам сценария. Присутствует, только если session_kind = business.", "properties": { "status": { "type": "string" }, "node_id": { "type": "string", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "document_type": { "type": "string", "enum": [ "LEGAL_PRESENCE", "COMPANY_DETAILS", "OWNERSHIP_STRUCTURE", "REPRESENTATIVES_AUTHORIZATION", "OTHER" ], "nullable": true, "description": "Высокоуровневая группа документов KYB, к которой был отнесён файл. `null`, пока файл не классифицирован." }, "document_subtype": { "type": "string", "nullable": true, "description": "Конкретный подтип, определённый OCR (например, `CERTIFICATE_OF_INCORPORATION`, `SHAREHOLDER_REGISTRY`); `UNKNOWN`, если OCR не удалось уверенно классифицировать документ." }, "document_group": { "type": "string", "enum": [ "LEGAL_PRESENCE", "COMPANY_DETAILS", "OWNERSHIP_STRUCTURE", "REPRESENTATIVES_AUTHORIZATION", "OTHER" ], "nullable": true, "description": "Псевдоним `document_type` — имя группы, используемое `groups` и `required_groups`." }, "file_url": { "type": "string", "format": "uri", "nullable": true, "description": "Временная предварительно подписанная ссылка на загруженный файл. `null` для созданных аналитиком заполнителей запросов документов (`is_requested = true`), которые ещё не были выполнены." }, "original_filename": { "type": "string", "nullable": true, "description": "Имя файла при загрузке пользователем или аналитиком." }, "file_size": { "type": "integer", "nullable": true, "description": "Размер файла в байтах." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Статус верификации по каждому документу." }, "created_at": { "type": "string", "format": "date-time" }, "cross_check_result": { "type": "object", "nullable": true, "description": "Сверка извлечённых через OCR полей документа с профилем компании из реестра. Объект с разделами `critical`, `non_critical` и `people`, каждый из которых связывает имя поля (например, `company_name`, `registration_number`, `incorporation_date`, `registered_address`) с записью сравнения вида `{\"document\": \"...\", \"registry\": \"...\", \"match\": true, \"score\": 0.97}`. `null`, если в документе не было данных OCR или отсутствовала компания из реестра для сравнения." }, "document_metadata": { "type": "object", "nullable": true, "description": "Метаданные, извлечённые из загруженного корпоративного документа. При успешном извлечении метаданных всегда присутствуют все 16 ключей (отдельные значения равны `null`, если они неприменимы к данному типу файла); весь объект равен `null`, если ничего извлечь не удалось. Для PDF-файлов поле `overlay_manipulation` содержит результаты форензик-анализа наложенного текста.", "properties": { "file_size": { "type": "integer", "nullable": true, "description": "Размер документа." }, "content_type": { "type": "string", "nullable": true, "description": "Тип содержимого документа." }, "creation_date": { "type": "string", "nullable": true, "description": "Дата создания документа." }, "modified_date": { "type": "string", "nullable": true, "description": "Дата изменения документа." }, "creator": { "type": "string", "nullable": true, "description": "Инструмент/пользователь, создавший файл, записанный в метаданных (PDF `Creator`)." }, "producer": { "type": "string", "nullable": true, "description": "Программное обеспечение, создавшее файл (`Producer` в PDF)." }, "software": { "type": "string", "nullable": true, "description": "Программное обеспечение для редактирования, зафиксированное в метаданных файла." }, "encryption": { "type": "string", "nullable": true, "description": "Схема шифрования файла, если он зашифрован." }, "is_signed": { "type": "boolean", "nullable": true, "description": "Содержит ли документ цифровую подпись." }, "is_tampered": { "type": "boolean", "nullable": true, "description": "Не прошла ли цифровая подпись проверку (изменение после подписания)." }, "signature_info": { "type": "object", "nullable": true, "description": "Сведения о цифровой подписи (подписях), если имеются." }, "exif_original_date": { "type": "string", "nullable": true, "description": "Исходная дата съёмки EXIF для загруженных изображений." }, "exif_digitized_date": { "type": "string", "nullable": true, "description": "Дата оцифровки EXIF для загруженных изображений." }, "processed_by_known_editor": { "type": "boolean", "nullable": true, "description": "Указывают ли метаданные на то, что файл обрабатывался в известном редакторе изображений или PDF." }, "has_different_creation_mod_date": { "type": "boolean", "nullable": true, "description": "Различаются ли даты создания и изменения — возможный (но не окончательный) признак редактирования." }, "overlay_manipulation": { "type": "object", "nullable": true, "description": "Криминалистический анализ PDF на предмет подозрения на манипуляции с наложением текста. Null, если свидетельств манипуляций с наложением не обнаружено или документ не являлся PDF.", "properties": { "detected": { "type": "boolean", "description": "Были ли обнаружены признаки манипуляций с наложенным текстом." }, "analyzed": { "type": "boolean", "description": "Удалось ли проанализировать PDF." }, "analysis_incomplete": { "type": "boolean", "description": "Присутствует и равно true только в том случае, если файл не удалось проверить полностью. Результаты проверки той части, которую удалось проверить, сохраняются, а в документе выводится предупреждение о непроверенной замене текста." }, "signals": { "type": "array", "items": { "type": "string" }, "description": "Сработавшие форензик-сигналы, такие как duplicate_font_subset или glyph_fragmentation." }, "manipulated_regions": { "type": "array", "description": "Области с подозрением на манипуляции в координатах страницы PDF.", "items": { "type": "object", "properties": { "page": { "type": "integer" }, "x": { "type": "number" }, "y": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "page_width": { "type": "number" }, "page_height": { "type": "number" } } } } } } } }, "description": { "type": "string", "nullable": true, "description": "Указанная аналитиком метка или причина запроса документа. `null` для стандартных загрузок." }, "is_requested": { "type": "boolean", "description": "True для созданных аналитиком плейсхолдеров запроса документов, ожидающих загрузки." }, "ocr_data": { "type": "object", "nullable": true }, "is_console_upload": { "type": "boolean", "description": "True для документов, загруженных из консоли, а не через сценарий конечного пользователя. Загрузки из консоли никогда не меняют совокупный статус на уровне функции." }, "is_confirmed": { "type": "boolean", "description": "Загрузки через Console начинаются со значения `false` и переключаются в `true` после подтверждения администратором; загрузки конечным пользователем всегда имеют значение `true`." } } } }, "groups": { "type": "object", "description": "Счётчики прогресса по группам, сгруппированные по названию группы (например, legal_presence, ownership_structure).", "additionalProperties": { "type": "object", "properties": { "total": { "type": "integer" }, "approved": { "type": "integer" }, "pending": { "type": "integer" }, "declined": { "type": "integer" }, "in_review": { "type": "integer" }, "other": { "type": "integer" }, "missing": { "type": "integer", "description": "Запрошенные плейсхолдеры, для которых ещё не загружен файл." } } } }, "required_groups": { "type": "array", "items": { "type": "string" } }, "warnings": { "type": "array", "items": { "type": "object" } } } } }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Была ли сессия создана продакшн-приложением (`live`) или приложением песочницы (`sandbox`). Сессии в песочнице бесплатны, полностью симулируются и никогда не списывают кредиты." }, "sandbox_scenario": { "type": "string", "nullable": true, "description": "Сценарий песочницы, с которым была создана сессия. Значение `null` для сессий в продакшн-среде и для сессий в песочнице, созданных без сценария." }, "resubmissions": { "type": "array", "description": "Возвращается только при `include=resubmissions`, для сессий пользователей и сессий компаний. По одной записи на каждый запрос повторной отправки, начиная с самых старых. Каждая запись содержит результаты, возвращённые повторно отправленными шагами до запроса, поэтому более ранние отправки остаются доступными для чтения. Удаление сессии удаляет все отправки.", "items": { "type": "object", "properties": { "number": { "type": "integer", "description": "1 для первой повторной отправки сессии, 2 для второй и так далее." }, "created_at": { "type": "string", "format": "date-time", "description": "Время запроса повторной отправки." }, "previous_status": { "type": "string", "description": "Статус сессии непосредственно перед запросом." }, "nodes": { "type": "array", "description": "Шаги сценария, отправленные обратно пользователю.", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "feature": { "type": "string" } } } }, "reasons": { "type": "object", "nullable": true, "additionalProperties": { "type": "string" }, "description": "Причина, указанная для каждого шага, с ключом по `node_id`." }, "requested_by": { "type": "object", "nullable": true, "description": "Кто запросил повторную отправку.", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "type": { "type": "string" } } }, "results": { "type": "object", "additionalProperties": true, "description": "Что вернули повторно отправленные шаги до запроса, под теми же ключами и в том же формате, что и текущие результаты этого ответа (`id_verifications`, `nfc_verifications`, `liveness_checks`, `face_matches`, `poa_verifications`, `phone_verifications`, `email_verifications`, `aml_screenings`, `ip_analyses`, `database_validations`, `questionnaire_responses`, `document_ai_documents`, `geolocation_checks`; для бизнес-сессий также `document_verifications`). Отображаются только ключи тех шагов, которые были отправлены повторно." } } } }, "biometric_consent": { "type": "object", "nullable": true, "description": "Требовалось ли в сессии явное согласие на обработку биометрии перед захватом лица, по какой причине, а также подтверждение ответа. Только для сессий Проверки пользователей (KYC); тот же объект находится в `decision` webhook сессии. Значение `null`, если сессия не оценивалась, например в сценарии без захвата лица. Поля без зафиксированного значения равны `null`. Нативный SDK версии ниже 4.10.0 или SDK, не передающий свою версию, не может отобразить шаг согласия: захват лица выполняется как прежде, а сессия, требовавшая согласия, возвращает `status: \"pending\"` с `reason: \"BIOMETRIC_CONSENT_UNSUPPORTED_SDK\"`. См. [Согласие на обработку биометрии](/ru/getting-started/biometric-consent).", "properties": { "required": { "type": "boolean", "description": "Whether the session must collect explicit biometric consent. Never goes back to `false`." }, "trigger": { "type": "string", "nullable": true, "enum": [ "declared_state", "ip_state", "ip_unknown", "document_issuer", "forced", "customer_collected" ], "description": "Причина, по которой требуется согласие, или способ его получения. `declared_state`: вы указали штат, на который распространяется требование (`user_state` или адрес в США в `expected_details`). `ip_state`: IP-адрес человека находится в штате, на который распространяется требование (Иллинойс, Техас, Колорадо). `ip_unknown`: данные указывают на нахождение в США, но штат определить невозможно (IP-адрес в США без указания штата, или местоположение не определяется, при этом ваши данные или документ указывают на США). `document_issuer`: документ, удостоверяющий личность, выдан штатом, на который распространяется требование. `forced`: для приложения установлен режим Always. `customer_collected`: вы передали `biometric_consent` при создании сессии. `null`, если согласие не требуется." }, "status": { "type": "string", "enum": [ "not_required", "pending", "given", "declined" ], "description": "`not_required`; `pending` (требуется, но не предоставлено: человек еще не ответил либо в `reason` указана причина, почему оно не было собрано); `given`; `declined` (зафиксирован отказ, и сессия завершилась со статусом `Declined`; в настоящее время ни один экран Didit не предлагает возможность отказа)." }, "given_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда согласие было дано. Для `customer_collected` это переданное вами значение `given_at`." }, "declined_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда было зафиксировано отклонение." }, "text_version": { "type": "string", "nullable": true, "description": "Идентификатор версии текста согласия, на который ответил пользователь, или текста, который вы отправили." }, "text_hash": { "type": "string", "nullable": true, "description": "SHA-256 (hex) точного показанного текста согласия на том языке, на котором он отображался." }, "locale": { "type": "string", "nullable": true, "description": "Язык, на котором был показан текст согласия." }, "policy_url": { "type": "string", "format": "uri", "nullable": true, "description": "Политика обработки биометрических данных, на которую ссылался шаг согласия." }, "step": { "type": "string", "nullable": true, "description": "Шаг сценария, на котором находилась сессия, когда человек дал ответ, например `LIVENESS`." }, "node_id": { "type": "string", "nullable": true, "description": "Узел графа сценария, на котором находилась сессия, когда человек дал ответ." }, "ip_address": { "type": "string", "nullable": true, "description": "IP-адрес, с которого был получен ответ." }, "ip_country_code": { "type": "string", "nullable": true, "description": "Код страны IP-адреса ответа по стандарту ISO 3166-1 alpha-2." }, "ip_state": { "type": "string", "nullable": true, "description": "Подразделение по ISO 3166-2 для IP ответа, например `US-IL`." }, "ip_city": { "type": "string", "nullable": true, "description": "Город, определённый по IP-адресу, с которого был дан ответ." }, "user_agent": { "type": "string", "nullable": true, "description": "User-Agent запроса с ответом." }, "detected_ip_address": { "type": "string", "nullable": true, "description": "IP-адрес человека, с которого требование оценивалось в последний раз. Может отличаться от `ip_address`, если человек ответил с другого устройства." }, "detected_country_code": { "type": "string", "nullable": true, "description": "Код страны обнаруженного IP-адреса по стандарту ISO 3166-1 alpha-2." }, "detected_state": { "type": "string", "nullable": true, "description": "Подразделение по ISO 3166-2 обнаруженного IP-адреса." }, "detected_city": { "type": "string", "nullable": true, "description": "Город обнаруженного IP-адреса." }, "declared_state": { "type": "string", "nullable": true, "description": "Указанное вами подразделение по ISO 3166-2: `user_state` или штат адреса в США в `expected_details`." }, "document_state": { "type": "string", "nullable": true, "description": "Подразделение по ISO 3166-2, выдавшее документ, удостоверяющий личность; считывается при захвате документа." }, "jurisdictions": { "type": "array", "items": { "type": "string" }, "description": "Штаты США (коды USPS, например `IL`), законы о биометрии которых распространяются на лицо. `US`, если по имеющимся данным лицо находится в США, но конкретный штат неизвестен. Пусто, если ничего не применимо." }, "retention_months": { "type": "integer", "nullable": true, "description": "Минимальный срок хранения биометрических данных в месяцах среди `jurisdictions`. `null`, если ни один не применяется." }, "reason": { "type": "string", "nullable": true, "enum": [ "BIOMETRIC_CONSENT_UNSUPPORTED_SDK", "BIOMETRIC_CONSENT_DECLINED" ], "description": "`BIOMETRIC_CONSENT_UNSUPPORTED_SDK`: требовалось согласие, и нативный SDK версии ниже 4.10.0 или не передавший свою версию захватил лицо без шага согласия; `status` остаётся `pending` или переходит в `given`, если человек позже дал согласие в размещённом сценарии. `BIOMETRIC_CONSENT_DECLINED`: был зафиксирован отказ (он заменяет причину SDK). В противном случае `null`, и всегда `null`, если сессия не требовала согласия." }, "decline_reason": { "type": "string", "nullable": true, "enum": [ "BIOMETRIC_CONSENT_DECLINED" ], "description": "`BIOMETRIC_CONSENT_DECLINED`, если зафиксированный отказ завершил сессию, иначе `null`." }, "face_data_deleted_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда при отклонении были удалены изображения лица, видео и биометрические шаблоны лица сессии. `null`, если отклонение не было зафиксировано." } } }, "investigator": { "$ref": "#/components/schemas/InvestigatorBlock" }, "biometric_retention": { "$ref": "#/components/schemas/BiometricRetention" }, "fraud_check": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Результат вызова Fraud Check API. `null` для всех остальных сессий." }, "full_session_video": { "type": "string", "format": "uri", "nullable": true, "description": "Временный URL полной видеозаписи сессии. Возвращается только тогда, когда ваша организация записывает видео всей сессии." }, "full_session_video_recorded_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда была сделана запись всей сессии. Возвращается только тогда, когда ваша организация записывает видео всей сессии." } } }, "WorkflowDetail": { "type": "object", "description": "Поля ниже являются типизированными; объект также содержит все остальные столбцы конфигурации сценария (переключатели функций, пороги, действия при предупреждениях, разрешённые документы, обратные вызовы) в качестве дополнительных свойств. Поля, неприменимые к `workflow_type`, имеют значение `null`.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Идентификатор конкретной версии (`settings_uuid`). Каждая версия сценария имеет собственный идентификатор." }, "workflow_id": { "type": "string", "format": "uuid", "description": "Постоянный идентификатор, общий для всех версий сценария. Созданные с его помощью сессии используют последнюю опубликованную версию." }, "workflow_label": { "type": "string", "description": "Отображаемое имя сценария." }, "workflow_type": { "type": "string", "nullable": true, "enum": [ "kyc", "kyb", "adaptive_age_verification", "biometric_authentication", "address_verification", "questionnaire_verification", "email_verification", "phone_verification", null ], "description": "Шаблон сценария. `null` для графовых сценариев, созданных без шаблона." }, "is_default": { "type": "boolean", "description": "Является ли этот сценарий сценарием по умолчанию для приложения." }, "is_archived": { "type": "boolean", "description": "Архивные сценарии не могут запускать новые сессии." }, "version": { "type": "integer", "description": "Номер версии внутри сценария." }, "status": { "type": "string", "enum": [ "draft", "published" ], "description": "Черновые версии можно редактировать; опубликованные версии неизменяемы и используются для новых сессий." }, "published_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда была опубликована эта версия. `null` для черновиков." }, "is_simple_workflow": { "type": "boolean", "description": "`true`, если сценарий не имеет пользовательского `workflow_graph`." }, "is_editable": { "type": "boolean", "description": "`true` только для версий со статусом `draft`." }, "workflow_url": { "type": "string", "format": "uri", "description": "Публичный URL для запуска сессии с этим сценарием." }, "workflow_graph": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Структура графа сценария (узлы и рёбра). `null` для простых сценариев." }, "features": { "type": "string", "description": "Включенные функции, объединенные через `\" + \"`, например `\"OCR + LIVENESS\"`." }, "total_price": { "type": "number", "nullable": true, "description": "Цена за сессию; для графовых сценариев это самый дорогой путь." }, "min_price": { "type": "number", "nullable": true, "description": "Цена самого дешёвого пути в сценарии." }, "max_price": { "type": "number", "nullable": true, "description": "Цена самого дорогого пути в сценарии." }, "special_add_on_prices": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Специальные цены на дополнения для организации или `null`, если они не заданы." }, "max_retry_attempts": { "type": "integer", "description": "Количество повторных попыток, разрешенных после отклоненной верификации." }, "retry_window_days": { "type": "integer", "nullable": true, "description": "Количество дней, в течение которых разрешены повторные попытки." }, "session_expiration_time": { "type": "integer", "description": "Количество секунд до истечения срока незавершённой сессии." }, "questionnaire": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Анкета, прикрепленная к сценарию, или `null`." }, "kyb_role_settings": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Настройки верификации по ролям для ключевых лиц KYB." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "signature_availability": { "type": "object", "description": "Какие уровни Электронной подписи доступны для подписания прямо сейчас. Проверьте это перед установкой `signature_level`. Возвращается в сценариях `kyc`, `kyb` и графовых сценариях.", "properties": { "simple": { "type": "boolean", "description": "Simple доступен всегда." }, "aes": { "type": "boolean", "description": "Доступна ли сейчас подпись с расширенным уровнем (AES). Пока значение `false`, сохранение нового шага с `signature_level: \"aes\"` отклоняется с ошибкой `aes_not_available`." }, "qes": { "type": "boolean", "description": "Доступна ли сейчас подпись с квалифицированным уровнем (QES). Имеет значение `false`, пока не подключен квалифицированный провайдер." } } }, "is_bank_verification_enabled": { "type": "boolean", "description": "Выполняется ли в простом сценарии KYC или KYB верификация банка. Она выполняется после шагов контакта (и верификации местоположения) и перед проверкой по базам данных, AML и анализом IP. Верификация банка пока не является общедоступной: её включение отклоняется везде, где она не активирована." }, "bank_verification_config": { "type": "object", "additionalProperties": true, "description": "Настройки верификации банковских счетов простого сценария с теми же ключами, которые принимает узел `BANK_VERIFICATION` (например, `bank_countries` и `bank_method_order`). Неизвестные ключи отбрасываются. Каждый ключ необязателен, а отсутствующий ключ сохраняет значение по умолчанию, поэтому `{}` означает использование всех значений по умолчанию. См. раздел [Настройки верификации счетов](/ru/management-api/workflows/feature-configs#верификация-банка).", "example": {} }, "is_geolocation_enabled": { "type": "boolean", "description": "Выполняется ли в простом сценарии KYC верификация местоположения. Она выполняется после шагов контакта и перед верификацией банка и проверкой по базам данных. В сценариях верификации бизнеса (KYB) этот шаг недоступен." }, "geolocation_config": { "type": "object", "additionalProperties": true, "description": "Настройки верификации местоположения для простого сценария с теми же ключами, которые принимает узел `GEOLOCATION` (например, `is_geolocation_geofencing_enabled` и `geolocation_max_attempts`). Неизвестные ключи отбрасываются. Каждый ключ необязателен; отсутствующий ключ сохраняет значение по умолчанию, поэтому `{}` означает использование всех значений по умолчанию.", "example": {} } }, "additionalProperties": true }, "UserSessionListItem": { "title": "KYC session row (session_kind: user)", "type": "object", "description": "Сводная строка для сессии Проверки пользователей (KYC). Поля личности (`full_name`, `country`, `document_type`, `portrait_image`, контактные поля) заполняются по мере прохождения пользователем шагов верификации и имеют значение `null`, пока соответствующий шаг не завершён. Поля, ограниченные настройкой атрибутов ответа сценария, также возвращаются как `null`.", "required": [ "session_id", "session_kind", "session_number", "session_url", "portrait_image", "document_type", "full_name", "country", "status", "vendor_data", "didit_internal_id", "created_at", "features", "phone_number", "email_address", "additional_details" ], "properties": { "session_id": { "type": "string", "format": "uuid", "description": "Уникальный идентификатор сессии верификации. Используйте его с `GET /v3/session/{sessionId}/decision/`, чтобы получить полный payload решения.", "example": "5b3720ed-d429-42ef-b67f-37ea805f48ee" }, "session_kind": { "type": "string", "enum": [ "user" ], "description": "Дискриминатор строки. Всегда `\"user\"` для строк KYC; строки Верификации бизнеса (KYB) содержат `\"business\"` и имеют другую структуру.", "example": "user" }, "session_number": { "type": "integer", "description": "Понятный порядковый номер сессии внутри вашего приложения. Также сопоставляется с параметром `search`.", "example": 720 }, "session_url": { "type": "string", "nullable": true, "description": "Размещённый URL верификации, который открывает конечный пользователь для прохождения сценария. `null`, если у сессии нет размещённого URL.", "example": "https://verify.didit.me/session/CuXoBYCYVO5Y" }, "portrait_image": { "type": "string", "nullable": true, "description": "Временный (предварительно подписанный) URL наилучшего доступного фото лица: фото с NFC-чипа при наличии, иначе фото из документа, удостоверяющего личность, иначе эталонное изображение проверки живости. `null`, пока ни одно из них не появится. Скачайте оперативно; срок действия ссылки ограничен.", "example": "https:///portraits/5b3720ed.jpg?X-Amz-Expires=3600&X-Amz-Signature=..." }, "document_type": { "type": "string", "nullable": true, "enum": [ "Passport", "Identity Card", "Driver's License", "Residence Permit", "Health Insurance Card", "Tax Card" ], "description": "Понятный человеку тип проверенного документа, удостоверяющего личность. Значение `null` до завершения верификации документа, а также `null` после завершения, если проверенный код не имеет сопоставления для отображения (`SSC`, `WP`, `VISA`, `PSC`, `BC`, `OTHER`). Примечание: параметр запроса `document_type` фильтрует по коротким кодам (`P`, `ID`, `DL`, `RP`, ...), а не по этим отображаемым значениям.", "example": "Passport" }, "full_name": { "type": "string", "nullable": true, "description": "Наилучшее доступное полное имя для сессии, определяемое в следующем порядке: OCR документа, удостоверяющего личность, данные AML-скрининга, данные проверки по базам данных, документ подтверждения адреса, затем ожидаемые данные, переданные при создании сессии. Значение `null`, если данные пока недоступны.", "example": "Jane Marie Doe" }, "country": { "type": "string", "nullable": true, "description": "Код страны по стандарту ISO 3166-1 alpha-3, связанный с сессией, определяемый по порядку: государство выдачи документа, удостоверяющего личность; государство выдачи по проверке баз данных; государство выдачи документа, подтверждающего адрес; ожидаемые данные; затем страна подтвержденного телефона. Может отличаться от гражданства.", "example": "ESP" }, "status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Общий статус сессии. О жизненном цикле см. на странице [Статусы верификации](/ru/integration/verification-statuses).", "example": "Approved" }, "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный идентификатор конечного пользователя, возвращаемый в точности так, как был отправлен при создании сессии.", "example": "your-user-id-123" }, "didit_internal_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Внутренний идентификатор Didit для профиля верифицированного пользователя, привязанного к этой сессии. Постоянен между несколькими сессиями одного и того же пользователя; доступна фильтрация через query-параметр `didit_internal_id`.", "example": "d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147" }, "created_at": { "type": "string", "format": "date-time", "description": "Временная метка UTC создания сессии.", "example": "2026-06-09T12:26:54.328364Z" }, "features": { "type": "array", "description": "Статус по функциям для каждого шага верификации, настроенного в сценарии сессии, в порядке выполнения сценария.", "items": { "type": "object", "required": [ "feature", "status" ], "properties": { "feature": { "type": "string", "enum": [ "ID_VERIFICATION", "NFC", "LIVENESS", "FACE_MATCH", "POA", "QUESTIONNAIRE", "EMAIL_VERIFICATION", "PHONE", "AML", "IP_ANALYSIS", "AGE_ESTIMATION", "DATABASE_VALIDATION", "GEOLOCATION" ], "description": "Идентификатор функции верификации.", "example": "ID_VERIFICATION" }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Статус этой функции. Имеет значение `Not Finished` до завершения шага.", "example": "Approved" } } } }, "phone_number": { "type": "object", "nullable": true, "description": "Телефон, связанный с сессией: подтвержденный телефон, если выполнялась проверка телефона, иначе контактный телефон, указанный при создании сессии. `null`, если ни один из них не предоставлен.", "required": [ "number", "is_verified" ], "properties": { "number": { "type": "string", "description": "Номер телефона в формате E.164.", "example": "+14155552671" }, "is_verified": { "type": "boolean", "description": "`true` только в том случае, если функция проверки телефона одобрила этот номер.", "example": true } } }, "email_address": { "type": "object", "nullable": true, "description": "Электронная почта, связанная с сессией: подтверждённый адрес, если выполнялась проверка электронной почты, либо контактный адрес, указанный при создании сессии. `null`, если ничего из этого нет.", "required": [ "email", "is_verified" ], "properties": { "email": { "type": "string", "format": "email", "example": "jane@example.com" }, "is_verified": { "type": "boolean", "description": "`true` только в том случае, если функция проверки электронной почты одобрила этот адрес.", "example": true } } }, "additional_details": { "type": "object", "nullable": true, "description": "Компактные дополнительные данные по каждой функции. В качестве ключей появляются только функции, вернувшие данные; `null`, если ни одна функция не предоставила дополнительных данных. Поля, исключённые конфигурацией response-attributes сценария, опускаются.", "properties": { "aml": { "type": "object", "description": "Присутствует, если выполнялся AML-скрининг.", "properties": { "total_hits": { "type": "integer", "description": "Количество совпадений при AML-скрининге.", "example": 0 }, "entity_type": { "type": "string", "description": "Тип проверяемой сущности.", "example": "person" }, "is_adverse_media_fetched": { "type": "boolean", "example": false }, "screened_data": { "type": "object", "description": "Подмножество данных, прошедших скрининг. Включаются только непустые ключи.", "properties": { "nationality": { "type": "string", "example": "ESP" }, "document_number": { "type": "string", "example": "XX1234567" }, "date_of_birth": { "type": "string", "example": "1990-05-21" } } } } }, "database_validation": { "type": "object", "description": "Присутствует, если выполнялась проверка по базам данных.", "properties": { "validation_type": { "type": "string", "example": "DOCUMENT_VALIDATION" }, "match_type": { "type": "string", "example": "FULL_MATCH" }, "identification_number": { "type": "string", "description": "Налоговый, личный номер или номер документа, который был проверен (первый доступный).", "example": "12345678Z" } } }, "poa": { "type": "object", "description": "Присутствует, если выполнялось подтверждение адреса.", "properties": { "document_type": { "type": "string", "example": "UTILITY_BILL" }, "issuer": { "type": "string", "example": "Energy Co" }, "address": { "type": "string", "example": "Calle Mayor 1, 28013 Madrid" }, "name_on_document": { "type": "string", "example": "Jane Marie Doe" } } }, "liveness": { "type": "object", "description": "Присутствует, если выполнялась проверка живости.", "properties": { "method": { "type": "string", "example": "PASSIVE" }, "score": { "type": "number", "description": "Оценка уверенности проверки живости, округлённая до 2 знаков после запятой.", "example": 0.98 } } }, "face_match": { "type": "object", "description": "Присутствует, если выполнялось сравнение лиц.", "properties": { "score": { "type": "number", "description": "Оценка схожести сравнения лиц, округленная до 2 знаков после запятой.", "example": 0.95 }, "source_image": { "type": "string", "description": "Временный (предварительно подписанный) URL исходного изображения лица.", "example": "https:///faces/source.jpg?X-Amz-Expires=3600&..." }, "target_image": { "type": "string", "description": "Временный (предварительно подписанный) URL целевого изображения лица.", "example": "https:///faces/target.jpg?X-Amz-Expires=3600&..." } } }, "phone_verification": { "type": "object", "description": "Присутствует, если выполнялась проверка телефона.", "properties": { "country_code": { "type": "string", "description": "Код страны номера телефона по стандарту ISO 3166-1 alpha-2.", "example": "US" }, "is_temporary": { "type": "boolean", "example": false }, "is_ported": { "type": "boolean", "example": false }, "is_blocked": { "type": "boolean", "example": false } } }, "email_verification": { "type": "object", "description": "Присутствует, если выполнялась проверка электронной почты.", "properties": { "is_breached": { "type": "boolean", "example": false }, "is_disposable": { "type": "boolean", "example": false }, "is_undeliverable": { "type": "boolean", "example": false }, "is_blocklisted": { "type": "boolean", "example": false } } } } }, "assignee": { "type": "object", "nullable": true, "description": "Проверяющий в Консоли, которому назначена сессия, или `null`, если она никому не назначена.", "properties": { "email": { "type": "string", "format": "email" }, "assigned_at": { "type": "string", "format": "date-time", "nullable": true } } }, "waiting_since": { "type": "string", "format": "date-time", "nullable": true, "description": "Время, когда сессия перешла в ожидание проверки. `null`, если сессия не находится в статусе `In Review`." }, "sla_due_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Срок завершения проверки в соответствии с дедлайном, установленным для вашего приложения в Console. `null`, если сессия не находится в статусе `In Review` или дедлайн не задан." }, "top_warnings": { "type": "array", "description": "До нескольких наиболее важных предупреждений сессии для быстрого предварительного анализа. Полный список приведён в решении.", "items": { "type": "object", "properties": { "risk": { "type": "string", "description": "Код предупреждения, например `FACE_MATCH_LOW_SIMILARITY`." }, "feature": { "type": "string", "description": "Функция, вызвавшая его." }, "log_type": { "type": "string", "nullable": true, "description": "`error` или `warning`; `null` для устаревшей записи." }, "short_description": { "type": "string" } } } }, "warnings_count": { "type": "integer", "description": "Количество предупреждений по сессии." } } }, "BusinessSessionListItem": { "title": "KYB session row (session_kind: business)", "type": "object", "description": "Сводная строка для сессии Верификации бизнеса (KYB). Возвращается, только если `session_kind` имеет значение `business` или `all`.", "required": [ "session_id", "session_kind", "session_number", "status", "vendor_data", "created_at", "workflow_id", "workflow_type", "workflow_label", "company_name", "registration_number", "country" ], "properties": { "session_id": { "type": "string", "format": "uuid", "description": "Уникальный идентификатор сессии верификации бизнеса.", "example": "8a1f63c2-1b9e-4f3a-9c41-2f6a1f0b7d52" }, "session_kind": { "type": "string", "enum": [ "business" ], "description": "Дискриминатор строки. Всегда `\"business\"` для строк KYB.", "example": "business" }, "session_number": { "type": "integer", "description": "Понятный порядковый номер бизнес-сессии внутри вашего приложения. Нумеруется независимо от KYC-сессий.", "example": 42 }, "status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Общий статус сессии. См. страницу [Статусы верификации](/ru/integration/verification-statuses).", "example": "Approved" }, "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный идентификатор компании, возвращаемый в точности так, как был отправлен при создании сессии.", "example": "your-company-id-77" }, "created_at": { "type": "string", "format": "date-time", "description": "Временная метка UTC создания сессии.", "example": "2026-06-08T09:14:02.118450Z" }, "workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Идентификатор сценария, с которым была создана эта сессия.", "example": "9f9b1234-aaaa-bbbb-cccc-1234567890ab" }, "workflow_type": { "type": "string", "nullable": true, "description": "Тип сценария. `kyb` для сценариев верификации бизнеса.", "example": "kyb" }, "workflow_label": { "type": "string", "nullable": true, "description": "Отображаемое имя сценария.", "example": "Standard KYB" }, "company_name": { "type": "string", "nullable": true, "description": "Название верифицируемой компании из записи о компании в реестре, связанной с сессией. `null`, пока компания не выбрана.", "example": "Acme Holdings S.L." }, "registration_number": { "type": "string", "nullable": true, "description": "Регистрационный номер компании из реестра компаний, привязанного к сессии.", "example": "B12345678" }, "country": { "type": "string", "nullable": true, "description": "Код страны компании из реестра, привязанной к сессии.", "example": "ES" } } }, "TransactionVerificationSessionAction": { "title": "Verification session", "type": "object", "properties": { "type": { "type": "string", "enum": [ "verification_session" ] }, "url": { "type": "string", "format": "uri", "description": "Размещённый URL верификации для открытия конечным пользователем." }, "session_id": { "type": "string", "format": "uuid", "description": "ID сессии верификации." }, "session_token": { "type": "string", "description": "token сессии, используемый мобильными SDK для нативного запуска сценария." }, "status": { "type": "string", "description": "Статус сессии верификации." } }, "required": [ "type", "url" ] }, "TransactionWalletOwnershipAction": { "title": "Wallet ownership", "type": "object", "properties": { "type": { "type": "string", "enum": [ "wallet_ownership" ] }, "url": { "type": "string", "format": "uri", "description": "Размещённый URL виджета подтверждения владения кошельком. Открывайте его в полноценном интерфейсе браузера: на мобильных устройствах используйте SFSafariViewController или Chrome Custom Tab, ни в коем случае не встроенный webview." }, "widget_session_id": { "type": "string", "format": "uuid", "description": "Идентификатор сессии виджета подтверждения владения кошельком." }, "expires_at": { "type": "string", "format": "date-time", "description": "Когда истекает срок сессии виджета." } }, "required": [ "type", "url" ] }, "TransactionRuleActionAddScore": { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "add_score" ] }, "value": { "type": "integer", "description": "Баллы, добавленные к оценке риска транзакции. Могут быть отрицательными." } }, "description": "Добавьте баллы к совокупной оценке риска транзакции; итоговое значение определяет статус с учётом заданных приложением порогов проверки и отклонения." }, "TransactionRuleActionChangeStatus": { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "change_status" ] }, "value": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Статус, который необходимо установить немедленно, независимо от оценки. Псевдоним ключа: status." }, "workflow_id": { "type": "string", "format": "uuid", "description": "ОБЯЗАТЕЛЬНО, если значение равно AWAITING_USER: сценарий верификации, который субъект должен пройти. Ключ псевдонима: remediation_workflow_id. Didit создаёт размещённую сессию для устранения проблемы для субъекта при срабатывании правила." } }, "description": "Напрямую устанавливает статус транзакции. DECLINED всегда имеет приоритет среди сработавших правил." }, "TransactionRuleActionAddTags": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "add_tags" ] }, "tag_uuid": { "type": "string", "format": "uuid", "description": "Существующий тег приложения, который нужно прикрепить." }, "tag_name": { "type": "string", "description": "Имя тега для прикрепления; создается при первом использовании (сохраняется в верхнем регистре). Укажите tag_uuid или tag_name." }, "tag_color": { "type": "string", "description": "Шестнадцатеричный цвет (hex), используемый, когда tag_name создаёт новый тег, например #007AFE." } }, "description": "Прикрепить тег приложения к совпавшей транзакции." }, "TransactionRuleActionAddNote": { "type": "object", "required": [ "type", "note" ], "properties": { "type": { "type": "string", "enum": [ "add_note" ] }, "note": { "type": "string", "description": "Текст заметки, прикреплённой к транзакции (автор: Rule Engine). Ключ-алиас: значение." } }, "description": "Прикрепить автоматическую заметку аналитика к совпавшей транзакции." }, "TransactionRuleActionAddToList": { "type": "object", "required": [ "type", "list_id" ], "properties": { "type": { "type": "string", "enum": [ "add_to_list" ] }, "list_id": { "type": "string", "format": "uuid", "description": "Список, в который нужно добавить vendor_data субъекта." } }, "description": "Добавьте vendor_data субъекта в список блокировки, список разрешений или пользовательский список." }, "TransactionRuleActionOpenCase": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "open_case" ] }, "blueprint": { "type": "string", "format": "uuid", "description": "UUID шаблона кейса; по умолчанию используется шаблон по умолчанию для приложения." }, "grouping": { "type": "string", "enum": [ "by_applicant", "by_rule_and_applicant" ], "description": "Объединяются ли повторные совпадения в один кейс на заявителя или в один кейс на комбинацию правила и заявителя." }, "attach_matched_transaction": { "type": "boolean", "description": "Прикрепить совпавшую транзакцию к кейсу." } }, "description": "Открыть кейс расследования (или добавить в существующий). Применяется только первое действие open_case в правиле." }, "KYBRegistrySearchResults": { "type": "object", "properties": { "companies": { "type": "array", "items": { "type": "object", "properties": { "kyb_response_id": { "type": "string", "nullable": true, "description": "Идентификатор (handle) для этого кандидата — передайте его в `POST /v3/kyb/select/`, чтобы получить полный профиль. Является эфемерным и привязанным к этому поиску: не сохраняйте его на длительный срок; выполните повторный поиск, чтобы получить актуальный.", "example": "69aeeb95febb0f1704042259" }, "name": { "type": "string", "nullable": true, "description": "Зарегистрированное наименование компании.", "example": "Tesco PLC" }, "registration_number": { "type": "string", "nullable": true, "description": "Регистрационный номер в реестре.", "example": "00445790" }, "status": { "type": "string", "nullable": true, "description": "Нормализованный статус компании по данным реестра (например, `active`, `dissolved`, `inactive`, `struck off`).", "example": "active" }, "type": { "type": "string", "nullable": true, "description": "Организационно-правовая форма по данным реестра.", "example": "Public Limited Company" }, "registered_address": { "type": "string", "nullable": true, "description": "Зарегистрированный адрес кандидата, если он указан в реестре. Используйте его вместе с регистрационным номером, чтобы различать компании с одинаковыми названиями: в США кандидат может быть указан в штате, где компания ведёт деятельность, а не в том штате, по которому вы выполняли поиск.", "example": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, AL7 1GA" }, "risk_level": { "type": "string", "nullable": true, "description": "Уровень риска по данным реестра, если доступен. Обычно `null` во время поиска." }, "fetch_status": { "type": "string", "nullable": true, "description": "Всегда `pending` для кандидатов поиска — полный профиль компании запрашивается (и тарифицируется) только при выборе кандидата.", "example": "pending" } } }, "description": "Дедуплицированный список кандидатов. Пуст, пока `search_resolved=false` (режим webhook) или если совпадений не найдено." }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "description": "Количество возвращённых кандидатов." }, "page": { "type": "integer" }, "per_page": { "type": "integer", "example": 25 } } }, "search_status": { "type": "string", "nullable": true, "enum": [ "pending", "resolved" ], "description": "Статус жизненного цикла поиска в реестре." }, "search_resolved": { "type": "boolean", "description": "`true`, когда список кандидатов окончательно сформирован." } } }, "KYBRegistryCandidateRequest": { "type": "object", "required": [ "kyb_response_id" ], "properties": { "kyb_response_id": { "type": "string", "maxLength": 1024, "description": "Идентификатор кандидата (handle) из `POST /v3/kyb/search/` (`kyb_registry.companies[].kyb_response_id`). Является временным: используйте его вскоре после запроса, который его вернул. Идентификаторы могут быть длинными, поэтому сохраняйте и отправляйте значение в точности так, как оно возвращено, не обрезая его и не делая предположений о длине.", "example": "69aeeb95febb0f1704042259" }, "vendor_data": { "type": "string", "description": "Ваш идентификатор этой компании; возвращается в ответе и сохраняется вместе с сессией компании." }, "metadata": { "type": "object", "nullable": true, "description": "JSON в свободной форме, сохраняемый с бизнес-сессией и возвращаемый в ответе." }, "save_api_request": { "type": "boolean", "default": true, "description": "Должно быть `true` (по умолчанию). Выборки из реестра KYB всегда сохраняются для отслеживания биллинга и получения данных; `false` возвращает `400`." } } }, "WebhookEventEnvelope": { "type": "object", "description": "Поля, которые Didit добавляет к каждой подписанной доставке webhook независимо от типа события. Читайте `webhook_type`, чтобы определить полученный payload.", "required": [ "event_id", "webhook_type", "timestamp", "created_at", "application_id", "environment" ], "properties": { "event_id": { "type": "string", "format": "uuid", "description": "Идентификатор события. Каждый адрес назначения получает одно и то же значение, и при повторной доставке оно сохраняется, поэтому используйте его для дедупликации." }, "webhook_type": { "$ref": "#/components/schemas/WebhookEvent" }, "timestamp": { "type": "integer", "description": "Unix-время в секундах, когда эта доставка была подписана. Совпадает с заголовком `X-Timestamp`; повторная доставка содержит новое значение." }, "created_at": { "type": "integer", "description": "Unix-время в секундах изменения, вызвавшего событие." }, "application_id": { "type": "string", "format": "uuid", "description": "Приложение, к которому относится событие." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "`sandbox` для сессий в песочнице и приложений в песочнице, иначе `live`." } } }, "SessionWebhookEventData": { "type": "object", "description": "Поля сессии для `status.updated` и `data.updated`. Необязательные поля опускаются и никогда не отправляются как `null`, если они неприменимы. Сессии верификации бизнеса (KYB) добавляют `business_session_id`, `session_kind` и `vendor_business_id`.", "required": [ "session_id", "status", "sandbox_scenario" ], "properties": { "session_id": { "type": "string", "format": "uuid", "description": "Сессия верификации." }, "business_session_id": { "type": "string", "format": "uuid", "description": "Только для сессий верификации бизнеса (KYB): то же значение, что и `session_id`." }, "session_kind": { "type": "string", "enum": [ "business" ], "description": "Только для сессий верификации бизнеса (KYB). События сессий пользователей (KYC) не содержат `session_kind` на верхнем уровне; вместо этого используйте `decision.session_kind`." }, "status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Статус сессии после изменения." }, "trigger": { "type": "string", "description": "Присутствует, когда событие было создано не самим сценарием верификации, например `manual_review`, `manual_step_update`, `ongoing_monitoring`, `webhook_reconciliation` (повторно отправленный `status.updated`, поскольку первый финальный webhook так и не был создан, поэтому вы можете получить повторное событие для решения, которое вы уже получали: выполняйте дедупликацию по `session_id` и `status`), `manual_webhook_recovery`, `kyb_registry_change`, `biometric_retention` (отправляемый `data.updated`, когда живые биометрические данные сессии удаляются по расписанию) или редактирование `console_*`, такое как `console_registry_edit`, `console_key_people_skip` либо `console_key_people_regenerate`." }, "workflow_id": { "type": "string", "format": "uuid", "description": "Сценарий сессии. Опускается, если у сессии его нет." }, "workflow_version": { "type": "integer", "description": "Версия сценария, в которой была запущена сессия. Отправляется вместе с `workflow_id`." }, "vendor_data": { "type": "string", "description": "Ваш `vendor_data` для сессии. Опускается, если пустой." }, "vendor_business_id": { "type": "string", "description": "Только для сессий верификации бизнеса (KYB): компания, к которой относится сессия. Опускается, если отсутствует." }, "metadata": { "type": "object", "additionalProperties": true, "description": "Метаданные вашей сессии (`metadata`). Опускается, если пусто." }, "decision": { "$ref": "#/components/schemas/SessionDecision" }, "resubmit_info": { "type": "object", "description": "Только если `status` имеет значение `Resubmitted`: шаги, которые пользователь должен пройти повторно, и причина.", "required": [ "nodes_to_resubmit", "reasons" ], "properties": { "nodes_to_resubmit": { "type": "array", "items": { "type": "object", "required": [ "node_id", "feature" ], "properties": { "node_id": { "type": "string", "description": "Идентификатор узла в том виде, в каком он указан в определении сценария сессии (например, `feature_ocr`, `feature_liveness`).", "example": "feature_poa" }, "feature": { "type": "string", "description": "Тип функции узла, например `OCR`, `LIVENESS` или `PROOF_OF_ADDRESS`.", "example": "PROOF_OF_ADDRESS" } } }, "description": "Шаги сценария, которые пользователь должен повторить. Те же записи `{node_id, feature}`, что и `nodes_to_resubmit` в [Обновление статуса](#patch-/v3/session/-sessionId-/update-status/)." }, "reasons": { "type": "object", "additionalProperties": true, "description": "Причина для каждого `node_id` в `nodes_to_resubmit`." } } }, "sandbox_scenario": { "type": "string", "nullable": true, "description": "Смоделированный результат, настроенный для сессии в песочнице, или `null`. Всегда `null` для продакшн-сессий." } } }, "SessionStatusUpdatedEvent": { "description": "Сессия верификации изменила статус. `decision` отправляется только для `Approved`, `Declined`, `In Review` и `Abandoned`; для адресов назначения с версией webhook 3 (по умолчанию) оно имеет структуру `GET /v3/session/{sessionId}/decision/`, а для адресов назначения версий 1 или 2 имеет устаревшую сокращённую структуру. Сессии верификации бизнеса всегда получают решение для бизнеса версии 3.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "$ref": "#/components/schemas/SessionWebhookEventData" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "status.updated" ], "description": "Всегда `status.updated`." } }, "required": [ "webhook_type" ] } ] }, "SessionDataUpdatedEvent": { "description": "Данные сессии верификации изменились без смены статуса, например после правки при ручной проверке, переопределения шага или повторного скрининга при постоянном мониторинге. `decision` отправляется только для `Approved`, `Declined`, `In Review` и `Abandoned`; имеет структуру `GET /v3/session/{sessionId}/decision/` для адресов назначения с версией webhook 3 (по умолчанию) и более раннюю сокращённую структуру для адресов с версиями 1 или 2. Корпоративные сессии всегда получают бизнес-решение версии 3.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "$ref": "#/components/schemas/SessionWebhookEventData" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "data.updated" ], "description": "Всегда `data.updated`." } }, "required": [ "webhook_type" ] } ] }, "UserStatusUpdatedEvent": { "description": "Пользователь изменил статус. Не отправляется при создании пользователя.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "user.status.updated" ], "description": "Всегда `user.status.updated`." }, "vendor_user_id": { "type": "string", "format": "uuid", "description": "Пользователь, к которому относится событие." }, "vendor_data": { "type": "string", "nullable": true, "description": "Ваш `vendor_data` для пользователя или `null`." }, "status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Статус пользователя после изменения." }, "previous_status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Статус до изменения." } }, "required": [ "webhook_type", "vendor_user_id", "vendor_data", "status", "previous_status" ] } ] }, "UserDataUpdatedEvent": { "description": "Поля пользователя изменены. Не отправляется при создании пользователя. Одно сохранение может вызвать событие как статуса, так и данных.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "user.data.updated" ], "description": "Всегда `user.data.updated`." }, "vendor_user_id": { "type": "string", "format": "uuid", "description": "Пользователь, к которому относится событие." }, "vendor_data": { "type": "string", "nullable": true, "description": "Ваш `vendor_data` для пользователя или `null`." }, "status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Статус пользователя после изменения." }, "changed_fields": { "type": "array", "items": { "type": "string", "enum": [ "vendor_data", "display_name", "full_name", "date_of_birth", "metadata", "portrait_image", "issuing_states", "approved_emails", "approved_phones", "features", "session_count", "approved_count", "declined_count", "in_review_count", "first_session_at", "last_session_at" ] }, "description": "Названия изменившихся полей." }, "changes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "previous": { "nullable": true, "description": "Значение до изменения. Даты представляют собой строки формата ISO 8601." }, "current": { "nullable": true, "description": "Значение после изменения. Даты представляют собой строки формата ISO 8601." } } }, "description": "Предыдущее и текущее значение каждого изменённого поля с ключом по имени поля. Значения могут содержать персональные данные (имена, даты рождения, ссылки на портреты, адреса электронной почты, номера телефонов); обрабатывайте их соответствующим образом." } }, "required": [ "webhook_type", "vendor_user_id", "vendor_data", "status", "changed_fields", "changes" ] } ] }, "BusinessStatusUpdatedEvent": { "description": "Статус компании изменился. Не отправляется при создании компании.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "business.status.updated" ], "description": "Всегда `business.status.updated`." }, "vendor_business_id": { "type": "string", "format": "uuid", "description": "Компания, к которой относится событие." }, "vendor_data": { "type": "string", "nullable": true, "description": "Ваш `vendor_data` для компании или `null`." }, "status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Статус компании после изменения." }, "previous_status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Статус до изменения." } }, "required": [ "webhook_type", "vendor_business_id", "vendor_data", "status", "previous_status" ] } ] }, "BusinessDataUpdatedEvent": { "description": "Поля компании изменены. Не отправляется при создании компании. Одно сохранение может вызвать событие как статуса, так и данных.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "business.data.updated" ], "description": "Всегда `business.data.updated`." }, "vendor_business_id": { "type": "string", "format": "uuid", "description": "Компания, к которой относится событие." }, "vendor_data": { "type": "string", "nullable": true, "description": "Ваш `vendor_data` для компании или `null`." }, "status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Статус компании после изменения." }, "changed_fields": { "type": "array", "items": { "type": "string", "enum": [ "vendor_data", "display_name", "metadata", "legal_name", "registration_number", "country_code", "session_count", "approved_count", "declined_count", "in_review_count", "features", "first_session_at", "last_session_at" ] }, "description": "Названия изменившихся полей." }, "changes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "previous": { "nullable": true, "description": "Значение до изменения. Даты представляют собой строки формата ISO 8601." }, "current": { "nullable": true, "description": "Значение после изменения. Даты представляют собой строки формата ISO 8601." } } }, "description": "Предыдущее и текущее значение каждого изменённого поля с ключом по имени поля." } }, "required": [ "webhook_type", "vendor_business_id", "vendor_data", "status", "changed_fields", "changes" ] } ] }, "TransactionCreatedEvent": { "description": "Транзакция была создана и проверена. Отправляется только для продакшн-приложений.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "transaction.created" ], "description": "Всегда `transaction.created`." }, "transaction_id": { "type": "string", "format": "uuid", "description": "Идентификатор транзакции Didit." }, "txn_id": { "type": "string", "nullable": true, "description": "`transaction_id`, переданный вами при создании, или `null`." }, "status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Статус мониторинга после изменения." }, "score": { "type": "integer", "description": "Оценка риска, накопленная правилами." }, "severity": { "type": "string", "nullable": true, "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL", null ], "description": "Серьёзность риска или `null`, пока значение не установлено правилом или провайдером." }, "amount": { "type": "string", "description": "Сумма транзакции в виде десятичной строки. В отличие от API, она не нормализуется, поэтому может содержать завершающие нули (до 18 знаков после запятой)." }, "currency": { "type": "string", "description": "Код валюты или символ криптоактива для `amount`." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Направление относительно субъекта." }, "action_required": { "type": "object", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TransactionVerificationSessionAction" }, { "$ref": "#/components/schemas/TransactionWalletOwnershipAction" } ], "discriminator": { "propertyName": "type", "mapping": { "verification_session": "#/components/schemas/TransactionVerificationSessionAction", "wallet_ownership": "#/components/schemas/TransactionWalletOwnershipAction" } }, "description": "Ожидающее действие конечного пользователя или `null`. Тот же объект, что и `action_required` в транзакции; `session_token` является учётными данными, поэтому никогда не записывайте его в журнал." } }, "required": [ "webhook_type", "transaction_id", "txn_id", "status", "score", "severity", "amount", "currency", "direction", "action_required" ] } ] }, "TransactionStatusUpdatedEvent": { "description": "Транзакция изменила статус в результате срабатывания правила, ручной проверки или действия конечного пользователя. Отправляется только для продакшн-приложений.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "transaction.status.updated" ], "description": "Всегда `transaction.status.updated`." }, "transaction_id": { "type": "string", "format": "uuid", "description": "Идентификатор транзакции Didit." }, "txn_id": { "type": "string", "nullable": true, "description": "`transaction_id`, переданный вами при создании, или `null`." }, "status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Статус мониторинга после изменения." }, "score": { "type": "integer", "description": "Оценка риска, накопленная правилами." }, "severity": { "type": "string", "nullable": true, "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL", null ], "description": "Серьёзность риска или `null`, пока значение не установлено правилом или провайдером." }, "amount": { "type": "string", "description": "Сумма транзакции в виде десятичной строки. В отличие от API, она не нормализуется, поэтому может содержать завершающие нули (до 18 знаков после запятой)." }, "currency": { "type": "string", "description": "Код валюты или символ криптоактива для `amount`." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Направление относительно субъекта." }, "action_required": { "type": "object", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TransactionVerificationSessionAction" }, { "$ref": "#/components/schemas/TransactionWalletOwnershipAction" } ], "discriminator": { "propertyName": "type", "mapping": { "verification_session": "#/components/schemas/TransactionVerificationSessionAction", "wallet_ownership": "#/components/schemas/TransactionWalletOwnershipAction" } }, "description": "Ожидающее действие конечного пользователя или `null`. Тот же объект, что и `action_required` в транзакции; `session_token` является учётными данными, поэтому никогда не записывайте его в журнал." } }, "required": [ "webhook_type", "transaction_id", "txn_id", "status", "score", "severity", "amount", "currency", "direction", "action_required" ] } ] }, "TravelRuleStatusUpdatedEvent": { "description": "Обмен Travel Rule изменил статус. Отправляется при каждом переходе вплоть до `FINISHED`, `CANCELLED` или `EXPIRED` включительно, но никогда после. Отправляется для приложений в продакшн-среде и, для обменов Travel Rule, также для приложений в песочнице (`environment: sandbox`). Поле `status` верхнего уровня отсутствует.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "travel_rule.status.updated" ], "description": "Всегда `travel_rule.status.updated`." }, "transaction_id": { "type": "string", "format": "uuid", "description": "Транзакция, к которой относится обмен." }, "txn_id": { "type": "string", "nullable": true, "description": "`transaction_id`, переданный вами при создании, или `null`." }, "travel_rule_status": { "type": "string", "enum": [ "AWAITING_COUNTERPARTY", "ON_HOLD", "COMPLETED", "FINISHED", "CANCELLED", "EXPIRED", "COUNTERPARTY_MISMATCHED_DATA", "COUNTERPARTY_VASP_NOT_FOUND", "COUNTERPARTY_VASP_NOT_REACHABLE", "UNCONFIRMED_OWNERSHIP", "COUNTERPARTY_VASP_GENERAL_DECLINE", "NOT_ENOUGH_COUNTERPARTY_DATA", "NOT_APPLICABLE" ], "description": "Статус обмена после изменения." }, "rail": { "type": "string", "enum": [ "", "INTERNAL", "TRP", "GTR", "TRUST", "VERIFYVASP", "SYGNA", "EMAIL", "TEST_VASP" ], "description": "Сеть, в которой выполняется обмен, или пустая строка, если её не удалось определить. `TEST_VASP` означает перевод в песочнице, на который ответил Didit Test VASP." }, "test_vasp": { "type": "boolean", "description": "Присутствует и имеет значение `true` только для перевода в песочнице, на который ответил Didit Test VASP." }, "test_vasp_scenario": { "type": "string", "description": "Присутствует только с `test_vasp`: сценарий песочницы, который определил результат, или пустая строка." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Направление перевода." } }, "required": [ "webhook_type", "transaction_id", "txn_id", "travel_rule_status", "rail", "direction" ] } ] }, "WorkflowComplianceChangedEvent": { "description": "Комплаенс-статус опубликованного сценария изменился после повторной оценки. Одно событие на сценарий. Статус верхнего уровня `status` отсутствует.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "workflow.compliance_changed" ], "description": "Всегда `workflow.compliance_changed`." }, "workflow_id": { "type": "string", "format": "uuid", "description": "Сценарий, который изменился." }, "workflow_version": { "type": "integer", "description": "Версия, которая оценивалась." }, "workflow_label": { "type": "string", "nullable": true, "description": "Отображаемое имя сценария." }, "transition": { "type": "object", "required": [ "from", "to" ], "properties": { "from": { "type": "string", "enum": [ "compliant", "gaps_detected", "pending_change", "unknown_coverage", "not_evaluated" ], "description": "Статус до повторной оценки." }, "to": { "type": "string", "enum": [ "compliant", "gaps_detected", "pending_change", "unknown_coverage", "not_evaluated" ], "description": "Статус после повторной оценки." } } }, "severity": { "type": "string", "enum": [ "actionable", "indicative", "informative" ], "description": "`actionable`, если обнаружены пробелы; `indicative` для ожидающего изменения; `informative`, когда пробелы были устранены." }, "kb_version": { "type": "string", "description": "Версия использованной базы знаний в области регулирования." } }, "required": [ "webhook_type", "workflow_id", "workflow_version", "workflow_label", "transition", "severity", "kb_version" ] } ] }, "WebhookEventPayload": { "description": "Тело подписанной доставки webhook, определяемое по `webhook_type`. На событие `activity.created` можно подписаться, но в настоящее время оно не отправляется. Обрабатывайте любой другой `webhook_type` как новый тип события и сохраняйте исходное тело запроса.", "oneOf": [ { "$ref": "#/components/schemas/SessionStatusUpdatedEvent" }, { "$ref": "#/components/schemas/SessionDataUpdatedEvent" }, { "$ref": "#/components/schemas/UserStatusUpdatedEvent" }, { "$ref": "#/components/schemas/UserDataUpdatedEvent" }, { "$ref": "#/components/schemas/BusinessStatusUpdatedEvent" }, { "$ref": "#/components/schemas/BusinessDataUpdatedEvent" }, { "$ref": "#/components/schemas/TransactionCreatedEvent" }, { "$ref": "#/components/schemas/TransactionStatusUpdatedEvent" }, { "$ref": "#/components/schemas/TravelRuleStatusUpdatedEvent" }, { "$ref": "#/components/schemas/WorkflowComplianceChangedEvent" }, { "$ref": "#/components/schemas/TransactionRuleSuggestionsCreatedEvent" } ], "discriminator": { "propertyName": "webhook_type", "mapping": { "status.updated": "#/components/schemas/SessionStatusUpdatedEvent", "data.updated": "#/components/schemas/SessionDataUpdatedEvent", "user.status.updated": "#/components/schemas/UserStatusUpdatedEvent", "user.data.updated": "#/components/schemas/UserDataUpdatedEvent", "business.status.updated": "#/components/schemas/BusinessStatusUpdatedEvent", "business.data.updated": "#/components/schemas/BusinessDataUpdatedEvent", "transaction.created": "#/components/schemas/TransactionCreatedEvent", "transaction.status.updated": "#/components/schemas/TransactionStatusUpdatedEvent", "travel_rule.status.updated": "#/components/schemas/TravelRuleStatusUpdatedEvent", "workflow.compliance_changed": "#/components/schemas/WorkflowComplianceChangedEvent", "transaction_rule_suggestions.created": "#/components/schemas/TransactionRuleSuggestionsCreatedEvent" } } }, "KYBRegistrySearchResolvedCallback": { "type": "object", "description": "Тело обратного вызова, отправляемого на `webhook_url` эндпоинта `POST /v3/kyb/search/` после завершения поиска в реестре. Оно не подписано: запрос содержит заголовок `X-Didit-Unsigned-Callback: true` и не содержит заголовков подписи, поэтому подтверждайте его путем сопоставления `request_id` с запущенным вами поиском. Использует `event_type`, а не `webhook_type`.", "required": [ "event_id", "event_type", "request_id", "vendor_data", "metadata", "search_status", "search_resolved", "kyb_registry", "timestamp", "created_at" ], "properties": { "event_id": { "type": "string", "format": "uuid", "description": "Идентификатор обратного вызова." }, "event_type": { "type": "string", "enum": [ "kyb.registry_search.resolved" ], "description": "Всегда `kyb.registry_search.resolved`." }, "request_id": { "type": "string", "format": "uuid", "description": "Параметр `request_id`, возвращённый `POST /v3/kyb/search/`." }, "vendor_data": { "type": "string", "nullable": true, "description": "Эхо отправленных вами `vendor_data`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Эхо-значение переданного вами `metadata`." }, "search_status": { "type": "string", "description": "В настоящее время всегда `resolved`." }, "search_resolved": { "type": "boolean", "description": "`true`, когда `search_status` имеет значение `resolved`." }, "kyb_registry": { "$ref": "#/components/schemas/KYBRegistrySearchResults" }, "timestamp": { "type": "integer", "description": "Unix-время в секундах, когда callback был помещён в очередь." }, "created_at": { "type": "integer", "description": "Unix-время в секундах, когда callback был помещён в очередь." } } }, "AMLScreening": { "type": "object", "properties": { "node_id": { "type": "string", "description": "Уникальный идентификатор этого шага AML в графе сценария." }, "status": { "type": "string", "description": "Статус этого AML-скрининга на уровне функции. Не зависит от общего `status` сессии: сессия может получить итоговое решение, пока отдельная функция остаётся `In Review`.", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ] }, "total_hits": { "type": "integer", "description": "Общее количество найденных совпадений" }, "entity_type": { "type": "string", "description": "Тип проверяемого субъекта: физическое лицо или компания" }, "hits": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Стабильный идентификатор Didit для совпадения: `hit_`, за которым следуют 24 шестнадцатеричных символа. Та же найденная сущность сохраняет тот же `id` при повторном скрининге субъекта. Передавайте его как `hit_id` в endpoint проверки совпадений AML." }, "url": { "type": "string", "format": "uri", "description": "Исходный URL для совпадения" }, "match": { "type": "boolean", "description": "Является ли это подтверждённым совпадением" }, "score": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 1, "description": "Устаревшая взвешенная оценка совпадения в диапазоне 0–1 (например, `0.73`). Используйте вместо этого `match_score` (0–100).", "deprecated": true }, "target": { "type": "boolean", "nullable": true, "description": "Является ли найденная сущность непосредственным объектом включения в список (в отличие от связанной стороны). `null`, если источник этого не указывает." }, "caption": { "type": "string", "description": "Подпись или заголовок совпадения" }, "datasets": { "type": "array", "items": { "type": "string", "enum": [ "PEP", "PEP Level 1", "PEP Level 2", "PEP Level 3", "PEP Level 4", "Sanctions", "Adverse Media", "Warnings and Regulatory Enforcement", "Fitness and Probity", "SIP", "SIE", "Insolvency", "Other Lists" ] }, "description": "Список категорий наборов данных, в которых найдено совпадение. Указывает, фигурировала ли сущность в списках PEP (с указанием уровня), санкционных базах данных, негативных публикациях в СМИ, предупреждениях/мерах регуляторного воздействия или других наборах данных комплаенса. Значение `Other Lists`, если источник сущности не указывает ни одну из этих категорий." }, "features": { "type": "object", "nullable": true, "description": "Дополнительные характеристики совпадения" }, "rca_name": { "type": "string", "description": "Имя RCA, если применимо" }, "last_seen": { "type": "string", "format": "date-time", "description": "Дата, когда совпадение наблюдалось в последний раз" }, "risk_view": { "type": "object", "properties": { "crimes": { "type": "object", "properties": { "score": { "type": "integer" }, "weightage": { "type": "integer" }, "risk_level": { "type": "string" }, "risk_scores": { "type": "object" } } }, "countries": { "type": "object", "properties": { "score": { "type": "integer" }, "weightage": { "type": "integer" }, "risk_level": { "type": "string" }, "risk_scores": { "type": "object" } } }, "categories": { "type": "object", "properties": { "score": { "type": "integer" }, "weightage": { "type": "integer" }, "risk_level": { "type": "string" }, "risk_scores": { "type": "object" } } }, "custom_list": { "type": "object" } } }, "first_seen": { "type": "string", "format": "date-time", "description": "Дата, когда совпадение было обнаружено впервые" }, "properties": { "type": "object", "properties": { "name": { "type": "array", "items": { "type": "string" } }, "alias": { "type": "array", "items": { "type": "string" } }, "notes": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string", "nullable": true }, "gender": { "type": "array", "items": { "type": "string" } }, "height": { "type": "string", "nullable": true }, "topics": { "type": "string", "nullable": true }, "weight": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "eyeColor": { "type": "string", "nullable": true }, "keywords": { "type": "string", "nullable": true }, "lastName": { "type": "array", "items": { "type": "string" } }, "position": { "type": "string", "nullable": true }, "religion": { "type": "string", "nullable": true }, "birthDate": { "type": "array", "items": { "type": "string" } }, "education": { "type": "array", "items": { "type": "string" } }, "ethnicity": { "type": "string", "nullable": true }, "firstName": { "type": "array", "items": { "type": "string" } }, "hairColor": { "type": "string", "nullable": true }, "weakAlias": { "type": "string", "nullable": true }, "birthPlace": { "type": "array", "items": { "type": "string" } }, "modifiedAt": { "type": "string", "nullable": true }, "wikidataId": { "type": "string", "nullable": true }, "citizenship": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true } } }, "match_score": { "type": "number", "description": "Взвешенная оценка уверенности в идентификации (0-100), рассчитанная на основе схожести имени, даты рождения и сопоставления страны. Используется для определения, является ли совпадение ложным срабатыванием или возможным совпадением.", "format": "float", "nullable": true }, "risk_score": { "type": "number", "description": "Оценка риска сущности (0-100). Используется для определения окончательного AML-статуса (Одобрена/На проверке/Отклонена) на основе наивысшего risk_score среди совпадений, не являющихся ложными срабатываниями." }, "review_status": { "type": "string", "description": "Статус проверки для этого совпадения. Может принимать значения 'Unreviewed', 'Confirmed Match', 'False Positive' или 'Inconclusive'.", "enum": [ "Unreviewed", "Confirmed Match", "False Positive", "Inconclusive" ] }, "score_breakdown": { "type": "object", "description": "Подробное описание того, как рассчитывался match_score.", "properties": { "name_score": { "type": "integer", "description": "Необработанный процент сходства имён (0-100)." }, "name_weight": { "type": "integer", "description": "Исходный вес для имени из конфигурации (0-100)." }, "name_weight_normalized": { "type": "number", "description": "Нормализованный вес для имени после пересчёта весов из-за отсутствующих данных (0-100)." }, "name_contribution": { "type": "number", "description": "Баллы за имя, вошедшие в общий балл." }, "dob_score": { "type": "integer", "description": "Оценка совпадения даты рождения (от -100 до 100)." }, "dob_weight": { "type": "integer", "description": "Исходный вес для даты рождения из конфигурации (0-100)." }, "dob_weight_normalized": { "type": "number", "description": "Нормализованный вес для даты рождения после пересчёта весов из-за отсутствующих данных (0-100)." }, "dob_contribution": { "type": "number", "description": "Баллы за дату рождения, вошедшие в общий балл." }, "country_score": { "type": "integer", "description": "Оценка совпадения страны (от -100 до 100)." }, "country_weight": { "type": "integer", "description": "Исходный вес для страны из конфигурации (0-100)." }, "country_weight_normalized": { "type": "number", "description": "Нормализованный вес для страны после пересчёта весов из-за отсутствующих данных (0-100)." }, "country_contribution": { "type": "number", "description": "Баллы за страну, вошедшие в общий балл." }, "document_number_match_type": { "type": "string", "description": "Результат оценки номера документа по правилу «Golden Key».", "enum": [ "MATCH", "NEUTRAL", "HARD_MISMATCH" ] }, "document_number_effect": { "type": "string", "description": "Понятное описание влияния номера документа на оценку." }, "total_score": { "type": "integer", "description": "Финальная взвешенная оценка совпадения (0-100)." } } }, "pep_matches": { "type": "array", "items": { "type": "object", "properties": { "aliases": { "type": "array", "items": { "type": "string" } }, "education": { "type": "array", "items": { "type": "string" } }, "list_name": { "type": "string" }, "publisher": { "type": "string" }, "source_url": { "type": "string", "format": "uri" }, "description": { "type": "string" }, "matched_name": { "type": "string" }, "pep_position": { "type": "string" }, "date_of_birth": { "type": "string" }, "other_sources": { "type": "array", "items": { "type": "string" } }, "place_of_birth": { "type": "string" } } } }, "linked_entities": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "array", "items": { "type": "string" } }, "active": { "type": "array", "items": { "type": "string" } }, "status": { "type": "array", "items": { "type": "string" } }, "details": { "type": "array", "items": { "type": "string" } }, "relation": { "type": "array", "items": { "type": "string" } } } } }, "warning_matches": { "type": "array", "description": "Список совпадений по предупреждениям и мерам регуляторного воздействия. Включает записи из категорий: Warning, SIP, Warnings and Regulatory Enforcement, Fitness and Probity, SIE и Insolvency.", "items": { "type": "object", "properties": { "list_name": { "type": "string", "description": "Название издателя списка предупреждений" }, "matched_name": { "type": "string", "description": "Имя совпало в списке предупреждений" }, "description": { "type": "string", "description": "Описание записи о предупреждении" }, "publisher": { "type": "string", "description": "Издатель или источник предупреждения" }, "source_url": { "type": "string", "format": "uri", "description": "URL источника предупреждения" }, "other_sources": { "type": "array", "items": { "type": "string" }, "description": "Дополнительные исходные URL" }, "countries": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Страны, связанные с предупреждением" }, "created_at": { "type": "string", "nullable": true, "description": "Дата создания записи о предупреждении" }, "updated_at": { "type": "string", "nullable": true, "description": "Дата последнего обновления записи о предупреждении" }, "additional_data": { "type": "object", "description": "Дополнительные данные из источника предупреждения. Может содержать объект `data` с массивом `case_details`.", "properties": { "data": { "type": "object", "properties": { "case_details": { "type": "array", "description": "Сведения о кейсах с предупреждениями, связанных с этим совпадением", "items": { "type": "object", "properties": { "case_type": { "type": "string", "description": "Тип кейса с предупреждением", "enum": [ "Accusation", "Arrest", "Bribery", "Criminal", "Fraud", "Illegal Fundraising", "Non-conviction Terror", "Proclaimed Offender", "Regulatory Enforcement", "Terrorism", "Terrorism-related", "Terrorism-related listing" ] } } } } } } } } } } }, "sanction_matches": { "type": "array", "description": "Список совпадений по санкционным спискам, найденных для этой сущности.", "items": { "type": "object", "properties": { "list_name": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Название санкционного списка (списков)" }, "matched_name": { "type": "string", "description": "Имя совпало с именем в санкционном списке" }, "description": { "type": "string", "description": "Описание санкционной записи" }, "reason": { "type": "string", "nullable": true, "description": "Причина применения санкций к субъекту в виде произвольного текста. Формируется объединением записей о причинах из санкционного списка. Примеры: 'Executive Order 13224 (Terrorism)', 'Support for actions undermining Ukraine's sovereignty', 'Listed due to national security concerns.'" }, "source_url": { "type": "string", "format": "uri", "description": "URL источника санкции" }, "other_sources": { "type": "array", "items": { "type": "string" }, "description": "Дополнительные исходные URL" }, "details": { "type": "array", "items": { "type": "string" }, "description": "Дополнительные сведения о санкции" }, "legal_basis": { "type": "array", "items": { "type": "string" }, "description": "Правовое основание для санкции" }, "listed_on": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Дата (даты) внесения субъекта в список" }, "sanction_list": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Идентификаторы санкционного списка" }, "sanction_program": { "type": "array", "items": { "type": "string" }, "description": "Санкционные программы, по которым сущность внесена в список" }, "sanctioning_authority": { "type": "array", "items": { "type": "string" }, "description": "Орган/органы, наложившие санкцию" }, "updated_on": { "type": "array", "items": { "type": "string" }, "description": "Дата (даты) последнего обновления санкционной записи" }, "additional_data": { "type": "object", "description": "Дополнительные данные из источника санкций, не вошедшие в основные поля" } } } }, "adverse_media_details": { "type": "object", "properties": { "sentiment": { "type": "string" }, "entity_type": { "type": "string" }, "sentiment_score": { "type": "integer" }, "adverse_keywords": { "type": "object", "additionalProperties": { "type": "integer" } } } }, "adverse_media_matches": { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string" }, "summary": { "type": "string" }, "headline": { "type": "string" }, "sentiment": { "type": "string" }, "thumbnail": { "type": "string", "format": "uri" }, "source_url": { "type": "string", "format": "uri" }, "author_name": { "type": "string", "nullable": true }, "other_sources": { "type": "array", "items": { "type": "string" } }, "adverse_keywords": { "type": "array", "items": { "type": "string" } }, "sentiment_score": { "type": "integer" }, "publication_date": { "type": "string", "format": "date-time" } } } }, "additional_information": { "type": "object" } } } }, "score": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Общий балл AML-скрининга — наивысшая оценка риска среди всех совпадений (число с плавающей точкой, 0–100). `null` до момента вычисления." }, "screened_data": { "type": "object", "properties": { "full_name": { "type": "string" }, "nationality": { "type": "string" }, "date_of_birth": { "type": "string", "format": "date" }, "document_number": { "type": "string", "nullable": true } } }, "is_ongoing_monitoring_enabled": { "type": "boolean", "description": "Включён ли постоянный AML-мониторинг для этого скрининга. Если `true`, сущность периодически проверяется повторно, и любые новые совпадения обновляют отчёт." }, "next_ongoing_monitoring_bill_date": { "type": "string", "format": "date", "nullable": true, "description": "Дата (ГГГГ-ММ-ДД), когда за эту подписку на постоянный мониторинг в следующий раз будут списаны средства. Вычисляется как дата последнего списания за постоянный мониторинг плюс 365 дней, если `is_ongoing_monitoring_enabled = true`; в противном случае `null`. Это дата биллинга, а не дата скрининга: для неё используйте `last_ongoing_screening_at`." }, "last_ongoing_screening_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда постоянный мониторинг в последний раз завершил повторный скрининг этой записи, независимо от того, изменился ли результат. `null`, если запись никогда не проходила повторный скрининг; значение никогда не заполняется задним числом от даты включения или даты биллинга." }, "last_ongoing_screening_datasets_updated_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Самая недавняя дата обновления набора данных AML, указанная провайдером на момент этого скрининга. `null`, если провайдер не предоставил даты набора данных; значение никогда не оценивается приблизительно." }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "feature": { "type": "string", "enum": [ "ID_VERIFICATION", "NFC", "LIVENESS", "FACEMATCH", "PROOF_OF_ADDRESS", "PHONE", "EMAIL", "AML", "LOCATION", "DATABASE_VALIDATION", "QUESTIONNAIRE", "DOCUMENT_AI", "KYB_REGISTRY", "KYB_DOCUMENTS", "KYB_KEY_PEOPLE", "GEOLOCATION", "SIGNATURE" ], "description": "Функция, сгенерировавшая это предупреждение. Значение определяет блок функции, к которому относится предупреждение. В рамках AML-скрининга это обычно `AML`, однако перечисление выше является определяющим для всех предупреждений функций в payload решения." }, "risk": { "type": "string" }, "additional_data": { "type": "object", "nullable": true }, "log_type": { "type": "string" }, "short_description": { "type": "string" }, "long_description": { "type": "string" }, "node_id": { "type": "string", "description": "Идентификатор узла графа сценария, сгенерировавшего это предупреждение" } } } } } }, "MonitoringEvent": { "type": "object", "description": "Одно сохранённое событие мониторинга, возвращаемое endpoints для получения списка и таймлайна субъекта. Конфиденциальные доказательства (payload, контекст устройства, доказательства правил) возвращаются только с помощью `GET /v3/events/{event_uuid}/`.", "required": [ "event_uuid", "event_id", "event_category", "action_type", "occurred_at", "received_at", "status", "score", "subject_vendor_data", "subject_entity_type", "subject_uuid", "counterparty_vendor_data", "session_id", "device_fingerprint", "ip_address", "ip_country", "amount", "currency", "game_id", "round_id", "bonus_id", "affiliate_code", "payment_reference_id", "retention_class", "rules_matched_count", "correlation_pending", "is_droppable" ], "properties": { "event_uuid": { "type": "string", "format": "uuid", "description": "Идентификатор события в Didit. Используйте его в качестве `{event_uuid}` в вызовах получения и удаления." }, "event_id": { "type": "string", "maxLength": 128, "description": "Ваш собственный идентификатор, переданный ключ идемпотентности." }, "event_category": { "type": "string", "enum": [ "auth", "session", "gameplay", "bonus", "affiliate", "payment", "dispute", "security", "responsible_gambling", "custom" ], "description": "Категория события." }, "action_type": { "type": "string", "maxLength": 128, "description": "Что произошло внутри категории в том виде, в котором вы это отправили." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Когда событие произошло на вашей стороне." }, "received_at": { "type": "string", "format": "date-time", "description": "Когда Didit принял событие." }, "status": { "type": "string", "enum": [ "ACCEPTED", "APPROVED", "IN_REVIEW", "DECLINED" ], "description": "`ACCEPTED`: сохранено, ни одно сработавшее правило не изменило статус (стандартный ответ для большинства событий и всегда ответ в приложении в песочнице, где правила не выполняются). `APPROVED`: правило сработало, и оценка осталась ниже вашего порога проверки. `IN_REVIEW`: правило повысило оценку выше порога проверки или установило этот статус. `DECLINED`: правило отклонило запрос или оценка превысила ваш порог отклонения." }, "score": { "type": "integer", "description": "Накопленная оценка правила. Начинается с 0; действия правила `add_score` изменяют её (допускаются отрицательные значения дельты)." }, "subject_vendor_data": { "type": "string", "maxLength": 255, "description": "`subject.vendor_data` события: ваш идентификатор пользователя или компании." }, "subject_entity_type": { "type": "string", "description": "`individual` или `company`: к какому типу субъекта относится `subject_vendor_data`.", "example": "individual" }, "subject_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID пользователя (физического лица) или компании, к которым относится событие, либо null, если эта запись больше не существует." }, "counterparty_vendor_data": { "type": "string", "nullable": true, "description": "Второй участник P2P-события (перенесено из `payload.counterparty_vendor_data`).", "maxLength": 255 }, "session_id": { "type": "string", "nullable": true, "description": "`session.session_id`, переданный с событием.", "maxLength": 255 }, "device_fingerprint": { "type": "string", "nullable": true, "description": "`device_context.fingerprint`, отправленный с событием.", "maxLength": 255 }, "ip_address": { "type": "string", "nullable": true, "description": "IP-адрес события. В серверном канале это переданный вами `device_context.network_context.ip_address`; в клиентском канале устройства это IP-адрес запроса.", "maxLength": 64 }, "ip_country": { "type": "string", "nullable": true, "description": "Код страны `ip_address`, полученный в результате обогащения данных IP, или null, если адрес не был обогащён (отсутствует, приватный или малозначимые данные телеметрии, адрес которых ранее не был известен).", "example": "ES" }, "amount": { "type": "string", "nullable": true, "description": "Сумма в виде десятичной строки с 18 знаками после запятой, из `transaction_context.amount`, `payload.amount` или `payload.stake_amount`, в указанном порядке.", "example": "250.000000000000000000" }, "currency": { "type": "string", "nullable": true, "description": "Валюта из `transaction_context.currency` или `payload.currency`.", "maxLength": 10 }, "game_id": { "type": "string", "nullable": true, "description": "Перенесено из `payload.game_id`.", "maxLength": 128 }, "round_id": { "type": "string", "nullable": true, "description": "Перенесено из `payload.round_id`.", "maxLength": 128 }, "bonus_id": { "type": "string", "nullable": true, "description": "Перенесено из `payload.bonus_id`.", "maxLength": 128 }, "affiliate_code": { "type": "string", "nullable": true, "description": "Перенесено из `payload.affiliate_code`.", "maxLength": 128 }, "payment_reference_id": { "type": "string", "nullable": true, "description": "Идентификатор платежа из `transaction_context.payment_reference_id` или `payload.payment_reference_id`.", "maxLength": 255 }, "retention_class": { "type": "string", "enum": [ "low_value", "standard", "risk_relevant", "monetary_or_compliance" ], "description": "Класс хранения. События платежей и споров имеют класс `monetary_or_compliance`; события безопасности и ответственной игры имеют класс `risk_relevant`; `session.page_view`, `session.sdk_heartbeat`, `session.sdk_loaded`, `session.device_seen`, `session.bot_signal_observed`, `bonus.promotion_viewed` и `affiliate.referral_clicked` имеют класс `low_value`; все остальные имеют класс `standard`. Событие, с которым совпало активное правило, повышается до `risk_relevant` (никогда не понижается)." }, "rules_matched_count": { "type": "integer", "minimum": 0, "description": "Количество правил, совпавших с событием, включая правила в режиме `TEST` (которые фиксируют свидетельства, но не применяют действия)." }, "correlation_pending": { "type": "boolean", "description": "`true`, пока для этого события ещё должно выполниться асинхронное правило (межсубъектная корреляция или последовательность длительностью более 24 часов). Оно завершается в течение нескольких минут, а значения `status`, `score` и `rules_matched_count` обновляются на месте." }, "is_droppable": { "type": "boolean", "description": "Может ли SDK при обратном давлении (backpressure) отбрасывать события этого типа. Значение `false` для каждого события `security`, `payment`, `dispute` и `responsible_gambling`, а также для `gameplay.bet_placed`, `gameplay.bet_settled` и `gameplay.p2p_settlement`." } } }, "MonitoringEventDetail": { "description": "Одно событие мониторинга с полной оболочкой, обогащёнными данными и подтверждениями правил. Все поля `MonitoringEvent` плюс поля, указанные ниже.", "allOf": [ { "$ref": "#/components/schemas/MonitoringEvent" }, { "type": "object", "required": [ "payload", "custom_values", "device_context", "field_sources", "session_sequence", "table_id", "hand_id", "match_id", "market_id", "side", "role", "net_result_amount", "payment_fingerprint", "instrument_reference_hash", "withdrawal_address_hash", "dispute_id", "chargeback_id", "changed_field", "identity_match_ref", "schema_version", "expires_at", "rules_evaluated_count", "rule_runs", "ip_enrichment", "subject_profile", "tags" ], "properties": { "payload": { "type": "object", "additionalProperties": true, "description": "Поля категории, которые вы отправили в `payload`." }, "custom_values": { "type": "object", "additionalProperties": true, "description": "Переданные вами скалярные `custom_values`. Didit добавляет `vpn_or_proxy_detected: true` или `is_data_center: true`, если обогащение данных по IP отмечает адрес флагом, а вы их не задали." }, "device_context": { "type": "object", "additionalProperties": true, "description": "Контекст устройства в сохранённом виде: ваш `device_context` (включая `fingerprint`, `persistent_device_id` и `bot_score`, если они были переданы) с `network_context`, дополненным обогащением по IP (`ip_country`, `ip_country_code`, `ip_city`, `asn_number`, `asn_organization`, `is_vpn_or_tor`, `is_data_center`, `proxy_type`, `connection_type`) для незаполненных вами ключей." }, "field_sources": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "customer", "sdk", "server" ] }, "description": "Путь поля к источнику данных: `customer` (отправлено вашим бэкендом), `sdk` (отправлено через канал устройства) или `server` (сгенерировано Didit, например `received_at` и обогащённые сетевые поля). Проверьте его перед обработкой совпадения." }, "session_sequence": { "type": "integer", "format": "int64", "nullable": true, "description": "`session.sequence`, переданный с событием." }, "table_id": { "type": "string", "nullable": true, "description": "Перенесено из `payload.table_id`.", "maxLength": 128 }, "hand_id": { "type": "string", "nullable": true, "description": "Перенесено из `payload.hand_id`.", "maxLength": 128 }, "match_id": { "type": "string", "nullable": true, "description": "Перенесено из `payload.match_id`.", "maxLength": 128 }, "market_id": { "type": "string", "nullable": true, "description": "Перенесено из `payload.market_id`.", "maxLength": 128 }, "side": { "type": "string", "nullable": true, "description": "Перенесено из `payload.side`.", "maxLength": 64 }, "role": { "type": "string", "nullable": true, "description": "Перенесено из `payload.role`.", "maxLength": 64 }, "net_result_amount": { "type": "string", "nullable": true, "description": "Перенесено из `payload.net_result_amount`, в виде десятичной строки с 18 знаками после запятой.", "example": "-120.000000000000000000" }, "payment_fingerprint": { "type": "string", "nullable": true, "description": "Перенесено из `payload.payment_fingerprint`.", "maxLength": 255 }, "instrument_reference_hash": { "type": "string", "nullable": true, "description": "Перенесено из `payload.instrument_reference_hash`.", "maxLength": 255 }, "withdrawal_address_hash": { "type": "string", "nullable": true, "description": "Перенесено из `payload.withdrawal_address_hash` (или `payload.destination_reference_hash`).", "maxLength": 255 }, "dispute_id": { "type": "string", "nullable": true, "description": "Перенесено из `payload.dispute_id`.", "maxLength": 255 }, "chargeback_id": { "type": "string", "nullable": true, "description": "Перенесено из `payload.chargeback_id`.", "maxLength": 255 }, "changed_field": { "type": "string", "nullable": true, "description": "Перенесено из `payload.changed_field` (события изменения безопасности).", "maxLength": 128 }, "identity_match_ref": { "type": "string", "nullable": true, "description": "Перенесено из `payload.identity_match_ref` (совпадения в реестрах ответственной азартной игры).", "maxLength": 255 }, "schema_version": { "type": "integer", "description": "Версия схемы конверта события. В настоящее время `1`.", "example": 1 }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда срок хранения события по его классу хранения истекает и оно удаляется: `occurred_at` плюс период класса (14, 30 или 90 дней по умолчанию, настраивается для каждого приложения). Null для событий `monetary_or_compliance`, для которых действует срок хранения транзакций." }, "rules_evaluated_count": { "type": "integer", "minimum": 0, "description": "Количество правил событий, проверенных для этого события." }, "rule_runs": { "type": "array", "description": "Каждое правило, совпавшее с событием, начиная с самых новых.", "items": { "$ref": "#/components/schemas/MonitoringEventRuleRun" } }, "ip_enrichment": { "type": "object", "nullable": true, "description": "Обогащенные данные IP-адреса события или null, если адрес не был обогащен данными. См. [Обогащение данных по IP](https://docs.didit.me/ru/transaction-monitoring/ip-enrichment).", "properties": { "ip_country_code": { "type": "string", "nullable": true, "description": "Код страны адреса." }, "ip_city": { "type": "string", "nullable": true, "description": "Город адреса." }, "asn_number": { "type": "integer", "nullable": true, "description": "Номер автономной системы (ASN)." }, "asn_organization": { "type": "string", "nullable": true, "description": "Организация, управляющая автономной системой." }, "is_vpn_or_tor": { "type": "boolean", "description": "Является ли адрес известным выходным узлом VPN или Tor." }, "is_data_center": { "type": "boolean", "description": "Принадлежит ли адрес хостинговой сети или сети центра обработки данных." }, "proxy_type": { "type": "string", "nullable": true, "description": "Классификация прокси для адреса в виде непрозрачной строки или null." }, "last_enriched_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда адрес в последний раз обогащался данными." } }, "required": [ "ip_country_code", "ip_city", "asn_number", "asn_organization", "is_vpn_or_tor", "is_data_center", "proxy_type", "last_enriched_at" ] }, "subject_profile": { "type": "object", "nullable": true, "description": "Кэшированные сигналы риска электронной почты и телефона субъекта, или null, если профиль субъекта отсутствует.", "properties": { "email_risk_score": { "type": "integer", "nullable": true, "description": "Оценка риска электронной почты." }, "email_deliverability": { "type": "string", "nullable": true, "description": "Вердикт о доставляемости электронной почты." }, "email_is_disposable": { "type": "boolean", "nullable": true, "description": "Является ли адрес электронной почты одноразовым." }, "email_is_breached": { "type": "boolean", "nullable": true, "description": "Фигурирует ли адрес электронной почты в известных утечках данных." }, "email_social_count": { "type": "integer", "nullable": true, "description": "Количество онлайн-аккаунтов, привязанных к адресу электронной почты." }, "email_social_providers": { "type": "array", "items": { "type": "string" }, "description": "Названия онлайн-сервисов, в которых найден аккаунт, привязанный к этому адресу электронной почты." }, "phone_risk_score": { "type": "integer", "nullable": true, "description": "Оценка риска номера телефона." }, "phone_line_type": { "type": "string", "nullable": true, "description": "Тип телефонной линии." }, "phone_carrier": { "type": "string", "nullable": true, "description": "Название оператора связи." }, "phone_social_count": { "type": "integer", "nullable": true, "description": "Количество онлайн-аккаунтов, привязанных к номеру телефона." }, "phone_social_providers": { "type": "array", "items": { "type": "string" }, "description": "Названия онлайн-сервисов, в которых найден аккаунт, привязанный к этому номеру телефона." }, "source_provider": { "type": "string", "nullable": true, "description": "Непрозрачный идентификатор источника профиля." }, "last_enriched_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Время последнего обновления профиля." } }, "required": [ "email_risk_score", "email_deliverability", "email_is_disposable", "email_is_breached", "email_social_count", "email_social_providers", "phone_risk_score", "phone_line_type", "phone_carrier", "phone_social_count", "phone_social_providers", "source_provider", "last_enriched_at" ] }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Названия тегов, прикреплённых к событию (действия правила `add_tags`)." } } } ] }, "MonitoringEventRuleRun": { "type": "object", "properties": { "rule_uuid": { "type": "string", "format": "uuid", "description": "UUID правила мониторинга транзакций." }, "rule_title": { "type": "string", "description": "Название правила." }, "library_key": { "type": "string", "nullable": true, "description": "Ключ библиотеки, если правило было установлено из библиотеки правил, иначе null." }, "matched": { "type": "boolean", "description": "Всегда `true`: записываются только совпадающие запуски." }, "mode": { "type": "string", "enum": [ "ACTIVE", "TEST" ], "description": "Режим правила во время выполнения. Запуск в режиме `TEST` фиксирует доказательства, но не применяет никаких действий." }, "is_async": { "type": "boolean", "description": "`true`, если запуск произошёл из асинхронного прохода корреляции, а не из запроса приёма данных." }, "severity": { "type": "string", "nullable": true, "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL", null ], "description": "Уровень серьёзности правила. Null для запусков `TEST` и для правил без уровня серьёзности." }, "score_delta": { "type": "integer", "description": "Насколько данный запуск изменил скоринг события (0 для запусков со статусом `TEST`)." }, "action_summary": { "type": "string", "nullable": true, "description": "Краткая сводка применённых действий, например `score +40; add_tag:VPN_LOGIN`. Null, если ничего не применялось." }, "matched_payload": { "type": "array", "description": "Условия и агрегации, которые совпали. Записи условий содержат `field`, `operator`, `expected_value`, `current_value`, `matched`, `group_index`, `group_logic` и `field_source` (`server`, `sdk` или `customer`); записи агрегаций содержат `metric`, `field`, `operator`, `expected_value`, `computed_value`, `window`, `filters`, `matched` и `sample_references`.", "items": { "type": "object", "additionalProperties": true } }, "created_at": { "type": "string", "format": "date-time", "description": "Время записи выполнения правила." } }, "required": [ "rule_uuid", "rule_title", "library_key", "matched", "mode", "is_async", "severity", "score_delta", "action_summary", "matched_payload", "created_at" ] }, "MonitoringEventPage": { "type": "object", "description": "Одна страница событий мониторинга, сначала с самым новым `occurred_at`.", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "description": "Количество подходящих событий: точное до 100, с ограничением в 100 при превышении. Не рассчитывайте количество страниц на его основе; переходите по `next`, пока оно не станет null." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL следующей страницы или null на последней странице." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL предыдущей страницы или null на первой странице." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/MonitoringEvent" } } } }, "MonitoringEventCreateRequest": { "type": "object", "description": "Конверт события, одинаковый для каждой категории. Принимаются псевдонимы в camelCase: `eventId`, `eventCategory` (или `category`), `actionType`, `occurredAt`, `timeZone` (или `zoneId`), `deviceContext` (или `device`), `transactionContext`, `customValues` (или `props`); внутри `subject`: `vendorData`, `entityType`, `fullName`; внутри `session`: `sessionId`, `pageUrl`; внутри `transaction_context`: `paymentReferenceId`.", "required": [ "event_id", "event_category", "action_type", "occurred_at", "subject" ], "properties": { "event_id": { "type": "string", "maxLength": 128, "description": "Ваш идентификатор события, уникальный в рамках приложения. Является ключом идемпотентности: повторная отправка тех же `event_category`, `action_type`, `occurred_at`, `subject.vendor_data` и `payload` с ним считается повтором, а любые отличия считаются конфликтом.", "example": "login-2026-10-17-000001" }, "event_category": { "type": "string", "enum": [ "auth", "session", "gameplay", "bonus", "affiliate", "payment", "dispute", "security", "responsible_gambling", "custom" ], "description": "Категория события.", "example": "auth" }, "action_type": { "type": "string", "minLength": 1, "maxLength": 128, "description": "Что произошло внутри категории. Открытый словарь; управляемые действия, перечисленные в [Сборе событий](https://docs.didit.me/ru/transaction-monitoring/events) (например, `login`, `deposit_completed`, `chargeback_opened`), открывают доступ к типизированной валидации и полям управляемых правил. Начальные и конечные пробелы обрезаются.", "example": "login" }, "occurred_at": { "type": "string", "format": "date-time", "description": "Когда событие произошло на вашей стороне, ISO 8601 (значение без смещения считывается как UTC). Должно быть не более чем на 7 дней в прошлом и не более чем на 5 минут в будущем.", "example": "2026-10-17T09:15:02.481Z" }, "time_zone": { "type": "string", "nullable": true, "maxLength": 64, "description": "Часовой пояс события на вашей стороне, например `Europe/Madrid`. Сохраняется вместе с событием; не возвращается endpoint чтения." }, "subject": { "type": "object", "description": "Пользователь или компания, к которым относится событие. Соответствует пользователю (или компании) с этим `vendor_data` в вашем приложении; если сущность отсутствует, она будет создана.", "required": [ "vendor_data" ], "properties": { "vendor_data": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Ваш id для субъекта.", "example": "user-42" }, "entity_type": { "type": "string", "maxLength": 32, "default": "individual", "description": "`company` определяет субъекта как компанию; любое другое значение (по умолчанию `individual`) определяет его как физическое лицо. Один и тот же `vendor_data` может указывать на каждого из них.", "example": "individual" }, "full_name": { "type": "string", "nullable": true, "maxLength": 512, "description": "Отображаемое имя, используемое только тогда, когда это событие создаёт пользователя или компанию." }, "email": { "type": "string", "format": "email", "nullable": true, "description": "Проверяется как адрес электронной почты; не сохраняется в событии." }, "phone": { "type": "string", "nullable": true, "maxLength": 32, "description": "Проверено; не сохраняется в событии." }, "country": { "type": "string", "nullable": true, "maxLength": 3, "description": "Проверено; не сохраняется в событии." } } }, "business": { "type": "object", "description": "Компания, к которой относится событие, если она отличается от субъекта. Считывается только `vendor_data`.", "additionalProperties": true, "properties": { "vendor_data": { "type": "string", "maxLength": 255, "description": "Ваш id для компании. Можно фильтровать как `business_vendor_data`.", "example": "merchant-7" } } }, "session": { "type": "object", "description": "Ваш контекст сессии для события.", "properties": { "session_id": { "type": "string", "nullable": true, "maxLength": 255, "description": "Ваш идентификатор сессии. Доступен для фильтрации и возвращается как `session_id`." }, "sequence": { "type": "integer", "nullable": true, "description": "Позиция события внутри сессии. Возвращается как `session_sequence`." }, "page_url": { "type": "string", "nullable": true, "maxLength": 2048, "description": "Проверено; не сохраняется в событии." }, "referrer": { "type": "string", "nullable": true, "maxLength": 2048, "description": "Проверено; не сохраняется в событии." } } }, "device_context": { "type": "object", "additionalProperties": true, "description": "Контекст устройства и сети, сохраняемый в переданном виде и возвращаемый `GET /v3/events/{event_uuid}/`. На этом серверном маршруте Didit не видит подключение конечного пользователя, поэтому адресом, обогащаемым данными и используемым правилами, является `network_context.ip_address` в том виде, в котором вы его отправляете.", "properties": { "fingerprint": { "type": "string", "maxLength": 255, "description": "Цифровой отпечаток устройства. Доступна фильтрация по `device_fingerprint`." }, "persistent_device_id": { "type": "string", "maxLength": 255, "description": "Ваш постоянный идентификатор устройства." }, "bot_score": { "type": "integer", "description": "Оценка бота из вашей собственной системы обнаружения в виде целого числа." }, "network_context": { "type": "object", "additionalProperties": true, "properties": { "ip_address": { "type": "string", "maxLength": 64, "description": "IP-адрес конечного пользователя. Публичные адреса обогащаются данными один раз для каждого уникального адреса.", "example": "203.0.113.42" } } } } }, "transaction_context": { "type": "object", "description": "Контекст денежных средств. Непустые значения здесь также соответствуют обязательным ключам payload действия.", "properties": { "amount": { "type": "string", "nullable": true, "description": "Сумма в виде десятичной строки (число также принимается).", "example": "1000.00" }, "currency": { "type": "string", "nullable": true, "maxLength": 10, "description": "Код валюты." }, "direction": { "type": "string", "nullable": true, "maxLength": 16, "description": "Направление движения денежных средств, например `inbound` или `outbound`." }, "payment_reference_id": { "type": "string", "nullable": true, "maxLength": 255, "description": "Ваш идентификатор платежа. Доступен для фильтрации как `payment_reference_id`." } } }, "payload": { "type": "object", "additionalProperties": true, "description": "Доменные поля категории, не более 16384 байт после кодирования в JSON. Для некоторых действий требуются ключи (в `payload` или `transaction_context`): для `gameplay.p2p_settlement` требуются `game_id`, `counterparty_vendor_data`, `stake_amount`, `net_result_amount`, `role` и одно из `hand_id`, `round_id`, `match_id`; для `gameplay.bet_placed` и `gameplay.bet_settled` требуется `game_id`; для `payment.deposit_initiated`, `payment.deposit_completed`, `payment.withdrawal_requested` и `payment.withdrawal_completed` требуются `payment_reference_id`, `amount`, `currency`, `payment_method`, `status`; для `payment.withdrawal_address_changed` требуется `withdrawal_address_hash`; для `dispute.chargeback_opened`, `dispute.chargeback_won` и `dispute.chargeback_lost` требуются `payment_reference_id` и одно из `dispute_id`, `chargeback_id`; для `session.bot_signal_observed` требуются `telemetry_schema_version` и одно из `bot_score`, `actions_per_minute`, `timing_variance_ms`, `pointer_entropy`, `keystroke_entropy`, `reaction_time_ms_p50`; для `responsible_gambling.self_exclusion_match` требуются `registry_source`, `exclusion_status`, `identity_match_ref`. Для каждого действия категории `security`, оканчивающегося на `_changed`, требуется `changed_field`, а также `previous_reference_hash` или `new_reference_hash`, если полем является `password`, `mfa_method`, `mfa`, `email`, `phone`, `withdrawal_address`, `payout_method` или `api_key`. Отправляйте хеши и ссылки, но ни в коем случае не номер карты, полный адрес вывода средств, хеш пароля или секрет MFA." }, "custom_values": { "type": "object", "description": "До 100 ваших собственных ключей, доступных из правил как `custom_values.`. Значения должны быть скалярными (строка, число, логическое значение или null); вложенные объекты и массивы отклоняются.", "additionalProperties": { "nullable": true, "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "example": { "event_id": "login-2026-10-17-000001", "event_category": "auth", "action_type": "login", "occurred_at": "2026-10-17T09:15:02.481Z", "time_zone": "Europe/Madrid", "subject": { "vendor_data": "user-42", "entity_type": "individual" }, "session": { "session_id": "web-session-abc", "sequence": 142 }, "device_context": { "fingerprint": "fp-a8c1", "network_context": { "ip_address": "203.0.113.42" } }, "payload": { "method": "password" }, "custom_values": { "vip_tier": "gold" } } }, "MonitoringEventIngestResult": { "type": "object", "description": "Результат приёма одного события. Для нового события и для идемпотентного повтора возвращается одна и та же структура.", "required": [ "event_uuid", "event_id", "status", "score", "rules_evaluated_count", "rules_matched_count", "correlation_pending", "retention_class", "expires_at", "idempotent_replay", "rule_matches" ], "properties": { "event_uuid": { "type": "string", "format": "uuid", "description": "Идентификатор сохранённого события в Didit." }, "event_id": { "type": "string", "description": "Ваш `event_id`." }, "status": { "type": "string", "enum": [ "ACCEPTED", "APPROVED", "IN_REVIEW", "DECLINED" ], "description": "Статус после выполнения правил реального времени. См. `MonitoringEvent.status`." }, "score": { "type": "integer", "description": "Оценка после выполнения правил в реальном времени." }, "rules_evaluated_count": { "type": "integer", "minimum": 0, "description": "Количество правил событий, проверенных в запросе. 0 для приложения в песочнице, где правила не выполняются." }, "rules_matched_count": { "type": "integer", "minimum": 0, "description": "Количество совпавших правил, включая правила в режиме `TEST`." }, "correlation_pending": { "type": "boolean", "description": "`true`, если асинхронное правило всё ещё должно выполниться. Вызовите `GET /v3/events/{event_uuid}/` через несколько минут, чтобы получить окончательные `status` и `score`." }, "retention_class": { "type": "string", "enum": [ "low_value", "standard", "risk_relevant", "monetary_or_compliance" ], "description": "Класс хранения после любого повышения, выполненного совпавшим правилом." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда срок хранения события в соответствии с его классом хранения истекает и оно удаляется. Null для событий `monetary_or_compliance` (платёжные события и события, связанные со спорами)." }, "idempotent_replay": { "type": "boolean", "description": "`true`, если событие с таким `event_id` и тем же содержимым уже было сохранено; значения соответствуют сохранённому событию, и повторный запуск правил не производился." }, "rule_matches": { "type": "array", "description": "Правила, совпавшие с событием.", "items": { "type": "object", "required": [ "rule_id", "library_key", "mode", "is_async" ], "properties": { "rule_id": { "type": "string", "format": "uuid", "description": "UUID правила." }, "library_key": { "type": "string", "nullable": true, "description": "Ключ библиотеки, если правило было установлено из библиотеки правил, иначе null." }, "mode": { "type": "string", "enum": [ "ACTIVE", "TEST" ], "description": "Правила типа `TEST` регистрируют совпадение, но не применяют никаких действий." }, "is_async": { "type": "boolean", "description": "`true`, если совпадение было получено в результате асинхронного прохода." } } } } } }, "ComplianceList": { "type": "object", "description": "Список блокировки, список разрешений или кастомный список одного приложения.", "required": [ "uuid", "name", "description", "list_type", "entry_type", "is_system", "entry_count", "last_entry_added_at", "created_at", "updated_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Идентификатор списка. Используйте его как `list_uuid` в endpoint'ах списков и записей, а также как значение условия правила сценария или правила транзакции с `value_type: \"list\"`." }, "name": { "type": "string", "maxLength": 255, "description": "Название списка, уникальное среди списков приложения." }, "description": { "type": "string", "description": "Описание в виде произвольного текста. Пустая строка, если не задано." }, "list_type": { "type": "string", "enum": [ "blocklist", "allowlist", "custom" ], "description": "`blocklist`: совпадение отклоняет сессию или транзакцию (только системные списки, по одному на каждый тип записи). `allowlist`: совпадающие элементы считаются доверенными, например список разрешённых лиц пропускает действие при обнаружении дубликата лица; никогда не переопределяет совпадение со списком блокировки. `custom`: используется в условиях правил сценария и транзакций (`value_type: \"list\"`)." }, "entry_type": { "type": "string", "enum": [ "face", "document", "phone", "email", "ip_address", "device_fingerprint", "wallet_address", "bank_account", "country", "user", "business", "key" ], "description": "Что содержит список: `face`, `document` (номер документа), `phone`, `email`, `ip_address` (IP-адрес или диапазон CIDR), `device_fingerprint`, `wallet_address`, `bank_account`, `country` (ISO 3166-1 alpha-3), `user` или `business` (ваши `vendor_data`), либо `key` (любая строка). Это определяет, как проверяются и сопоставляются значения записей." }, "is_system": { "type": "boolean", "description": "`true` для списков, предоставляемых Didit: по одному списку блокировки на каждый тип записи (`face`, `document`, `phone`, `email`, `ip_address`, `device_fingerprint`, `wallet_address`, `bank_account`, `user`, `business`), пользовательский список **High Risk Countries** и системные белые списки. Системные списки нельзя переименовывать, редактировать или удалять; вы можете добавлять и удалять их записи." }, "entry_count": { "type": "integer", "minimum": 0, "description": "Количество записей, находящихся в списке в данный момент." }, "last_entry_added_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Время добавления самой новой текущей записи. `null` для пустого списка." }, "created_at": { "type": "string", "format": "date-time", "description": "Время создания списка." }, "updated_at": { "type": "string", "format": "date-time", "description": "Время последнего обновления списка." } } }, "ComplianceListEntry": { "type": "object", "description": "Одно значение в списке.", "required": [ "uuid", "value", "display_label", "comment", "added_by", "reference_session_id", "reference_session_number", "reference_session_type", "reference_object_uuid", "metadata", "created_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Идентификатор записи. Используйте его в качестве `entry_uuid` в запросе «Удалить запись списка»." }, "value": { "type": "string", "description": "Значение из списка: номер телефона в формате E.164, адрес электронной почты, номер документа, IP-адрес или диапазон CIDR, цифровой отпечаток устройства, адрес кошелька, банковский счёт, трёхбуквенный код страны по стандарту ISO 3166-1 alpha-3, `vendor_data`, любая строка в списке типа `key` или UUID сохранённого лица в списке лиц. Отправляемые вами значения сохраняются в нижнем регистре, за исключением номеров телефонов и кодов стран. Сопоставление нечувствительно к регистру." }, "display_label": { "type": "string", "nullable": true, "maxLength": 512, "description": "Понятная метка. Didit заполняет её для записей, взятых из сессии (например, имя владельца и номер документа), если вы ничего не передали." }, "comment": { "type": "string", "description": "Примечание в виде произвольного текста. Пустая строка, если не задано." }, "added_by": { "type": "string", "nullable": true, "description": "Кто добавил запись: `api` (API-ключ), адрес электронной почты пользователя консоли или `console`, `system` или `migration` (записи, созданные Didit), либо `rule` (действие правила транзакций или мониторинга)." }, "reference_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Сессия верификации, из которой была взята запись. `null`, если запись была добавлена по значению." }, "reference_session_number": { "type": "integer", "nullable": true, "description": "Номер этой сессии в рамках приложения, как он отображается в консоли." }, "reference_session_type": { "type": "string", "nullable": true, "enum": [ "kyc", "kyb", null ], "description": "`kyc` для сессии проверки физического лица, `kyb` для сессии верификации бизнеса, `null`, если сессия отсутствует." }, "reference_object_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "Запись, которой соответствует элемент: запись лица, документа, телефона или адреса электронной почты, считанная из сессии, лицо, созданное с помощью «Загрузить лицо в список», или переданный вами UUID (например, UUID транзакции или `didit_internal_id` пользователя)." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Дополнительный контекст. Содержит ключи, установленные Didit (перечисленные здесь), объединенные с любыми `metadata`, переданными вами при создании записи, и возвращается в сохраненном виде. `null`, если контекст отсутствует.", "properties": { "reference_image_url": { "type": "string", "description": "Записи лиц: короткоживущий подписанный URL, генерируемый заново при каждом вызове; `null` для API-ключа с ограниченными правами без `media: read`. Отсутствует, если к записи не привязано изображение." }, "front_image_url": { "type": "string", "description": "Записи документов, содержащие изображение лицевой стороны документа: временный подписанный URL, генерируемый заново при каждом вызове; `null` для API-ключа с ограниченной областью действия без `media: read`." }, "full_name": { "type": "string", "description": "Записи документов, полученные из сессии: полное имя владельца." }, "issuing_state": { "type": "string", "description": "Записи документов, полученные из сессии: страна выдачи по стандарту ISO 3166-1 alpha-3." }, "document_type": { "type": "string", "description": "Записи документов, полученные из сессии: код типа документа, например `P`, `ID` или `DL`." }, "region": { "type": "string", "description": "Записи документов, полученные из сессии: штат или провинция выдачи для документа регионального выпуска, пусто, если неприменимо. Не задаётся действием добавления элементов сессии в список блокировки." }, "document_number": { "type": "string", "description": "Записи документов, полученные из сессии: номер документа." }, "face_image_source": { "type": "string", "enum": [ "front_image_camera_front", "back_image_camera_front" ], "description": "Записи лиц, полученные из селфи с захвата документа: какое именно селфи. Отсутствует для лиц из проверки живости." }, "reference_node_id": { "type": "string", "nullable": true, "description": "Записи лиц, полученные из селфи с захвата документа: узел верификации личности, из которого поступило селфи." }, "fingerprint_tier": { "type": "string", "nullable": true, "enum": [ "persistent_id", "composite_hash", "legacy_fp", "unknown", null ], "description": "Записи цифрового отпечатка устройства, полученные из сессии: способ формирования отпечатка. `persistent_id` идентифицирует одно устройство; `composite_hash` и `legacy_fp` могут быть общими для устройств одной модели." }, "sandbox": { "type": "boolean", "description": "`true` для записи лица, загруженной в приложении песочницы; такая запись ни с чем не совпадает." }, "reference_type": { "type": "string", "enum": [ "transaction", "vendor_user", "vendor_business" ], "description": "Задаётся вами: объект, на который указывает `reference_object_uuid`, чтобы консоль ссылалась на него." }, "reference_id": { "type": "string", "description": "Задаётся вами: идентификатор исходной записи." } } }, "created_at": { "type": "string", "format": "date-time", "description": "Когда запись была добавлена." } } }, "BlocklistedItem": { "type": "object", "description": "Одно лицо, документ, удостоверяющий личность, номер телефона или адрес электронной почты из списка блокировки, обнаруженные в сессии верификации. Поля, неприменимые к `type` элемента, содержат `null`.", "required": [ "type", "session_id", "session_number", "blocklisted_at", "face_image", "document_type", "document_number", "front_image", "phone_number", "country_code", "email" ], "properties": { "type": { "type": "string", "enum": [ "face", "document", "phone", "email" ], "description": "Что было добавлено в список блокировки." }, "session_id": { "type": "string", "format": "uuid", "description": "Сессия верификации, к которой относится элемент." }, "session_number": { "type": "integer", "nullable": true, "description": "Номер этой сессии в рамках приложения, как он отображается в консоли." }, "blocklisted_at": { "type": "string", "format": "date-time", "description": "Время последнего добавления элемента в список блокировки." }, "face_image": { "type": "string", "nullable": true, "description": "Элементы лиц: короткоживущий подписанный URL, генерируемый заново при каждом вызове; `null` для API-ключа с ограниченными правами без `media: read`. Также `null`, если эталонное изображение не сохранено." }, "document_type": { "type": "string", "nullable": true, "description": "Элементы документа: код типа документа, например `P` (паспорт), `ID` (национальное удостоверение личности), `DL` (водительские права) или `RP` (вид на жительство)." }, "document_number": { "type": "string", "nullable": true, "description": "Элементы документа: номер документа или личный номер, если у документа нет номера." }, "front_image": { "type": "string", "nullable": true, "description": "Элементы документа: изображение лицевой стороны документа, временный подписанный URL, генерируемый заново при каждом вызове; `null` для API-ключа с ограниченной областью действия без `media: read`." }, "phone_number": { "type": "string", "nullable": true, "description": "Элементы телефонного номера: номер телефона в формате E.164." }, "country_code": { "type": "string", "nullable": true, "description": "Элементы телефонного номера: страна номера по стандарту ISO 3166-1 alpha-2." }, "email": { "type": "string", "nullable": true, "description": "Элементы электронной почты: адрес электронной почты." } } }, "TransactionNote": { "type": "object", "description": "Одна заметка в хронологии проверки отслеживаемой транзакции.", "required": [ "uuid", "note", "actor_email", "actor_name", "metadata", "created_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Идентификатор заметки." }, "note": { "type": "string", "description": "Текст обычной заметки." }, "actor_email": { "type": "string", "format": "email", "nullable": true, "description": "Электронная почта пользователя Console, оставившего заметку или изменившего статус. `null` для заметок, созданных с помощью API-ключа, и заметок, добавляемых Didit автоматически." }, "actor_name": { "type": "string", "nullable": true, "description": "Отображаемое имя пользователя Console (его email, если имя не указано). `Rule Engine` для заметок, которые Didit добавляет автоматически. `null` для заметок, созданных с помощью API-ключа." }, "metadata": { "type": "object", "description": "Различает типы заметок. Заметки, добавленные через API или консоль, содержат `mentioned_emails`. Изменение статуса, сделанное в консоли, содержит `type: status_change` с `previous_status`, `new_status`, `reason_code` и `reason_label`. Заметки, добавленные Didit, содержат `source`: `rule_action` (с `rule_uuid`) для действия правила `add_note` или `remediation_session` для проблемы при создании сессии верификации по действию пользователя.", "properties": { "mentioned_emails": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "Упомянутые участники организации в нижнем регистре с удалением дубликатов. Пусто, если никто не был упомянут." }, "type": { "type": "string", "enum": [ "status_change" ], "description": "Присутствует в заметках, фиксирующих изменение статуса, сделанное в Консоли." }, "previous_status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Статус до изменения." }, "new_status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Статус после изменения." }, "reason_code": { "type": "string", "nullable": true, "description": "Код причины, указанный при изменении." }, "reason_label": { "type": "string", "nullable": true, "description": "Метка причины, указанная при изменении." }, "source": { "type": "string", "enum": [ "rule_action", "remediation_session" ], "description": "Присутствует в заметках, которые Didit добавляет автоматически." }, "rule_uuid": { "type": "string", "format": "uuid", "description": "Правило, чьё действие `add_note` создало заметку (с `source: rule_action`)." } } }, "created_at": { "type": "string", "format": "date-time", "description": "Время сохранения заметки." } } }, "TransactionSummary": { "type": "object", "description": "Сводка отслеживаемой транзакции со структурой, описанной в `GET /v3/transactions/`. Вызовите `GET /v3/transactions/{transaction_id}/` с `uuid` для получения сторон, оповещений и срабатываний правил.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID транзакции Didit. Используйте его в качестве `{transaction_id}` в endpoint'ах транзакций." }, "transaction_number": { "type": "integer", "nullable": true, "description": "Порядковый номер в рамках приложения, отображаемый в консоли." }, "txn_id": { "type": "string", "nullable": true, "description": "Ваш собственный идентификатор из вызова создания. Уникален для каждого приложения." }, "transaction_type": { "type": "string", "description": "Категория в сохранённом виде: `finance`, `kyc`, `travelRule`, `userPlatformEvent`, `gamblingBet`, `gamblingLimitChange`, `gamblingBonusChange` или `auditTrailEvent`." }, "action_type": { "type": "string", "description": "Подтип внутри категории, например `withdrawal`." }, "status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Текущий вердикт мониторинга." }, "source": { "type": "string", "enum": [ "LIVE", "IMPORTED" ], "description": "`LIVE` для транзакций, отправленных на мониторинг, `IMPORTED` для исторического импорта." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Направление относительно субъекта." }, "amount": { "type": "string", "description": "Сумма в виде десятичной строки с удалёнными замыкающими нулями (до 18 знаков после запятой)." }, "currency": { "type": "string", "description": "Код валюты или символ криптоактива для `amount`." }, "currency_type": { "type": "string", "nullable": true, "description": "`fiat` или `crypto`, если известно." }, "preferred_currency_amount": { "type": "string", "nullable": true, "description": "Значение `amount`, конвертированное в предпочтительную валюту приложения, если курс был доступен." }, "preferred_currency_code": { "type": "string", "nullable": true, "description": "Валюта для `preferred_currency_amount`." }, "payment_details": { "type": "string", "nullable": true, "description": "Назначение платежа в виде произвольного текста." }, "txn_date": { "type": "string", "format": "date-time", "description": "Когда произошла транзакция." }, "created_at": { "type": "string", "format": "date-time", "description": "Когда Didit записал это." }, "score": { "type": "integer", "description": "Оценка риска. Чем выше, тем рискованнее." }, "severity": { "type": "string", "nullable": true, "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL", null ], "description": "Серьёзность риска, `null`, пока значение не установлено." }, "decision_reason_code": { "type": "string", "nullable": true, "description": "Машиночитаемая причина текущего `status`." }, "decision_reason_label": { "type": "string", "nullable": true, "description": "Понятная метка для `decision_reason_code`." }, "tags": { "type": "array", "description": "Теги транзакции.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "color": { "type": "string", "description": "Шестнадцатеричный цвет (hex), например `#F59E0B`." }, "description": { "type": "string", "nullable": true }, "source": { "type": "string", "enum": [ "didit", "custom" ], "description": "Предустановленный или пользовательский тег Didit." } } } }, "subject_name": { "type": "string", "nullable": true, "description": "Полное имя стороны `APPLICANT`." }, "subject_vendor_data": { "type": "string", "nullable": true, "description": "Ваш `vendor_data` для заявителя." }, "subject_type": { "type": "string", "nullable": true, "enum": [ "user", "business", null ], "description": "Связан ли заявитель с пользователем или компанией Didit; `null`, если он не связан ни с тем, ни с другим." }, "subject_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID пользователя или компании Didit, с которыми связан заявитель." }, "subject_country": { "type": "string", "nullable": true, "description": "Код страны заявителя." }, "counterparty_name": { "type": "string", "nullable": true, "description": "Полное имя стороны `COUNTERPARTY`, если применимо." }, "counterparty_vendor_data": { "type": "string", "nullable": true, "description": "Ваш `vendor_data` для контрагента." }, "counterparty_country": { "type": "string", "nullable": true, "description": "Код страны контрагента." }, "assigned_to_name": { "type": "string", "nullable": true, "description": "Имя проверяющего в Console, назначенного на транзакцию." }, "travel_rule_status": { "type": "string", "nullable": true, "description": "Статус передачи Travel Rule для транзакции, или `null`, если её нет." }, "application_id": { "type": "string", "format": "uuid", "description": "Приложение, которому принадлежит транзакция." }, "application_name": { "type": "string", "nullable": true, "description": "Название этого приложения." }, "organization_id": { "type": "string", "format": "uuid", "description": "Организация, владеющая приложением." }, "organization_name": { "type": "string", "nullable": true, "description": "Название этой организации." } } }, "ApplicationAnalyticsDataPoint": { "type": "object", "description": "Количество сессий за один день по дате создания (UTC). Каждое значение отражает текущий статус сессии. Точки предыдущего периода содержат как минимум обязательные поля.", "required": [ "rounded_date", "total", "approved", "declined", "canceled", "pending" ], "properties": { "rounded_date": { "type": "string", "format": "date", "description": "День, `YYYY-MM-DD`." }, "total": { "type": "integer", "description": "Сессии, созданные в этот день." }, "approved": { "type": "integer", "description": "Из них сессии `Approved` или `Kyc Expired`." }, "declined": { "type": "integer", "description": "Сессии со статусом `Declined`." }, "canceled": { "type": "integer", "description": "Сессии со статусом `Expired` или `Abandoned`." }, "pending": { "type": "integer", "description": "Сессии со статусом `Not Started`, `In Progress` или `In Review`." }, "in_review": { "type": "integer", "description": "Сессии со статусом `In Review`." }, "expired": { "type": "integer", "description": "Сессии со статусом `Expired`." }, "abandoned": { "type": "integer", "description": "Сессии со статусом `Abandoned`." }, "in_progress": { "type": "integer", "description": "Сессии со статусом `In Progress`." }, "not_started": { "type": "integer", "description": "Сессии со статусом `Not Started`." }, "manually_approved": { "type": "integer", "description": "Сессии, одобренные проверяющим после того, как сценарий вынес иной вердикт." }, "manually_declined": { "type": "integer", "description": "Сессии, отклонённые проверяющим после того, как сценарий вынес иной вердикт." } } }, "ApplicationAnalyticsRequestBreakdown": { "type": "object", "description": "Итоговые данные по статусам за диапазон. Разбивка за предыдущий период содержит как минимум обязательные поля.", "required": [ "total_approved", "total_in_review", "total_declined", "total_canceled", "total_pending" ], "properties": { "total_approved": { "type": "integer", "description": "Сессии со статусом `Approved` или `Kyc Expired`." }, "total_in_review": { "type": "integer", "description": "Сессии со статусом `In Review`." }, "total_declined": { "type": "integer", "description": "Сессии со статусом `Declined`." }, "total_canceled": { "type": "integer", "description": "Сессии со статусом `Expired` или `Abandoned`." }, "total_pending": { "type": "integer", "description": "Сессии со статусом `Not Started`, `In Progress` или `In Review` (включает `total_in_review`)." }, "total_expired": { "type": "integer", "description": "Сессии со статусом `Expired`." }, "total_abandoned": { "type": "integer", "description": "Сессии со статусом `Abandoned`." }, "total_in_progress": { "type": "integer", "description": "Сессии со статусом `In Progress`." }, "total_not_started": { "type": "integer", "description": "Сессии со статусом `Not Started`." }, "total_manually_approved": { "type": "integer", "description": "Одобрена проверяющим." }, "total_manually_declined": { "type": "integer", "description": "Отклонена проверяющим." } } }, "ApplicationAnalyticsCountryCount": { "type": "object", "properties": { "country": { "type": "string", "description": "Название страны." }, "country_code": { "type": "string", "description": "Двухбуквенный код страны." }, "session_count": { "type": "integer", "description": "Сессии из этой страны." } } }, "ApplicationAnalyticsLocationStats": { "type": "object", "properties": { "ip_countries": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsCountryCount" }, "description": "Страны IP-адресов пользователей, в порядке убывания числа сессий." }, "countries": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsCountryCount" }, "description": "Тот же список, что и `ip_countries`." }, "id_countries": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsCountryCount" }, "description": "Страны выдачи верифицированных документов, удостоверяющих личность, в порядке убывания количества сессий." }, "conversion_by_country": { "type": "array", "description": "По стране выдачи документа: завершённые сессии (одобрена, отклонена или на проверке) и количество одобренных. Сортировка по убыванию количества завершённых.", "items": { "type": "object", "properties": { "country": { "type": "string" }, "country_code": { "type": "string" }, "finished": { "type": "integer" }, "approved": { "type": "integer" } } } }, "cities": { "type": "array", "description": "До 100 городов по IP, сначала города с наибольшим числом сессий.", "items": { "type": "object", "properties": { "location": { "type": "string", "description": "`City, Country`." }, "session_count": { "type": "integer" }, "latitude": { "type": "number", "nullable": true }, "longitude": { "type": "number", "nullable": true } } } } } }, "ApplicationAnalyticsDemographicStats": { "type": "object", "properties": { "age_distribution": { "type": "object", "description": "Сессии по возрастным группам из документа, удостоверяющего личность. Пусто, если данные отсутствуют.", "properties": { "under_18": { "type": "integer" }, "18_24": { "type": "integer" }, "25_34": { "type": "integer" }, "35_44": { "type": "integer" }, "45_64": { "type": "integer" }, "65_plus": { "type": "integer" } }, "additionalProperties": { "type": "integer" } }, "gender_distribution": { "type": "object", "description": "Сессии по коду пола из документа: `M`, `F` или `U` (неизвестно).", "additionalProperties": { "type": "integer" } } } }, "ApplicationAnalyticsDeviceDetails": { "type": "object", "description": "Топ-5 по каждой категории, сначала с наибольшим количеством сессий.", "properties": { "device_models": { "type": "array", "description": "Бренды устройств: `Apple`, `Android`, `LG`, все остальные сгруппированы как `Other`.", "items": { "type": "object", "properties": { "device": { "type": "string" }, "count": { "type": "integer" } } } }, "browsers": { "type": "array", "description": "Браузеры: `Chrome`, `Safari`, `Didit App`, `Firefox`, всё остальное сгруппировано как `Other`.", "items": { "type": "object", "properties": { "browser": { "type": "string" }, "count": { "type": "integer" } } } }, "operating_systems": { "type": "array", "description": "Операционные системы.", "items": { "type": "object", "properties": { "os": { "type": "string" }, "count": { "type": "integer" } } } } } }, "ApplicationAnalyticsWorkflowFunnel": { "type": "object", "description": "С ключами по ID сценария. `total` показывает сессии, запущенные по этому сценарию; `steps` подсчитывает сессии, дошедшие до каждого шага (`OCR`, `LIVENESS`, `FACE_MATCH`, `AML`, `POA`, `PHONE`, `EMAIL`, `NFC`, `DATABASE_VALIDATION`, `QUESTIONNAIRE`, `IP_ANALYSIS`, `AGE_ESTIMATION`, `KYB_REGISTRY`, `KYB_DOCUMENTS`, `KYB_KEY_PEOPLE`). Дойти до шага не означает пройти его.", "additionalProperties": { "type": "object", "properties": { "total": { "type": "integer" }, "steps": { "type": "object", "additionalProperties": { "type": "object", "properties": { "reached": { "type": "integer" } } } } } } }, "ApplicationAnalyticsVerificationTimeStats": { "type": "object", "description": "Активное время, затраченное пользователями на верификацию, без учёта пауз бездействия. Пустой объект, если данных нет.", "properties": { "overall_avg_seconds": { "type": "number", "description": "Среднее значение за сессию, один десятичный знак." }, "overall_count": { "type": "integer", "description": "Измеренные сессии." }, "per_feature": { "type": "object", "description": "С ключами по функциям, например `OCR` или `LIVENESS`.", "additionalProperties": { "type": "object", "properties": { "avg_seconds": { "type": "number" }, "total_seconds": { "type": "number" }, "count": { "type": "integer" } } } }, "per_sub_step": { "type": "object", "description": "С ключами по функциям, затем по подшагам, например `front_id_photo`.", "additionalProperties": { "type": "object", "additionalProperties": { "type": "object", "properties": { "avg_seconds": { "type": "number" }, "total_seconds": { "type": "number" }, "count": { "type": "integer" } } } } } } }, "ApplicationAnalyticsResubmissionStats": { "type": "object", "properties": { "first_pass": { "type": "integer", "description": "Завершённые сессии без повторной отправки." }, "second": { "type": "integer", "description": "Завершённые сессии, отправленные повторно один раз." }, "third_plus": { "type": "integer", "description": "Завершённые сессии, отправленные повторно два или более раз." }, "abandoned": { "type": "integer", "description": "Прерванные сессии." } } }, "ApplicationAnalyticsOriginalStatusStats": { "type": "object", "description": "Автоматическое решение сценария до того, как проверяющий изменил его.", "properties": { "approved": { "type": "integer" }, "in_review": { "type": "integer" }, "declined": { "type": "integer" } } }, "ApplicationAnalyticsWarningStats": { "type": "object", "description": "С ключами по функциям (`ID_VERIFICATION`, `LIVENESS`, `FACEMATCH`, `AML`, `PROOF_OF_ADDRESS`, `PHONE`, `EMAIL`, `NFC`, `LOCATION`, `DATABASE_VALIDATION`, `QUESTIONNAIRE` и функции KYB). Значение `total` содержит сессии, дошедшие до функции; `risks` подсчитывает сессии по коду и уровню предупреждения.", "additionalProperties": { "type": "object", "properties": { "total": { "type": "integer" }, "risks": { "type": "object", "additionalProperties": { "type": "object", "properties": { "error": { "type": "integer" }, "warning": { "type": "integer" }, "information": { "type": "integer" } } } } } } }, "ApplicationAnalyticsDemographicPoint": { "type": "object", "properties": { "date": { "type": "string", "description": "Ключ периода: `YYYY-MM-DD` для дня, понедельник недели или `YYYY-MM` для месяца в соответствии с `grouping_mode`." }, "age_distribution": { "type": "object", "additionalProperties": { "type": "integer" } }, "gender_distribution": { "type": "object", "additionalProperties": { "type": "integer" } } } }, "ApplicationAnalyticsDevicePoint": { "type": "object", "properties": { "date": { "type": "string", "description": "Ключ периода: `YYYY-MM-DD` для дня, понедельник недели или `YYYY-MM` для месяца в соответствии с `grouping_mode`." }, "devices": { "type": "object", "additionalProperties": { "type": "integer" } }, "browsers": { "type": "object", "additionalProperties": { "type": "integer" } }, "operating_systems": { "type": "object", "additionalProperties": { "type": "integer" } } } }, "ApplicationAnalyticsVerificationTimePoint": { "type": "object", "properties": { "date": { "type": "string", "description": "Ключ периода: `YYYY-MM-DD` для дня, понедельник недели или `YYYY-MM` для месяца в соответствии с `grouping_mode`." }, "overall_avg": { "type": "number", "description": "Среднее количество активных секунд на сессию." }, "per_feature": { "type": "object", "description": "Среднее количество активных секунд на функцию.", "additionalProperties": { "type": "number" } } } }, "ApplicationAnalyticsResubmissionPoint": { "type": "object", "properties": { "date": { "type": "string", "description": "Ключ периода: `YYYY-MM-DD` для дня, понедельник недели или `YYYY-MM` для месяца в соответствии с `grouping_mode`." }, "first_pass": { "type": "integer" }, "second": { "type": "integer" }, "third_plus": { "type": "integer" }, "abandoned": { "type": "integer" } } }, "ApplicationAnalyticsOriginalStatusPoint": { "type": "object", "properties": { "date": { "type": "string", "description": "Ключ периода: `YYYY-MM-DD` для дня, понедельник недели или `YYYY-MM` для месяца в соответствии с `grouping_mode`." }, "approved": { "type": "integer" }, "in_review": { "type": "integer" }, "declined": { "type": "integer" } } }, "ApplicationAnalyticsSummary": { "type": "object", "description": "Сводка проверки пользователей (KYC), возвращаемая, если не переданы ни `scope`, ни `widget_keys`.", "required": [ "data_points", "request_breakdown", "previous_data_points", "previous_request_breakdown", "conversion_rate", "location_stats", "demographic_stats", "device_details", "workflow_funnel_stats", "verification_time_stats", "resubmission_stats", "warning_stats", "original_status_stats", "grouping_mode", "demographic_time_series", "device_time_series", "verification_time_time_series", "resubmission_time_series", "original_status_time_series" ], "properties": { "data_points": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsDataPoint" }, "description": "Одна точка на день, начиная с первого дня с сессиями в указанном диапазоне и до `end_date`. Всегда с ежедневной детализацией независимо от значения `grouping_mode`." }, "request_breakdown": { "$ref": "#/components/schemas/ApplicationAnalyticsRequestBreakdown" }, "previous_data_points": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsDataPoint" }, "description": "Ежедневные точки за период такой же длительности непосредственно перед `start_date`." }, "previous_request_breakdown": { "$ref": "#/components/schemas/ApplicationAnalyticsRequestBreakdown" }, "conversion_rate": { "type": "number", "nullable": true, "description": "`total_approved / (total_approved + total_declined + total_in_review) x 100`, один знак после запятой. `null`, когда ничего не завершилось." }, "location_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsLocationStats" }, "demographic_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsDemographicStats" }, "device_details": { "$ref": "#/components/schemas/ApplicationAnalyticsDeviceDetails" }, "workflow_funnel_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsWorkflowFunnel" }, "verification_time_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsVerificationTimeStats" }, "resubmission_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsResubmissionStats" }, "warning_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsWarningStats" }, "original_status_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsOriginalStatusStats" }, "grouping_mode": { "type": "string", "enum": [ "day", "week", "month" ], "description": "Способ группировки списков `*_time_series`: `day` для периодов до 14 дней, `week` до 90 дней, `month` свыше 90 дней. Отсчитывается от первого дня с сессиями в диапазоне." }, "demographic_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsDemographicPoint" } }, "device_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsDevicePoint" } }, "verification_time_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsVerificationTimePoint" } }, "resubmission_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsResubmissionPoint" } }, "original_status_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsOriginalStatusPoint" } } } }, "ApplicationAnalyticsWidget": { "type": "object", "description": "Один виджет панели управления. Каждый виджет содержит `kind` и `title`; остальные поля зависят от `kind`. Виджеты сессий повторно используют объекты сводки (`data_points`, `request_breakdown`, `workflow_funnel_stats` и т. д.); списочные виджеты помещают свои записи в `items`; метрики транзакций используют `value`.", "required": [ "kind", "title" ], "properties": { "kind": { "type": "string", "enum": [ "sessions_volume", "workflow_funnel", "average_verification_time", "country_distribution", "warning_insights", "conversion_rate", "conversion_by_country", "resubmission_insights", "original_status_distribution", "database_validation_coverage", "database_validation_latency", "demographics", "device_details", "horizontal_bar", "kyb_registry_coverage", "kyb_registry_data_completeness", "metric", "time_series", "breakdown", "status_time_series", "leaderboard", "histogram" ], "description": "Тип виджета." }, "title": { "type": "string", "description": "Отображаемый заголовок, например `Verification volume`." }, "grouping_mode": { "type": "string", "enum": [ "day", "week", "month" ], "description": "Способ группировки списков `*_time_series`: `day` для периодов до 14 дней, `week` до 90 дней, `month` свыше 90 дней. Отсчитывается от первого дня с сессиями в диапазоне." }, "data_points": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsDataPoint" } }, "request_breakdown": { "$ref": "#/components/schemas/ApplicationAnalyticsRequestBreakdown" }, "previous_data_points": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsDataPoint" } }, "previous_request_breakdown": { "$ref": "#/components/schemas/ApplicationAnalyticsRequestBreakdown" }, "conversion_rate": { "type": "number", "nullable": true }, "workflow_funnel_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsWorkflowFunnel" }, "verification_time_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsVerificationTimeStats" }, "verification_time_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsVerificationTimePoint" } }, "warning_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsWarningStats" }, "resubmission_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsResubmissionStats" }, "resubmission_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsResubmissionPoint" } }, "original_status_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsOriginalStatusStats" }, "original_status_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsOriginalStatusPoint" } }, "demographic_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsDemographicStats" }, "demographic_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsDemographicPoint" } }, "device_details": { "$ref": "#/components/schemas/ApplicationAnalyticsDeviceDetails" }, "device_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsDevicePoint" } }, "items": { "type": "array", "description": "Элементы виджета списка. `country_distribution` (KYC): `country`, `country_code`, `session_count`. `conversion_by_country`: `country`, `country_code`, `finished`, `approved`. `time_series`: `date`, `value`. `status_time_series`: `date`, `approved`, `declined`, `flagged`. `breakdown`: `transaction_type` или `action_type` с `count` и `volume`, либо `tag_id`, `tag_name`, `count`. `leaderboard`: `rule_title`, `trigger_count` или `assignee`, `handled_count`, `average_processing_seconds`, каждый с `approved_percentage`, `declined_percentage`, `flagged_percentage`. `histogram`: `score`, `count`.", "items": { "type": "object", "additionalProperties": {} } }, "previous_items": { "type": "array", "description": "Временной ряд транзакций за период такой же длительности непосредственно перед `start_date`.", "items": { "type": "object", "additionalProperties": {} } }, "value": { "type": "number", "description": "Виджеты `metric`: показатель за диапазон." }, "currency": { "type": "string", "nullable": true, "description": "Виджеты объёма и суммы транзакций: валюта транзакций приложения по умолчанию." }, "thresholds": { "type": "object", "description": "Виджет `histogram`: пороговые значения скоринга приложения для отправки на проверку и отклонения.", "properties": { "review": { "type": "integer" }, "decline": { "type": "integer" } } }, "search": { "type": "object", "description": "Виджет `kyb_registry_coverage`: сводные данные поиска по реестрам.", "properties": { "searches_total": { "type": "integer" }, "searches_with_no_candidates": { "type": "integer" } } } } }, "ApplicationAnalyticsWidgetResponse": { "type": "object", "description": "Виджеты панели управления, возвращаемые при передаче `scope` или `widget_keys`.", "required": [ "scope", "available_widget_keys", "requested_widget_keys", "widgets" ], "properties": { "scope": { "type": "string", "enum": [ "home", "kyc", "kyb", "transactions" ], "description": "Вкладка панели управления." }, "available_widget_keys": { "type": "array", "items": { "type": "string" }, "description": "Каждый ключ виджета, принимаемый этой областью видимости." }, "requested_widget_keys": { "type": "array", "items": { "type": "string" }, "description": "Ключи виджета в ответе по порядку: ваши действующие `widget_keys` или значения по умолчанию для области видимости." }, "widgets": { "type": "object", "description": "С ключами по ключам виджетов в порядке `requested_widget_keys`.", "additionalProperties": { "$ref": "#/components/schemas/ApplicationAnalyticsWidget" } } } }, "ApplicationAnalyticsToday": { "type": "object", "description": "Сегодняшние верификации по местным часам в сравнении с тем же днём недели на прошлой неделе.", "required": [ "time_zone", "date", "current_hour", "previous_date", "hours", "previous_hours", "total", "previous_total_so_far", "outcomes" ], "properties": { "time_zone": { "type": "string", "description": "Часовой пояс IANA, в котором указаны день и его часы.", "example": "Europe/Madrid" }, "date": { "type": "string", "format": "date", "description": "Сегодня в этом часовом поясе.", "example": "2026-10-30" }, "current_hour": { "type": "integer", "minimum": 0, "maximum": 23, "description": "Текущий локальный час.", "example": 14 }, "previous_date": { "type": "string", "format": "date", "description": "День сравнения: тот же день недели неделей ранее.", "example": "2026-10-23" }, "hours": { "type": "array", "items": { "type": "integer", "minimum": 0 }, "minItems": 24, "maxItems": 24, "description": "Верификации, созданные сегодня, по часам местного времени начиная с 00:00. Для предстоящих часов значение равно 0." }, "previous_hours": { "type": "array", "items": { "type": "integer", "minimum": 0 }, "minItems": 24, "maxItems": 24, "description": "Верификации, созданные в день сравнения, по часам местного времени начиная с 00:00." }, "total": { "type": "integer", "minimum": 0, "description": "Верификации, созданные сегодня к настоящему моменту.", "example": 165 }, "previous_total_so_far": { "type": "integer", "minimum": 0, "description": "Верификации, созданные в день сравнения к тому же местному времени.", "example": 151 }, "outcomes": { "type": "object", "description": "Сколько из сегодняшних верификаций сейчас одобрено, находится на проверке и отклонено. Остальные ещё не завершены.", "required": [ "approved", "in_review", "declined" ], "properties": { "approved": { "type": "integer", "minimum": 0 }, "in_review": { "type": "integer", "minimum": 0 }, "declined": { "type": "integer", "minimum": 0 } } } } }, "WebhookConfigDestination": { "type": "object", "description": "Адрес назначения webhook, указанный в конфигурации webhook, без метрик доставки. `GET /v3/webhook/destinations/{destination_uuid}/` добавляет сводку по доставке.", "required": [ "uuid", "label", "url", "enabled", "webhook_version", "secret_shared_key", "subscribed_events", "created_at", "updated_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "ID адреса назначения." }, "label": { "type": "string", "maxLength": 255, "description": "Понятное человеку имя." }, "url": { "type": "string", "format": "uri", "maxLength": 2000, "description": "HTTPS-endpoint, на который Didit отправляет события." }, "enabled": { "type": "boolean", "description": "`false` приостанавливает доставки на этот адрес назначения." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Версия payload, отправляемая по этому адресу назначения." }, "secret_shared_key": { "type": "string", "description": "Секрет подписи для этого адреса назначения (43-символьный URL-безопасный токен). Проверяйте каждый webhook с помощью секрета того адреса назначения, на который он был отправлен. Вызывающие с API-ключом всегда получают его полностью; пользователи Консоли без `read:webhooks` получают пустую строку." }, "subscribed_events": { "type": "array", "uniqueItems": true, "description": "Типы событий, доставляемые на этот адрес назначения. Пусто, если адрес назначения был создан без событий; в таком случае он ничего не получает.", "items": { "$ref": "#/components/schemas/WebhookEvent" } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "WebhookConfig": { "type": "object", "description": "Конфигурация webhook уровня приложения, политика хранения данных и хосты возврата кошелька Digital ID вместе со всеми адресами назначения webhook.", "required": [ "webhook_url", "webhook_version", "secret_shared_key", "capture_method", "data_retention_months", "face_retention_policy", "face_retention_days", "available_events", "allowed_return_hosts", "endpoints" ], "properties": { "webhook_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL webhook уровня приложения (устаревший). Didit отправляет на него запросы только до тех пор, пока у приложения нет включённого адреса назначения webhook, и только события `status.updated` и `data.updated`. Любое создание, обновление или удаление адреса назначения webhook устанавливает его в URL самого старого включённого адреса назначения webhook или в `null`, если ни один не включён." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Версия payload устаревшего `webhook_url`. У каждого адреса назначения своя `webhook_version`." }, "secret_shared_key": { "type": "string", "description": "Секрет подписи уровня приложения (43-символьный URL-безопасный токен). Он подписывает только доставку на устаревший `webhook_url`; каждый адрес назначения подписывает со своим `secret_shared_key`. При вызове с API-ключом он всегда возвращается полностью; пользователи консоли без разрешения `read:webhooks` получают пустую строку." }, "capture_method": { "type": "string", "enum": [ "MOBILE", "MOBILE_AND_DESKTOP" ], "description": "Устаревшая настройка приложения. Сценарий верификации её не считывает: параметры захвата настраиваются для каждого сценария отдельно." }, "data_retention_months": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 120, "description": "Окно автоматического удаления. Сессии проверки пользователей, созданные более указанного количества месяцев назад (месяц считается как 30 дней), удаляются автоматически, и это удаление необратимо. `null` означает, что сессии никогда не удаляются автоматически. См. раздел [Хранение данных](https://docs.didit.me/ru/console/data-retention)." }, "face_retention_policy": { "type": "string", "enum": [ "delete_with_session", "retain_until_user_deleted" ], "description": "Что происходит с эмбеддингом лица сессии при удалении сессии. `delete_with_session` (по умолчанию) удаляет его вместе с сессией. `retain_until_user_deleted` представляет собой подключаемое [хранение биометрических шаблонов](https://docs.didit.me/ru/console/data-retention#хранение-биометрических-шаблонов): биометрический шаблон без изображения, привязанный к пользователю, администрируется отдельно до окончания срока его хранения, удаления пользователя или принудительной очистки вами." }, "face_retention_days": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 3650, "description": "Срок хранения биометрических шаблонов в днях согласно политике `retain_until_user_deleted`. Обязателен, если задана эта политика." }, "biometric_consent_mode": { "type": "string", "enum": [ "auto", "always", "never" ], "description": "Когда размещённый сценарий и нативные SDK запрашивают у человека явное биометрическое согласие перед захватом лица. Значение `auto` (по умолчанию) запрашивает согласие только при срабатывании триггера: указанный штат, IP-адрес пользователя или эмитент документа, удостоверяющего личность, относятся к Иллинойсу, Техасу или Колорадо, либо пользователь предположительно находится в США без определённого штата. Значение `always` запрашивает согласие у каждого человека, чей сценарий включает захват лица. Значение `never` никогда не показывает этот шаг, и вы собираете согласие самостоятельно перед селфи. Каждое изменение фиксируется в журнале аудита. См. [Biometric consent](https://docs.didit.me/ru/getting-started/biometric-consent)." }, "available_events": { "type": "array", "description": "Каждый тип события, на который может подписаться адрес назначения, с отображаемой меткой.", "items": { "type": "object", "required": [ "value", "label" ], "properties": { "value": { "$ref": "#/components/schemas/WebhookEvent" }, "label": { "type": "string", "description": "Отображаемая метка, например `Session status updated`." } } } }, "allowed_return_hosts": { "type": "array", "maxItems": 20, "description": "Имена хостов (точное совпадение, только HTTPS), на которые автономная верификация кошелька Digital ID может вернуть пользователя через `return_url`. Ваш White label домен также всегда разрешён. См. [Зарегистрируйте адрес назначения для возврата](https://docs.didit.me/ru/standalone-apis/digital-id-wallets#регистрация-адреса-возврата).", "items": { "type": "string", "maxLength": 253 } }, "endpoints": { "type": "array", "description": "Каждый адрес назначения webhook приложения, начиная с самых старых, каждый со своим секретом подписи. Здесь доступен только просмотр: управляйте адресами назначения с помощью endpoint `/v3/webhook/destinations/`.", "items": { "$ref": "#/components/schemas/WebhookConfigDestination" } }, "allowed_domains": { "type": "array", "maxItems": 50, "items": { "type": "string", "maxLength": 300 }, "description": "Источники (origins, например `https://app.example.com`; `http` разрешен только для `localhost`), в которые может быть встроен размещенный сценарий верификации и куда пользователь может быть перенаправлен с помощью обратного вызова сессии. На вызовы между серверами ограничение не распространяется. Пустой список означает отсутствие ограничений. Didit сохраняет каждый origin в нижнем регистре без порта по умолчанию. Недопустимая запись приводит к ошибке `400` в `allowed_domains`.", "example": [ "https://app.example.com" ] } } }, "WebhookDestinationDelivery": { "type": "object", "description": "Одна попытка доставки на адрес назначения webhook. Первая отправка события, каждая автоматическая повторная попытка и каждая повторная отправка считаются отдельными доставками.", "required": [ "uuid", "session_id", "request_url", "response_status", "response_time_ms", "status", "webhook_type", "created_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "ID доставки для запросов сведений и повторной отправки." }, "session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Сессия проверки пользователей, к которой относится событие. `null` для событий бизнес-сессий, пользователей, компаний, транзакций, Travel Rule и сценариев." }, "request_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL, на который была отправлена доставка: URL адреса назначения на момент генерации события." }, "response_status": { "type": "integer", "nullable": true, "description": "HTTP-статус, возвращённый вашим endpoint. `null`, пока доставка находится в очереди и попытка ещё не совершена. Если HTTP-ответ не был получен, Didit фиксирует собственный статус: `504`, если ваш endpoint не ответил в течение 5 секунд, `503` при ошибке подключения, `400`, если URL был отклонён как небезопасный (например, приватный или внутренний адрес), и `404` при любой другой ошибке запроса. Статус `400` или выше считается неудачной доставкой." }, "response_time_ms": { "type": "integer", "nullable": true, "minimum": 0, "description": "Время, затраченное на попытку, в миллисекундах. `null`, пока доставка находится в очереди." }, "status": { "type": "string", "nullable": true, "description": "Статус, о котором сообщило событие при создании: статус сессии для событий сессии (например, `Approved` или `In Review`), статус физического лица или компании для событий пользователей и компаний, а также статус транзакции для событий транзакций. Значение `null` для событий без статуса." }, "webhook_type": { "$ref": "#/components/schemas/WebhookEvent" }, "created_at": { "type": "string", "format": "date-time", "description": "Когда была создана доставка." } } }, "WebhookDestinationDeliveryDetail": { "type": "object", "description": "Одна попытка доставки на адрес назначения webhook с точными заголовками и телом запроса, отправленными Didit.", "required": [ "uuid", "session_id", "request_url", "response_status", "response_time_ms", "status", "webhook_type", "created_at", "request_header", "request_body" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "ID доставки для запросов сведений и повторной отправки." }, "session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Сессия проверки пользователей, к которой относится событие. `null` для событий бизнес-сессий, пользователей, компаний, транзакций, Travel Rule и сценариев." }, "request_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL, на который была отправлена доставка: URL адреса назначения на момент генерации события." }, "response_status": { "type": "integer", "nullable": true, "description": "HTTP-статус, возвращённый вашим endpoint. `null`, пока доставка находится в очереди и попытка ещё не совершена. Если HTTP-ответ не был получен, Didit фиксирует собственный статус: `504`, если ваш endpoint не ответил в течение 5 секунд, `503` при ошибке подключения, `400`, если URL был отклонён как небезопасный (например, приватный или внутренний адрес), и `404` при любой другой ошибке запроса. Статус `400` или выше считается неудачной доставкой." }, "response_time_ms": { "type": "integer", "nullable": true, "minimum": 0, "description": "Время, затраченное на попытку, в миллисекундах. `null`, пока доставка находится в очереди." }, "status": { "type": "string", "nullable": true, "description": "Статус, о котором сообщило событие при создании: статус сессии для событий сессии (например, `Approved` или `In Review`), статус физического лица или компании для событий пользователей и компаний, а также статус транзакции для событий транзакций. Значение `null` для событий без статуса." }, "webhook_type": { "$ref": "#/components/schemas/WebhookEvent" }, "created_at": { "type": "string", "format": "date-time", "description": "Когда была создана доставка." }, "request_header": { "type": "string", "description": "JSON-текст (строка) заголовков запроса, отправленных Didit: `Content-Type`, `X-Signature`, `X-Signature-V2`, `X-Signature-Simple`, `X-Timestamp` и `User-Agent`. Разберите его с помощью JSON-парсера. Он содержит подписи и никогда не содержит секрет подписи." }, "request_body": { "type": "string", "description": "JSON-текст (строка) точного payload, отправленного Didit, с отсортированными ключами, включая `event_id` и `timestamp`. Разберите его с помощью JSON-парсера; см. [Формат payload](https://docs.didit.me/ru/integration/webhooks#структура-payload). Для ключа с ограниченной областью действия без `media: read` URL-адреса медиафайлов внутри него имеют значение `null`; без `sessions: write` токены сессий и ссылки на размещённую страницу верификации имеют значение `null`. После такого изменения тела подписи больше ему не соответствуют. Didit не сохраняет тело ответа, возвращённое вашим endpoint." } } }, "SessionWebhookDelivery": { "type": "object", "description": "Одна попытка доставки webhook, зафиксированная для сессии верификации, с точными заголовками и телом запроса, отправленными Didit.", "required": [ "uuid", "session_id", "request_url", "response_status", "status", "webhook_type", "request_header", "request_body", "created_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "ID доставки. Используйте его в качестве `{webhook_uuid}`, чтобы получить или повторно отправить эту доставку." }, "session_id": { "type": "string", "format": "uuid", "description": "Сессия, к которой относится доставка (сессия в пути URL)." }, "request_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL, на который была отправлена доставка." }, "response_status": { "type": "integer", "nullable": true, "description": "HTTP-статус, возвращённый вашим endpoint. `null`, пока доставка находится в очереди и попытка ещё не совершена. Если HTTP-ответ не был получен, Didit фиксирует собственный статус: `504`, если ваш endpoint не ответил в течение 5 секунд, `503` при ошибке подключения, `400`, если URL был отклонён как небезопасный (например, приватный или внутренний адрес), и `404` при любой другой ошибке запроса. Статус `400` или выше считается неудачной доставкой." }, "status": { "type": "string", "nullable": true, "description": "Статус сессии на момент генерации события, например `In Progress`, `Approved` или `Declined`." }, "webhook_type": { "$ref": "#/components/schemas/WebhookEvent" }, "request_header": { "type": "string", "description": "JSON-текст (строка) заголовков запроса, отправленных Didit: `Content-Type`, `X-Signature`, `X-Signature-V2`, `X-Signature-Simple`, `X-Timestamp` и `User-Agent`. Разберите его с помощью JSON-парсера. Он содержит подписи и никогда не содержит секрет подписи." }, "request_body": { "type": "string", "description": "JSON-текст (строка) точного payload, отправленного Didit, с отсортированными ключами, включая `event_id` и `timestamp`. Разберите его с помощью JSON-парсера; см. [Формат payload](https://docs.didit.me/ru/integration/webhooks#структура-payload). Для ключа с ограниченной областью действия без `media: read` URL-адреса медиафайлов внутри него имеют значение `null`; без `sessions: write` токены сессий и ссылки на размещённую страницу верификации имеют значение `null`. После такого изменения тела подписи больше ему не соответствуют. Didit не сохраняет тело ответа, возвращённое вашим endpoint." }, "created_at": { "type": "string", "format": "date-time", "description": "Когда была создана доставка." } } }, "SessionEvent": { "type": "object", "description": "Одна запись в хронологии событий сессии верификации.", "required": [ "uuid", "event_type", "created_at", "component", "feature_step", "step", "details", "ip_address", "user_agent", "device_info", "file_url", "sent_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Идентификатор события." }, "event_type": { "type": "string", "enum": [ "SESSION_CREATED", "SESSION_COMPLETED", "SESSION_STATUS_CHANGED", "LINK_OPENED", "FORM_SUBMITTED", "BUTTON_CLICKED", "FILE_UPLOADED", "ATTEMPT_FAILED", "FEATURE_STEP_CHANGED", "STEP_RENDERED", "NOTE_ADDED", "MANUAL_REVIEW_STARTED", "WORKFLOW_BRANCH_EVALUATED", "WORKFLOW_STATUS_NODE_REACHED", "LOG" ], "description": "Что произошло. Передаётся устройством в размещённом сценарии или в SDK: `LINK_OPENED`, `STEP_RENDERED`, `BUTTON_CLICKED`, `FORM_SUBMITTED`, `FILE_UPLOADED`, `ATTEMPT_FAILED` и `LOG` (отладка). Фиксируется сервером: `SESSION_CREATED`, `SESSION_STATUS_CHANGED` (`details.old_status`, `details.current_status`), `FEATURE_STEP_CHANGED` (`details.old_feature_step`, `details.current_feature_step`), `WORKFLOW_BRANCH_EVALUATED` и `WORKFLOW_STATUS_NODE_REACHED` (трассировка маршрутизации сценария). В более старых сессиях могут встречаться `SESSION_COMPLETED`, `NOTE_ADDED` и `MANUAL_REVIEW_STARTED`." }, "created_at": { "type": "string", "format": "date-time", "description": "Когда Didit сохранил событие. События сохраняются асинхронно, через несколько секунд после `sent_at`." }, "component": { "type": "string", "nullable": true, "description": "UI-компонент, сообщивший о событии (только события устройства)." }, "feature_step": { "type": "string", "nullable": true, "enum": [ "OCR", "OCR_BACK", "NFC", "AML", "FACE", "LIVENESS", "FACE_MATCH", "IP_ANALYSIS", "AGE_ESTIMATION", "PROOF_OF_ADDRESS", "PHONE_VERIFICATION", "EMAIL_VERIFICATION", "FACE_SEARCH", "DATABASE_VALIDATION", "QUESTIONNAIRE", "KYB_REGISTRY", "KYB_DOCUMENTS", "KYB_KEY_PEOPLE", "DOCUMENT_AI", "GEOLOCATION", null ], "description": "Функция верификации, на которой находилась сессия в момент наступления события." }, "step": { "type": "string", "nullable": true, "description": "Экран внутри функции, например `DOCUMENT_CAPTURE_FRONT` или `FACE_PASSIVE_LIVENESS`." }, "details": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Данные, специфичные для события. Ключи зависят от `event_type`." }, "ip_address": { "type": "string", "nullable": true, "description": "IP-адрес, с которого устройство зафиксировало событие. `null` для событий, зарегистрированных на сервере." }, "user_agent": { "type": "string", "nullable": true, "description": "User-Agent устройства. `null` для событий, зафиксированных сервером." }, "device_info": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Сведения об устройстве, переданные SDK или браузером." }, "file_url": { "type": "string", "format": "uri", "nullable": true, "description": "Временная предварительно подписанная ссылка на файл, прикреплённый к событию (например, захваченное изображение). `null`, если файл отсутствует, и всегда `null` для API-ключа с ограниченной областью действия без права `media: read`." }, "sent_at": { "type": "integer", "format": "int64", "description": "Когда событие произошло, в виде Unix timestamp в миллисекундах. Результаты упорядочены по этому значению." } } }, "AMLDatasetSourceFreshness": { "type": "object", "description": "Актуальность одного семейства наборов данных AML.", "required": [ "last_updated_at", "oldest_updated_at", "dataset_count", "dated_dataset_count" ], "properties": { "last_updated_at": { "type": "string", "format": "date-time", "description": "Самое последнее обновление любого набора данных в семействе." }, "oldest_updated_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Граница актуальности: каждый набор данных в семействе актуален как минимум на этот момент. `null`, если хотя бы один набор данных в семействе не сообщил дату обновления, так как в этом случае граница неизвестна." }, "dataset_count": { "type": "integer", "description": "Количество наборов данных в семействе." }, "dated_dataset_count": { "type": "integer", "description": "Количество тех наборов данных, которые сообщили дату обновления." } } }, "AMLDatasetFreshness": { "type": "object", "description": "Насколько актуальными были наборы данных AML на момент проведения скрининга. Даты никогда не являются приблизительными.", "required": [ "captured_at", "provider", "catalog_version", "sources" ], "properties": { "captured_at": { "type": "string", "format": "date-time", "description": "Когда Didit прочитал каталог наборов данных, на основе которого определяется эта свежесть." }, "provider": { "type": "string", "description": "Непрозрачный идентификатор источника данных AML. Обрабатывайте его как непрозрачную строку; не создавайте ветвление логики на его основе.", "example": "aml_data_source" }, "catalog_version": { "type": "string", "nullable": true, "description": "Идентификатор версии каталога наборов данных, если источник его сообщает." }, "sources": { "type": "object", "description": "Актуальность по семействам наборов данных. Семейство, чьи наборы данных не сообщили дату обновления, отсутствует в ответе, а не заполняется значением `null`.", "properties": { "sanctions": { "$ref": "#/components/schemas/AMLDatasetSourceFreshness" }, "pep": { "$ref": "#/components/schemas/AMLDatasetSourceFreshness" }, "warnings": { "$ref": "#/components/schemas/AMLDatasetSourceFreshness" }, "adverse_media": { "$ref": "#/components/schemas/AMLDatasetSourceFreshness" } } } } }, "AMLScreeningRun": { "type": "object", "description": "Один завершённый повторный AML-скрининг в рамках постоянного мониторинга.", "required": [ "uuid", "run_id", "completed_at", "started_at", "outcome", "trigger", "provider", "status", "score", "total_hits", "new_hits", "entities_screened", "dataset_freshness" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Идентификатор этого запуска скрининга." }, "run_id": { "type": "string", "format": "uuid", "description": "Запуск мониторинга, к которому относится этот скрининг. Он является общим для всех верификаций, проверенных в рамках одного запуска." }, "completed_at": { "type": "string", "format": "date-time", "description": "Когда завершился повторный скрининг этого субъекта. Результаты отсортированы по этому времени: сначала новые." }, "started_at": { "type": "string", "format": "date-time", "description": "Время запуска пакета мониторинга, к которому относится этот повторный скрининг." }, "outcome": { "type": "string", "enum": [ "NO_CHANGE", "CHANGED", "FAILED" ], "description": "`NO_CHANGE`: завершено, результат не изменился. `CHANGED`: завершено, изменились оценка, статус, количество совпадений или сами совпадения. `FAILED`: пригодный ответ по данному субъекту отсутствует, поэтому проверка осталась без изменений." }, "trigger": { "type": "string", "enum": [ "ONGOING_MONITORING" ], "description": "Что инициировало скрининг. На данный момент всегда `ONGOING_MONITORING`." }, "provider": { "type": "string", "description": "Непрозрачный идентификатор ответившего источника данных AML. Обрабатывайте его как непрозрачную строку; не создавайте ветвление логики на его основе.", "example": "aml_data_source" }, "status": { "type": "string", "nullable": true, "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested", null ], "description": "Статус AML-проверки, в котором проверка осталась после этого запуска." }, "score": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "AML-оценка, в которой проверка осталась после этого запуска." }, "total_hits": { "type": "integer", "nullable": true, "description": "Количество совпадений, с которым проверка осталась после этого запуска." }, "new_hits": { "type": "integer", "nullable": true, "description": "Количество совпадений, найденных в этом запуске, которых не было в проверке ранее. `0`, если ничего нового не найдено; `null`, если запуск завершился сбоем или был зафиксирован до появления этого счётчика." }, "entities_screened": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Количество сущностей, проверенных в этом запуске для верификации: `1`, если субъект был проверен, `0`, если запуск завершился сбоем." }, "dataset_freshness": { "allOf": [ { "$ref": "#/components/schemas/AMLDatasetFreshness" } ], "nullable": true, "description": "Свежесть набора данных на момент этого запуска или `null`, если даты были недоступны." } } }, "KYBKeyPeopleParty": { "type": "object", "description": "Сторона из числа ключевых лиц сессии Верификации бизнеса (KYB) с её дочерней верификацией. Та же сторона отображается в `key_people_checks[].submitted.parties[]` решения по сессии компании.", "required": [ "uuid", "entity_type", "source", "name", "is_active", "is_skipped", "requires_verification", "roles", "kyc_session_deleted", "kyb_sub_session_deleted" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Идентификатор стороны." }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Является ли сторона физическим лицом или компанией." }, "source": { "type": "string", "enum": [ "REGISTRY", "USER" ], "description": "`REGISTRY`: получено из реестра компаний. `USER`: введено на экране «Ключевые лица»." }, "name": { "type": "string", "description": "Отображаемое имя стороны." }, "first_name": { "type": "string", "nullable": true, "description": "Имя (физические лица)." }, "last_name": { "type": "string", "nullable": true, "description": "Фамилия (физические лица)." }, "company_name": { "type": "string", "nullable": true, "description": "Название компании (стороны-компании)." }, "registration_number": { "type": "string", "nullable": true, "description": "Регистрационный номер компании (стороны-компании)." }, "email": { "type": "string", "format": "email", "nullable": true, "description": "Адрес электронной почты, на который отправляется ссылка на верификацию." }, "nationality": { "type": "string", "nullable": true, "description": "Гражданство для физических лиц, страна регистрации для компаний." }, "phone_number": { "type": "string", "nullable": true, "description": "Номер телефона, полученный для стороны." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Дата рождения (физические лица)." }, "position": { "type": "string", "nullable": true, "description": "Название должности в виде произвольного текста (физические лица)." }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Пользовательские поля, определённые сценарием и собранные для стороны, с ключами, соответствующими ключам полей." }, "is_active": { "type": "boolean", "description": "Является ли сторона активной." }, "is_skipped": { "type": "boolean", "description": "Освобождена ли сторона от верификации. Повторная генерация сбрасывает это значение." }, "requires_verification": { "type": "boolean", "description": "Требуют ли правила, касающиеся роли и структуры владения, проведения верификации для этой стороны." }, "roles": { "type": "array", "description": "Роли, которые сторона занимает в компании.", "items": { "type": "object", "required": [ "role", "ownership_percent", "voting_percent" ], "properties": { "role": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ], "description": "Код роли." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Процент владения для этой роли, если известен." }, "voting_percent": { "type": "number", "nullable": true, "description": "Доля прав голоса для этой роли в процентах, если известна." } } } }, "kyc_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Дочерняя индивидуальная сессия KYC (физические лица)." }, "kyc_session_status": { "type": "string", "nullable": true, "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User", null ], "description": "Статус дочерней KYC-сессии. Удалённая сессия сохраняет статус, который у неё был на момент удаления." }, "kyc_session_url": { "type": "string", "format": "uri", "nullable": true, "description": "Размещённая ссылка дочерней сессии KYC. `null`, если ссылка отсутствует или была удалена, а также для ограниченного API-ключа без права `sessions: write`." }, "kyc_session_deleted": { "type": "boolean", "description": "Дочерняя сессия KYC была удалена, поэтому она никогда не сможет завершиться." }, "kyb_sub_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Дочерняя сессия KYB (стороны, являющиеся компаниями)." }, "kyb_sub_session_status": { "type": "string", "nullable": true, "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User", null ], "description": "Статус дочерней KYB-сессии." }, "kyb_sub_session_url": { "type": "string", "format": "uri", "nullable": true, "description": "Размещённая ссылка дочерней сессии KYB с теми же правилами для `null`, что и у `kyc_session_url`." }, "kyb_sub_session_deleted": { "type": "boolean", "description": "Аналог `kyc_session_deleted` для компаний." }, "verification_workflow_type": { "type": "string", "nullable": true, "enum": [ "kyc", "kyb", "adaptive_age_verification", "biometric_authentication", "address_verification", "questionnaire_verification", "email_verification", "phone_verification", null ], "description": "Тип сценария, который запускает дочерняя сессия." }, "verification_workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Сценарий, который выполняет дочерняя сессия." }, "verification_workflow_label": { "type": "string", "nullable": true, "description": "Метка этого сценария." }, "verification_workflow_features": { "type": "array", "nullable": true, "description": "Функции сценария дочерней сессии с их текущим статусом.", "items": { "type": "object", "required": [ "feature", "status" ], "properties": { "feature": { "type": "string", "description": "Код функции, например `ID_VERIFICATION` или `LIVENESS`." }, "status": { "type": "string", "description": "Статус функции, `Not Finished` до ее выполнения." } } } }, "didit_internal_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Идентификатор верифицированного лица в Didit, когда он известен." } } }, "TravelRuleDelivery": { "type": "object", "description": "Текущий статус последнего сообщения, которое перевод должен отправить другой стороне. Didit связывается с контрагентом после возврата ответа на запрос, создавший или изменивший перевод, поэтому данный объект показывает, было ли доставлено это сообщение: в очереди, отправляется, ожидает повторной попытки после ошибки, доставлено или произошел сбой. В случае сбоя, после которого сеть еще может восстановиться (нет ответа вовремя, ошибка соединения, HTTP `408`, `429` или `5xx`), повторная попытка выполняется через 30 секунд, 2 минуты, 10 минут, 30 минут и 1 час. Если первое сообщение (`kind: SEND`) окончательно завершается сбоем из-за отказа сети или неудачи шестой попытки, перевод переходит в статус `COUNTERPARTY_VASP_NOT_REACHABLE` с полем `last_error` в истории `timeline`; любое другое сообщение, окончательно завершившееся ошибкой, фиксируется в `timeline`. Поле `status` перевода остается первоисточником истины для самого обмена.", "required": [ "kind", "status", "rail", "attempts", "last_error", "next_attempt_at", "delivered_at" ], "properties": { "kind": { "type": "string", "enum": [ "SEND", "ANSWER", "TXID", "CANCEL", "POLL" ], "description": "Что содержит сообщение. `SEND`: первое сообщение перевода контрагенту (исходящее; канал передачи выбирается при отправке). `ANSWER`: ваше согласие или отклонение, направляемое запросившей сети (входящее). `TXID`: хеш ончейн-транзакции после завершения перевода. `CANCEL`: отмена после того, как вы отменили перевод. `POLL`: запрос статуса к сети, поддерживающей такую возможность, повторяемый каждые 5 минут, пока перевод ожидает ответа от контрагента." }, "status": { "type": "string", "enum": [ "QUEUED", "SENDING", "RETRYING", "DELIVERED", "FAILED" ], "description": "`QUEUED`: ожидает отправки. `SENDING`: выполняется попытка. `RETRYING`: попытка завершилась неудачей, следующая запустится в `next_attempt_at`. `DELIVERED`: принимающая сторона приняла сообщение. `FAILED`: принимающая сторона отклонила его или последняя попытка завершилась неудачей." }, "rail": { "type": "string", "enum": [ "INTERNAL", "TRP", "GTR", "TRUST", "VERIFYVASP", "SYGNA", "EMAIL", "" ], "description": "Транспортная сеть (rail), передающая сообщение. Пусто до тех пор, пока Didit не выберет её для первого сообщения." }, "attempts": { "type": "integer", "minimum": 0, "description": "Количество попыток, сделанных для этого сообщения на данный момент. Для сообщения, не являющегося опросом статуса, выполняется не более 6 попыток." }, "last_error": { "type": "string", "description": "Тип сбоя, возникшего при последней попытке, либо `\"\"`, если сбоев не было: например `email undeliverable`, `trp identity endpoint unreachable` или `trp transfer inquiry delivery failed`. Он никогда не содержит собственный ответ контрагента, который сохраняется в `timeline` перевода.\nКогда GTR возвращает ошибку, включаются собственный код состояния и сообщение. Тела ответов никогда не включаются.", "example": "email undeliverable" }, "next_attempt_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Время следующей попытки, пока сообщение находится в статусе `QUEUED` или `RETRYING`." }, "delivered_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Время получения сообщения другой стороной." } } }, "TravelRuleDiscoveryStep": { "type": "object", "description": "Один шаг поиска контрагента, выполненный Didit для исходящего перевода, в порядке их выполнения. Первый шаг, определяющий VASP с доступным маршрутом, завершает цепочку.", "properties": { "step": { "type": "string", "enum": [ "internal_address_book", "wallet_attribution", "network_lookup", "customer_hint", "end_user" ], "description": "`internal_address_book`: другой клиент Didit, подтвердивший контроль над кошельком назначения. `wallet_attribution`: атрибуция блокчейн-аналитики кошелька. `network_lookup`: сеть, способная определить, какой VASP управляет адресом. `customer_hint`: имя VASP, LEI или юрисдикция, переданные вами в `beneficiary_data`. `end_user`: контрагент, выбранный конечным пользователем (или вами), либо запрос на его выбор." }, "outcome": { "type": "string", "enum": [ "match", "miss", "skipped" ], "description": "`match`: шаг определил контрагента. `miss`: шаг был выполнен, но совпадений не найдено. `skipped`: шаг не удалось выполнить, причина указана в `reason`." }, "reason": { "type": "string", "description": "Машиночитаемая причина, `\"\"` при совпадении: `no_proven_internal_wallet`, `attribution_disabled`, `already_attributed`, `no_attributed_entity`, `directory_match_no_route`, `gtr_address_lookup_runs_on_dispatch`, `no_membership`, `network_switched_off`, `no_network_address_lookup`, `no_directory_match`, `awaiting_end_user` или `picked_member_without_proven_wallet`." }, "vasp": { "type": "string", "format": "uuid", "nullable": true, "description": "VASP из каталога, указанный на данном шаге, если он был указан." }, "rail": { "type": "string", "nullable": true, "description": "Транспортная сеть (rail), через которую достигается этот контрагент, если шаг её обнаружил." }, "at": { "type": "string", "format": "date-time" } } }, "TravelRuleNextAction": { "type": "object", "description": "Одно действие, которое позволяет продвинуть перевод со статусом `COUNTERPARTY_VASP_NOT_FOUND` или `COUNTERPARTY_VASP_NOT_REACHABLE`. См. раздел [Почему перевод завис](/ru/transaction-monitoring/travel-rule#почему-перевод-застрял).", "properties": { "action": { "type": "string", "enum": [ "select_counterparty_vasp", "declare_self_hosted", "add_vasp_hint", "update_compliance_email", "resend" ], "description": "`select_counterparty_vasp`: конечный пользователь выбирает VASP назначения в виджете владения кошельком, либо вы отправляете PATCH с `action=beneficiary_vasp`. `declare_self_hosted`: конечный пользователь объявляет кошелёк некастодиальным в виджете. `add_vasp_hint`: укажите Didit, кто является контрагентом, с помощью названия VASP, LEI или Travel Address (например, `travel_address` в записи адресной книги кошелька назначения), затем повторите отправку. `update_compliance_email` и `resend` являются значениями `action` для `PATCH /v3/transactions/{transaction_id}/travel-rule/`: передайте адрес электронной почты комплаенс-службы контрагента повторно и перезапустите маршрутизацию." }, "url": { "type": "string", "format": "uri", "description": "Ссылка на виджет подтверждения владения кошельком, при `select_counterparty_vasp` и `declare_self_hosted`, пока у перевода есть открытая сессия виджета." } }, "required": [ "action" ] }, "TransactionTravelRule": { "type": "object", "description": "Перевод Travel Rule для транзакции в том виде, в котором его возвращают `GET /v3/transactions/{transaction_id}/`, ответ `201` метода `POST /v3/transactions/` и каждая строка `GET /v3/transactions/`. Поля `direction`, `rail`, `counterparty_vasp`, `delivery`, `discovery`, `reason` и `next_actions` имеют ту же структуру, что и в `PATCH /v3/transactions/{transaction_id}/travel-rule/`, поэтому одно чтение транзакции объясняет, почему перевод заблокирован и что необходимо сделать для его продвижения.", "properties": { "uuid": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "protocol": { "type": "string", "nullable": true }, "required": { "type": "boolean" }, "obligations_count": { "type": "integer" }, "originator_data": { "type": "object", "description": "Сторона-отправитель. Для входящего перевода значения контрагента маскируются до тех пор, пока владение не будет подтверждено." }, "beneficiary_data": { "type": "object", "description": "Сторона-получатель. Для входящего перевода значения контрагента маскируются до подтверждения владения." }, "name_match": { "type": "object", "nullable": true, "description": "Сравнение имен, на основе которого было принято решение по переводу (оценка и строгость). Null до выполнения проверки. Сравниваемые имена маскируются вместе со сторонами." }, "data_match": { "$ref": "#/components/schemas/TravelRuleDataMatch" }, "mismatched_fields": { "type": "array", "items": { "type": "string" }, "description": "Сокращение для `data_match.mismatched_fields`. Пусто, если различий нет." }, "data_unmasked": { "$ref": "#/components/schemas/TravelRuleDataUnmasked" }, "data_masked": { "type": "boolean", "description": "Имеет значение true, пока персональные данные контрагента маскируются в этом ответе." }, "metadata": { "type": "object" }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Какой стороной обмена является данный перевод." }, "rail": { "type": "string", "nullable": true, "description": "Транспортная сеть (rail), через которую прошёл перевод: `INTERNAL`, `TRP`, `GTR`, `TRUST`, `VERIFYVASP`, `SYGNA` или `EMAIL` (`TEST_VASP` в приложении в песочнице, когда ответил Didit Test VASP), либо `null` до выбора сети." }, "counterparty_vasp": { "type": "object", "nullable": true, "properties": { "name": { "type": "string" }, "lei": { "type": "string" }, "dd_score": { "type": "integer", "description": "Оценка дью-дилидженс от 0 до 100, где большее значение лучше. Та же шкала, что и в каталоге VASP." }, "dd_score_breakdown": { "type": "object", "description": "Вклад каждого компонента в dd_score: один объект на компонент в соответствии со справочником VASP (jurisdiction, verification, protocol, lei, history, essentials, responsiveness), каждый со структурой {points, max, reason, detail}. Пустой объект {}, пока контрагент не был оценён.", "additionalProperties": { "type": "object", "properties": { "points": { "type": "number", "description": "Баллы, начисленные за этот компонент." }, "max": { "type": "integer", "description": "Максимальное количество баллов, которое может начислить этот компонент." }, "reason": { "type": "string", "description": "Машиночитаемый код вердикта компонента." }, "detail": { "type": "string", "description": "Понятная человеку причина начисления баллов." } } } }, "dd_assessed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда в последний раз проводилась оценка в рамках комплексной проверки. Null, пока контрагент не был оценён." } }, "description": "Запись контрагента в каталоге или `null`, если перевод не привязан ни к одной." }, "delivery": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/TravelRuleDelivery" } ], "description": "Последнее сообщение, которое перевод должен отправить другой стороне. `null`, если отправка не требовалась, например ниже `threshold_amount` или для заявленного некастодиального кошелька." }, "discovery": { "type": "array", "description": "Как Didit выполнял поиск контрагента: по одной записи на каждый выполненный шаг. Пусто, если поиск не выполнялся, например для входящего перевода.", "items": { "$ref": "#/components/schemas/TravelRuleDiscoveryStep" } }, "reason": { "type": "string", "description": "Причина, по которой перевод со статусом `COUNTERPARTY_VASP_NOT_FOUND` или `COUNTERPARTY_VASP_NOT_REACHABLE` приостановлен; `\"\"` для любого другого статуса. Неудачная доставка определяет её в первую очередь и только при `COUNTERPARTY_VASP_NOT_REACHABLE`: `email_undeliverable` (почтовый провайдер отклонил комплаенс-письмо, и адресов для повторной попытки не осталось: при отправке, при напоминании или в виде постоянного сбоя доставки, о котором сообщено позже) или `delivery_failed` (канал доставки окончательно вышел из строя: сетевой канал отклонил сообщение или исчерпал лимит повторных попыток, хост идентификации `TRP` не ответил либо `TRP`-хост контрагента не принял запрос). В противном случае её определяет трассировка `discovery`: `awaiting_end_user` (ни на одном шаге не указан контрагент, с которым Didit может связаться), `directory_match_no_route` (на шаге указан VASP из каталога, у которого нет маршрута), `picked_member_without_proven_wallet` (конечный пользователь выбрал клиента Didit, который не подтвердил контроль над кошельком) или `no_directory_match`, если трассировка не возвращает иной причины. Повторная отправка продвигает перевод дальше, поэтому причина сбрасывается. См. [Почему перевод приостановлен](/ru/transaction-monitoring/travel-rule#почему-перевод-застрял)." }, "next_actions": { "type": "array", "description": "Действия, продвигающие перевод дальше; `[]` для любого статуса, кроме `COUNTERPARTY_VASP_NOT_FOUND` или `COUNTERPARTY_VASP_NOT_REACHABLE`. `email_undeliverable` предлагает `update_compliance_email`, затем `resend`. `delivery_failed` предлагает `resend`. Причина типа discovery предлагает `select_counterparty_vasp`, `declare_self_hosted`, `add_vasp_hint` и `resend`.", "items": { "$ref": "#/components/schemas/TravelRuleNextAction" } }, "chain_details": { "$ref": "#/components/schemas/TravelRuleChainDetails" } } }, "NetworkListCounts": { "type": "object", "description": "Количество сетей для представлений списка и параметров фильтрации; каждая сеть учитывается один раз. Возвращается, только если `summary` не равно `false`. `scopes` подсчитывает все сети, видимые приложению. `views` подсчитывает видимые сети внутри выбранного `scope`. `facets` подсчитывает сети в выбранном `scope` и представлении `status` (отклонённые сети исключаются, если `status` не включает их). Другие фильтры списка не влияют на эти подсчёты.", "properties": { "scopes": { "type": "object", "description": "Видимые сети по продуктам.", "properties": { "all": { "type": "integer" }, "identity": { "type": "integer", "description": "Каждая другая сеть." }, "transactions": { "type": "integer", "description": "Сети, все участники которых являются сторонами транзакции." } } }, "views": { "type": "object", "description": "Видимые сети внутри выбранного `scope` по статусу, плюс два сохранённых представления.", "properties": { "all": { "type": "integer" }, "active": { "type": "integer" }, "in_review": { "type": "integer" }, "resolved": { "type": "integer" }, "dismissed": { "type": "integer" }, "mine": { "type": "integer", "description": "Сети, назначенные вызывающему участнику консоли. Всегда 0 для API-ключа." }, "high_risk": { "type": "integer", "description": "Сети с оценкой риска 80 или выше, которые не были отклонены." } } }, "facets": { "type": "object", "description": "Количество для каждого варианта фильтра в рамках выбранного `scope` и представления статусов.", "properties": { "total": { "type": "integer", "description": "Сети в выбранном `scope` и представлении статуса." }, "last_activity_days": { "type": "object", "description": "Сети с активностью за последние 7, 30 и 90 дней, с ключом по количеству дней.", "properties": { "7": { "type": "integer" }, "30": { "type": "integer" }, "90": { "type": "integer" } } }, "risk_min": { "type": "object", "description": "Сети с оценкой риска не менее 50 и не менее 80, с ключом по порогу.", "properties": { "50": { "type": "integer" }, "80": { "type": "integer" } } }, "signal_types": { "type": "object", "description": "Сети как минимум с одним сигналом каждого типа.", "properties": { "ip_address": { "type": "integer" }, "device": { "type": "integer" }, "face": { "type": "integer" }, "document_number": { "type": "integer" }, "phone": { "type": "integer" }, "email": { "type": "integer" }, "address": { "type": "integer" } } }, "priority": { "type": "object", "description": "Сети по приоритету. `none` подсчитывает сети без приоритета.", "properties": { "low": { "type": "integer" }, "medium": { "type": "integer" }, "high": { "type": "integer" }, "none": { "type": "integer" } } }, "assignee": { "type": "object", "description": "Сети по назначенным исполнителям.", "properties": { "me": { "type": "integer", "description": "Назначено вызвавшему участнику консоли. Всегда 0 для API-ключа." }, "unassigned": { "type": "integer", "description": "Никому не назначен." }, "users": { "type": "array", "description": "Одна запись на каждого назначенного ответственного, сначала с наибольшим количеством сетей.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "full_name": { "type": "string", "description": "Имя назначенного исполнителя или адрес его электронной почты, если имя не указано." }, "email": { "type": "string" }, "count": { "type": "integer" } } } } } }, "has_case": { "type": "integer", "description": "Сети, по которым это приложение открыло кейс." }, "min_size": { "type": "object", "description": "Сети как минимум с 10 участниками, с ключом по минимальному размеру.", "properties": { "10": { "type": "integer" } } } } } } }, "NetworkTag": { "type": "object", "description": "Один из тегов вашего приложения в сети.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID тега, то же значение, что передается в `tag_uuid`." }, "name": { "type": "string" }, "color": { "type": "string", "description": "Шестнадцатеричный цвет (hex), например `#6366F1`." }, "source": { "type": "string", "enum": [ "didit", "custom" ], "description": "`didit` для предустановленного тега Didit, `custom` для тега, созданного вашей командой." }, "added_by": { "type": "string", "nullable": true, "description": "Электронная почта участника консоли, добавившего тег. Null, если он добавлен с помощью API-ключа." }, "added_at": { "type": "string", "format": "date-time" } } }, "NetworkOutcomes": { "type": "object", "description": "Текущее состояние пользователей и компаний в сети. Каждый участник, которого вы можете видеть, учитывается один раз по статусу его последней верификации, по которой было вынесено решение. Стороны транзакции не учитываются.", "properties": { "approved": { "type": "integer", "description": "Участники, чья последняя верификация, по которой принято решение, была одобрена." }, "declined": { "type": "integer", "description": "Участники, чья последняя верификация, по которой принято решение, была отклонена." }, "in_review": { "type": "integer", "description": "Участники, чья последняя верификация, по которой принято решение, находится на проверке." }, "total": { "type": "integer", "description": "Участники хотя бы с одной верификацией, завершённой или нет. Участник, у которого все верификации не завершены решением (не начаты, в процессе, истекли или прерваны), учитывается здесь и ни в каком другом ключе." } } }, "NetworkPatternScore": { "type": "object", "description": "Насколько схож один из типов данных участников во всей сети. Паттерн не является сигналом: участников не связывает общее значение.", "properties": { "type": { "type": "string", "enum": [ "background" ], "description": "`background`: среднее сходство фонов селфи для каждой пары участников (человек маскируется). Учитывается самое свежее селфи каждого человека (не более 50 последних) и исключаются сессии подтверждения возраста. Охватывает всю сеть, а не только участников ваших приложений." }, "score": { "type": "number", "nullable": true, "minimum": 0, "maximum": 1, "description": "От 0 до 1, округлено до 4 знаков после запятой. Null, когда задано поле `reason`." }, "members": { "type": "integer", "nullable": true, "description": "Количество селфи участников, с которыми производилось сравнение. Селфи, которое невозможно прочитать или на котором слишком мало фона, не сравнивается. Равно null во время `computing`; 0 или 1 при `not_enough_selfies`." }, "reason": { "type": "string", "enum": [ "computing", "not_enough_selfies" ], "nullable": true, "description": "Почему оценка отсутствует. `computing`: оценка для текущих участников вычисляется; повторно запросите данные сети позднее. `not_enough_selfies`: менее чем у двух участников есть пригодное селфи. Null, если оценка есть." }, "computed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Время расчёта оценки. Null во время `computing`." } } }, "NetworkDetailResponse": { "description": "Сведения о сети, а также режим обмена данными организации, применяются ли к ней межорганизационные сигналы, теги вашего приложения в сети, результаты участников и оценки паттернов.", "allOf": [ { "$ref": "#/components/schemas/NetworkDetail" }, { "type": "object", "properties": { "sharing_mode": { "type": "string", "enum": [ "off", "private", "global" ], "description": "Режим межорганизационного обмена данными организации. Только `global` сравнивает сети между организациями; `private` и `off` оставляют их только в истории этой организации.", "example": "global" }, "cross_org_available": { "type": "boolean", "description": "Применяются ли сигналы между организациями к этой организации. Для них требуются как тариф Enterprise, так и режим общего доступа `global`.", "example": true }, "cross_org_unavailable_reason": { "type": "string", "enum": [ "plan", "sharing_mode" ], "nullable": true, "description": "Причина, по которой межорганизационные сигналы не применяются; проверяются в следующем порядке. `plan`: тариф организации не включает межорганизационную сеть защиты от мошенничества (требуется тариф Enterprise) независимо от режима обмена данными. `sharing_mode`: тариф включает её, но режим обмена установлен как `private` или `off`. Null, если `cross_org_available` равен `true`.", "example": null }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkTag" }, "description": "Теги вашего приложения в сети, сначала старые. Каждое приложение видит только свои теги. Поле `fraud_tags` существует отдельно и не изменяется: теги, присвоенные участниками сети." }, "outcomes": { "$ref": "#/components/schemas/NetworkOutcomes" }, "patterns": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkPatternScore" }, "description": "Оценки паттернов по всей сети. На данный момент один элемент: `background`." } } } ] }, "NetworkTagRequest": { "type": "object", "required": [ "tag_uuid" ], "properties": { "tag_uuid": { "type": "string", "format": "uuid", "description": "UUID одного из тегов вашего приложения." } }, "example": { "tag_uuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7" } }, "NetworkTimeline": { "title": "Default timeline (no contract)", "type": "object", "description": "Без `contract`: собственные события сети, сначала старые, без пагинации.", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkTimelineEvent" } } } }, "NetworkTimelinePage": { "title": "Typed timeline page (contract=2)", "type": "object", "description": "С `contract=2`: одна страница типизированных событий, сначала новые.", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkTypedTimelineEvent" } }, "next_cursor": { "type": "string", "nullable": true, "description": "Передайте как `cursor` для чтения следующей страницы. Имеет значение null на последней странице." } } }, "NetworkTypedTimelineEvent": { "type": "object", "description": "Одно типизированное событие таймлайна: четыре поля по умолчанию, а также его id, время сохранения в Didit, аккаунт участника и запись, к которым оно относится, и блок деталей его типа события. Остальные блоки деталей равны null.", "properties": { "id": { "type": "string", "description": "`:`, уникальный в пределах хронологии.", "example": "session:3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "event_type": { "type": "string", "enum": [ "network_detected", "signal_observed", "network_active", "network_in_review", "network_resolved", "network_dismissed", "verification_attempt", "transaction", "login", "rule_hit", "case_linked", "note_added" ] }, "occurred_at": { "type": "string", "format": "date-time", "description": "Когда это произошло." }, "ingested_at": { "type": "string", "format": "date-time", "description": "Когда Didit сохранил это." }, "label": { "type": "string", "description": "Короткая метка на английском языке, например `Verification attempt 2 of 3`." }, "metadata": { "type": "object", "description": "Для собственных событий сети используются те же метаданные, что и в таймлайне по умолчанию. В противном случае пусто." }, "account": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineAccount" } ], "nullable": true, "description": "Учётная запись участника. Null для собственных событий сети, `case_linked` и `note_added`." }, "source_ref": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineSourceRef" } ], "nullable": true, "description": "Исходная запись. Null для собственных событий сети и для `note_added`." }, "verification_attempt": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineAttempt" } ], "nullable": true, "description": "Устанавливается для событий `verification_attempt`." }, "transaction": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineTransaction" } ], "nullable": true, "description": "Устанавливается для событий `transaction`." }, "login": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineLogin" } ], "nullable": true, "description": "Устанавливается для событий `login`." }, "rule_hit": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineRuleHit" } ], "nullable": true, "description": "Устанавливается для событий `rule_hit`." }, "case_linked": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineCaseLinked" } ], "nullable": true, "description": "Устанавливается для событий `case_linked`." }, "note_added": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineNoteAdded" } ], "nullable": true, "description": "Устанавливается для событий `note_added`. Никогда не возвращается для API-ключа." } } }, "NetworkTimelineAccount": { "type": "object", "description": "Учётная запись участника, к которой относится событие.", "properties": { "node_id": { "type": "string", "description": "`:`, где kind может быть `vendor_user`, `vendor_business` или `transaction_party`.", "example": "vendor_user:3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "node_type": { "type": "string", "enum": [ "account", "business_account", "transaction_party" ] }, "uuid": { "type": "string", "format": "uuid" }, "vendor_data": { "type": "string", "nullable": true }, "display_name": { "type": "string", "nullable": true }, "ownership": { "type": "string", "enum": [ "owned", "organization" ], "description": "`owned`, когда запись принадлежит приложению, которое вы вызвали (для участника консоли: приложению, к которому ему был предоставлен доступ). `organization`, когда она принадлежит другому приложению вашей организации." }, "route": { "$ref": "#/components/schemas/NetworkTimelineRoute" } } }, "NetworkTimelineSourceRef": { "type": "object", "description": "Запись, из которой было считано событие.", "properties": { "kind": { "type": "string", "enum": [ "session", "business_session", "transaction", "monitoring_event", "case" ] }, "id": { "type": "string", "format": "uuid" }, "ownership": { "type": "string", "enum": [ "owned", "organization" ], "description": "`owned`, когда запись принадлежит приложению, которое вы вызвали (для участника консоли: приложению, к которому ему был предоставлен доступ). `organization`, когда она принадлежит другому приложению вашей организации." }, "route": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineRoute" } ], "description": "Отсутствует для `monitoring_event` и `case`." } } }, "NetworkTimelineRoute": { "type": "object", "description": "Где открывается запись: ее тип, UUID и приложение, которому она принадлежит.", "properties": { "kind": { "type": "string", "description": "`user`, `business` или `transaction_party` для аккаунта; `session`, `business_session` или `transaction` для записи-источника." }, "id": { "type": "string", "format": "uuid" }, "application_id": { "type": "string", "format": "uuid" } } }, "NetworkTimelineAttempt": { "type": "object", "description": "Одна сессия верификации аккаунта.", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "UUID сессии или UUID бизнес-сессии для компании." }, "session_number": { "type": "integer", "nullable": true }, "attempt": { "type": "integer", "description": "Позиция этой сессии среди сессий аккаунта в порядке создания." }, "attempt_count": { "type": "integer", "description": "Сколько сессий у аккаунта." }, "status": { "type": "string", "description": "Статус сессии, например `Approved` или `Declined`." }, "status_changed_at": { "type": "string", "format": "date-time", "nullable": true }, "decline_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkTimelineDeclineReason" }, "description": "Только для отклонённой сессии: её предупреждения, сначала самые старые, по одному на предупреждение. В противном случае пусто." } } }, "NetworkTimelineDeclineReason": { "type": "object", "properties": { "risk": { "type": "string", "description": "Код предупреждения." }, "feature": { "type": "string", "description": "Функция, вызвавшая предупреждение." }, "short_description": { "type": "string" } } }, "NetworkTimelineTransaction": { "type": "object", "description": "Транзакция, в которой участвовал аккаунт участника, датированная датой её совершения.", "properties": { "transaction_id": { "type": "string", "format": "uuid" }, "transaction_number": { "type": "integer", "nullable": true }, "transaction_type": { "type": "string" }, "action_type": { "type": "string" }, "amount": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineAmount" } ], "nullable": true, "description": "Null, когда у транзакции нет суммы." }, "status": { "type": "string" }, "decision_reason_code": { "type": "string", "nullable": true }, "decision_reason_label": { "type": "string", "nullable": true }, "party_role": { "type": "string", "description": "Роль счёта в транзакции: `APPLICANT`, `REMITTER`, `BENEFICIARY` или `COUNTERPARTY`." } } }, "NetworkTimelineAmount": { "type": "object", "properties": { "value": { "type": "string", "description": "Десятичная сумма в виде строки." }, "currency": { "type": "string" }, "direction": { "type": "string", "nullable": true } } }, "NetworkTimelineLogin": { "type": "object", "description": "Событие входа, отправленное вами для лица через API событий.", "properties": { "action": { "type": "string", "description": "`.`: `auth.login` или `security.login_succeeded` для входа, `auth.login_failed` или `security.login_failed` для неудачного." }, "succeeded": { "type": "boolean" }, "status": { "type": "string", "description": "Статус события." }, "ip": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineIP" } ], "nullable": true, "description": "Null, когда у события нет IP-адреса." }, "device": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineDevice" } ], "nullable": true, "description": "Null, когда у события нет цифрового отпечатка устройства или контекста." }, "is_first_login": { "type": "boolean", "description": "Первый зафиксированный успешный вход в учётную запись." }, "is_new_device": { "type": "boolean", "description": "Успешный вход с устройства, с которого ранее не совершалось ни одного успешного входа в этот аккаунт. Никогда не принимает значение true при первом входе." } } }, "NetworkTimelineIP": { "type": "object", "properties": { "address": { "type": "string" }, "country_code": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "connection_type": { "type": "string", "nullable": true, "description": "Метка типа подключения для адреса в виде произвольного текста." }, "is_vpn_or_tor": { "type": "boolean" }, "is_data_center": { "type": "boolean" } } }, "NetworkTimelineDevice": { "type": "object", "properties": { "fingerprint": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true, "description": "Понятная метка устройства, сформированная на основе контекста устройства из события." } } }, "NetworkTimelineRuleHit": { "type": "object", "description": "Правило в продакшне, сработавшее на транзакцию или событие участника. Срабатывания в тестовом режиме не включены.", "properties": { "rule_id": { "type": "string", "format": "uuid" }, "rule_title": { "type": "string" }, "rule_category": { "type": "string" }, "rule_source": { "type": "string" }, "severity": { "type": "string", "nullable": true }, "score_delta": { "type": "integer" }, "status_target": { "type": "string", "nullable": true }, "action_summary": { "type": "string", "nullable": true } } }, "NetworkTimelineCaseLinked": { "type": "object", "description": "Кейс, открытый для сети в вашей организации. Поле `source_ref.ownership` указывает, принадлежит ли он вызванному вами приложению.", "properties": { "case_id": { "type": "string", "format": "uuid" }, "case_number": { "type": "string", "nullable": true }, "status": { "type": "string" }, "author_email": { "type": "string", "nullable": true }, "author_name": { "type": "string", "nullable": true } } }, "NetworkTimelineNoteAdded": { "type": "object", "description": "Заметка, оставленная в сети. Текст заметки не включён.", "properties": { "note_id": { "type": "string", "format": "uuid" }, "author_email": { "type": "string" } } }, "FeatureStatusOverride": { "type": "object", "description": "Одно переопределение статуса проверки (функции), выполненное с помощью `PATCH /v3/session/{sessionId}/features/{nodeId}/update-status/`: что оно меняет, применено ли оно или всё ещё ожидает завершения сценария пользователем, кто запросил и почему.", "required": [ "id", "node_id", "feature_type", "feature_model", "previous_status", "new_status", "state", "forced", "reason", "requested_by", "requested_at", "applied_at", "cancelled_at", "cancel_reason" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Идентификатор переопределения. Передайте его в endpoint отмены.", "example": "7c9e6679-7425-40de-944b-e07fc1f90ae7" }, "node_id": { "type": "string", "description": "Узел сценария, указанный в запросе (`default` для шага без узла).", "example": "feature_ocr_1" }, "feature_type": { "type": "string", "description": "Параметр `feature_type`, переданный в запросе, или пустая строка, если он не был передан.", "example": "" }, "feature_model": { "type": "string", "description": "Тип проверки, которая была переопределена, например `KYC`, `Face`, `AML` или `GeolocationCheck`.", "example": "KYC" }, "previous_status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Статус проверки на момент запроса переопределения.", "example": "In Review" }, "new_status": { "type": "string", "enum": [ "Approved", "Declined", "In Review" ], "description": "Статус, устанавливаемый переопределением.", "example": "Approved" }, "state": { "type": "string", "enum": [ "applied", "pending_until_flow_finishes", "cancelled" ], "description": "`applied`: проверка получила новый статус. `pending_until_flow_finishes`: переопределение ожидает и применяется, когда пользователь завершает прохождение сценария. `cancelled`: ожидание завершилось без применения (см. `cancel_reason`).", "example": "applied" }, "forced": { "type": "boolean", "description": "`true`, если переопределение применилось немедленно, пока человек ещё находился в сценарии.", "example": false }, "reason": { "type": "string", "nullable": true, "description": "Параметр `comment`, отправленный с запросом, или `null`.", "example": "Document manually verified by compliance." }, "requested_by": { "type": "object", "nullable": true, "description": "Кто запросил переопределение, или `null`, если это неизвестно.", "properties": { "email": { "type": "string", "format": "email", "nullable": true, "description": "Электронная почта пользователя консоли или `null` для API-ключей и системы.", "example": "reviewer@example.com" }, "name": { "type": "string", "nullable": true, "description": "Отображаемое имя запрашивающего или `null`.", "example": "Alex Reviewer" }, "type": { "type": "string", "enum": [ "CONSOLE_USER", "API_KEY", "SYSTEM" ], "description": "Кто выполнил запрос: пользователь консоли, API-ключ или сам Didit.", "example": "CONSOLE_USER" } } }, "requested_at": { "type": "string", "format": "date-time", "description": "Время запроса переопределения.", "example": "2026-10-13T09:15:00Z" }, "applied_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда проверка перешла в новый статус, или `null`, пока она ожидает или после её отмены.", "example": "2026-10-13T09:15:00Z" }, "cancelled_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда переопределение в состоянии ожидания было отменено, или `null`.", "example": null }, "cancel_reason": { "type": "string", "nullable": true, "enum": [ "cancelled_by_reviewer", "replaced", "check_changed", "session_closed", null ], "description": "Причина, по которой отложенное переопределение не было применено, или `null`. `cancelled_by_reviewer`: отменено через endpoint отмены. `replaced`: заменено более новым переопределением для той же проверки. `check_changed`: человек повторно прошёл проверку до завершения сценария. `session_closed`: сессия вышла из сценария до того, как человек завершил его (прервана, истекла или решение принято в процессе сценария).", "example": null } } }, "SandboxSimulateRequest": { "type": "object", "description": "Принудительно задать статус сессии в песочнице. Все поля необязательны, но требуется хотя бы одно из `new_status`, `scenario` или `risk`.", "properties": { "new_status": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Expired", "Abandoned" ], "description": "Устанавливаемый статус. Если его опустить, по умолчанию используется стандартный статус кейса риска (`risk` или первый риск, который содержат магические значения сценария), иначе используется стандартный статус сценария.", "example": "Declined" }, "comment": { "type": "string", "maxLength": 500, "description": "Заметка, добавленная к записи об активности, которую фиксирует смена статуса.", "example": "Testing the decline path" }, "scenario": { "type": "string", "maxLength": 100, "description": "Слаг сценария из каталога (`GET /v1/sandbox/scenarios/`). Он задаёт статус по умолчанию и, если не указан `risk`, предупреждение, заложенное в его магических значениях. Неизвестный слаг возвращает `400`.", "example": "decline_aml_hit" }, "risk": { "type": "string", "maxLength": 128, "description": "Риск-кейс из каталога. Его предупреждение добавляется к сессии с типом лога, соответствующим `new_status`. Неизвестное значение возвращает `400`.", "example": "POSSIBLE_MATCH_FOUND" }, "node_id": { "type": "string", "maxLength": 128, "description": "Узел сценария, к которому привязано предупреждение о риске. По умолчанию используется текущий узел сессии.", "example": "feature_aml_1" }, "send_webhooks": { "type": "boolean", "default": true, "description": "`true` отправляет на адреса назначения приложения песочницы ровно те webhook, которые отправляет реальное изменение статуса: `status.updated`, плюс события `user.status.updated` / `user.data.updated` (или `business.status.updated` / `business.data.updated`), вызванные этим изменением, для подписанных на них адресов назначения. `false` изменяет статус без логирования и отправки webhook: восстановление пропущенных webhook никогда не отправляет это решение повторно, панель управления по-прежнему обновляется в реальном времени, а следующее изменение статуса сессии отправляет webhook в обычном режиме.", "example": true } } }, "SandboxSimulateResponse": { "type": "object", "required": [ "session_id", "previous_status", "status", "scenario", "risk", "send_webhooks" ], "properties": { "session_id": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "previous_status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Статус сессии перед симуляцией.", "example": "In Progress" }, "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Expired", "Abandoned" ], "description": "Статус, установленный симуляцией.", "example": "Declined" }, "scenario": { "type": "string", "nullable": true, "description": "Переданный вами слаг сценария или `null`.", "example": "decline_aml_hit" }, "risk": { "type": "string", "nullable": true, "description": "Применённый кейс риска (`risk` или взятый из сценария) либо `null`, если отсутствует.", "example": "POSSIBLE_MATCH_FOUND" }, "send_webhooks": { "type": "boolean", "description": "Значение `send_webhooks`, применённое симуляцией.", "example": false } } }, "CaseTeamSummary": { "type": "object", "nullable": true, "description": "Команда проверки, ответственная за кейс, или null, если команда не назначена. Задаётся маршрутизацией, когда правило маршрутизации распределяет кейс в одну из команд. Изменить или очистить можно с помощью `PATCH .../cases/{case_uuid}/` (`team`).", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } }, "CaseChecker": { "type": "object", "nullable": true, "description": "Участник, назначенный для одобрения или отклонения ожидающего решения. Задаётся только тогда, когда решение по принципу четырех глаз ожидает назначенного проверяющего. Null, когда нет ожидающих решений, пока ожидающее решение находится в очереди проверяющих, а также после того, как решение одобрено, отклонено или возвращено на повторную проверку из-за изменения доказательств.", "properties": { "member_uuid": { "type": "string", "format": "uuid", "description": "UUID пользователя-участника: значение, которое вы передаете в качестве `checker` при разрешении кейса." }, "name": { "type": "string", "nullable": true, "description": "Полное имя участника или null, если оно неизвестно." }, "email": { "type": "string", "format": "email" } } }, "ServiceStatusFeed": { "type": "object", "description": "Публичный статус сервисов: состояние каждого сервиса Didit, общий статус и инциденты, которые происходят сейчас или были устранены за последние 7 дней.", "required": [ "status", "updated_at", "services", "incidents" ], "properties": { "status": { "type": "string", "enum": [ "operational", "degraded", "down" ], "description": "Худшее состояние любого сервиса на текущий момент, определяемое только текущими инцидентами.", "example": "degraded" }, "updated_at": { "type": "string", "format": "date-time", "description": "Когда Didit сформировал этот ответ (ISO 8601, UTC). Ответы кэшируются на 30 секунд, поэтому он может быть устаревшим максимум на 30 секунд.", "example": "2026-10-13T09:41:07.512345Z" }, "services": { "type": "array", "description": "Одна запись на каждую службу, все службы перечисляются всегда.", "items": { "$ref": "#/components/schemas/ServiceStatusService" } }, "incidents": { "type": "array", "description": "Сначала самые новые по `started_at`. Все текущие инциденты, а также инциденты, завершённые за последние 7 дней (не более 50 завершённых инцидентов). Пусто, если за это время ничего не произошло.", "items": { "$ref": "#/components/schemas/ServiceStatusIncident" } } } }, "ServiceStatusService": { "type": "object", "required": [ "key", "name", "status" ], "properties": { "key": { "type": "string", "enum": [ "service_id_verification", "service_liveness_face_match", "service_aml_screening", "service_kyb_registries", "service_database_validation", "service_phone_delivery", "service_email_delivery", "service_transaction_monitoring" ], "description": "Постоянный ключ сервиса. Сопоставляйте по нему, а не по отображаемому названию. `service_id_verification`: верификация личности, `service_liveness_face_match`: проверка живости и сравнение лиц, `service_aml_screening`: AML-скрининг, `service_kyb_registries`: реестры KYB, `service_database_validation`: проверка по базам данных, `service_phone_delivery`: доставка для проверки телефона, `service_email_delivery`: доставка для проверки электронной почты, `service_transaction_monitoring`: мониторинг транзакций.", "example": "service_database_validation" }, "name": { "type": "string", "description": "Отображаемое имя сервиса на английском языке.", "example": "Database validation" }, "status": { "type": "string", "enum": [ "operational", "degraded", "down" ], "description": "`operational`, если для сервиса нет текущих инцидентов, иначе худшее состояние среди его текущих инцидентов.", "example": "degraded" } } }, "ServiceStatusIncident": { "type": "object", "required": [ "id", "service", "service_name", "state", "status", "title", "body", "affected", "country_name", "started_at", "resolved_at", "duration_minutes" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Идентификатор инцидента.", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "service": { "type": "string", "enum": [ "service_id_verification", "service_liveness_face_match", "service_aml_screening", "service_kyb_registries", "service_database_validation", "service_phone_delivery", "service_email_delivery", "service_transaction_monitoring" ], "description": "Ключ затронутого сервиса (см. `services[].key`).", "example": "service_database_validation" }, "service_name": { "type": "string", "description": "Отображаемое имя затронутого сервиса на английском языке.", "example": "Database validation" }, "state": { "type": "string", "enum": [ "degraded", "down" ], "description": "Как затронут сервис. Устранённый инцидент сохраняет своё последнее состояние.", "example": "degraded" }, "status": { "type": "string", "enum": [ "ongoing", "resolved" ], "description": "`ongoing` до восстановления сервиса, затем `resolved`.", "example": "ongoing" }, "title": { "type": "string", "description": "Заголовок на английском языке. Чтобы перевести его, сформируйте собственный текст на основе полей `service`, `state` и `country_name`.", "example": "Database validation is degraded in Brazil." }, "body": { "type": "string", "description": "Строка с подробностями на английском языке: с какого момента проверки могут замедляться или завершаться ошибкой, либо когда работоспособность восстановилась.", "example": "Checks against Brazil (CPF) may be slow or fail since 08:55 UTC." }, "affected": { "type": "string", "description": "Затронутые страны или реестры, например `Brazil (CPF)`. Пусто, если инцидент не связан со страной или реестром.", "example": "Brazil (CPF)" }, "country_name": { "type": "string", "description": "Затронутая страна на английском языке. Пусто, если инцидент не связан со страной.", "example": "Brazil" }, "started_at": { "type": "string", "format": "date-time", "description": "Время начала инцидента (ISO 8601, UTC).", "example": "2026-10-13T08:55:00Z" }, "resolved_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Время восстановления сервиса (ISO 8601, UTC). `null`, пока инцидент продолжается." }, "duration_minutes": { "type": "integer", "nullable": true, "description": "Полные минуты от `started_at` до `resolved_at`. `null`, пока инцидент продолжается." } } }, "TravelRuleJoinInvitation": { "type": "object", "description": "Что отображается на странице присоединения до ввода каких-либо данных.", "properties": { "email": { "type": "string", "format": "email", "description": "Адрес, на который было отправлено приглашение." }, "vasp_name": { "type": "string" }, "source": { "type": "string", "description": "Источник приглашения, например `pickup`." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true }, "prefill": { "type": "object", "properties": { "vasp_id": { "type": "string", "format": "uuid", "nullable": true }, "legal_name": { "type": "string" }, "lei": { "type": "string" }, "jurisdiction": { "type": "string" }, "domains": { "type": "array", "items": { "type": "string" } } } } } }, "TravelRuleJoinRegisterRequest": { "type": "object", "required": [ "email", "password" ], "properties": { "email": { "type": "string", "format": "email", "maxLength": 254, "description": "Должен быть адресом, на который было отправлено приглашение." }, "password": { "type": "string", "minLength": 8, "maxLength": 128 } } }, "TravelRuleJoinVerifyRequest": { "type": "object", "required": [ "email", "code" ], "properties": { "email": { "type": "string", "format": "email", "maxLength": 254 }, "code": { "type": "string", "minLength": 6, "maxLength": 6, "description": "6-символьный код, отправленный по электронной почте после регистрации." } } }, "TravelRuleJoinCredentials": { "type": "object", "description": "Новая бесплатная организация и учетные данные, с помощью которых ее приложение вызывает API.", "properties": { "organization": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" } } }, "application": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" } } }, "client_id": { "type": "string" }, "api_key": { "type": "string", "description": "Отправляйте в заголовке `x-api-key` при вызове endpoint рабочего пространства." } } }, "TravelRuleWorkspaceClaimRequest": { "type": "object", "required": [ "vasp_id" ], "properties": { "vasp_id": { "type": "string", "format": "uuid", "description": "Запись каталога, которой соответствует это рабочее пространство. Получайте идентификаторы через `GET /v3/travel-rule/vasps/`." } } }, "TravelRuleWorkspaceDomainConfirmRequest": { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string", "minLength": 6, "maxLength": 6 } } }, "TravelRuleWorkspaceBillingRequest": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true, "description": "Принимается только `true`: исходящий биллинг нельзя отключить обратно через API." } } }, "TravelRuleWorkspaceDomainCodeResponse": { "type": "object", "properties": { "domain": { "type": "string" }, "status": { "type": "string", "enum": [ "unverified", "code_sent", "verified" ] }, "txt": { "$ref": "#/components/schemas/TravelRuleWorkspaceTxtRecord" } } }, "TravelRuleWorkspaceTxtRecord": { "type": "object", "description": "TXT-запись для публикации в рамках DNS-подтверждения. Пусто, пока подтверждение не запущено.", "properties": { "host": { "type": "string", "example": "didit-tr-verify.example.com" }, "value": { "type": "string" } } }, "TravelRuleWorkspace": { "type": "object", "description": "Бесплатное рабочее пространство Travel Rule приложения, подключившегося бесплатно.", "properties": { "joined_free": { "type": "boolean" }, "work_email": { "type": "string", "format": "email" }, "joined_at": { "type": "string", "format": "date-time", "nullable": true }, "claim": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "unclaimed", "pending_review", "claimed", "rejected" ] }, "proved_by_domain": { "type": "boolean" }, "claimed_at": { "type": "string", "format": "date-time", "nullable": true }, "reviewed_at": { "type": "string", "format": "date-time", "nullable": true }, "review_note": { "type": "string" }, "vasp_id": { "type": "string", "format": "uuid", "nullable": true }, "vasp_name": { "type": "string" } } }, "prefill": { "type": "object", "description": "Значения профиля, взятые из записи каталога: `vasp_id`, `legal_name`, `lei`, `jurisdiction`, `compliance_email`, `domains`. Ничего не записывается, пока не заявлены права на профиль." }, "domain": { "type": "object", "properties": { "domain": { "type": "string" }, "status": { "type": "string", "enum": [ "unverified", "code_sent", "verified" ] }, "verified_at": { "type": "string", "format": "date-time", "nullable": true }, "txt": { "$ref": "#/components/schemas/TravelRuleWorkspaceTxtRecord" } } }, "billing_enabled": { "type": "boolean", "description": "Получение данных Travel Rule бесплатно. Отправка тарифицируется только после включения биллинга." }, "billing_enabled_at": { "type": "string", "format": "date-time", "nullable": true }, "didit_network": { "type": "object", "description": "Включён ли этот VASP в сеть Didit и, если нет, какие условия ещё не выполнены." }, "settings": { "$ref": "#/components/schemas/TravelRuleSettingsDetail" } } }, "InvestigatorDecision": { "type": "object", "description": "Как элемент покинул очередь Investigator. `decided_by`, `original_outcome` и `overrides` возвращаются эндпоинтами принятия и переопределения, а также отчётом; блок `investigator` решения по сессии содержит остальные поля.", "properties": { "outcome": { "type": "string", "enum": [ "accepted", "edited", "overridden", "decided_elsewhere", "automated" ], "description": "`accepted` или `edited`: рекомендация принята (`edited` с изменённым описанием), `overridden`: выбрано другое действие, `decided_elsewhere`: решение принято вне Investigator, пока отчёт был открыт, `automated`: решение, принятое Investigator автоматически." }, "action": { "type": "string", "enum": [ "approve", "decline", "escalate", "request" ] }, "actor_email": { "type": "string", "nullable": true }, "actor_name": { "type": "string", "nullable": true }, "override_category": { "type": "string", "enum": [ "missing_context", "needs_information", "policy_differs", "evidence_misread", "other", "" ], "nullable": true }, "override_reason": { "type": "string", "nullable": true }, "final_status": { "type": "string", "description": "Статус элемента после принятия решения." }, "agreed": { "type": "boolean", "description": "Совпало ли решение с рекомендацией.", "nullable": true }, "decided_at": { "type": "string", "format": "date-time" }, "billed": { "type": "boolean", "description": "За проверку была списана плата." }, "decided_by": { "type": "string", "enum": [ "investigator", "member" ] }, "original_outcome": { "type": "object", "description": "Решение, принятое модулем Investigator самостоятельно, без учёта последующих переопределений. Null для решений, принятых командой.", "properties": { "action": { "type": "string" }, "final_status": { "type": "string" }, "decided_at": { "type": "string", "format": "date-time" } }, "nullable": true }, "overrides": { "type": "array", "description": "Каждое переопределение решения, принятое Investigator самостоятельно, начиная с самых старых.", "items": { "type": "object", "properties": { "action": { "type": "string" }, "actor_email": { "type": "string", "nullable": true }, "actor_name": { "type": "string", "nullable": true }, "override_category": { "type": "string" }, "override_reason": { "type": "string" }, "previous_status": { "type": "string" }, "final_status": { "type": "string" }, "agreed": { "type": "boolean", "nullable": true }, "overridden_at": { "type": "string", "format": "date-time" } } } } } }, "InvestigatorBlock": { "type": "object", "nullable": true, "description": "Последняя проверка элемента в Investigator или null, если она никогда не проводилась. Передаётся в решении сессии V3 и бизнес-сессии (и, следовательно, в webhook `status.updated`).", "properties": { "run_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "running", "completed", "failed" ] }, "stage": { "type": "string", "enum": [ "shadow", "live" ] }, "queue": { "type": "string", "enum": [ "kyc", "kyb", "aml", "transactions", "cases" ] }, "is_open": { "type": "boolean" }, "recommendation": { "type": "string", "enum": [ "approve", "decline", "escalate", "request" ], "nullable": true }, "recommendation_detail": { "type": "string", "nullable": true }, "confidence": { "type": "string", "enum": [ "high", "moderate", "low" ], "nullable": true }, "summary": { "type": "string", "nullable": true }, "ready_to_accept": { "type": "boolean" }, "prepared_at": { "type": "string", "format": "date-time", "nullable": true }, "automated": { "type": "boolean", "description": "Investigator принял решение самостоятельно, даже если впоследствии решение было переопределено." }, "decided_by": { "type": "string", "enum": [ "investigator", "member" ], "nullable": true }, "decision": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/InvestigatorDecision" } ], "type": "object" } } }, "InvestigatorQueueRow": { "type": "object", "properties": { "run_id": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "session", "business_session", "transaction", "case" ] }, "queue": { "type": "string", "enum": [ "kyc", "kyb", "aml", "transactions", "cases" ] }, "stage": { "type": "string", "enum": [ "shadow", "live" ] }, "subject": { "type": "object", "description": "Проверяемый элемент: `id`, `number`, `status`, `name` и, в зависимости от типа, `country`, `workflow`, `vendor_data`, `txn_id`, `amount`, `currency`, `direction`, `title` или `priority`.", "additionalProperties": true }, "recommendation": { "type": "string", "enum": [ "approve", "decline", "escalate", "request" ] }, "recommendation_detail": { "type": "string" }, "confidence": { "type": "string", "enum": [ "high", "moderate", "low" ] }, "summary": { "type": "string" }, "sources_count": { "type": "integer" }, "ready_to_accept": { "type": "boolean" }, "guardrails": { "description": "Зафиксированные защитные ограничения, удерживающие этот элемент, если таковые имеются." }, "waiting_since": { "type": "string", "format": "date-time", "nullable": true }, "due_at": { "type": "string", "format": "date-time", "nullable": true }, "prepared_at": { "type": "string", "format": "date-time", "nullable": true } } }, "InvestigatorRunDetail": { "allOf": [ { "$ref": "#/components/schemas/InvestigatorQueueRow" }, { "type": "object", "properties": { "status": { "type": "string" }, "is_open": { "type": "boolean" }, "lookups": { "type": "integer", "description": "Сколько разделов и связанных записей было прочитано." }, "duration_ms": { "type": "integer", "nullable": true }, "agent_version": { "type": "string" }, "prepared_before_opened": { "type": "boolean", "nullable": true }, "report": { "type": "object", "additionalProperties": true, "description": "Отчёт: обоснование, пункты доказательств с их вердиктом (`ok`, `risk`, `look`, `explained`, `context`) и указанными источниками, вердикты совпадений скрининга (`same`, `not_same`, `unclear`) и предлагаемые следующие шаги." }, "trail": { "description": "Что было проверено: обзор, разделы и прочитанные записи по порядку." }, "decision": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/InvestigatorDecision" } ], "type": "object" }, "autonomy": { "type": "object", "additionalProperties": true, "description": "Решение автономной системы по отчёту (`result`, `reason`, `tier`, `policy_version`, `rule`, `agreement`, `decisions`, `threshold`, `at`). Null, если очередь не автоматизирована.", "nullable": true } } } ] }, "InvestigatorAcceptRequest": { "type": "object", "properties": { "narrative": { "type": "string", "maxLength": 4000, "description": "Переписанное описание. Его отправка фиксирует решение как отредактированное и принятое." }, "send_email": { "type": "boolean", "default": false, "description": "Отправить человеку письмо с решением по электронной почте." }, "email_address": { "type": "string", "format": "email", "description": "Обязательно, когда `send_email` имеет значение true." }, "email_language": { "type": "string", "default": "en", "maxLength": 16 } } }, "InvestigatorOverrideRequest": { "type": "object", "required": [ "action", "category", "reason" ], "properties": { "action": { "type": "string", "enum": [ "approve", "decline", "escalate", "request" ] }, "category": { "type": "string", "enum": [ "missing_context", "needs_information", "policy_differs", "evidence_misread", "other" ] }, "reason": { "type": "string", "minLength": 10, "maxLength": 500 }, "send_email": { "type": "boolean", "default": false, "description": "Отправить человеку письмо с решением по электронной почте." }, "email_address": { "type": "string", "format": "email", "description": "Обязательно, когда `send_email` имеет значение true." }, "email_language": { "type": "string", "default": "en", "maxLength": 16 } } }, "InvestigatorBatchAcceptRequest": { "type": "object", "required": [ "run_ids" ], "properties": { "run_ids": { "type": "array", "minItems": 1, "maxItems": 50, "items": { "type": "string", "format": "uuid" } } } }, "InvestigatorBatchAcceptResponse": { "type": "object", "properties": { "accepted": { "type": "integer" }, "skipped": { "type": "integer" }, "results": { "type": "array", "items": { "type": "object", "properties": { "run_id": { "type": "string", "format": "uuid" }, "result": { "type": "string", "enum": [ "accepted", "skipped" ] }, "reason": { "type": "string", "enum": [ "not_found", "forbidden", "already_decided", "not_ready", "guardrail", "invalid" ] }, "detail": {}, "action": { "type": "string" }, "final_status": { "type": "string" } } } } } }, "InvestigatorSettings": { "type": "object", "properties": { "stage": { "type": "string", "enum": [ "none", "shadow", "live" ] }, "stage_changed_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "stage_changed_by": { "type": "string", "readOnly": true }, "monthly_spend_limit": { "type": "string", "format": "decimal", "description": "Ежемесячный лимит в валюте вашего биллинга, от 0.01 до 1,000,000. Null отключает его.", "nullable": true }, "spend_limit": { "type": "object", "readOnly": true, "properties": { "enabled": { "type": "boolean" }, "limit": { "type": "string", "format": "decimal", "nullable": true }, "spent": { "type": "string", "format": "decimal" }, "reviews": { "type": "integer" }, "reserved": { "type": "string", "format": "decimal", "description": "Цена каждого открытого отчета в продакшн-среде, удержанная, так как ее принятие списывает средства." }, "currency": { "type": "string" }, "paused": { "type": "boolean", "description": "Достигнут лимит: новая проверка не запускается." } } } } }, "TravelRuleUtxoEntry": { "type": "object", "description": "Один вход или выход UTXO-транзакции в том виде, в каком он зафиксирован в блокчейне.", "required": [ "address" ], "properties": { "address": { "type": "string", "maxLength": 128 }, "amount": { "type": "string", "nullable": true, "description": "Десятичная строка в единицах самой монеты (BTC, не сатоши). Необязательно.", "example": "0.0125" }, "txid": { "type": "string", "maxLength": 128, "description": "Необязательно. Транзакция, которую расходует вход (input)." }, "vout": { "type": "integer", "nullable": true, "minimum": 0, "description": "Необязательно. Индекс выхода (output index), который расходуется входом (input)." } } }, "TravelRuleUtxo": { "type": "object", "description": "Входы и выходы UTXO-перевода (BTC, LTC, BCH, DOGE). Принимаются только для этих сетей: для любой другой сети возвращается `400`. На их основе Didit определяет кошелёк отправителя (заявленный, иначе входной адрес с наибольшим вкладом) и выход получателя (заявленный, иначе единственный выход, который не возвращает сдачу на входной адрес, иначе выход, выплачивающий сумму перевода). Результат находится в `chain_details` перевода.", "required": [ "outputs" ], "properties": { "inputs": { "type": "array", "maxItems": 1000, "items": { "$ref": "#/components/schemas/TravelRuleUtxoEntry" }, "description": "Необязательно. Без входов (inputs) отправитель не определяется, а выход со сдачей (change output) не распознается." }, "outputs": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/TravelRuleUtxoEntry" } } } }, "TravelRuleChainSide": { "type": "object", "description": "Кошелёк одной из сторон, определённый Didit на основе данных блокчейна.", "properties": { "address": { "type": "string", "description": "Кошелёк. В сетях с memo это классический адрес (XRP X-address разделяется на классический адрес и тег); в Lightning это идентификатор узла получателя или Lightning Address." }, "memo": { "type": "string", "description": "Destination tag или memo, являющиеся частью кошелька; `\"\"`, если отсутствует." }, "source": { "type": "string", "enum": [ "declared", "x_address", "largest_input", "only_non_change_output", "amount_match", "invoice_payee", "updated" ], "description": "Откуда получен кошелёк: `declared` (ваш запрос), `x_address` (выделен из X-адреса XRP), `largest_input` (входной адрес UTXO с наибольшим вкладом), `only_non_change_output` (единственный выход UTXO, не являющийся сдачей), `amount_match` (единственный выход UTXO, выплачивающий сумму перевода), `invoice_payee` (получатель, указанный в платежном запросе Lightning), `updated` (установлен позже с помощью `action: update_originator_wallet`)." } } }, "TravelRuleChainDetails": { "type": "object", "description": "Как блокчейн перевода именует два своих кошелька, когда перевод выполняется не просто с одного адреса на другой. Пусто (`{}`) для переводов в сетях на основе аккаунтов (EVM, Solana, Tron), где эти два адреса и есть кошельки. Сопоставление, маршрутизация и адресная книга читают кошельки в первую очередь отсюда.", "properties": { "chain": { "type": "string", "description": "Каноническая сеть, например `BTC`, `XRP` или `LIGHTNING` для перевода через Lightning." }, "shape": { "type": "string", "enum": [ "utxo", "memo", "lightning" ] }, "originator": { "$ref": "#/components/schemas/TravelRuleChainSide" }, "beneficiary": { "$ref": "#/components/schemas/TravelRuleChainSide" }, "utxo": { "type": "object", "description": "Для перевода UTXO: входы и выходы в сохраненном виде (суммы в виде десятичных строк) и то, как именно Didit интерпретировал выходы.", "properties": { "inputs": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleUtxoEntry" } }, "outputs": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleUtxoEntry" } }, "change_output_indexes": { "type": "array", "items": { "type": "integer" }, "description": "Выходы, возвращающие средства обратно на адрес входа." }, "beneficiary_output_index": { "type": "integer", "nullable": true, "description": "Выход, выплачивающий средства получателю; null, если не удалось определить ни один." } } }, "lightning": { "type": "object", "description": "Для перевода Lightning: содержимое платежного запроса. Всегда `kind` (`bolt11`, `bolt12_offer`, `bolt12_invoice`, `bolt12_invoice_request`, `lnurl`, `lightning_address`, `node_id` или `unknown`); инвойс BOLT11 добавляет `network`, `payee_node_id`, `payment_hash`, `amount_msat`, `created_at` и `expires_at`; строка BOLT12 добавляет `blinded_paths` и `payee_node_id`; LNURL или Lightning Address добавляет свой `domain`. По сети ничего не запрашивается: выполняется только декодирование запроса.", "additionalProperties": true }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "declared_originator_not_an_input", "declared_beneficiary_not_an_output", "beneficiary_output_ambiguous", "beneficiary_output_amount_differs" ] }, "description": "Несоответствия UTXO, заслуживающие внимания: заявленный отправитель отсутствует во входах (inputs), заявленный получатель отсутствует в выходах (outputs), невозможно выделить единственный выход получателя или сумма в выходе получателя отличается от указанной в транзакции." }, "not_applicable_reason": { "type": "string", "enum": [ "LIGHTNING_NO_PAYEE_IDENTIFIER", "LIGHTNING_BOLT12_BLINDED_PAYEE", "LIGHTNING_LNURL_NAMES_NO_PAYEE" ], "description": "Для исходящего перевода Lightning, в платежном запросе которого не указан получатель: причина, почему перевод имеет статус `NOT_APPLICABLE`. `LIGHTNING_NO_PAYEE_IDENTIFIER` (в запросе не указан узел получателя или запрос не удалось декодировать), `LIGHTNING_BOLT12_BLINDED_PAYEE` (предложение скрывает своего получателя за слепыми путями), `LIGHTNING_LNURL_NAMES_NO_PAYEE` (LNURL указывает сервис, а не получателя). Тот же код открывает последнюю запись `timeline` перевода." } } }, "WalletAddressImportRow": { "type": "object", "description": "Один кошелёк для импорта: по его `address`, его `address_hash` или обоим полям. Формы этих полей в camelCase также принимаются, как и `walletAddress`, `walletAddressHash`, `destinationTag` и `externalUserId`.", "properties": { "address": { "type": "string", "maxLength": 128, "description": "Адрес кошелька. Псевдоним: `walletAddress`." }, "address_hash": { "type": "string", "description": "SHA-256 адреса в нижнем регистре в виде 64 шестнадцатеричных символов или 44 символов base64. Передайте только его, чтобы зарегистрировать кошелёк без раскрытия его адреса; при передаче вместе с `address` он должен являться хешем этого адреса. Псевдоним: `walletAddressHash`." }, "chain": { "type": "string", "maxLength": 32 }, "memo": { "type": "string", "maxLength": 256, "description": "Тег назначения или memo. XRP: тег назначения, целое число от 0 до 4294967295 (принимается число JSON). XLM: текстовое memo до 28 байт, 64-битный id или 32-байтный хеш в hex. EOS: до 256 байт. ATOM: до 256 символов. HBAR: до 100 байт. Для кошельков Bitcoin, EVM, Solana, Tron, Litecoin, Bitcoin Cash, Dogecoin и Lightning memo не используется: передача memo вызовет ошибку `400`." }, "holder_name": { "type": "string", "maxLength": 255 }, "holder_vendor_data": { "type": "string", "maxLength": 255, "description": "Ваш внутренний идентификатор владельца. Псевдоним: `externalUserId`." }, "entity_type": { "type": "string", "enum": [ "individual", "company" ], "default": "individual" }, "label": { "type": "string", "maxLength": 255 }, "owner_type": { "type": "string", "enum": [ "customer", "internal", "vasp" ], "default": "customer" }, "travel_address": { "type": "string", "maxLength": 512 }, "self_declared": { "type": "boolean", "default": false, "description": "Создать запись, уже верифицированную на основе самодекларации, если это разрешено вашими настройками." } } }, "WalletAddressImportReport": { "type": "object", "description": "Что произошло с каждой строкой импорта в порядке отправки.", "properties": { "total": { "type": "integer" }, "created": { "type": "integer" }, "existing": { "type": "integer" }, "duplicate": { "type": "integer" }, "failed": { "type": "integer" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "row": { "type": "integer", "description": "Номер строки, начиная с 1." }, "status": { "type": "string", "enum": [ "created", "existing", "duplicate", "failed" ], "description": "`created`: добавлен в книгу. `existing`: кошелёк уже есть в книге и оставлен без изменений. `duplicate`: повторяет более раннюю строку этого импорта. `failed`: см. `errors`." }, "entry_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Запись адресной книги, которую создала или нашла эта строка." }, "errors": { "type": "object", "description": "Ошибки полей строки со статусом `failed`; в противном случае пусто." }, "duplicate_of_row": { "type": "integer", "nullable": true, "description": "В строке со статусом `duplicate`: строка, которую она повторяет." } } } } } }, "TravelRuleCounterpartyContact": { "type": "object", "description": "Комплаенс-адрес, на который отправляет сообщения транспорт EMAIL для одной записи справочника.", "properties": { "uuid": { "type": "string", "format": "uuid" }, "counterparty": { "type": "string", "format": "uuid", "description": "`id` записи каталога, как его возвращает GET /v3/travel-rule/vasps/." }, "counterparty_name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "name": { "type": "string", "description": "Необязательная метка, например название команды." }, "source": { "type": "string", "enum": [ "staff", "application", "learned" ], "description": "staff: курируется Didit. learned: адрес на одном из собственных доменов VASP, ответивший на запрос по ссылке для ответа. application: добавлен вашим приложением." }, "scope": { "type": "string", "enum": [ "platform", "application" ], "description": "platform: отбирается и поддерживается Didit или получено из проверенного ответа, используется для каждого клиента Didit, доступно вам только для чтения. application: приватно для вашего приложения." }, "created_by": { "type": "string", "description": "Пусто для контактов платформы и контактов, добавленных с помощью API-ключа." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда по этому адресу в последний раз отвечали на запрос через ссылку для ответа." }, "is_invalid": { "type": "boolean", "description": "true, если адрес вернул ошибку доставки или пожаловался; маршрут EMAIL пропускает его." }, "invalid_reason": { "type": "string", "enum": [ "", "hard_bounce", "soft_bounce", "spam_complaint", "suppressed" ] }, "invalid_detail": { "type": "string", "description": "Причина, указанная принимающим почтовым сервером, если она была предоставлена." }, "invalid_at": { "type": "string", "format": "date-time", "nullable": true }, "created_at": { "type": "string", "format": "date-time" } } }, "TravelRuleCounterpartyContactCreate": { "type": "object", "required": [ "counterparty", "email" ], "properties": { "counterparty": { "type": "string", "format": "uuid", "description": "`id` записи каталога." }, "email": { "type": "string", "format": "email", "maxLength": 254 }, "name": { "type": "string", "description": "Необязательная метка.", "maxLength": 255 } } }, "TravelRuleNameMatch": { "type": "object", "nullable": true, "description": "Сравнение имен, на основе которого было принято решение по переводу, или null до выполнения проверки. Пока стороны маскированы, а также в копии транзакции INTERNAL у другого клиента, поля `transfer_name`, `compared_name`, `matched_names` и `mismatched_names` скрыты. Значения `score` и `matched` могут расходиться: `matched` следует уровню строгости, а `score` отражает степень сходства двух полных имен.", "properties": { "score": { "type": "integer", "minimum": 0, "maximum": 100, "description": "Степень сходства двух полных имен, от 0 до 100. Равно 0, если хотя бы одно имя пустое." }, "matched": { "type": "boolean", "description": "Соответствуют ли имена значению `strictness`. Исход перевода зависит от `data_match`, где сравнивается каждое поле, поэтому перевод может иметь статус COUNTERPARTY_MISMATCHED_DATA, даже если здесь true." }, "method": { "type": "string", "enum": [ "none", "exact_token", "token_subset", "token_containment", "sequence_ratio" ], "description": "Как определялось `matched`: none (`NONE`), exact_token (`STRICT`), token_subset (`DEFAULT`), token_containment (`CONTAINS`) или sequence_ratio (`FUZZY`)." }, "strictness": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ] }, "compared_with": { "type": "string", "enum": [ "wallet_holder", "counterparty_vasp" ], "description": "wallet_holder: владелец, указанный для кошелька. counterparty_vasp: название, указанное контрагентом на странице ответа по электронной почте, или ответ Didit Test VASP в песочнице." }, "transfer_name": { "type": "string", "description": "Имя в переводе." }, "compared_name": { "type": "string", "description": "Имя, с которым проводилось сравнение." }, "matched_names": { "type": "array", "items": { "type": "string" }, "description": "Слова из `transfer_name`, найденные в `compared_name`." }, "mismatched_names": { "type": "array", "items": { "type": "string" }, "description": "Слова из `transfer_name`, отсутствующие в `compared_name`, затем слова из `compared_name`, отсутствующие в `transfer_name`." } } }, "TravelRuleTransferRow": { "type": "object", "description": "Один перевод по Travel Rule в том виде, как его отображает список переводов: только названия VASP, кошельки и примечания, без персональных данных отправителя или получателя.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Идентификатор (id) перевода." }, "transaction_id": { "type": "string", "format": "uuid", "description": "Транзакция Didit, к которой относится перевод." }, "txn_id": { "type": "string", "nullable": true, "description": "Ваш собственный идентификатор транзакции. Переводы, которые Didit регистрирует за вас, например входящий перевод Didit Test VASP, содержат сгенерированный идентификатор." }, "txn_date": { "type": "string", "format": "date-time" }, "kind": { "type": "string", "enum": [ "withdrawal", "deposit", "message" ], "description": "withdrawal: исходящий. message: входящий перевод, созданный маршрутом из сообщения контрагента (запрос TRP, входящее плечо INTERNAL либо сообщение GTR, VerifyVASP или Sygna Bridge). deposit: любой другой входящий перевод." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ] }, "status": { "type": "string", "enum": [ "AWAITING_COUNTERPARTY", "ON_HOLD", "COMPLETED", "FINISHED", "CANCELLED", "EXPIRED", "COUNTERPARTY_MISMATCHED_DATA", "COUNTERPARTY_VASP_NOT_FOUND", "COUNTERPARTY_VASP_NOT_REACHABLE", "UNCONFIRMED_OWNERSHIP", "COUNTERPARTY_VASP_GENERAL_DECLINE", "NOT_ENOUGH_COUNTERPARTY_DATA", "NOT_APPLICABLE" ] }, "reason": { "type": "string", "description": "Причина, по которой перевод со статусом `COUNTERPARTY_VASP_NOT_FOUND` или `COUNTERPARTY_VASP_NOT_REACHABLE` приостановлен; то же значение, что и у собственного поля перевода `reason`, что позволяет отличать недоставленное комплаенс-письмо от контрагента без маршрута без необходимости открывать каждый перевод. `\"\"` для любого другого статуса. См. [Почему перевод приостановлен](/ru/transaction-monitoring/travel-rule#почему-перевод-застрял)." }, "rail": { "type": "string", "nullable": true, "enum": [ "INTERNAL", "TRP", "GTR", "TRUST", "VERIFYVASP", "SYGNA", "EMAIL", "TEST_VASP", null ] }, "asset": { "type": "string", "description": "Валюта транзакции." }, "amount": { "type": "string", "description": "Сумма в виде простого десятичного числа, например \"1.25\"." }, "originator_vasp": { "type": "string", "description": "Исходящий: юридическое наименование вашего VASP. Входящий: имя или наименование контрагента из записи в каталоге, участника сети Didit, отправителя TRP, Didit Test VASP или наименование, указанное при переводе. Пусто, если ничего не известно." }, "beneficiary_vasp": { "type": "string", "description": "Исходящий: имя или наименование контрагента, определённое тем же способом. Входящий: юридическое наименование вашего VASP." }, "originator_wallet": { "type": "string" }, "beneficiary_wallet": { "type": "string" }, "originator_memo": { "type": "string", "description": "Memo или destination tag; пусто в блокчейнах без их поддержки." }, "beneficiary_memo": { "type": "string" }, "originator_wallet_type": { "type": "string", "enum": [ "vasp", "self_hosted", "own" ], "description": "vasp, self_hosted (заявлен как некастодиальный) или own (кошелёк, записанный в вашей адресной книге как ваш). Ваша сторона всегда vasp." }, "beneficiary_wallet_type": { "type": "string", "enum": [ "vasp", "self_hosted", "own" ] }, "matched_transaction_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Вторая сторона депозита, сопоставленная с объявленным переводом вручную." }, "deadline_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда истекает срок перевода, если он все еще ожидает контрагента. Задается для каждого перевода, создаваемого через `POST /v3/transactions/`, требующего обмена данными, исходящего или входящего. Имеет значение null ниже порога, для платежей Lightning, к которым не применяется Travel Rule, а также для входящих переводов, создаваемых Didit при обращении контрагента (входящий запрос TRP, сетевое сообщение или входящее плечо INTERNAL)." }, "created_at": { "type": "string", "format": "date-time" } } }, "BankAccountCheckHolder": { "description": "Имя, с которым проверяется учётная запись. Передайте ровно одно из полей: `full_name` или `business_name`.", "oneOf": [ { "$ref": "#/components/schemas/BankAccountCheckPersonHolder" }, { "$ref": "#/components/schemas/BankAccountCheckBusinessHolder" } ] }, "BankAccountCheckRequest": { "type": "object", "required": [ "country", "account", "holder" ], "properties": { "country": { "type": "string", "minLength": 3, "maxLength": 3, "description": "Страна счёта в виде кода ISO 3166-1 alpha-3, например `NGA`. Допускается строчный регистр.", "example": "NGA" }, "account": { "type": "object", "description": "Счёт в формате, принятом в соответствующей стране: `iban` или `account_number` с кодом банка или отделения, требуемым страной (`sort_code`, `routing_number`, `transit_institution`, `bsb`, `ifsc`, `bank_code` или `bic`). Для Мексики используется `clabe`, а для Аргентины `cbu_cvu`, которые уже содержат код банка. Для счёта компании добавляется `registration_id`, если это требуется страной. Пробелы, дефисы и точки игнорируются. Ключи, не используемые проверкой соответствующей страны, игнорируются; отсутствие необходимого ключа приводит к ошибке `400` с указанием его имени.", "properties": { "iban": { "type": "string", "maxLength": 64, "description": "IBAN в стране, использующей IBAN. Он должен относиться к `country`." }, "account_number": { "type": "string", "maxLength": 64, "description": "Номер счёта для страны, в которой счёт указывается с отдельным кодом банка или отделения." }, "sort_code": { "type": "string", "maxLength": 64, "description": "Великобритания: 6-значный сорт-код." }, "routing_number": { "type": "string", "maxLength": 64, "description": "США: 9-значный маршрутный номер ABA (routing number)." }, "transit_institution": { "type": "string", "maxLength": 64, "description": "Канада: 8-значный номер транзита и финансового учреждения." }, "bsb": { "type": "string", "maxLength": 64, "description": "Австралия: 6-значный код BSB." }, "ifsc": { "type": "string", "maxLength": 64, "description": "Индия: 11-символьный IFSC." }, "bank_code": { "type": "string", "maxLength": 64, "description": "Код банка, если требуется для страны, например в Нигерии." }, "bic": { "type": "string", "maxLength": 64, "description": "BIC банка, если проверка в данной стране требует его указания." }, "clabe": { "type": "string", "maxLength": 64, "description": "Мексика: 18-значный CLABE. В нём уже указан банк." }, "cbu_cvu": { "type": "string", "maxLength": 64, "description": "Аргентина: 22-значный CBU или CVU. Он уже содержит название банка." }, "registration_id": { "type": "string", "maxLength": 64, "description": "Регистрационный номер бизнес-аккаунта, если страна требует его указания." } }, "additionalProperties": { "type": "string", "maxLength": 64 }, "example": { "bank_code": "000014", "account_number": "0123450001" } }, "holder": { "$ref": "#/components/schemas/BankAccountCheckHolder" }, "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный идентификатор этой проверки, возвращаемый без изменений.", "example": "payout_20481" }, "consent": { "type": "boolean", "default": false, "description": "Установите значение `true`, если владелец счёта дал явное согласие на эту проверку. Обязательно в странах, где проверка счёта требует такого согласия: без него в проверке будет отказано с ошибкой `400`, где `field` равен `consent`, а `reason` равен `required`, при этом средства не списываются. В остальных странах параметр необязателен, и Didit фиксирует его вместе с начислением за проверку, если вы его передаёте.", "example": true } } }, "BankAccountCheckResponse": { "type": "object", "required": [ "request_id", "result", "holder_name", "account", "vendor_data", "created_at" ], "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID этой проверки." }, "result": { "type": "string", "enum": [ "match", "close_match", "no_match", "cannot_verify" ], "description": "`match`: банк ведет счет на указанное вами имя. `close_match`: на близкое имя, например, пропущено отчество/второе имя или допущена опечатка. `no_match`: на другое имя либо такого счета не существует. `cannot_verify`: банк вернул ответ без сравнения имени, например, для заблокированного или закрытого счета." }, "holder_name": { "type": "string", "nullable": true, "description": "Только при `close_match` и только если банк его вернул: имя владельца счёта в том виде, в котором оно зарегистрировано в банке. В противном случае `null`." }, "account": { "type": "string", "description": "Счёт, маскированный до последних 4 символов." }, "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный идентификатор в том виде, в котором вы его отправили." }, "created_at": { "type": "string", "format": "date-time", "description": "Когда выполнялась проверка, в UTC." } } }, "BankAccountCheckError": { "type": "object", "required": [ "detail" ], "properties": { "detail": { "type": "string", "description": "Что пошло не так, на английском языке." }, "code": { "type": "string", "description": "Стабильный код для ветвления логики. Отсутствует при `401` и `403`." }, "field": { "type": "string", "description": "Только для `400`: поле тела запроса, которое необходимо исправить, в виде пути через точку, например `account.sort_code`." }, "reason": { "type": "string", "enum": [ "required", "length", "format", "checksum", "country_mismatch", "rejected" ], "description": "Только для `400`: причина отклонения поля. `required`, `length`, `format`, `checksum` и `country_mismatch` (IBAN другой страны) являются собственными проверками Didit; `rejected` означает, что банк отклонил счёт в переданном виде." } } }, "BankVerificationResult": { "type": "object", "description": "Результат одного шага проверки банка для Проверки пользователей и Верификации бизнеса (KYB). `method` указывает, как был подтверждён счёт, а `none` означает, что пользователь продолжил без банка до оценки какой-либо попытки. `continued_without_bank` указывает, что пользователь продолжил без банка, в том числе после оценённой попытки. См. [Способы проверки банка](/ru/core-technology/bank-verification/verification-methods) и [Если пользователь не может подтвердить банк](/ru/core-technology/bank-verification/fallbacks).", "properties": { "schema_version": { "type": "integer", "description": "Версия этой структуры результата. На текущий момент `1`." }, "bank_verification_id": { "type": "string", "format": "uuid", "description": "ID этого результата." }, "node_id": { "type": "string", "description": "Узел сценария, к которому относится этот результат." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Expired" ], "description": "Вердикт шага после выполнения его действий и правил статуса." }, "original_status": { "type": "string", "nullable": true, "description": "Первый вердикт, вынесенный на шаге, до любых последующих изменений, таких как ручная проверка." }, "method": { "type": "string", "nullable": true, "enum": [ "open_banking", "account_lookup", "microdeposits", "statement", "none" ], "description": "Способ верификации счёта: `open_banking` (вход через банк: человек авторизовался в своём банке), `account_lookup` (проверка счёта: человек ввёл реквизиты счёта, и банк подтвердил имя), `microdeposits` или `statement` (загрузка банковской выписки). `none`, если человек продолжил без банка до оценки какой-либо попытки, поэтому ни один счёт не был верифицирован. После оцененной попытки сохраняется метод этой попытки. `null` до оценки счёта, а также когда сценарий ограничивает возвращаемые данные. Правила сценария читают то же значение, что и `bank.method`." }, "provider": { "type": "string", "nullable": true, "description": "Ключ маршрута, выполнившего подключение. Чтобы определить, как был проверен аккаунт, читайте `method`, а не этот ключ." }, "credential_source": { "type": "string", "nullable": true, "enum": [ "native", "byok" ], "description": "`native`: собственный маршрут Didit, списываемый с вашего баланса Didit. `byok`: провайдер маркетплейса, подключенный с использованием ваших собственных учетных данных." }, "route": { "type": "object", "nullable": true, "description": "Маршрут, выбранный до получения согласия. Впоследствии он никогда не меняется.", "properties": { "provider_key": { "type": "string", "nullable": true, "description": "Ключ маршрута." }, "credential_source": { "type": "string", "enum": [ "native", "byok" ] }, "is_fallback": { "type": "boolean", "description": "Использовался ли собственный маршрут Didit в качестве замены провайдера маркетплейса, который не смог подключиться." }, "provider_connection_id": { "type": "string", "nullable": true, "description": "Использованное подключение к маркетплейсу, для `byok`." }, "requested_scopes": { "type": "array", "items": { "type": "string" }, "description": "Данные, запрошенные подключением, например `ownership` или `balances`." } } }, "connection": { "type": "object", "nullable": true, "description": "Подключение последней попытки. `null` до первой попытки.", "properties": { "status": { "type": "string", "enum": [ "pending", "connected", "cancelled", "timeout", "failed", "unsupported", "revoked", "expired" ] }, "institution_id": { "type": "string", "nullable": true, "description": "Идентификатор банка. `null` для проверки счёта, если банк не выбран." }, "institution_name": { "type": "string", "nullable": true, "description": "Название банка. `null` для проверки счёта." }, "institution_country": { "type": "string", "nullable": true, "description": "Страна счёта, ISO 3166-1 alpha-3." }, "oauth": { "type": "boolean", "nullable": true, "description": "Выполнялся ли вход в банк через OAuth или по схеме app-to-app. `null` для проверки счёта." }, "connected_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда подключение прошло успешно." }, "consent_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда заканчивается банковское согласие, для входа через банк." }, "last_refreshed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда финансовые данные в последний раз считывались повторно." }, "attempts": { "type": "integer", "description": "Количество попыток, совершённых человеком на этом шаге, по всем методам суммарно." }, "reason_code": { "type": "string", "nullable": true, "description": "Причина, по которой подключение имеет статус, отличный от `connected`, например `USER_CANCELLED`, `INSTITUTION_DOWN`, `ACCOUNT_NOT_FOUND`, `REFERENCE_IDENTITY_MISSING` или `VERIFICATION_COMPLETED`." } } }, "account": { "type": "object", "nullable": true, "description": "Оцениваемый аккаунт. Имеет значение `null` до тех пор, пока аккаунт не будет оценён.", "properties": { "account_id_masked": { "type": "string", "nullable": true, "description": "Номер счёта, маскированный." }, "iban_masked": { "type": "string", "nullable": true, "description": "Маскированный IBAN." }, "sort_code": { "type": "string", "nullable": true, "description": "Код сортировки в Великобритании." }, "routing_number_masked": { "type": "string", "nullable": true, "description": "Маршрутизационный номер, маскированный." }, "type": { "type": "string", "nullable": true, "enum": [ "checking", "current", "savings", "business", "other" ] }, "subtype": { "type": "string", "nullable": true, "description": "Собственный подтип счёта, используемый банком." }, "currency": { "type": "string", "nullable": true, "description": "Валюта счёта по стандарту ISO 4217." }, "holder_type": { "type": "string", "nullable": true, "enum": [ "person", "business", "unknown" ] }, "holders_count": { "type": "integer", "nullable": true }, "is_joint": { "type": "boolean", "nullable": true }, "is_business": { "type": "boolean", "nullable": true } } }, "ownership": { "type": "object", "nullable": true, "description": "Результат сопоставления владельца счёта с подтверждённой личностью. `null` до тех пор, пока счёт не будет оценен.", "properties": { "result": { "type": "string", "enum": [ "match", "partial_match", "no_match", "unknown", "not_verifiable" ], "description": "`partial_match`: близкое совпадение. `not_verifiable`: банк ответил без указания владельца для сравнения. `unknown`: подтверждающие данные не удалось прочитать, либо не было данных личности для сравнения." }, "reference_identity_source": { "type": "string", "nullable": true, "description": "Шаг, с данными которого сравнивалась личность владельца: `kyc`, `database_validation`, `expected_details`, `questionnaire`, `document_ai` или `kyb`." }, "name_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "Оценка имени держателя от Didit." }, "provider_name_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "Собственная оценка совпадения имени владельца от банка, если она была возвращена." }, "address_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "Оценка адреса владельца, если выполнялось сопоставление адреса." }, "email_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "Оценка email владельца, если выполнялось сопоставление email." }, "phone_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "Оценка телефона владельца, если выполнялось сопоставление телефона." }, "dob_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "Оценка даты рождения владельца, если банк предоставил её." }, "close_match": { "type": "boolean", "nullable": true, "description": "Попало ли имя в диапазон близкого совпадения." }, "holder_confirmation": { "type": "string", "nullable": true, "enum": [ "pending", "confirmed", "rejected" ], "description": "Ответ человека на запрос подтверждения близкого совпадения имени. `null`, если запрос не отправлялся." }, "method": { "type": "string", "nullable": true, "enum": [ "exact", "token_set", "nickname", "transliteration", "fuzzy", "provider_only", "microdeposits" ], "description": "Какое сравнение имён сформировало оценку. Это не метод верификации: для него смотрите поле верхнего уровня `method`." }, "matched_holder_index": { "type": "integer", "nullable": true }, "holders": { "type": "array", "items": { "type": "object" }, "description": "Каждый владелец, указанный банком, с соответствующими оценками." }, "owner_identity_available": { "type": "boolean", "nullable": true }, "evidence_freshness": { "type": "string", "nullable": true, "enum": [ "live", "cached", "refreshed" ] }, "evaluated_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда было вычислено решение." } } }, "financial_data": { "type": "object", "description": "Финансовые данные, прочитанные шагом. Их считывает только вход через банк.", "properties": { "balances": { "type": "object", "nullable": true, "description": "С областью видимости `balances`." }, "transactions": { "type": "object", "nullable": true, "description": "С областью видимости `transactions`." }, "income": { "type": "object", "nullable": true, "description": "С областью видимости `income`." }, "categorization": { "type": "object", "nullable": true, "description": "Категоризация прочитанных транзакций от Didit. `null` при их отсутствии." }, "not_collected": { "type": "array", "items": { "type": "string", "enum": [ "balances", "income", "transactions" ] }, "description": "Данные, запрошенные шагом, которые не собираются методом, верифицировавшим счёт. Балансы, транзакции и доходы поступают только через банковскую авторизацию, поэтому для аккаунта, верифицированного проверкой счёта, они перечисляются здесь. Никогда не является ошибкой. В противном случае пусто." } } }, "billing": { "type": "object", "nullable": true, "properties": { "route": { "type": "string", "enum": [ "native", "byok" ] }, "billed": { "type": "boolean" }, "marketplace_fee": { "type": "string", "nullable": true, "description": "Списанная комиссия платформы маркетплейса, для `byok`." }, "usage_type": { "type": "string", "nullable": true, "description": "Строка использования, по которой было списано начисление: `bank_verification` для входа в банк или проверки счёта, `bank_statement_upload` для загрузки выписки без предшествующей тарифицируемой попытки входа в банк и `bank_byok_fee` для комиссии маркетплейса при использовании собственного провайдера. `null`, если ничего не было списано." } } }, "reference_identity": { "type": "object", "nullable": true, "description": "Личность, с которой сравнивался владелец, с указанием источника." }, "signals": { "type": "object", "nullable": true, "description": "Сигналы счёта, считанные из истории транзакций, если шаг считывал её." }, "connection_abandoned": { "type": "boolean", "nullable": true, "description": "Завершился ли шаг без совпадения после того, как пользователь покинул процесс на этапе своего банка." }, "not_covered": { "type": "boolean", "nullable": true, "description": "Были ли банк или страна пользователя недоступны на этом шаге. Также имеет значение `true`, если пользователь продолжил без банка, поскольку ни один метод не позволил верифицировать его страну или банк." }, "continued_without_bank": { "type": "boolean", "description": "Завершил ли пользователь шаг, нажав **Continue without your bank**. В таком случае `continuation` указывает причину. Параметр `method` равен `none`, если до продолжения не было оценено ни одной попытки. После оценённой попытки, например, при несовпадении владельца, `method` сохраняет метод этой попытки, а её вердикт и коды причин остаются в силе. Возвращается даже в том случае, если сценарий сужает возвращаемые данные." }, "continuation": { "type": "object", "nullable": true, "description": "Как пользователь продолжил без банка. `null`, если он этого не сделал. Когда сценарий ограничивает возвращаемые данные, `reason` всё равно возвращается, а все остальные ключи содержат `null`.", "properties": { "reason": { "type": "string", "enum": [ "no_route", "institution_unsupported", "attempts_exhausted", "person_choice" ], "description": "Причина, определённая Didit, когда пользователь продолжил: `no_route` (в его стране нет подходящего входа в банк или проверки счёта), `institution_unsupported` (выбранный банк не может использоваться на этом шаге), `attempts_exhausted` (все попытки уже исчерпаны и ни одна не выполняется) или `person_choice` (способ проверки был, но пользователь решил продолжить, в том числе когда банк был недоступен в данный момент). `no_route` и `institution_unsupported` следуют `bank_unsupported_action`, `attempts_exhausted` следует `bank_attempts_exhausted_action`, а `person_choice` следует `bank_skipped_action`, если только оценённая попытка уже не определила исход шага." }, "country": { "type": "string", "nullable": true, "description": "Страна, в которой человек проходил верификацию, в формате ISO 3166-1 alpha-3. `null`, если он продолжил до выбора страны." }, "offered": { "type": "array", "items": { "type": "string", "enum": [ "statement", "microdeposits" ] }, "nullable": true, "description": "Другие способы верификации, предложенные пользователю для этой страны при продолжении, в порядке их предложения: `statement` (загрузка выписки), затем `microdeposits`. Пусто, если ничего предложено не было." }, "institution_id": { "type": "string", "nullable": true, "description": "Для `institution_unsupported`, ID банка, которым человек не смог воспользоваться: банк, который он выбрал, или банк, на котором завершилась его последняя попытка. Didit берёт его из собственного списка банков и никогда с устройства человека, поэтому банк, отсутствующий в этом списке, равен `null`. `null` для любой другой причины." }, "institution_name": { "type": "string", "nullable": true, "description": "Для `institution_unsupported`: название этого банка из того же списка, что и `institution_id`. `null`, если банка нет в этом списке, а также для любой другой причины." }, "continued_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Время, когда пользователь продолжил действие." } } }, "evidence_purged_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда банковские подтверждения были удалены в соответствии с `bank_evidence_retention_days`. В остальных случаях `null`." }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "Информационные коды, например `holder_declared`. Предупреждение само по себе никогда не меняет статус." }, "reason_codes": { "type": "array", "items": { "type": "string" }, "description": "Почему вердикт оказался именно таким, например `OWNER_NAME_PARTIAL`. Может применяться несколько причин. `NOT_COVERED`: пользователь продолжил без банка, так как ни один метод не смог проверить его страну или банк. `SKIPPED`: пользователь решил продолжить без банка, хотя способ проверки был доступен. Ни одна из причин не добавляется, если оценённая попытка уже определила шаг." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "BankAccountCheckPersonHolder": { "type": "object", "description": "Человек, который должен быть владельцем аккаунта.", "required": [ "full_name" ], "properties": { "full_name": { "type": "string", "maxLength": 255, "description": "Полное имя лица, которое должно быть владельцем аккаунта.", "example": "Maria Oliveira" } } }, "BankAccountCheckBusinessHolder": { "type": "object", "description": "Компания, которой должен принадлежать счет. Проверяет бизнес-счет.", "required": [ "business_name" ], "properties": { "business_name": { "type": "string", "maxLength": 255, "description": "Название компании, которой должен принадлежать счет. Выполняет проверку корпоративного счета." } } }, "BankVerificationPricing": { "type": "object", "description": "Цены из публичного прейскуранта на банковскую верификацию: загрузка выписки, комиссия за собственный ключ провайдера и методы для каждой страны.", "required": [ "currency", "statement_upload", "own_provider_fee_usd", "countries" ], "properties": { "currency": { "type": "string", "enum": [ "USD" ], "description": "Валюта каждой цены в ответе.", "example": "USD" }, "statement_upload": { "$ref": "#/components/schemas/BankStatementUploadPricing" }, "own_provider_fee_usd": { "type": "string", "description": "Комиссия за каждую оплачиваемую проверку структуры владения по маршруту, использующему ваш собственный контракт с провайдером вместо контракта Didit; взимается независимо от результата. Отменённое, завершившееся по таймауту или прерванное подключение не тарифицируется. Десятичная строка с 4 знаками после запятой, в USD.", "example": "0.0200" }, "countries": { "type": "object", "description": "Каждая страна, с ключом по коду ISO 3166-1 alpha-3.", "additionalProperties": { "$ref": "#/components/schemas/BankVerificationPricingCountry" } } } }, "BankStatementUploadPricing": { "type": "object", "description": "Как тарифицируется загрузка выписки из банковского счёта.", "required": [ "price_usd", "included_after_charged_bank_attempt", "standalone_available" ], "properties": { "price_usd": { "type": "string", "description": "Цена загрузки выписки после платной попытки через банк. Десятичная строка с 4 знаками после запятой в USD.", "example": "0.0000" }, "included_after_charged_bank_attempt": { "type": "boolean", "description": "`true`, если загрузка включена без дополнительной платы после оплаченной попытки банковской проверки в той же сессии.", "example": true }, "standalone_available": { "type": "boolean", "description": "`true`, когда загрузка выписки может выполняться отдельно, без предварительной попытки через банк. `false` в продакшене; сессии в песочнице могут тестировать это без списания средств.", "example": false } } }, "BankVerificationPricingCountry": { "type": "object", "description": "Методы банковской верификации для одной страны и их цены по прайс-листу.", "required": [ "name", "methods" ], "properties": { "name": { "type": "string", "description": "Название страны на английском языке.", "example": "United Kingdom" }, "methods": { "$ref": "#/components/schemas/BankVerificationPricingMethods" } } }, "BankVerificationPricingMethods": { "type": "object", "description": "Два метода банковской верификации в стране.", "required": [ "open_banking", "account_lookup" ], "properties": { "open_banking": { "$ref": "#/components/schemas/BankSignInPricing" }, "account_lookup": { "$ref": "#/components/schemas/BankAccountCheckPricing" } } }, "BankSignInPricing": { "type": "object", "description": "Вход в банк: пользователь входит в свой банковский аккаунт. Цена зависит от рынка и одинакова для всех банков в нём.", "required": [ "available", "market", "price_usd", "add_ons" ], "properties": { "available": { "type": "boolean", "description": "`true` только в тех случаях, когда Didit поддерживает вход через банк в этой стране в продакшене.", "example": true }, "market": { "type": "string", "nullable": true, "description": "Рынок, чья цена применяется. `null`, если недоступно.", "example": "UK and EEA" }, "price_usd": { "type": "string", "nullable": true, "description": "Базовая цена одного входа в банк. `null`, если недоступно. Десятичная строка с 4 знаками после запятой, в USD.", "example": "0.7900" }, "add_ons": { "type": "object", "description": "Дополнительные опции с ценой для этой страны, каждая в виде десятичной строки с 4 знаками после запятой в USD, добавляемые к цене входа через банк. Перечислены только те опции, которые доступны в стране; пусто, если вход через банк недоступен.", "properties": { "balance": { "type": "string", "description": "Дополнение для баланса счёта.", "example": "0.3500" }, "transactions": { "type": "string", "description": "Дополнение «Транзакции».", "example": "1.3000" } } } } }, "BankAccountCheckPricing": { "type": "object", "description": "Проверка счёта: пользователь вводит номер своего счёта, и Didit проверяет его в банке. Цена зависит от страны.", "required": [ "available", "price_usd" ], "properties": { "available": { "type": "boolean", "description": "`true` только в тех случаях, когда Didit поддерживает проверку счёта в этой стране в продакшене.", "example": true }, "price_usd": { "type": "string", "nullable": true, "description": "Базовая цена одной проверки счёта, на которую отвечает банк. `null`, если недоступно. Десятичная строка с 4 знаками после запятой, в USD.", "example": "0.4000" } } }, "ImportProvider": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "sumsub", "jumio", "veriff", "onfido", "persona", "metamap", "socure", "idnow", "shufti", "idenfy", "ondato", "trulioo", "au10tix", "complycube", "other" ] }, "name": { "type": "string" }, "mode": { "type": "string", "enum": [ "api_list", "api_ids", "export_file" ], "description": "`api_list`: Didit выводит список записей с помощью ключа. `api_ids`: загрузить идентификаторы записей из экспорта. `export_file`: загрузить экспорт в формате Didit." }, "record_noun": { "type": "string" }, "credential_fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "secret": { "type": "boolean" } } } }, "regions": { "type": "array", "items": { "type": "string" } }, "required_permissions": { "type": "array", "items": { "type": "string" } }, "docs_url": { "type": "string", "nullable": true }, "status_mapping": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Expired", "Not Finished", "Abandoned" ] } } } }, "ImportJobSummary": { "type": "object", "description": "Одно задание импорта любого типа в формате, который считывает боковая панель заданий импорта в консоли.", "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "sessions", "businesses", "users", "status_rules", "transactions" ] }, "source": { "type": "string", "enum": [ "file", "api", "provider" ] }, "provider": { "type": "string", "nullable": true }, "provider_name": { "type": "string", "nullable": true }, "filename": { "type": "string", "nullable": true }, "state": { "type": "string", "enum": [ "ready", "queued", "running", "paused", "completed", "errors", "failed", "cancelled" ], "description": "Состояние задачи, как оно отображается в консоли; `errors` означает завершенную задачу с отклоненными строками." }, "status": { "type": "string" }, "is_dry_run": { "type": "boolean" }, "credential_hint": { "type": "string", "nullable": true }, "resumes_at": { "type": "string", "format": "date-time", "nullable": true }, "last_error": { "type": "string", "nullable": true }, "started_by": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } } }, "progress": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "processed": { "type": "integer", "format": "int64" }, "imported": { "type": "integer", "format": "int64" }, "updated": { "type": "integer", "format": "int64" }, "already_in_didit": { "type": "integer", "format": "int64" }, "failed": { "type": "integer", "format": "int64" }, "not_finished": { "type": "integer", "format": "int64" }, "same_person": { "type": "integer", "format": "int64" } } }, "face_templates": { "type": "object", "nullable": true, "properties": { "enabled": { "type": "boolean" }, "built": { "type": "integer", "format": "int64" }, "duplicates": { "type": "integer", "format": "int64" }, "blocklisted": { "type": "integer", "format": "int64" } } }, "eta_seconds": { "type": "integer", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "started_at": { "type": "string", "format": "date-time", "nullable": true }, "completed_at": { "type": "string", "format": "date-time", "nullable": true } } }, "FiledRegulatoryReport": { "type": "object", "description": "Завершённый регуляторный отчёт, препятствующий запрошенному удалению.", "required": [ "uuid", "report_number", "report_type", "case_uuid" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID отчёта." }, "report_number": { "type": "string", "description": "Номер отчёта, отображаемый в Console (например, SAR-0001)." }, "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ], "description": "Тип регуляторного отчёта." }, "case_uuid": { "type": "string", "format": "uuid", "description": "Кейс, к которому относится отчёт." } } }, "FiledReportTransaction": { "type": "object", "description": "Транзакция не может быть удалена, так как она включена в завершённый регуляторный отчёт.", "required": [ "uuid", "transaction_id", "reports" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID транзакции Didit." }, "transaction_id": { "type": "string", "description": "Идентификатор транзакции, переданный при ее создании." }, "reports": { "type": "array", "items": { "$ref": "#/components/schemas/FiledRegulatoryReport" }, "description": "Финализированные отчёты, содержащие эту транзакцию." } } }, "InFiledReportError": { "type": "object", "description": "В удалении отказано, поскольку выбранные данные включены в сформированный регуляторный отчёт. Ничего не удалено. Удалите отчёт, затем повторите запрос.", "required": [ "detail", "code" ], "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "in_filed_report" ], "description": "Постоянный код ошибки для удаления, заблокированного завершённым регуляторным отчётом." }, "reports": { "type": "array", "items": { "$ref": "#/components/schemas/FiledRegulatoryReport" }, "description": "Отчёты, блокирующие удаление лица, компании, кейса или сессии." }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/FiledReportTransaction" }, "description": "Транзакции, блокирующие удаление транзакции, каждая со списком отчётов, в которых она фигурирует." } } }, "SubjectDeletionInProgressError": { "type": "object", "description": "Другой запрос всё ещё удаляет это физическое лицо или компанию. Этот запрос ничего не удалил и может быть повторён после завершения того удаления; при повторе будет удалено всё, что осталось выбранным.", "required": [ "detail", "code" ], "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "subject_deletion_in_progress" ], "description": "Постоянный код ошибки для физического лица или компании, которых другой запрос всё ещё удаляет." } } }, "TravelRuleNetworkParticipantSummary": { "type": "object", "nullable": true, "description": "Собственный участник этого приложения в сети или null, если его нет.", "properties": { "mode": { "type": "string", "enum": [ "platform", "own" ], "description": "platform: передаётся через членство Didit; own: онбординг выполнен в рамках собственного членства приложения." }, "status": { "type": "string", "enum": [ "not_requested", "questionnaire_pending", "submitted_to_network", "active", "suspended", "rejected" ], "description": "not_requested: запрос никогда не отправлялся или сеть отклонила первый запрос (см. last_error); questionnaire_pending: ожидание одобрения анкеты комплексной проверки; submitted_to_network: передано на онбординг сети; active: сеть присвоила этому приложению собственный код участника; suspended / rejected: Didit приостановил или отклонил его." }, "participant_code": { "type": "string", "description": "Код, присвоенный сетью этому приложению (для GTR, его VASP-код). Исходящие сообщения содержат этот код, а не собственный код Didit." }, "requested_at": { "type": "string", "format": "date-time", "nullable": true }, "activated_at": { "type": "string", "format": "date-time", "nullable": true }, "last_error": { "type": "string", "description": "Ответ сети в случае отказа в регистрации; в остальных случаях пусто." } } }, "TravelRuleNetworkState": { "type": "object", "description": "Каким образом сообщения Travel Rule в одной сети отправлялись бы для этого приложения и почему они не могут быть отправлены. Статус конфигурации, а не проверка состояния или доставки в реальном времени.", "properties": { "rail": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA" ] }, "mode": { "type": "string", "enum": [ "own", "didit", "off", "unavailable" ], "description": "own: используется подключённое членство приложения; didit: членство Didit представляет приложение как своего собственного активного участника; off: маршрутизация платформы отключена в disabled_networks при отсутствии собственного членства; unavailable: в этой сети пока ничего нельзя отправить (см. state и reason)." }, "state": { "type": "string", "enum": [ "own_membership", "live_through_didit", "off", "didit_onboarding", "questionnaire_needed", "questionnaire_in_review", "request_access", "request_sent", "unavailable", "error" ], "description": "own_membership: отправка выполняется через ваше подключённое членство; live_through_didit: отправка выполняется через вашего собственного участника в рамках членства Didit; off: вы отключили маршрутизацию платформы; didit_onboarding: собственное членство Didit в этой сети ещё не активно, поэтому оно пока не может принимать участников; questionnaire_needed / questionnaire_in_review: анкету комплексной проверки необходимо отправить или она уже передана Didit; request_access: анкета одобрена, запросите доступ к сети; request_sent: выполняется онбординг вашего участника; unavailable: см. reason; error: см. reason." }, "reason": { "type": "string", "enum": [ "own_membership_connected", "platform_network_switched_off", "own_membership_only", "sandbox_application", "didit_membership_not_live", "participant_suspended", "participant_rejected", "questionnaire_not_submitted", "questionnaire_submitted", "questionnaire_changes_requested", "questionnaire_rejected", "participant_not_requested", "participant_active", "participant_key_missing", "participant_key_unresolved", "provisioning_failed", "questionnaire_pending", "submitted_to_network" ], "description": "Машиночитаемые подробности состояния. own_membership_only: Didit не размещает приложения в этой сети (TRUST), подключите собственное членство; sandbox_application: переводы в песочнице никогда не поступают в сеть; provisioning_failed: сеть отклонила регистрацию, last_error участника содержит причину, а повторный запрос к сети запускает новую попытку." }, "platform_available": { "type": "boolean", "description": "Настроено ли собственное участие Didit в этой сети; не является проверкой состояния в реальном времени." }, "connected": { "type": "boolean", "description": "Существует ли членство у подключённого клиента. Учётные данные проверяются локально; проверка в сети происходит на действующей бирже." }, "participant": { "$ref": "#/components/schemas/TravelRuleNetworkParticipantSummary" }, "vasps_reachable": { "type": "integer", "description": "VASP из каталога, доступные в этой сети." }, "routed_30d": { "type": "integer", "description": "Переводы этого приложения, проведённые в этой сети за последние 30 дней." } } }, "TravelRuleNetworkQuestionnaireAnswers": { "type": "object", "description": "Анкета комплексной проверки сети Didit. Сохранения частичные: при сохранении остаются все ответы, которые не указаны явно. Для отправки требуются все поля, кроме lei и data_protection_contact_email, а также значение true для трёх аттестаций.", "properties": { "legal_name": { "type": "string", "maxLength": 255 }, "registration_number": { "type": "string", "maxLength": 255 }, "incorporation_country": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Двухбуквенный код страны ISO 3166-1 alpha-2." }, "registered_address": { "type": "string", "maxLength": 1000 }, "website": { "type": "string", "format": "uri", "maxLength": 500 }, "lei": { "type": "string", "maxLength": 20, "description": "Необязательно. Действительный LEI по стандарту ISO 17442 при указании." }, "licences": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "regulator", "jurisdiction", "licence_type", "licence_number" ], "properties": { "regulator": { "type": "string", "maxLength": 255 }, "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Двухбуквенный код страны ISO 3166-1 alpha-2." }, "licence_type": { "type": "string", "maxLength": 255 }, "licence_number": { "type": "string", "maxLength": 255 } } }, "description": "Каждая лицензия или регистрация, имеющаяся у VASP." }, "operating_jurisdictions": { "type": "array", "minItems": 1, "maxItems": 250, "items": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Двухбуквенный код страны ISO 3166-1 alpha-2." } }, "compliance_officer_name": { "type": "string", "maxLength": 255 }, "compliance_officer_email": { "type": "string", "format": "email" }, "aml_ctf_policy_attested": { "type": "boolean", "description": "Для отправки должно быть true." }, "sanctions_screening_attested": { "type": "boolean", "description": "Для отправки должно быть true." }, "data_protection_attested": { "type": "boolean", "description": "Для отправки должно быть true." }, "data_protection_contact_email": { "type": "string", "format": "email", "description": "Необязательно." }, "expected_monthly_transfers": { "type": "integer", "minimum": 0 }, "expected_monthly_volume_usd": { "type": "string", "format": "decimal", "description": "Ожидаемый ежемесячный объём в USD с точностью до 2 знаков после запятой. Возвращается в виде строки." }, "assets": { "type": "array", "minItems": 1, "maxItems": 200, "items": { "type": "string", "maxLength": 32 }, "description": "Тикеры активов, сохранённые в верхнем регистре, отсортированные и без дубликатов." } } }, "TravelRuleNetworkQuestionnaire": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "draft", "submitted", "changes_requested", "approved", "rejected" ], "description": "Ответы можно сохранять в статусах draft или changes_requested; статусы submitted, approved и rejected устанавливает Didit." }, "answers": { "$ref": "#/components/schemas/TravelRuleNetworkQuestionnaireAnswers" }, "submitted_at": { "type": "string", "format": "date-time", "nullable": true }, "reviewed_at": { "type": "string", "format": "date-time", "nullable": true }, "review_note": { "type": "string", "description": "Примечание Didit к последнему решению, например, что необходимо изменить." }, "history": { "type": "array", "readOnly": true, "description": "Каждое изменение статуса, начиная с самых старых.", "items": { "type": "object", "properties": { "at": { "type": "string", "format": "date-time" }, "from": { "type": "string" }, "to": { "type": "string" }, "note": { "type": "string", "description": "Примечание к проверке или ответ сети, если он есть." } } } }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } }, "TravelRuleNetworkParticipant": { "type": "object", "description": "Собственный участник этого приложения в одной сети.", "properties": { "network": { "type": "string", "enum": [ "gtr", "trust", "verifyvasp", "sygna" ] }, "rail": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA" ] }, "mode": { "type": "string", "enum": [ "platform", "own" ] }, "status": { "type": "string", "enum": [ "not_requested", "questionnaire_pending", "submitted_to_network", "active", "suspended", "rejected" ], "description": "not_requested: запрос никогда не отправлялся или сеть отклонила первый запрос (см. last_error); questionnaire_pending: ожидание одобрения анкеты комплексной проверки; submitted_to_network: передано на онбординг сети; active: сеть присвоила этому приложению собственный код участника; suspended / rejected: Didit приостановил или отклонил его." }, "participant_code": { "type": "string" }, "requested_at": { "type": "string", "format": "date-time", "nullable": true }, "submitted_at": { "type": "string", "format": "date-time", "nullable": true }, "activated_at": { "type": "string", "format": "date-time", "nullable": true }, "suspended_at": { "type": "string", "format": "date-time", "nullable": true }, "last_error": { "type": "string", "description": "Ответ сети в случае отказа в регистрации; в остальных случаях пусто." }, "history": { "type": "array", "readOnly": true, "description": "Каждое изменение статуса, начиная с самых старых.", "items": { "type": "object", "properties": { "at": { "type": "string", "format": "date-time" }, "from": { "type": "string" }, "to": { "type": "string" }, "note": { "type": "string", "description": "Примечание к проверке или ответ сети, если он есть." } } } } } }, "TravelRuleNetworksOverview": { "type": "object", "properties": { "platform_networks_enabled": { "type": "boolean", "description": "Открыт ли доступ к сети через членство Didit. Пока значение false, сохранение анкет, их отправка и сетевые запросы возвращают код 403." }, "questionnaire": { "$ref": "#/components/schemas/TravelRuleNetworkQuestionnaire" }, "participants": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleNetworkParticipant" } }, "networks": { "type": "object", "readOnly": true, "description": "По каждой сети: как это приложение будет отправлять данные и почему оно не может этого сделать. Ни одна сеть, включая GTR, не подключена по умолчанию: сеть доступна через ваше собственное подключённое членство или через членство Didit, когда членство Didit в этой сети активировано и ваш собственный участник в ней активен. Не является проверкой состояния или доставки в реальном времени.", "properties": { "gtr": { "$ref": "#/components/schemas/TravelRuleNetworkState" }, "trust": { "$ref": "#/components/schemas/TravelRuleNetworkState" }, "verifyvasp": { "$ref": "#/components/schemas/TravelRuleNetworkState" }, "sygna": { "$ref": "#/components/schemas/TravelRuleNetworkState" } } } } }, "AddressValidationResult": { "type": "object", "description": "Результат одной проверки Address Validation: существует ли адрес и его нормализованная форма. Подтверждается только адрес; он никогда не привязывается к человеку.", "required": [ "status", "verification_level", "address", "formatted_address", "latitude", "longitude" ], "properties": { "status": { "type": "string", "enum": [ "verified", "partially_verified", "not_verified", "unavailable" ], "description": "`verified`: адрес подтверждён с точностью до здания (или квартиры, или абонентского ящика). `partially_verified`: адрес подтверждён только до улицы либо до максимального уровня точности, доступного в почтовых справочных данных для этой местности. `not_verified`: совпал только регион или город, либо ничего не совпало. `unavailable`: проверку не удалось выполнить (например, справочный сервис не ответил); плата за неё не взимается, и она никак не влияет на верификацию." }, "verification_level": { "type": "string", "nullable": true, "enum": [ "administrative_area", "locality", "thoroughfare", "premise", "delivery_point", null ], "description": "Наиболее точный уровень, на котором совпал адрес. `null`, если совпадений нет или `status` имеет значение `unavailable`." }, "address": { "type": "object", "nullable": true, "description": "Нормализованный адрес. `null`, если `status` равен `unavailable`.", "properties": { "address_line_1": { "type": "string", "nullable": true, "description": "Первая строка адреса доставки в формате, принятом в данной стране.", "example": "1600 Amphitheatre Pkwy" }, "address_line_2": { "type": "string", "nullable": true, "description": "Вторая строка адреса доставки (квартира, здание или район), если она есть в адресе." }, "city": { "type": "string", "nullable": true, "example": "Mountain View" }, "region": { "type": "string", "nullable": true, "description": "Штат, провинция или регион.", "example": "CA" }, "postal_code": { "type": "string", "nullable": true, "example": "94043-1351" }, "country": { "type": "string", "nullable": true, "description": "Двухбуквенный код страны ISO 3166-1 alpha-2.", "example": "US" } } }, "formatted_address": { "type": "string", "nullable": true, "description": "Нормализованный адрес в одну строку.", "example": "1600 Amphitheatre Pkwy, Mountain View CA 94043-1351" }, "latitude": { "type": "number", "nullable": true, "example": 37.422022 }, "longitude": { "type": "number", "nullable": true, "example": -122.08429 } } }, "AddressValidationRequest": { "type": "object", "required": [ "country" ], "description": "Один адрес: в одну строку (`address`) или в виде структурированных полей как минимум с `address_line_1`, но никогда оба варианта одновременно.", "properties": { "address": { "type": "string", "maxLength": 500, "description": "Полный адрес одной строкой.", "example": "Paseo de la Castellana 259, 28046 Madrid" }, "address_line_1": { "type": "string", "maxLength": 255, "description": "Улица и номер дома.", "example": "1600 Amphitheatre Pkwy" }, "address_line_2": { "type": "string", "maxLength": 255, "description": "Квартира, номер офиса/помещения, этаж или здание." }, "city": { "type": "string", "maxLength": 128, "description": "Город или населённый пункт.", "example": "Mountain View" }, "region": { "type": "string", "maxLength": 128, "description": "Штат, провинция или регион.", "example": "CA" }, "postal_code": { "type": "string", "maxLength": 32, "example": "94043" }, "country": { "type": "string", "maxLength": 3, "description": "Двух- или трехбуквенный код страны адреса по стандарту ISO 3166-1 (alpha-2 или alpha-3).", "example": "US" } } }, "AddressValidationResponse": { "type": "object", "required": [ "request_id", "address_validation", "created_at" ], "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Идентификатор этого запроса; укажите его при обращении в поддержку. Сессия не создаётся." }, "address_validation": { "$ref": "#/components/schemas/AddressValidationResult" }, "created_at": { "type": "string", "format": "date-time" } } }, "TravelRuleWalletProofFailureReason": { "type": "string", "enum": [ "", "SIGNATURE_INVALID", "SIGNATURE_UNSUPPORTED_SCHEME", "DEPOSIT_NOT_FOUND", "DEPOSIT_UNCONFIRMED", "DEPOSIT_LOOKUP_FAILED", "DEPOSIT_MISMATCH", "DEPOSIT_STALE", "TXID_REUSED", "CHAIN_UNSUPPORTED", "WINDOW_EXPIRED", "OWNERSHIP_CHANGED", "METHOD_SWITCHED", "REVIEW_REJECTED", "ABANDONED" ], "description": "Причина, по которой подтверждение владения кошельком или его последняя попытка не получили статус VERIFIED. Пусто, если сбоев не было. Статус PENDING может содержать причину: последняя попытка не удалась, и конечный пользователь может попробовать снова. Значения DEPOSIT_MISMATCH, DEPOSIT_STALE, TXID_REUSED и REVIEW_REJECTED переводят подтверждение в статус REJECTED. SIGNATURE_INVALID: подпись не соответствует кошельку и запросу (вызов). SIGNATURE_UNSUPPORTED_SCHEME: кошелёк подписал данные в формате, который Didit не проверяет. DEPOSIT_NOT_FOUND, DEPOSIT_UNCONFIRMED, DEPOSIT_LOOKUP_FAILED: тестовый депозит не удаётся прочитать или он ещё не подтверждён; Didit продолжает проверку до закрытия окна тестирования. DEPOSIT_MISMATCH: транзакция не отправляет ожидаемую сумму с кошелька на адрес депозита. DEPOSIT_STALE: транзакция была совершена до вызова. TXID_REUSED: транзакция уже использовалась для подтверждения другого кошелька. CHAIN_UNSUPPORTED: метод недоступен в этом блокчейне. WINDOW_EXPIRED: окно тестирования истекло. OWNERSHIP_CHANGED: владелец кошелька изменился или кошелёк был удалён из адресной книги после создания сессии виджета. METHOD_SWITCHED: конечный пользователь выбрал другой метод до завершения текущего. REVIEW_REJECTED: проверяющий отклонил скриншот. ABANDONED: время сессии виджета истекло до завершения конечным пользователем." }, "TravelRuleWidgetProofError": { "type": "object", "properties": { "detail": { "type": "string", "description": "Понятное сообщение на английском языке." }, "code": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleWalletProofFailureReason" } ], "description": "Машиночитаемая причина, позволяющая клиенту отобразить собственное переведённое сообщение." }, "status": { "type": "string", "enum": [ "PENDING", "VERIFIED", "REJECTED", "EXPIRED" ], "description": "Присутствует, когда подтверждение закрыто: REJECTED только что отправленным депозитом (400), либо REJECTED или EXPIRED, когда доказательство отправлено для уже закрытого подтверждения (409)." }, "proof_id": { "type": "string", "format": "uuid", "description": "Присутствует со статусом: закрытое подтверждение." }, "method": { "type": "string", "enum": [ "MESSAGE_SIGNING", "SATOSHI_TEST", "SCREENSHOT", "SELF_DECLARATION" ], "description": "Присутствует со статусом: метод закрытого подтверждения." }, "max_attempts": { "type": "integer", "description": "Присутствует со статусом: отклонённые подтверждения кошелька, разрешённые в этой сессии." }, "attempts_used": { "type": "integer", "description": "Присутствует со статусом: отклонённые подтверждения на данный момент." }, "attempts_remaining": { "type": "integer", "description": "Присутствует со статусом: когда значение равно 0, запуск другого подтверждения возвращает 409 и вам нужно выпустить новую сессию виджета." } } }, "TravelRuleWidgetProofCreate": { "type": "object", "required": [ "method" ], "properties": { "method": { "type": "string", "enum": [ "MESSAGE_SIGNING", "SATOSHI_TEST", "SCREENSHOT", "SELF_DECLARATION" ], "description": "Метод подтверждения, выбранный конечным пользователем. Он должен входить в allowed_methods контекста." }, "wallet_address": { "type": "string", "maxLength": 128, "description": "По умолчанию соответствует wallet_address сессии. Должен совпадать с кошельком перевода, если сессия привязана к переводу." }, "chain": { "type": "string", "maxLength": 32, "description": "По умолчанию соответствует блокчейну сессии." } } }, "TravelRuleWidgetProofVerifyResult": { "type": "object", "properties": { "proof_id": { "type": "string", "format": "uuid" }, "method": { "type": "string", "enum": [ "MESSAGE_SIGNING", "SATOSHI_TEST", "SCREENSHOT", "SELF_DECLARATION" ] }, "status": { "type": "string", "enum": [ "PENDING", "VERIFIED", "REJECTED", "EXPIRED" ] }, "is_ownership_verified": { "type": "boolean", "description": "Присутствует, когда подтверждение находится в статусе VERIFIED: владение записью в адресной книге теперь подтверждено." }, "transfer_status": { "type": "string", "nullable": true, "description": "Присутствует, когда подтверждение находится в статусе VERIFIED: статус связанного перевода, null при его отсутствии." }, "detail": { "type": "string", "description": "Присутствует, пока подтверждение остаётся в статусе PENDING: отправленный скриншот, ожидающий проверки, или тестовый депозит, который ещё не подтверждён." }, "code": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleWalletProofFailureReason" } ], "description": "Присутствует для тестового депозита в статусе ожидания: причина, по которой он ещё не подтверждён." } } }, "TravelRuleWalletProofReview": { "type": "object", "properties": { "proof_id": { "type": "string", "format": "uuid" }, "method": { "type": "string", "enum": [ "SCREENSHOT" ] }, "status": { "type": "string", "enum": [ "PENDING", "VERIFIED", "REJECTED", "EXPIRED" ] }, "wallet_address": { "type": "string" }, "chain": { "type": "string", "description": "Канонический идентификатор сети, например ETH, BTC, SOL, TRX." }, "holder_name": { "type": "string" }, "is_ownership_verified": { "type": "boolean", "description": "Подтверждено ли владение записью в адресной книге с помощью этого или другого подтверждения." }, "transaction_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Транзакция, для перевода Travel Rule которой была создана сессия виджета. Null для сессии, созданной без transaction_id." }, "file_name": { "type": "string", "nullable": true }, "content_type": { "type": "string", "nullable": true }, "screenshot_url": { "type": "string", "nullable": true, "description": "Ссылка с ограниченным сроком действия на загруженный скриншот. Запросите список очереди повторно, чтобы обновить ссылку." }, "attempts": { "type": "integer", "description": "Сколько файлов загрузил конечный пользователь для этого подтверждения." }, "failure_reason": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleWalletProofFailureReason" } ], "description": "REVIEW_REJECTED после отклонения, OWNERSHIP_CHANGED при смене владельца кошелька или его удалении до принятия решения. В остальных случаях пусто." }, "method_chosen_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда конечный пользователь выбрал метод создания снимка экрана." }, "decided_at": { "type": "string", "format": "date-time", "nullable": true }, "decided_by": { "type": "string", "description": "Кто закрыл подтверждение: review: для проверяющего из консоли, review для решения по API-ключу, widget или sweeper, если Didit закрыл его автоматически. Пусто, пока статус PENDING." }, "review_note": { "type": "string", "description": "Заметка, отправленная вместе с решением. Пусто, если заметка отсутствует." }, "created_at": { "type": "string", "format": "date-time" } } }, "TravelRuleWalletProofDecision": { "type": "object", "required": [ "decision" ], "properties": { "decision": { "type": "string", "enum": [ "approve", "reject" ] }, "note": { "type": "string", "maxLength": 512, "description": "Необязательно. Сохраняется вместе с подтверждением и возвращается как review_note." } } }, "DigitalIdWalletApiWalletDigitalCredentialsRequest": { "type": "object", "properties": { "protocol": { "type": "string", "description": "openid4vp-v1-signed." }, "request": { "type": "object", "additionalProperties": {}, "description": "Передайте как есть: navigator.credentials.get({digital: request}) в браузере или JSON.stringify(request) как requestJson для GetDigitalCredentialOption на Android. Подписано Didit для вашего приложения." } }, "required": [ "protocol", "request" ] }, "DigitalIdWalletApiGoogleWalletWalletVerificationStartRequest": { "type": "object", "description": "Запустить верификацию через Google Wallet (USA, GBR, BRA, SGP, TWN).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiGoogleWalletWalletVerificationStartCountryEnum" } ], "description": "Код страны ISO 3166-1 alpha-3 для удостоверения Google Wallet.\n\n* `USA` - USA\n* `GBR` - GBR\n* `BRA` - BRA\n* `SGP` - SGP\n* `TWN` - TWN" }, "origin": { "type": "string", "minLength": 1, "description": "Откуда ваша страница или приложение будут запрашивать кошелёк: https origin вашей страницы (её хост должен входить в allowed_return_hosts приложения или являться его доменом White label), например https://app.example.com, либо android:apk-key-hash:. В любом другом месте кошелёк отклонит запрос.", "maxLength": 256 } }, "required": [ "country", "origin" ] }, "DigitalIdWalletApiGoogleWalletWalletVerificationStartCountryEnum": { "enum": [ "USA", "GBR", "BRA", "SGP", "TWN" ], "type": "string", "description": "* `USA` - USA\n* `GBR` - GBR\n* `BRA` - BRA\n* `SGP` - SGP\n* `TWN` - TWN" }, "DigitalIdWalletApiWalletDigitalCredentialResponseRequest": { "type": "object", "description": "Ответ, который кошелёк вернул вашей странице или приложению при верификации ``request_digital_credential``.", "properties": { "response": { "type": "object", "additionalProperties": {}, "description": "В точности то, что вернул кошелёк: {protocol, data} объекта DigitalCredential из navigator.credentials.get или распарсенный credentialJson объекта DigitalCredential Android. Зашифровано для Didit; не изменяйте это значение." } }, "required": [ "response" ] }, "SessionFilesExport": { "type": "object", "description": "Один ZIP-архив со всеми файлами сессии в исходном качестве.", "required": [ "export_id", "session_id", "status", "file_count", "size_bytes", "download_url", "expires_at", "error", "created_at", "completed_at" ], "properties": { "export_id": { "type": "string", "format": "uuid", "description": "ID экспорта. Передайте его в `GET /v3/session/{sessionId}/files-export/{exportId}/`." }, "session_id": { "type": "string", "format": "uuid", "description": "Сессия, из которой получены файлы." }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "READY", "FAILED", "EXPIRED" ], "description": "`PENDING` и `PROCESSING` во время подготовки ZIP-архива, `READY`, как только его можно скачать, `FAILED`, если не удалось подготовить (запросите новый экспорт), `EXPIRED` после удаления ZIP-архива." }, "file_count": { "type": "integer", "nullable": true, "description": "Файлы в архиве ZIP. Задаётся только пока `status` равен `READY`." }, "size_bytes": { "type": "integer", "format": "int64", "nullable": true, "description": "Размер ZIP-архива в байтах. Заполняется только пока `status` равен `READY`." }, "download_url": { "type": "string", "format": "uri", "nullable": true, "description": "Подписанный URL-адрес ZIP-архива, действующий в течение короткого времени. Заполняется только пока `status` равен `READY`; для получения нового запросите экспорт повторно." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда ZIP-архив удаляется, через 24 часа после готовности. Задаётся только пока `status` имеет значение `READY`." }, "error": { "type": "string", "nullable": true, "description": "Причина сбоя экспорта, если `status` имеет значение `FAILED`." }, "created_at": { "type": "string", "format": "date-time", "description": "Когда был запрошен экспорт." }, "completed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Когда ZIP-архив был готов или экспорт завершился ошибкой." } } }, "TransactionRuleSuggestionsCreatedEvent": { "description": "Запуск механизма предложений правил для транзакций сформировал новые изменения правил для вашего приложения. Отправляется, если в настройках предложений правил включены webhook-уведомления. Поле верхнего уровня `status` отсутствует.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope" }, { "type": "object", "properties": { "webhook_type": { "type": "string", "enum": [ "transaction_rule_suggestions.created" ], "description": "Всегда `transaction_rule_suggestions.created`." }, "run_id": { "type": "string", "format": "uuid", "description": "Запуск генерации предложений, создавший новые предложения." }, "open_count": { "type": "integer", "description": "Количество предложений, остающихся открытыми после этого запуска, включая новые." }, "suggestions": { "type": "array", "description": "Предложения, созданные этим запуском.", "items": { "type": "object", "required": [ "suggestion_id", "kind", "title", "rule_id", "expected_impact" ], "properties": { "suggestion_id": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "ADD", "TWEAK", "DISABLE" ], "description": "`ADD` предлагает новое правило, `TWEAK` изменяет существующее, `DISABLE` отключает правило." }, "title": { "type": "string" }, "rule_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Правило, к которому относится предложение `TWEAK` или `DISABLE`; `null` для `ADD`." }, "expected_impact": { "type": "object", "additionalProperties": true, "description": "Что сделает изменение, как это отображается в предложении в Console." } } } } }, "required": [ "webhook_type", "run_id", "open_count", "suggestions" ] } ] }, "GeolocationCheck": { "type": "object", "description": "Один результат проверки местоположения, принятая попытка одного узла сценария. Измерение, погрешность и подлинность находятся в отдельных ключах, поэтому точное неподтверждённое определение местоположения отличается от неточного подтверждённого.", "properties": { "node_id": { "type": "string", "nullable": true, "description": "Узел сценария, создавший этот результат, благодаря чему сценарий с двумя шагами проверки местоположения остаётся понятным." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Статус этого шага верификации местоположения на уровне функции, определённый на основе его предупреждений. Не зависит от `status` сессии." }, "outcome": { "type": "string", "nullable": true, "description": "Что произошло во время этой попытки.", "enum": [ "verified", "low_accuracy", "accuracy_undetermined", "stale", "approximate", "denied", "restricted", "unavailable", "timeout", "mock_detected", "outside_geofence", "in_blocked_area", "anonymizer_detected", "skipped", "replay_rejected", "unsupported_client", null ] }, "permission": { "type": "string", "nullable": true, "description": "Что предоставила операционная система или браузер. `not_requested` означает, что шаг использует только IP-геолокацию подключения, поэтому у пользователя никогда не запрашивается разрешение.", "enum": [ "granted_precise", "granted_approximate", "denied", "restricted", "unavailable", "timeout", "dismissed", "not_requested", null ] }, "latitude": { "type": "number", "nullable": true, "description": "Широта точки фиксации по WGS84. `null`, если точка не определена.", "format": "double" }, "longitude": { "type": "number", "nullable": true, "description": "Долгота точки фиксации по WGS84. `null`, если точка не определена.", "format": "double" }, "accuracy_m": { "type": "number", "nullable": true, "description": "Радиус неопределённости в метрах при уровне уверенности, указанном в `accuracy_confidence`.", "format": "double" }, "accuracy_confidence": { "type": "string", "nullable": true, "description": "Уровень уверенности, который платформа присваивает `accuracy_m`: `p95` (браузеры), `p68` (Android) или `unspecified` (iOS).", "enum": [ "p95", "p68", "unspecified", null ] }, "measured_at": { "type": "string", "nullable": true, "description": "Когда устройство определило координаты, по своим внутренним часам.", "format": "date-time" }, "age_seconds": { "type": "integer", "nullable": true, "description": "Количество секунд между фиксацией координат устройством и их получением Didit." }, "source": { "type": "string", "nullable": true, "description": "Источник определения местоположения, если платформа его указывает. `ip` означает, что местоположение определено по IP-адресу подключения.", "enum": [ "gps", "fused", "network", "wifi", "cell", "browser", "unknown", "ip", null ] }, "platform": { "type": "string", "nullable": true, "description": "Клиент, создавший исправление.", "enum": [ "web", "ios", "android", "react_native", "flutter", null ] }, "sdk_version": { "type": "string", "nullable": true, "description": "Версия SDK, сформировавшего исправление." }, "is_mock": { "type": "boolean", "nullable": true, "description": "`true`, если устройство сообщает, что координаты получены от поставщика фиктивного местоположения или ПО для симуляции. `null`, если платформа об этом не сообщает (браузеры не могут это определить); `null` не эквивалентно `false`." }, "produced_by_accessory": { "type": "boolean", "nullable": true, "description": "Только для iOS: `true`, если данные позиционирования получены от внешнего аксессуара. В остальных случаях `null`." }, "integrity": { "type": "string", "enum": [ "attested", "not_attested", "failed", "unsupported", "not_determined" ], "description": "Подтверждено ли исправление аттестацией устройства. Браузеры возвращают значение `unsupported`, поскольку в веб-среде нет механизма аттестации; это не является ошибкой." }, "country_code": { "type": "string", "nullable": true, "description": "Код страны по стандарту ISO 3166-1 alpha-2, в которой находится точка фиксации." }, "region_code": { "type": "string", "nullable": true, "description": "Подразделение по ISO 3166-2, в котором находится геопозиция." }, "city": { "type": "string", "nullable": true, "description": "Ближайший населённый пункт, метка для проверяющих." }, "geofence": { "type": "object", "description": "Результат применения правил шага для страны и региона.", "properties": { "enabled": { "type": "boolean", "description": "Применяет ли шаг какое-либо правило для страны или региона." }, "result": { "type": "string", "nullable": true, "description": "Положение позиции относительно правил. Значение `undetermined` означает, что круг погрешности пересекает границу или позиция не сопоставлена ни с одной страной; это не свидетельствует о нахождении за пределами территории.", "enum": [ "inside", "outside", "undetermined", null ] } } }, "inside_geofence": { "type": "boolean", "nullable": true, "description": "`true`, когда `geofence.result` имеет значение `inside`, `false`, когда `outside`, иначе `null`." }, "geofence_basis": { "type": "string", "nullable": true, "description": "По какому местоположению оценивался результат для зоны: по координатам `device` или по локации соединения по `ip`.", "enum": [ "device", "ip", null ] }, "inside_areas": { "type": "array", "items": { "type": "string" }, "description": "Идентификаторы настроенных разрешённых зон, внутри которых находится позиция." }, "blocked_areas": { "type": "array", "items": { "type": "string" }, "description": "Идентификаторы настроенных заблокированных зон, в которых находится позиция." }, "position_source": { "type": "string", "nullable": true, "description": "Откуда шаг берет данные о местоположении в соответствии с настройками: данные устройства, сверенные с местоположением по IP, только данные устройства или только местоположение по IP.", "enum": [ "device_and_ip", "device_only", "ip_only", null ] }, "anonymizers": { "type": "object", "nullable": true, "description": "Характеристики подключения и устройства: каждое со значением `true`, `false` или `null`, если источник не может это определить.", "properties": { "vpn": { "type": "boolean", "nullable": true }, "proxy": { "type": "boolean", "nullable": true }, "tor": { "type": "boolean", "nullable": true }, "spoofing": { "type": "boolean", "nullable": true }, "emulator": { "type": "boolean", "nullable": true } } }, "ip_distance_km": { "type": "number", "nullable": true, "description": "Расстояние до IP-локации сессии за вычетом обоих радиусов неопределённости; `0`, если они перекрываются.", "format": "double" }, "ip_distance_uncertainty_km": { "type": "number", "nullable": true, "description": "Объединённый радиус, который был вычтен: радиус местоположения по IP плюс точность этой координаты.", "format": "double" }, "ip_consistent": { "type": "boolean", "nullable": true, "description": "Находится ли `ip_distance_km` в пределах расстояния, настроенного на шаге. `null`, если хотя бы одна из сторон неизвестна." }, "document_distance_km": { "type": "number", "nullable": true, "description": "Расстояние до геокодированного адреса из документа, удостоверяющего личность, или подтверждения адреса. `null`, если адрес в профиле отсутствует.", "format": "double" }, "travel_excused": { "type": "boolean", "nullable": true, "description": "Было ли расстояние от адреса признано допустимым благодаря допуску на перемещение для шага. Значение `null`, если допуск отключён." }, "consecutive_mismatches": { "type": "integer", "nullable": true, "description": "При финальной попытке: эта проверка плюс предыдущие несовпадения того же человека подряд." }, "attempts": { "type": "integer", "description": "Номер этой попытки в пределах узла, начиная с 1." }, "consent": { "type": "object", "nullable": true, "description": "Согласие, данное человеком перед системным промптом, записанное с версией формулировки и языком, которые он видел.", "properties": { "accepted_at": { "type": "string", "format": "date-time" }, "version": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true } } }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "feature": { "type": "string", "enum": [ "ID_VERIFICATION", "NFC", "LIVENESS", "FACEMATCH", "PROOF_OF_ADDRESS", "PHONE", "EMAIL", "AML", "LOCATION", "DATABASE_VALIDATION", "QUESTIONNAIRE", "DOCUMENT_AI", "KYB_REGISTRY", "KYB_DOCUMENTS", "KYB_KEY_PEOPLE", "GEOLOCATION", "SIGNATURE" ], "description": "Функция, сгенерировавшая это предупреждение. Значение определяет блок функции, к которому относится предупреждение. Массив предупреждений каждого модуля обычно использует значение, соответствующее его модулю (например, `PHONE` внутри `phone_verifications[].warnings`), однако перечисление выше является определяющим для всех предупреждений функций в payload решения." }, "risk": { "type": "string" }, "additional_data": { "type": "object", "nullable": true }, "log_type": { "type": "string" }, "short_description": { "type": "string" }, "long_description": { "type": "string" }, "node_id": { "type": "string", "description": "Идентификатор узла графа сценария, сгенерировавшего это предупреждение" } } }, "description": "Предупреждения, сформированные на этом шаге верификации местоположения, с параметром `feature`, равным `GEOLOCATION`. Коды предупреждений начинаются с `LOCATION_`." } } }, "GeolocationAttempt": { "type": "object", "description": "Одна попытка шага проверки местоположения: те же ключи, что и в `geolocation_checks[]`, за исключением `warnings`, а также время, когда Didit получил эту попытку.", "properties": { "node_id": { "type": "string", "nullable": true, "description": "Узел сценария, создавший этот результат, благодаря чему сценарий с двумя шагами проверки местоположения остаётся понятным." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Статус этого шага верификации местоположения на уровне функции, определённый на основе его предупреждений. Не зависит от `status` сессии." }, "outcome": { "type": "string", "nullable": true, "description": "Что произошло во время этой попытки.", "enum": [ "verified", "low_accuracy", "accuracy_undetermined", "stale", "approximate", "denied", "restricted", "unavailable", "timeout", "mock_detected", "outside_geofence", "in_blocked_area", "anonymizer_detected", "skipped", "replay_rejected", "unsupported_client", null ] }, "permission": { "type": "string", "nullable": true, "description": "Что предоставила операционная система или браузер. `not_requested` означает, что шаг использует только IP-геолокацию подключения, поэтому у пользователя никогда не запрашивается разрешение.", "enum": [ "granted_precise", "granted_approximate", "denied", "restricted", "unavailable", "timeout", "dismissed", "not_requested", null ] }, "latitude": { "type": "number", "nullable": true, "description": "Широта точки фиксации по WGS84. `null`, если точка не определена.", "format": "double" }, "longitude": { "type": "number", "nullable": true, "description": "Долгота точки фиксации по WGS84. `null`, если точка не определена.", "format": "double" }, "accuracy_m": { "type": "number", "nullable": true, "description": "Радиус неопределённости в метрах при уровне уверенности, указанном в `accuracy_confidence`.", "format": "double" }, "accuracy_confidence": { "type": "string", "nullable": true, "description": "Уровень уверенности, который платформа присваивает `accuracy_m`: `p95` (браузеры), `p68` (Android) или `unspecified` (iOS).", "enum": [ "p95", "p68", "unspecified", null ] }, "measured_at": { "type": "string", "nullable": true, "description": "Когда устройство определило координаты, по своим внутренним часам.", "format": "date-time" }, "age_seconds": { "type": "integer", "nullable": true, "description": "Количество секунд между фиксацией координат устройством и их получением Didit." }, "source": { "type": "string", "nullable": true, "description": "Источник определения местоположения, если платформа его указывает. `ip` означает, что местоположение определено по IP-адресу подключения.", "enum": [ "gps", "fused", "network", "wifi", "cell", "browser", "unknown", "ip", null ] }, "platform": { "type": "string", "nullable": true, "description": "Клиент, создавший исправление.", "enum": [ "web", "ios", "android", "react_native", "flutter", null ] }, "sdk_version": { "type": "string", "nullable": true, "description": "Версия SDK, сформировавшего исправление." }, "is_mock": { "type": "boolean", "nullable": true, "description": "`true`, если устройство сообщает, что координаты получены от поставщика фиктивного местоположения или ПО для симуляции. `null`, если платформа об этом не сообщает (браузеры не могут это определить); `null` не эквивалентно `false`." }, "produced_by_accessory": { "type": "boolean", "nullable": true, "description": "Только для iOS: `true`, если данные позиционирования получены от внешнего аксессуара. В остальных случаях `null`." }, "integrity": { "type": "string", "enum": [ "attested", "not_attested", "failed", "unsupported", "not_determined" ], "description": "Подтверждено ли исправление аттестацией устройства. Браузеры возвращают значение `unsupported`, поскольку в веб-среде нет механизма аттестации; это не является ошибкой." }, "country_code": { "type": "string", "nullable": true, "description": "Код страны по стандарту ISO 3166-1 alpha-2, в которой находится точка фиксации." }, "region_code": { "type": "string", "nullable": true, "description": "Подразделение по ISO 3166-2, в котором находится геопозиция." }, "city": { "type": "string", "nullable": true, "description": "Ближайший населённый пункт, метка для проверяющих." }, "geofence": { "type": "object", "description": "Результат применения правил шага для страны и региона.", "properties": { "enabled": { "type": "boolean", "description": "Применяет ли шаг какое-либо правило для страны или региона." }, "result": { "type": "string", "nullable": true, "description": "Положение позиции относительно правил. Значение `undetermined` означает, что круг погрешности пересекает границу или позиция не сопоставлена ни с одной страной; это не свидетельствует о нахождении за пределами территории.", "enum": [ "inside", "outside", "undetermined", null ] } } }, "inside_geofence": { "type": "boolean", "nullable": true, "description": "`true`, когда `geofence.result` имеет значение `inside`, `false`, когда `outside`, иначе `null`." }, "geofence_basis": { "type": "string", "nullable": true, "description": "По какому местоположению оценивался результат для зоны: по координатам `device` или по локации соединения по `ip`.", "enum": [ "device", "ip", null ] }, "inside_areas": { "type": "array", "items": { "type": "string" }, "description": "Идентификаторы настроенных разрешённых зон, внутри которых находится позиция." }, "blocked_areas": { "type": "array", "items": { "type": "string" }, "description": "Идентификаторы настроенных заблокированных зон, в которых находится позиция." }, "position_source": { "type": "string", "nullable": true, "description": "Откуда шаг берет данные о местоположении в соответствии с настройками: данные устройства, сверенные с местоположением по IP, только данные устройства или только местоположение по IP.", "enum": [ "device_and_ip", "device_only", "ip_only", null ] }, "anonymizers": { "type": "object", "nullable": true, "description": "Характеристики подключения и устройства: каждое со значением `true`, `false` или `null`, если источник не может это определить.", "properties": { "vpn": { "type": "boolean", "nullable": true }, "proxy": { "type": "boolean", "nullable": true }, "tor": { "type": "boolean", "nullable": true }, "spoofing": { "type": "boolean", "nullable": true }, "emulator": { "type": "boolean", "nullable": true } } }, "ip_distance_km": { "type": "number", "nullable": true, "description": "Расстояние до IP-локации сессии за вычетом обоих радиусов неопределённости; `0`, если они перекрываются.", "format": "double" }, "ip_distance_uncertainty_km": { "type": "number", "nullable": true, "description": "Объединённый радиус, который был вычтен: радиус местоположения по IP плюс точность этой координаты.", "format": "double" }, "ip_consistent": { "type": "boolean", "nullable": true, "description": "Находится ли `ip_distance_km` в пределах расстояния, настроенного на шаге. `null`, если хотя бы одна из сторон неизвестна." }, "document_distance_km": { "type": "number", "nullable": true, "description": "Расстояние до геокодированного адреса из документа, удостоверяющего личность, или подтверждения адреса. `null`, если адрес в профиле отсутствует.", "format": "double" }, "travel_excused": { "type": "boolean", "nullable": true, "description": "Было ли расстояние от адреса признано допустимым благодаря допуску на перемещение для шага. Значение `null`, если допуск отключён." }, "consecutive_mismatches": { "type": "integer", "nullable": true, "description": "При финальной попытке: эта проверка плюс предыдущие несовпадения того же человека подряд." }, "attempts": { "type": "integer", "description": "Номер этой попытки в пределах узла, начиная с 1." }, "consent": { "type": "object", "nullable": true, "description": "Согласие, данное человеком перед системным промптом, записанное с версией формулировки и языком, которые он видел.", "properties": { "accepted_at": { "type": "string", "format": "date-time" }, "version": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true } } }, "received_at": { "type": "string", "nullable": true, "description": "Когда Didit получил попытку.", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" } } }, "BiometricRetention": { "type": "object", "description": "Время удаления активных биометрических данных этой сессии.", "required": [ "jurisdictions", "deletes_at" ], "properties": { "jurisdictions": { "type": "array", "items": { "type": "string" }, "description": "Коды штатов США, чьи биометрические правила устанавливают лимит на удаление для этого человека (`US`, если штат неизвестен). Пусто, если ни одно из правил не применяется." }, "deletes_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Дата удаления активных биометрических данных (изображений лиц и шаблонов) этой сессии в соответствии с настройками хранения вашего приложения и юридическим лимитом юрисдикции этого лица, если он применим. `null`, если дата ещё не применима." } } }, "TravelRuleManualMatchRequest": { "type": "object", "required": [ "transaction_id" ], "properties": { "transaction_id": { "type": "string", "format": "uuid", "description": "Идентификатор `transaction_id` полученного сообщения Travel Rule (строка с `kind: message`)." } } }, "TravelRuleManualMatchResponse": { "type": "object", "required": [ "deposit", "message" ], "properties": { "deposit": { "$ref": "#/components/schemas/TravelRuleTransferRow" }, "message": { "$ref": "#/components/schemas/TravelRuleTransferRow" } } } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "x-api-key", "description": "API-ключ вашего приложения из раздела «Разработчикам» -> «API-ключи» в Business Console. Основной ключ имеет полный доступ. Именованный ключ может иметь ограниченную область действия: без доступа, чтение или запись для каждого ресурса, ограничение определенными сценариями или одобренными сессиями, списком IP-адресов и сроком действия. 401 означает, что ключ неверен, отозван или его срок действия истек; 403 означает, что ключ не был передан, у ключа нет доступа к этому ресурсу или действию, либо запрос поступил с адреса вне его списка IP-адресов; 404 на маршруте сессии означает, что сессия не входит в сценарии или статусы ключа. Ключ без доступа к медиа получает URL изображений, видео и PDF как null, а ключ без прав на запись сессий получает ссылки на сессии и токены как null. См. https://docs.didit.me/console/api-keys." }, "TransactionTokenAuth": { "type": "apiKey", "in": "header", "name": "X-Transaction-Token", "description": "Краткосрочный токен с ограниченной областью действия, сгенерированный вашим бэкендом через POST /v3/transactions/sdk-token/. Используется SDK Didit на endpoints /v1/transactions/, предназначенных для взаимодействия с устройством." }, "SessionTokenAuth": { "type": "apiKey", "in": "header", "name": "Session-Token", "description": "Временный токен, возвращаемый в поле `session_token` запроса POST /v3/session/. Используется размещённым процессом верификации (и кастомными интерфейсами песочницы) для вызова endpoint’ов сессии от имени верифицируемого пользователя без использования вашего серверного API-ключа." }, "BearerAuth": { "type": "http", "scheme": "bearer", "description": "Токен доступа приложения, полученный по учётным данным клиента." }, "CaseRequestToken": { "type": "apiKey", "in": "header", "name": "X-Case-Request-Token", "description": "Учётные данные для конкретного запроса из защищённой ссылки. Предоставляют доступ только к этому запросу." } }, "responses": { "Unauthorized": { "description": "Не авторизован", "content": { "application/json": { "examples": { "Invalid API Key": { "summary": "Недействительный API-ключ", "value": { "detail": "Invalid API Key." } } } } } }, "Forbidden": { "description": "Запрещено", "content": { "application/json": { "examples": { "No Permission": { "summary": "Нет разрешения", "value": { "detail": "You do not have permission to perform this action." } }, "Not Enough Credits": { "summary": "Недостаточно кредитов", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "NotFound": { "description": "Не найдено", "content": { "application/json": { "examples": { "Not Found": { "summary": "Не найдено", "value": { "detail": "Resource not found." } } } } } }, "PhoneRiskValidationError": { "description": "Ошибка валидации запроса.", "content": { "application/json": { "examples": { "Missing phone number": { "summary": "Отсутствует номер телефона", "value": { "phone_number": [ "This field is required." ] } }, "Invalid phone number": { "summary": "Недопустимый номер телефона", "value": { "phone_number": [ "Invalid phone number provided." ] } }, "Invalid signal IP": { "summary": "Недопустимый IP-адрес сигнала", "value": { "signals": { "ip": [ "Enter a valid IPv4 or IPv6 address." ] } } } } } } }, "EmailRiskValidationError": { "description": "Ошибка валидации запроса.", "content": { "application/json": { "examples": { "Missing email": { "summary": "Отсутствует адрес электронной почты", "value": { "email": [ "This field is required." ] } }, "Invalid email": { "summary": "Недопустимый адрес электронной почты", "value": { "email": [ "Enter a valid email address." ] } }, "Invalid country hint": { "summary": "Недопустимая подсказка страны", "value": { "country_code": [ "Ensure this field has no more than 3 characters." ] } } } } } }, "IPRiskValidationError": { "description": "Ошибка валидации запроса.", "content": { "application/json": { "examples": { "Missing IP address": { "summary": "Отсутствует IP-адрес", "value": { "ip_address": [ "This field is required." ] } }, "Invalid IP address": { "summary": "Недопустимый IP-адрес", "value": { "ip_address": [ "Enter a valid IPv4 or IPv6 address." ] } }, "Country hint too long": { "summary": "Подсказка страны слишком длинная", "value": { "claimed_country": [ "Ensure this field has no more than 3 characters." ] } } } } } }, "RiskPermissionDenied": { "description": "API-ключ отсутствует или недействителен, либо организация не может покрыть проверку в реальном времени. Этот API никогда не возвращает `401`.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Отсутствует заголовок `x-api-key`, либо ключ недействителен или отозван", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "Баланс организации недостаточен для оплаты цены поиска", "value": { "error": "You don't have enough credits to perform this request." } } } } } }, "RateLimitedWrite": { "description": "Превышен общий лимит на запись в 300 запросов в минуту на один API-ключ. Подождите время, указанное в `Retry-After`, перед повторной попыткой.", "content": { "application/json": { "schema": { "type": "object", "required": [ "detail" ], "properties": { "detail": { "type": "string" } } }, "example": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } }, "AddressValidationValidationError": { "description": "Тело запроса недействительно: отсутствует или неизвестно поле `country`, отсутствует адрес, либо переданы одновременно `address` и структурированные поля.", "content": { "application/json": { "examples": { "Unknown country": { "value": { "country": [ "Use an ISO 3166-1 alpha-2 or alpha-3 country code, e.g. 'US' or 'USA'." ] } }, "No address": { "value": { "address": [ "Send the address: 'address' on one line, or the structured fields with 'address_line_1'." ] } }, "Both shapes": { "value": { "address": [ "Send either 'address' or the structured fields (address_line_1, ...), not both." ] } } } } } }, "AddressValidationPermissionDenied": { "description": "API-ключ отсутствует или недействителен, у ключа с ограниченной областью видимости отсутствует доступ на запись `sessions`, либо организация не может покрыть валидацию. Этот API никогда не возвращает `401`.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "value": { "detail": "You don't have enough credits to perform this request. Please top up at https://business.didit.me", "code": "insufficient_credits" } } } } } }, "DocumentProcessingBusy": { "description": "В данный момент обрабатывается слишком много документов, поэтому эта загрузка не была обработана: ничего не сохранено, и попытка не была использована. Отправьте тот же файл повторно через количество секунд, указанное в `Retry-After`. Выполняйте ветвление по `code`, а не по тексту сообщения.", "headers": { "Retry-After": { "description": "Количество секунд ожидания перед повторной отправкой того же запроса.", "schema": { "type": "integer", "example": 10 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "detail", "code" ], "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "document_processing_busy" ] } } }, "example": { "detail": "We are busy processing documents. Please try again in a moment.", "code": "document_processing_busy" } } } } }, "parameters": { "WebhookSignature": { "name": "X-Signature", "in": "header", "required": true, "schema": { "type": "string" }, "description": "HMAC-SHA256 в виде шестнадцатеричной строки в нижнем регистре, вычисленный с использованием секрета адреса назначения в качестве ключа от точного исходного тела запроса." }, "WebhookSignatureV2": { "name": "X-Signature-V2", "in": "header", "required": true, "schema": { "type": "string" }, "description": "HMAC-SHA256 в виде шестнадцатеричной строки в нижнем регистре с использованием секрета адреса назначения в качестве ключа для канонического JSON тела запроса (ключи отсортированы, без пробелов, символы, отличные от ASCII, не экранированы). Рекомендуется к использованию, так как сохраняет валидность при прохождении через промежуточное ПО, выполняющее повторное кодирование тела запроса." }, "WebhookSignatureSimple": { "name": "X-Signature-Simple", "in": "header", "required": true, "deprecated": true, "schema": { "type": "string" }, "description": "HMAC-SHA256 в виде шестнадцатеричной строки в нижнем регистре с использованием секрета адреса назначения в качестве ключа для `{timestamp}:{session_id}:{status}:{webhook_type}` (пропущенные поля передаются как пустые строки). Охватывает только конверт, никогда не включает сам payload." }, "WebhookTimestamp": { "name": "X-Timestamp", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Unix-время в секундах, равное `timestamp` из тела запроса. Отклоняйте доставки старше нескольких минут." } } }, "x-webhooks": { "status.updated": { "post": { "summary": "Статус сессии изменён", "description": "Сессия верификации изменила статус. `decision` отправляется только для `Approved`, `Declined`, `In Review` и `Abandoned`; для адресов назначения с версией webhook 3 (по умолчанию) оно имеет структуру `GET /v3/session/{sessionId}/decision/`, а для адресов назначения версий 1 или 2 имеет устаревшую сокращённую структуру. Сессии верификации бизнеса всегда получают решение для бизнеса версии 3.", "tags": [ "Webhook" ], "parameters": [ { "$ref": "#/components/parameters/WebhookSignature" }, { "$ref": "#/components/parameters/WebhookSignatureV2" }, { "$ref": "#/components/parameters/WebhookSignatureSimple" }, { "$ref": "#/components/parameters/WebhookTimestamp" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionStatusUpdatedEvent" } } } }, "responses": { "2XX": { "description": "Любой ответ 2xx подтверждает доставку. При других ответах и таймаутах выполняется повторная попытка; см. https://docs.didit.me/integration/webhooks." } } } }, "data.updated": { "post": { "summary": "Данные сессии изменены", "description": "Данные сессии верификации изменились без смены статуса, например после правки при ручной проверке, переопределения шага или повторного скрининга при постоянном мониторинге. `decision` отправляется только для `Approved`, `Declined`, `In Review` и `Abandoned`; имеет структуру `GET /v3/session/{sessionId}/decision/` для адресов назначения с версией webhook 3 (по умолчанию) и более раннюю сокращённую структуру для адресов с версиями 1 или 2. Корпоративные сессии всегда получают бизнес-решение версии 3.", "tags": [ "Webhook" ], "parameters": [ { "$ref": "#/components/parameters/WebhookSignature" }, { "$ref": "#/components/parameters/WebhookSignatureV2" }, { "$ref": "#/components/parameters/WebhookSignatureSimple" }, { "$ref": "#/components/parameters/WebhookTimestamp" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionDataUpdatedEvent" } } } }, "responses": { "2XX": { "description": "Любой ответ 2xx подтверждает доставку. При других ответах и таймаутах выполняется повторная попытка; см. https://docs.didit.me/integration/webhooks." } } } }, "user.status.updated": { "post": { "summary": "Статус пользователя изменён", "description": "Пользователь изменил статус. Не отправляется при создании пользователя.", "tags": [ "Webhook" ], "parameters": [ { "$ref": "#/components/parameters/WebhookSignature" }, { "$ref": "#/components/parameters/WebhookSignatureV2" }, { "$ref": "#/components/parameters/WebhookSignatureSimple" }, { "$ref": "#/components/parameters/WebhookTimestamp" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserStatusUpdatedEvent" } } } }, "responses": { "2XX": { "description": "Любой ответ 2xx подтверждает доставку. При других ответах и таймаутах выполняется повторная попытка; см. https://docs.didit.me/integration/webhooks." } } } }, "user.data.updated": { "post": { "summary": "Данные пользователя изменены", "description": "Поля пользователя изменены. Не отправляется при создании пользователя. Одно сохранение может вызвать событие как статуса, так и данных.", "tags": [ "Webhook" ], "parameters": [ { "$ref": "#/components/parameters/WebhookSignature" }, { "$ref": "#/components/parameters/WebhookSignatureV2" }, { "$ref": "#/components/parameters/WebhookSignatureSimple" }, { "$ref": "#/components/parameters/WebhookTimestamp" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDataUpdatedEvent" } } } }, "responses": { "2XX": { "description": "Любой ответ 2xx подтверждает доставку. При других ответах и таймаутах выполняется повторная попытка; см. https://docs.didit.me/integration/webhooks." } } } }, "business.status.updated": { "post": { "summary": "Статус компании изменён", "description": "Статус компании изменился. Не отправляется при создании компании.", "tags": [ "Webhook" ], "parameters": [ { "$ref": "#/components/parameters/WebhookSignature" }, { "$ref": "#/components/parameters/WebhookSignatureV2" }, { "$ref": "#/components/parameters/WebhookSignatureSimple" }, { "$ref": "#/components/parameters/WebhookTimestamp" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessStatusUpdatedEvent" } } } }, "responses": { "2XX": { "description": "Любой ответ 2xx подтверждает доставку. При других ответах и таймаутах выполняется повторная попытка; см. https://docs.didit.me/integration/webhooks." } } } }, "business.data.updated": { "post": { "summary": "Данные компании изменены", "description": "Поля компании изменены. Не отправляется при создании компании. Одно сохранение может вызвать событие как статуса, так и данных.", "tags": [ "Webhook" ], "parameters": [ { "$ref": "#/components/parameters/WebhookSignature" }, { "$ref": "#/components/parameters/WebhookSignatureV2" }, { "$ref": "#/components/parameters/WebhookSignatureSimple" }, { "$ref": "#/components/parameters/WebhookTimestamp" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessDataUpdatedEvent" } } } }, "responses": { "2XX": { "description": "Любой ответ 2xx подтверждает доставку. При других ответах и таймаутах выполняется повторная попытка; см. https://docs.didit.me/integration/webhooks." } } } }, "transaction.created": { "post": { "summary": "Транзакция создана", "description": "Транзакция была создана и проверена. Отправляется только для продакшн-приложений.", "tags": [ "Webhook" ], "parameters": [ { "$ref": "#/components/parameters/WebhookSignature" }, { "$ref": "#/components/parameters/WebhookSignatureV2" }, { "$ref": "#/components/parameters/WebhookSignatureSimple" }, { "$ref": "#/components/parameters/WebhookTimestamp" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionCreatedEvent" } } } }, "responses": { "2XX": { "description": "Любой ответ 2xx подтверждает доставку. При других ответах и таймаутах выполняется повторная попытка; см. https://docs.didit.me/integration/webhooks." } } } }, "transaction.status.updated": { "post": { "summary": "Статус транзакции изменён", "description": "Транзакция изменила статус в результате срабатывания правила, ручной проверки или действия конечного пользователя. Отправляется только для продакшн-приложений.", "tags": [ "Webhook" ], "parameters": [ { "$ref": "#/components/parameters/WebhookSignature" }, { "$ref": "#/components/parameters/WebhookSignatureV2" }, { "$ref": "#/components/parameters/WebhookSignatureSimple" }, { "$ref": "#/components/parameters/WebhookTimestamp" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionStatusUpdatedEvent" } } } }, "responses": { "2XX": { "description": "Любой ответ 2xx подтверждает доставку. При других ответах и таймаутах выполняется повторная попытка; см. https://docs.didit.me/integration/webhooks." } } } }, "travel_rule.status.updated": { "post": { "summary": "Статус Travel Rule изменён", "description": "Обмен Travel Rule изменил статус. Отправляется при каждом переходе вплоть до `FINISHED`, `CANCELLED` или `EXPIRED` включительно, но никогда после. Отправляется для приложений в продакшн-среде и, для обменов Travel Rule, также для приложений в песочнице (`environment: sandbox`). Поле `status` верхнего уровня отсутствует.", "tags": [ "Webhook" ], "parameters": [ { "$ref": "#/components/parameters/WebhookSignature" }, { "$ref": "#/components/parameters/WebhookSignatureV2" }, { "$ref": "#/components/parameters/WebhookSignatureSimple" }, { "$ref": "#/components/parameters/WebhookTimestamp" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleStatusUpdatedEvent" } } } }, "responses": { "2XX": { "description": "Любой ответ 2xx подтверждает доставку. При других ответах и таймаутах выполняется повторная попытка; см. https://docs.didit.me/integration/webhooks." } } } }, "workflow.compliance_changed": { "post": { "summary": "Комплаенс сценария изменён", "description": "Комплаенс-статус опубликованного сценария изменился после повторной оценки. Одно событие на сценарий. Статус верхнего уровня `status` отсутствует.", "tags": [ "Webhook" ], "parameters": [ { "$ref": "#/components/parameters/WebhookSignature" }, { "$ref": "#/components/parameters/WebhookSignatureV2" }, { "$ref": "#/components/parameters/WebhookSignatureSimple" }, { "$ref": "#/components/parameters/WebhookTimestamp" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowComplianceChangedEvent" } } } }, "responses": { "2XX": { "description": "Любой ответ 2xx подтверждает доставку. При других ответах и таймаутах выполняется повторная попытка; см. https://docs.didit.me/integration/webhooks." } } } }, "kyb.registry_search.resolved": { "post": { "summary": "Поиск компании завершён (неподписанный обратный вызов)", "description": "Тело обратного вызова, отправляемого на `webhook_url` эндпоинта `POST /v3/kyb/search/` после завершения поиска в реестре. Оно не подписано: запрос содержит заголовок `X-Didit-Unsigned-Callback: true` и не содержит заголовков подписи, поэтому подтверждайте его путем сопоставления `request_id` с запущенным вами поиском. Использует `event_type`, а не `webhook_type`.", "tags": [ "Webhook" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KYBRegistrySearchResolvedCallback" } } } }, "responses": { "2XX": { "description": "Любой ответ 2xx подтверждает доставку. При других ответах и таймаутах выполняется повторная попытка; см. https://docs.didit.me/integration/webhooks." } } } }, "transaction_rule_suggestions.created": { "post": { "summary": "Созданы предложения правил для транзакций", "description": "Запуск механизма предложений правил для транзакций сформировал новые изменения правил для вашего приложения. Отправляется, если в настройках предложений правил включены webhook-уведомления. Поле верхнего уровня `status` отсутствует.", "tags": [ "Webhook" ], "parameters": [ { "$ref": "#/components/parameters/WebhookSignature" }, { "$ref": "#/components/parameters/WebhookSignatureV2" }, { "$ref": "#/components/parameters/WebhookSignatureSimple" }, { "$ref": "#/components/parameters/WebhookTimestamp" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleSuggestionsCreatedEvent" } } } }, "responses": { "2XX": { "description": "Любой ответ 2xx подтверждает доставку. При других ответах и таймаутах выполняется повторная попытка; см. https://docs.didit.me/integration/webhooks." } } } } } }