ComplianceProfile
The Organization's Compliance profile in force (1.32.0, workspace ADR 0082): its recording policy, the regions its Providers may process in, whether they must state a BAA, and whether a stage on its own key may fall back to Vocal's. Each Call runs on the version admission read.
An object with 17 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
byok_platform_fallback | ByokPlatformFallback | yes | Whether a stage on the Organization's own key may fall back to Vocal's; forbidden by default. |
contact_inactivity_days | integer | no | Days without a Call, a message, an enrollment or an API write after which a Contact is deleted by the daily retention.scrub job (1.61.0): 30 to 365, 365 by default (targets). Absent, from an api before 1.61.0, 365. |
content_visibility | ContentVisibility | no | The visibility matrix of the content classes by role (1.57.0), checked at read time against the profile in force. Absent from an api older than 1.57.0; a reader treats its absence as the default. |
export_content | ExportContent | no | Whether an S3 export may carry content (1.57.0, not built); off by default. Absent from an api older than 1.57.0; a reader treats its absence as the default. |
live_call_judging | LiveCallJudging | no | Whether live Calls may be judged (1.63.0); off by default. Absent from an api before 1.63.0, which a reader treats as the default. |
live_call_judging_sample_rate | number | no | The share of eligible Calls a judge reads while live_call_judging is on (1.63.0): 0.01 to 1, 0.1 by default (a target), drawn at finalize. Absent from an api before 1.63.0, which a reader treats as the default. |
object | "compliance_profile" | yes | |
provider_regions | array of ProviderRegion | yes | The regions where the Organization's Providers may process, one to as many as ProviderRegion holds (four from 1.38.0, three before), each once; us by default. Admission and publish apply the intersection with the cell's own set, and a Provider whose descriptor names a region outside it is dropped from every chain (region_not_allowed). |
recording_policy | RecordingPolicy | yes | The recording policy; on_with_announcement by default. |
require_baa | boolean | yes | When true, the chain resolver drops every Provider whose descriptor baa_available is neither yes nor not_applicable (baa_not_stated). Every real descriptor of 1.32.0 reads unknown, so an Organization that sets it runs only mock Providers, in test. False by default. |
reveal_approval | RevealApproval | no | Whether a reveal grant needs a second approver (1.57.0); none by default. Absent from an api older than 1.57.0; a reader treats its absence as the default. |
revocation_scope | RevocationScope | no | How far an opt-out reaches (1.61.0): all_channels (the default) or per_channel. Absent, from an api before 1.61.0, all_channels. |
trace_retention_days | integer or null | no | Shortens the retention of stage traces below the Call row's (1.57.0): 1 day up to the platform ceiling, or null, the default, to keep them with the Call row. The api refuses a value above the ceiling with the issue trace_retention_above_ceiling. Absent from an api older than 1.57.0; a reader treats its absence as the default. |
updated_at | Timestamp or null | yes | When the version was written; null for version 0. |
updated_by | ActorRef or null | yes | The Member who wrote the version, always an owner; null for version 0. |
verbose_capture | VerboseCapture | no | Where verbose capture may run (1.57.0); allowed by default. Absent from an api older than 1.57.0; a reader treats its absence as the default. |
version | integer | yes | The version in force: 0 for the defaults before the first update, then one more per update. Returned as the ETag and required in the If-Match of PATCH /v1/compliance-profile. |
Used by
The operations whose parameters, request body or responses name this shape directly.