Список политик
GET/v1/policies
Параметры
| Поле | Тип | Обязательно |
|---|---|---|
cursorзапрос | string | нет |
limitзапрос | integer | нет |
Ответы
200PolicyList400401403404409412413415422428429503
Справочник API
Политики
Политики решений: черновики, проверка, публикация, версии и различия.
Создать политику
POST/v1/policies
Тело запросаPolicyCreate
| Поле | Тип | Обязательно |
|---|---|---|
name | string | да |
purpose | string | да |
country_codes | array of string | да |
required_checksemail_signal is a low-assurance signal and is not allowed here. pep_screening and adverse_media_screening are optional checks only. | array of enum: document_ocr, document_authenticity, document_presence, document_status, face_match, face_pad, capture_integrity, nfc_integrity, ... | да |
optional_checksemail_signal is allowed only here; its fail and inconclusive do not block approval. pep_screening and adverse_media_screening are allowed only here: provider unavailability does not block approval, an unresolved potential match does until it is resolved. | array of enum: document_ocr, document_authenticity, document_presence, document_status, face_match, face_pad, capture_integrity, nfc_integrity, ... | нет |
legal_profile_id | string (uuid) | да |
retention_profile_id | string (uuid) | да |
ruleset_id | string (uuid) | да |
screening_profile_id | string (uuid) | нет |
calibration_profile_ids | array of string (uuid) | да |
allow_manual_review | boolean | да |
allow_reuse | boolean | да |
kyb_profile | KybProfile | нет |
previous_version_idPolicy version this version derives from (same tenant). Versions linked this way form one lineage. | string (uuid) | нет |
require_second_reviewApprove and reject resolutions of manual review need an approval of another identity (ReviewResolve.approval_id). | boolean | нет |
Ответы
201Policy400401403404409412413415422428429503
Получить политику
GET/v1/policies/{policy_id}
Параметры
| Поле | Тип | Обязательно |
|---|---|---|
policy_idпуть | string (uuid) | да |
Ответы
200Policy400401403404409412413415422428429503
Изменить черновик политики
PUT/v1/policies/{policy_id}
Параметры
| Поле | Тип | Обязательно |
|---|---|---|
policy_idпуть | string (uuid) | да |
Тело запросаPolicyCreate
| Поле | Тип | Обязательно |
|---|---|---|
name | string | да |
purpose | string | да |
country_codes | array of string | да |
required_checksemail_signal is a low-assurance signal and is not allowed here. pep_screening and adverse_media_screening are optional checks only. | array of enum: document_ocr, document_authenticity, document_presence, document_status, face_match, face_pad, capture_integrity, nfc_integrity, ... | да |
optional_checksemail_signal is allowed only here; its fail and inconclusive do not block approval. pep_screening and adverse_media_screening are allowed only here: provider unavailability does not block approval, an unresolved potential match does until it is resolved. | array of enum: document_ocr, document_authenticity, document_presence, document_status, face_match, face_pad, capture_integrity, nfc_integrity, ... | нет |
legal_profile_id | string (uuid) | да |
retention_profile_id | string (uuid) | да |
ruleset_id | string (uuid) | да |
screening_profile_id | string (uuid) | нет |
calibration_profile_ids | array of string (uuid) | да |
allow_manual_review | boolean | да |
allow_reuse | boolean | да |
kyb_profile | KybProfile | нет |
previous_version_idPolicy version this version derives from (same tenant). Versions linked this way form one lineage. | string (uuid) | нет |
require_second_reviewApprove and reject resolutions of manual review need an approval of another identity (ReviewResolve.approval_id). | boolean | нет |
Ответы
200Policy400401403404409412413415422428429503
Проверить политику
POST/v1/policies/{policy_id}/validate
Параметры
| Поле | Тип | Обязательно |
|---|---|---|
policy_idпуть | string (uuid) | да |
Ответы
200ValidationResult400401403404409412413415422428429503
Опубликовать политику
POST/v1/policies/{policy_id}/publish
Параметры
| Поле | Тип | Обязательно |
|---|---|---|
policy_idпуть | string (uuid) | да |
Тело запросаPublishRequest
| Поле | Тип | Обязательно |
|---|---|---|
approval_id | string (uuid) | да |
resource_sha256 | string | да |
reason_code | string | да |
Ответы
200Policy400401403404409412413415422428429503
Наборы тестовых сценариев
GET/v1/fixture-manifests
Platform fixture manifests for SimulationCreate (synthetic scenarios, no personal data).
Параметры
| Поле | Тип | Обязательно |
|---|---|---|
cursorзапрос | string | нет |
limitзапрос | integer | нет |
Ответы
200FixtureManifestList400401403404409412413415422428429503
Версии политики
GET/v1/policies/{policy_id}/versions
All versions of the lineage of this policy (linked by previous_version_id), newest first.
Параметры
| Поле | Тип | Обязательно |
|---|---|---|
policy_idпуть | string (uuid) | да |
cursorзапрос | string | нет |
limitзапрос | integer | нет |
Ответы
200PolicyList400401403404409412413415422428429503
Различия версий политики
GET/v1/policies/{policy_id}/diff
Параметры
| Поле | Тип | Обязательно |
|---|---|---|
policy_idпуть | string (uuid) | да |
againstзапросVersion to compare with; default previous_version_id of the policy. | string (uuid) | нет |
Ответы
200PolicyDiff400401403404409412413415422428429503
Профили политик
GET/v1/policy-profiles
Legal basis and retention profiles of the tenant and calibration profiles of released models, for legal_profile_id, retention_profile_id and calibration_profile_ids.
Параметры
| Поле | Тип | Обязательно |
|---|---|---|
kindзапросbasis or retention: tenant legal profiles of this kind; calibration: calibration profiles of released models (one page); absent: basis and retention profiles. | enum: basis, retention, calibration | нет |
cursorзапрос | string | нет |
limitзапрос | integer | нет |
Ответы
200PolicyProfileList400401403404409412413415422428429503