Skip to content
RS
Registry Stack
Docs
Development (unreleased)
Version
Development (unreleased)
v0.43.0
v0.42.0
v0.41.0
Select theme
Dark
Light
Auto
GitHub ↗
Menu
Start
Overview
How the products fit together
Registry Evidence
Overview
Your first assertion
How Evidence works
Tutorials
Return a governed value
Control who can request evidence
Assert a role-bound relationship
Request evidence as an SD-JWT VC
Use from applications
Request an assertion
Request an access token
Verify an assertion
Manage verifier trust
Connect a source
Connect an institution API
Connect a SQLite extract
Package a lookup over a registry
Prove and deploy
Prove with fixtures
Build and deploy
Sign with Vault Transit
Run with Docker Compose
Rotate signing keys
Audit log
Wallet delivery
Enable SD-JWT VC
Deliver to a wallet
Configuration reference
Errors and problem codes
API overview
API operations
Overview
/.well-known/evidence/jwks.json
GET
/.well-known/jwt-vc-issuer
GET
/.well-known/oauth-protected-resource
GET
/catalog.jsonld
GET
/health
GET
/openapi.json
GET
/ready
GET
/v1/evidence
POST
/v1/evidence-definitions
GET
/v1/evidence/batch
POST
API operations (wallet delivery)
Overview
/.well-known/oauth-authorization-server
GET
/.well-known/openid-credential-issuer
GET
/credential
POST
/health
GET
/nonce
POST
/offers
POST
/ready
GET
/token
POST
Security model
Base Registry Engine
Overview
Your first registry
How a registry works
Tutorials
Change it with an Action
Extend with a module
Derive from PublicSchema
Query and change from Python and Node
Author a registry
Author a project
Modeling patterns
Control access and reads
Actions and Proposals
Encrypt a field
Publish statistics
Test with journeys
Deploy and operate
Deploy and serve
Change an active registry
Monitor and recover
Retain, erase, and audit
Move data in bulk
Bind webhook receivers
Use from applications
Client reference
Client API reference
API reference
PublicSchema wizard
Authenticate with eSignet
Compose
Send events to a webhook
Serve a lookup to Evidence
Review a Proposal in Casework
Citizen chat assistant
Citizen chat assistant
Configuration reference
API operations (facility template)
Overview
/v1/actions/correct-address/proposals
POST
/v1/actions/deactivate-facility/proposals
POST
/v1/actions/register-facility
POST
/v1/actions/register-facility/availability
POST
/v1/proposals
GET
/v1/proposals/review-context
GET
/v1/proposals/{proposal_id}
GET
/v1/proposals/{proposal_id}/apply
POST
/v1/proposals/{proposal_id}/attachments/supporting-document
GET
/v1/proposals/{proposal_id}/attachments/supporting-document
DELETE
/v1/proposals/{proposal_id}/attachments/supporting-document
PATCH
/v1/proposals/{proposal_id}/cancel
POST
/v1/proposals/{proposal_id}/edit
POST
/v1/proposals/{proposal_id}/rebase
POST
/v1/proposals/{proposal_id}/retry
POST
/v1/proposals/{proposal_id}/review-context
GET
/v1/proposals/{proposal_id}/review-status
GET
/v1/proposals/{proposal_id}/revise
POST
/v1/proposals/{proposal_id}/submissions/{submission_version}
GET
/v1/proposals/{proposal_id}/submit
POST
/v1/records/directory-entries
GET
/v1/records/directory-entries
POST
/v1/records/directory-entries/{record_id}
GET
/v1/records/directory-entries/{record_id}
PATCH
/v1/records/facilities
GET
/v1/records/facilities/{record_id}
GET
/v1/records/facilities/{record_id}/operators
GET
/v1/records/facility-assignments
GET
/v1/records/facility-assignments/{record_id}
GET
/v1/records/operators
GET
/v1/records/operators
POST
/v1/records/operators/{record_id}
GET
/v1/records/operators/{record_id}
PATCH
/v1/review-completions
POST
Registry Casework
Overview
Decide your first ReviewRequest
How Casework works
Author a policy
Author a policy
Staff the directory
Deploy and operate
Deploy Casework
Change an active package
Retention and audit
Compose
Review a Proposal in Casework
API contract
API operations
Overview
/.well-known/jwks.json
GET
/health
GET
/ready
GET
/v1/casework
GET
/v1/directory
GET
/v1/directory/absences
GET
/v1/directory/absences
POST
/v1/directory/absences/{absence_id}
PUT
/v1/directory/absences/{absence_id}
DELETE
/v1/directory/bootstrap
POST
/v1/directory/caseload/apply
POST
/v1/directory/caseload/preview
POST
/v1/directory/clocks/recompute/apply
POST
/v1/directory/clocks/recompute/preview
POST
/v1/directory/holidays
POST
/v1/directory/holidays/{id}/revisions/{revision}
GET
/v1/directory/targets
GET
/v1/directory/teams/{team_id}
PUT
/v1/review-accountability/{event_id}
GET
/v1/review-policies
GET
/v1/review-policies/{policy_id}
GET
/v1/review-requests
POST
/v1/review-requests/{request_id}
GET
/v1/review-requests/{request_id}/cancel
POST
/v1/review-requests/{request_id}/clocks
GET
/v1/review-requests/{request_id}/history
GET
/v1/review-requests/{request_id}/notes
POST
/v1/review-requests/{request_id}/result
GET
/v1/review-results
GET
/v1/review-tasks
GET
/v1/review-tasks/holdings
GET
/v1/review-tasks/next
GET
/v1/review-tasks/own-decisions
GET
/v1/review-tasks/supervision
GET
/v1/review-tasks/{task_id}
GET
/v1/review-tasks/{task_id}/assign
POST
/v1/review-tasks/{task_id}/claim
POST
/v1/review-tasks/{task_id}/context
GET
/v1/review-tasks/{task_id}/decisions
POST
/v1/review-tasks/{task_id}/delegate
POST
/v1/review-tasks/{task_id}/draft
GET
/v1/review-tasks/{task_id}/draft
PUT
/v1/review-tasks/{task_id}/draft
DELETE
/v1/review-tasks/{task_id}/release
POST
/v1/review-tasks/{task_id}/task-grants
GET
/v1/review-tasks/{task_id}/task-grants
POST
/v1/review-tasks/{task_id}/task-grants/{grant_id}/revoke
POST
/v1/review-tasks/{task_id}/task-templates
GET
/v1/task-grants/{grant_id}/assertion
POST
/v1/task-grants/{grant_id}/status
GET
Client API reference
Registry Scheduling
Overview
Prove your first booking policy
How Scheduling works
Author a policy
Deploy and operate Scheduling
Configuration reference
API contract
API operations
Overview
/healthz
GET
/readyz
GET
/v1/appointments
GET
/v1/appointments
POST
/v1/appointments/receipt
POST
/v1/appointments/{appointment_id}
GET
/v1/appointments/{appointment_id}/cancel
POST
/v1/appointments/{appointment_id}/history
GET
/v1/appointments/{appointment_id}/reschedule
POST
/v1/availability
GET
/v1/availability/explain
GET
/v1/holds
POST
/v1/holds/{hold_id}
DELETE
/v1/locations
GET
/v1/offerings
GET
/v1/resources
GET
/v1/scheduling
GET
/v1/services
GET
Registry Render
Overview
Render your first document
How Render works
Deploy Render
Configuration reference
Registry Messaging
Overview
Send your first message
How Messaging works
Author a package
Deploy Messaging
Configuration reference
API contract
API operations
Overview
/health
GET
/ready
GET
/v1/messages
POST
/v1/messages/receipt
POST
/v1/messages/{message_id}
GET
/v1/messages/{message_id}/cancel
POST
/v1/provider-callbacks/{provider_id}
POST
/v1/provider-callbacks/{provider_id}/{token}
POST
/v1/templates/{template_id}/versions/{version}/preview
POST
Client API reference
Registry Coordinator
Overview
Review an application and send a notice
How Coordinator works
Author a flow
Deploy Coordinator
Configuration reference
API contract
API operations
Overview
/health
GET
/ready
GET
/v1/complete-execution-recovery
POST
/v1/doctor
GET
/v1/events/{workflow}/{trigger}
POST
/v1/release-admission-hold
POST
/v1/release-restore-hold
POST
/v1/restore-hold
POST
/v1/retention
POST
/v1/review-completions
POST
/v1/runs
GET
/v1/runs
POST
/v1/runs/{run}
GET
/v1/runs/{run}/cancel
POST
/v1/runs/{run}/inspect
GET
/v1/runs/{run}/reconcile
POST
/v1/runs/{run}/retry-same
POST
/v1/workflows/{workflow}
GET
Registry Discovery
Overview
Publish and consume an index
How Discovery works
Package and run an index
Operations
Overview
Operator handoff
Rotate credentials and trust
Connect an OIDC issuer
Inspect and diagnose
Back up and restore
Upgrade and retire
Retention and persistent state
Generated files and ownership
Production hardening
Security
Overview
Threat model
Known limitations
Report a vulnerability
Support window
Self-assessment
Release trust
Design
Architecture
Boundaries and map
Records stay home
Data minimization
Trusted context
DPI safeguards
Decisions
Registry Relay retirement
Registry Notary retirement
Reference
Overview
Errors and status codes
Environment variables
Configuration files
API overview
CLI commands
Overview
breg
bregctl
bregctl apply
bregctl check
bregctl data
bregctl data export
bregctl data import
bregctl data validate
bregctl dev
bregctl dev events
bregctl dev export-client
bregctl dev grant
bregctl dev start
bregctl dev stop
bregctl dev token
bregctl diff
bregctl doctor
bregctl evidence-retention
bregctl evidence-retention erase-expired
bregctl examples
bregctl examples list
bregctl examples review
bregctl examples run
bregctl explain
bregctl field-encryption
bregctl field-encryption erase-history
bregctl field-encryption keygen
bregctl field-encryption preflight
bregctl generate
bregctl history
bregctl history erase
bregctl history rebaseline
bregctl idempotency-retention
bregctl idempotency-retention erase-expired
bregctl import-authority
bregctl import-authority close
bregctl import-authority close-expired
bregctl import-authority list
bregctl import-authority open
bregctl init
bregctl instance-claim
bregctl instance-claim adopt
bregctl instance-claim status
bregctl migration
bregctl migration explain
bregctl migration reconcile
bregctl module
bregctl module add
bregctl module add consent
bregctl package
bregctl plan
bregctl project
bregctl project action-test
bregctl project lock
bregctl proposal-retention
bregctl proposal-retention cleanup-attachments
bregctl proposal-retention dry-run
bregctl proposal-retention erase
bregctl proposal-retention list
bregctl review-recovery
bregctl review-recovery close
bregctl review-recovery resubmit
bregctl review-recovery retry-application
bregctl statistics
bregctl statistics publish
bregctl statistics withdraw
bregctl status
bregctl test
bregctl verify
bregctl webhook
bregctl webhook discard
bregctl webhook drain
bregctl webhook list
bregctl webhook replay
bregctl webhook sample
breg-mcp
breg-mcp check
breg-mcp serve
breg-review
breg-review check
breg-review serve
casework
casework serve
caseworkctl
caseworkctl apply
caseworkctl check
caseworkctl dev
caseworkctl dev events
caseworkctl dev grant
caseworkctl dev identity
caseworkctl dev start
caseworkctl dev stop
caseworkctl dev token
caseworkctl doctor
caseworkctl explain
caseworkctl init
caseworkctl lifecycle
caseworkctl package
caseworkctl plan
caseworkctl provider
caseworkctl provider add
caseworkctl provider pair
caseworkctl status
caseworkctl test
caseworkctl types
scheduling
scheduling serve
schedulingctl
schedulingctl apply
schedulingctl check
schedulingctl explain
schedulingctl init
schedulingctl intents
schedulingctl package
schedulingctl plan
schedulingctl records
schedulingctl records apply
schedulingctl status
schedulingctl test
messaging
messaging serve
messagingctl
messagingctl apply
messagingctl check
messagingctl dev
messagingctl dev token
messagingctl init
messagingctl messages
messagingctl messages cancel
messagingctl messages list
messagingctl messages retry
messagingctl messages settle
messagingctl messages show
messagingctl package
messagingctl plan
messagingctl preview
messagingctl retention
messagingctl retention erase-expired
messagingctl status
evidence
evidence authority
evidence authority activate
evidence authority history
evidence check
evidence check-policy
evidence evaluate
evidence serve
evidence verify
evidence verify-presentation
evidencectl
evidencectl access
evidencectl access client
evidencectl access client add
evidencectl access client list
evidencectl access client revoke
evidencectl access profile
evidencectl access profile list
evidencectl artifact
evidencectl artifact inspect
evidencectl audit
evidencectl audit show
evidencectl check
evidencectl client
evidencectl client contracts
evidencectl client contracts fetch
evidencectl client profile
evidencectl client profile create
evidencectl dev
evidencectl dev check
evidencectl dev clean
evidencectl dev grant
evidencectl dev start
evidencectl dev stop
evidencectl dev token
evidencectl doctor
evidencectl explain
evidencectl fixtures
evidencectl fixtures run
evidencectl init
evidencectl jwk
evidencectl jwk from-pem
evidencectl jwks
evidencectl keygen
evidencectl keygen client-assertion
evidencectl keygen holder
evidencectl keygen secret
evidencectl keygen signing
evidencectl keygen token
evidencectl package
evidencectl request
evidencectl request prepare
evidencectl source
evidencectl source add
evidencectl source detach
evidencectl source diff
evidencectl source import
evidencectl source mock
evidencectl source mock check
evidencectl source mock generate
evidencectl source mock serve
evidencectl source suggest
evidencectl source update
evidencectl target
evidencectl target explain
evidencectl target new
evidencectl test
evidencectl tooling
evidencectl tooling editor
evidencectl tooling language-server
evidencectl types
evidencectl verify
evidence-oid4vci
evidence-oid4vci check
evidence-oid4vci inspect
evidence-oid4vci openapi
evidence-oid4vci serve
registry-render
registry-render check
registry-render compile
registry-render healthcheck
registry-render init
registry-render package
registry-render serve
registry-render validate
Compatibility
Contracts
API stability and versioning
Standards
ITB and SEMIC evidence
Specifications
Register
Documentation framework
Terms
Architecture
Registry Evidence protocol
Security model
Portable metadata model
Registry Manifest
Overview
Validate and render a manifest
Validate against profile fixtures
ITB and SEMIC validation
Reference
Changelog
Privacy
Accessibility
Glossary
Version
Development (unreleased)
v0.43.0
v0.42.0
v0.41.0
Select theme
Dark
Light
Auto
GitHub ↗
Docs
/
Reference
/
Overview
Overview
facility-registry
0.1.0
Section titled “facility-registry 0.1.0”
Information
OpenAPI version:
3.1.0
Operations
Section titled “Operations”
POST
/v1/actions/correct-address/proposals
POST
/v1/actions/deactivate-facility/proposals
POST
/v1/actions/register-facility
POST
/v1/actions/register-facility/availability
GET
/v1/proposals
GET
/v1/proposals/review-context
GET
/v1/proposals/{proposal_id}
POST
/v1/proposals/{proposal_id}/apply
GET
/v1/proposals/{proposal_id}/attachments/supporting-document
DELETE
/v1/proposals/{proposal_id}/attachments/supporting-document
PATCH
/v1/proposals/{proposal_id}/attachments/supporting-document
POST
/v1/proposals/{proposal_id}/cancel
POST
/v1/proposals/{proposal_id}/edit
POST
/v1/proposals/{proposal_id}/rebase
POST
/v1/proposals/{proposal_id}/retry
GET
/v1/proposals/{proposal_id}/review-context
GET
/v1/proposals/{proposal_id}/review-status
POST
/v1/proposals/{proposal_id}/revise
GET
/v1/proposals/{proposal_id}/submissions/{submission_version}
POST
/v1/proposals/{proposal_id}/submit
GET
/v1/records/directory-entries
POST
/v1/records/directory-entries
GET
/v1/records/directory-entries/{record_id}
PATCH
/v1/records/directory-entries/{record_id}
GET
/v1/records/facilities
GET
/v1/records/facilities/{record_id}
GET
/v1/records/facilities/{record_id}/operators
GET
/v1/records/facility-assignments
GET
/v1/records/facility-assignments/{record_id}
GET
/v1/records/operators
POST
/v1/records/operators
GET
/v1/records/operators/{record_id}
PATCH
/v1/records/operators/{record_id}
POST
/v1/review-completions
Authentication
Section titled “Authentication”
bearerAuth
Section titled “bearerAuth”
Security scheme type:
http
Bearer format:
JWT