@adcp/client API Reference - v4.19.0
    Preparing search index...

    Interface CheckGovernanceResponse

    Governance agent's response to a check request. Returns whether the action is approved under the campaign plan.

    interface CheckGovernanceResponse {
        check_id: string;
        status: "approved" | "denied" | "conditions";
        plan_id: string;
        explanation: string;
        findings?: {
            category_id: string;
            policy_id?: string;
            severity: EscalationSeverity;
            explanation: string;
            details?: {};
            confidence?: number;
            uncertainty_reason?: string;
        }[];
        conditions?: {
            field: string;
            required_value?: { [k: string]: unknown };
            reason: string;
        }[];
        expires_at?: string;
        next_check?: string;
        categories_evaluated?: string[];
        policies_evaluated?: string[];
        governance_context?: string;
    }
    Index

    Properties

    check_id status plan_id explanation findings? conditions? expires_at? next_check? categories_evaluated? policies_evaluated? governance_context?

    Properties

    check_id: string

    Unique identifier for this governance check record. Use in report_plan_outcome to link outcomes to the check that authorized them.

    status: "approved" | "denied" | "conditions"

    Governance decision. 'approved': proceed as planned. 'denied': do not proceed. 'conditions': approved if the caller accepts the listed conditions, then re-calls check_governance with the adjusted parameters.

    plan_id: string

    Echoed from request.

    explanation: string

    Human-readable explanation of the governance decision.

    findings?: {
        category_id: string;
        policy_id?: string;
        severity: EscalationSeverity;
        explanation: string;
        details?: {};
        confidence?: number;
        uncertainty_reason?: string;
    }[]

    Specific issues found during the governance check. Present when status is 'denied' or 'conditions'. MAY also be present on 'approved' for informational findings (e.g., budget approaching limit).

    Type Declaration

    • category_id: string

      Validation category that flagged the issue (e.g., 'budget_compliance', 'regulatory_compliance', 'brand_safety').

    • Optionalpolicy_id?: string

      Registry policy ID that triggered this finding. Present when the finding originates from a specific registry policy. Enables programmatic routing of compliance failures.

    • severity: EscalationSeverity
    • explanation: string

      Human-readable description of the issue.

    • Optionaldetails?: {}

      Structured details for programmatic consumption.

    • Optionalconfidence?: number

      Confidence score (0-1) in this finding. Distinguishes 'this definitely violates the policy' (0.95) from 'this might violate depending on how audience segments resolve' (0.6). When absent, the finding is presented without a confidence qualifier.

    • Optionaluncertainty_reason?: string

      Explanation of why confidence is below 1.0 (e.g., 'Targeting includes regions that partially overlap jurisdiction boundaries'). Present when confidence is below a governance-agent-defined threshold.

    conditions?: {
        field: string;
        required_value?: { [k: string]: unknown };
        reason: string;
    }[]

    Present when status is 'conditions'. Specific adjustments the caller must make. After applying conditions, the caller MUST re-call check_governance with the adjusted parameters before proceeding.

    Type Declaration

    • field: string

      Dot-path to the field that needs adjustment (in payload for proposed, in planned_delivery for committed).

    • Optionalrequired_value?: { [k: string]: unknown }

      The value the field must have for approval. When present, the condition is machine-actionable. When absent, the condition is advisory.

    • reason: string

      Why this condition is required.

    expires_at?: string

    When this approval expires. Present when status is 'approved' or 'conditions'. The caller must act before this time or re-call check_governance. A lapsed approval is no approval.

    next_check?: string

    When the seller should next call check_governance with delivery metrics. Present when the governance agent expects ongoing delivery reporting.

    categories_evaluated?: string[]

    Governance categories evaluated during this check.

    policies_evaluated?: string[]

    Registry policy IDs evaluated during this check.

    governance_context?: string

    Opaque governance context for this media buy. The buyer MUST attach this to the protocol envelope when sending the media buy to the seller. The seller MUST persist it and include it on all subsequent check_governance calls for this media buy's lifecycle. Only the issuing governance agent interprets this value.

    Settings

    Member Visibility

    On This Page

    Properties