Whitelist vault for private datastream

/api/v2/streams/subscriber_whitelist

AUTHENTICATIONBearer token · evidence:writeAUTHORITATIVE OWNERevidence-streamsCONTRACT AUTHORITYCapability registry · plannedSTATUSPlanned · not executable

PLANNING CONTRACT · NOT CALLABLE

This page describes intended capability and integration boundaries so people and agents can prepare safely. Do not send this request or register it as an executable tool. Wait until the capability registry marks it implemented-contract, then re-fetch the deployed OpenAPI document and build the request from that machine contract.

PURPOSE + BUSINESS CONTEXT

Planned capability: apply the requested transition to whitelist vault for private datastream through the authoritative trust service boundary.

WHEN THIS CALL IS USEFUL

Do not call or register this operation as an executable agent tool yet. Use this page to plan the future whitelist vault for private datastream workflow; enable it only after the status becomes implemented-contract and the exact operation appears in deployed OpenAPI.

OUTCOME · Planned · Create or advance

What changes

None today: this route is not executable. Its intended behavior is: none. The marker returns 501 and cannot create, pause, resume, archive, publish to, subscribe to, grant, revoke, ingest into, or otherwise change an evidence stream.

WHY IT MATTERS

Lets people and agents prepare for whitelist vault for private datastream without falsely presenting roadmap scope as a live capability.
Gives people and agents a contract-backed way to advance whitelist vault for private datastream.
Separates subject identity, consent, evidence, provider output, review, issuer credentials, and relying-party acceptance instead of collapsing them into a universal trust score.

ISOLATION + AUTHORITY

Bearer subject, tenant, purpose, policy version, role, issuer, reviewer, provider, and relying-party boundaries remain distinct. The response or transition grants no payment, custody, settlement, publisher, matching, or trading authority and must not expose regulated evidence beyond the live schema. This planning record grants no runtime authority, and only deployed OpenAPI can define an executable public contract.

BEFORE YOU CALL

First confirm that this operation is marked implemented-contract and exists in the currently deployed OpenAPI document; until then, no production request is valid.
Its capability-registry profile is provisional integration guidance, not an executable request schema.
Authenticate at the documented boundary: bearer.
Treat the capability-registry profile as design guidance only; deployed OpenAPI must define the executable request and response shapes.
Resolve the applicable purpose, policy version, consent or role basis, and required assurance before relying on this result.

WHAT TO DO NEXT

Keep this operation disabled in clients, agents, SDKs, and workflow automation while it remains planned-contract.
Use the stated owner, lifecycle, authority boundary, and provisional whitelist vault for private datastream profile to prepare requirements and conformance tests without sending a request.
Monitor the capability registry for implemented-contract, then re-fetch deployed OpenAPI and validate its exact security, parameters, schemas, responses, and agent metadata before enabling the integration.

AGENT GUIDANCE

Never call this planned contract, include it in an executable tool registry, or infer runtime availability from this readable page.
Its capability-registry profile is provisional integration guidance, not an executable request schema.
Use whitelist vault for private datastream only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Treat the capability-registry profile as design guidance only; deployed OpenAPI must define the executable request and response shapes.
Treat policy availability, consent, evidence capture, completed checks, review, decision, credential issuance, validity, and relying-party acceptance as separate facts.
After a timeout or conflict, read authoritative state before deciding whether an equivalent retry is safe.
When implementation lands, discard generated requests based on this planning record and rebuild them from the deployed OpenAPI operation.

MACHINE CONTRACT

This operation is a non-executable planning contract. Its capability-registry record defines the intended owner, parameters, responses, and integration boundary until an implemented Rust OpenAPI operation replaces it.

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

Examples describe the reviewed planning contract and remain non-executable until promoted into OpenAPI.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

AuthorizationheaderRequired

Bearer tokenCredential containing the evidence:write scope.EXAMPLEBearer hc_live_…

RESPONSES

Status and payload examples

501Non-executable legacy Evidence Streams compatibility marker.Not executable · JSON RESPONSE+

{
  "code": "planned_contract",
  "executable": false,
  "migration": "No canonical stream-access grant creation is executable yet; wait for an explicit subject-, purpose-, permission-, and expiry-bound contract."
}

INTEGRATION DECISIONplanned_contract

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from owner-scoped stream metadata, events, checkpoints, commitments, retention windows, and consumer positions through an implemented operation.
ESCALATE WHEN: Escalate when sequence continuity, checkpoint commitment, retention, ownership, or consumer position cannot be proven.

OPERATIONAL NOTES

Security and lifecycle guarantees

Do not call this bodyless marker. It performs no stream creation, lifecycle transition, publisher or subscriber grant, source enrollment, ingestion, or evidence mutation.
No canonical stream-access grant creation is executable yet; wait for an explicit subject-, purpose-, permission-, and expiry-bound contract.
Do not translate legacy bodies field-for-field or submit owner or vault selectors, generic whitelist or blacklist state, caller-authored publisher trust, private keys, credentials, replay material, or downstream authority assertions.
Publisher enrollment is not factual endorsement, subscriber access is not downstream business permission, pausing a stream does not delete evidence, and resolving an alert does not retroactively validate an event.
Verify the exact replacement in /api/v2/openapi.json. A planned-profiled Evidence Streams entry is documentation, not executable runtime behavior.

UPGRADING FROM V1

Legacy calls replaced by this operation

If you maintain an older integration, use this map to find the V2 replacement. Do not translate the old request field-for-field: rebuild it from the V2 parameters and schemas above because identity, authorization, replay protection, and response semantics may have changed.

POST/api/v1/streams/subscriber_whitelistWhitelist Vault for Private DataStream

DOCUMENTATION STATUS

This planned contract now defines its public parameters, authorization boundary, replay behavior, responses, and authoritative owner. It remains non-executable until its owner adapter and conformance tests are promoted into the Rust gateway.

Return to the V2 directory ↗