List policies
GET/v1/policies
Parameters
| Field | Type | Required |
|---|---|---|
cursorquery | string | no |
limitquery | integer | no |
Responses
200PolicyList400401403404409412413415422428429503
API reference
Policies
Decision policies: drafts, validation, publishing, versions and diffs.
Create a policy
POST/v1/policies
Request bodyPolicyCreate
| Field | Type | Required |
|---|---|---|
name | string | yes |
purpose | string | yes |
country_codes | array of string | yes |
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, ... | yes |
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, ... | no |
legal_profile_id | string (uuid) | yes |
retention_profile_id | string (uuid) | yes |
ruleset_id | string (uuid) | yes |
screening_profile_id | string (uuid) | no |
calibration_profile_ids | array of string (uuid) | yes |
allow_manual_review | boolean | yes |
allow_reuse | boolean | yes |
kyb_profile | KybProfile | no |
previous_version_idPolicy version this version derives from (same tenant). Versions linked this way form one lineage. | string (uuid) | no |
require_second_reviewApprove and reject resolutions of manual review need an approval of another identity (ReviewResolve.approval_id). | boolean | no |
Responses
201Policy400401403404409412413415422428429503
Get a policy
GET/v1/policies/{policy_id}
Parameters
| Field | Type | Required |
|---|---|---|
policy_idpath | string (uuid) | yes |
Responses
200Policy400401403404409412413415422428429503
Update a policy draft
PUT/v1/policies/{policy_id}
Parameters
| Field | Type | Required |
|---|---|---|
policy_idpath | string (uuid) | yes |
Request bodyPolicyCreate
| Field | Type | Required |
|---|---|---|
name | string | yes |
purpose | string | yes |
country_codes | array of string | yes |
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, ... | yes |
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, ... | no |
legal_profile_id | string (uuid) | yes |
retention_profile_id | string (uuid) | yes |
ruleset_id | string (uuid) | yes |
screening_profile_id | string (uuid) | no |
calibration_profile_ids | array of string (uuid) | yes |
allow_manual_review | boolean | yes |
allow_reuse | boolean | yes |
kyb_profile | KybProfile | no |
previous_version_idPolicy version this version derives from (same tenant). Versions linked this way form one lineage. | string (uuid) | no |
require_second_reviewApprove and reject resolutions of manual review need an approval of another identity (ReviewResolve.approval_id). | boolean | no |
Responses
200Policy400401403404409412413415422428429503
Validate a policy
POST/v1/policies/{policy_id}/validate
Parameters
| Field | Type | Required |
|---|---|---|
policy_idpath | string (uuid) | yes |
Responses
200ValidationResult400401403404409412413415422428429503
Publish a policy
POST/v1/policies/{policy_id}/publish
Parameters
| Field | Type | Required |
|---|---|---|
policy_idpath | string (uuid) | yes |
Request bodyPublishRequest
| Field | Type | Required |
|---|---|---|
approval_id | string (uuid) | yes |
resource_sha256 | string | yes |
reason_code | string | yes |
Responses
200Policy400401403404409412413415422428429503
List fixture manifests
GET/v1/fixture-manifests
Platform fixture manifests for SimulationCreate (synthetic scenarios, no personal data).
Parameters
| Field | Type | Required |
|---|---|---|
cursorquery | string | no |
limitquery | integer | no |
Responses
200FixtureManifestList400401403404409412413415422428429503
List policy versions
GET/v1/policies/{policy_id}/versions
All versions of the lineage of this policy (linked by previous_version_id), newest first.
Parameters
| Field | Type | Required |
|---|---|---|
policy_idpath | string (uuid) | yes |
cursorquery | string | no |
limitquery | integer | no |
Responses
200PolicyList400401403404409412413415422428429503
Get a policy diff
GET/v1/policies/{policy_id}/diff
Parameters
| Field | Type | Required |
|---|---|---|
policy_idpath | string (uuid) | yes |
againstqueryVersion to compare with; default previous_version_id of the policy. | string (uuid) | no |
Responses
200PolicyDiff400401403404409412413415422428429503
List policy profiles
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.
Parameters
| Field | Type | Required |
|---|---|---|
kindquerybasis 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 | no |
cursorquery | string | no |
limitquery | integer | no |
Responses
200PolicyProfileList400401403404409412413415422428429503