SDK configuration
Configure the central VeriProof endpoint for ingest and governed runtime calls. The SDK derives its central routes from that base URL.
Hosted VeriProof uses https://ingest.veriproof.app by default. Customer-managed Azure applications use the customer’s ingest API base URL.
An entitled application can also set VERIPROOF_EDGE_ENDPOINT. The SDK then routes ordinary governance calls through the local Edge Gateway and keeps the central endpoint for validated handoffs requested by the gateway.
Required inputs
| Input | Purpose |
|---|---|
| VeriProof endpoint | Base URL for ingest, policy evaluation, governance profile, directives, and acknowledgements |
| Edge endpoint | Optional local gateway URL for ordinary governance calls |
| Application SDK key | Application-scoped credential copied from the portal |
| Application identity | Existing application ID or the release-supported application discovery path |
| Service name | OpenTelemetry service identity used by the application |
Open Tools and SDKs for the approved packages and installation commands. Use the application’s Set up SDK workflow for its key, endpoint, and identifiers.
Copy the assigned application ID, not its display name. Keep the key and endpoint matched to the intended application environment.
Environment settings
The shared environment variables are:
| Variable | Purpose |
|---|---|
VERIPROOF_API_KEY | Authenticates one application. Read it from a secrets manager. |
VERIPROOF_ENDPOINT | Base URL for ingest and governed runtime calls. Defaults to https://ingest.veriproof.app. |
VERIPROOF_EDGE_ENDPOINT | Optional local Edge Gateway URL for ordinary governance calls. |
VERIPROOF_APPLICATION_ID | The assigned application ID. |
VERIPROOF_ENVIRONMENT | The application environment the session belongs to. |
VERIPROOF_ALLOW_LOOPBACK_HTTP | Set to true to permit a plain http:// endpoint on a loopback address during local development. |
VERIPROOF_ALLOW_LOOPBACK_HTTP is read by the TypeScript, Go, Java, and Rust SDKs. Python and .NET take the same setting as a client option instead: Veriproof.from_env(allow_loopback_http=True) and AllowLoopbackHttp = true. In every language it applies only to loopback addresses and never relaxes TLS checks for a remote endpoint.
Option availability and precedence vary by language. Check the installed package’s README and the SDK overview, especially when combining environment variables with code configuration.
Endpoint rules
The SDK preserves an explicit port and path prefix. Remote endpoints must use HTTPS; plain HTTP is limited to supported loopback hosts.
Do not include credentials, query strings, or fragments in the endpoint URL.
The central endpoint owns the central runtime route families. Do not configure separate ingest, gate, treasury, commitment, or review endpoints.
VERIPROOF_EDGE_ENDPOINT changes the ordinary runtime destination, not the application identity. An Edge failure never authorizes protected work.
Content capture
Content capture is disabled by default. Enable it only after reviewing the exact application data and testing supported redaction.
Redaction is pattern-based. It does not claim complete removal of personal, health, or confidential data.
Credentials
Read the application SDK key from an approved secrets manager. Use the language SDK’s dynamic provider where available when your application must rotate keys without restart.
Never place the key in source code, command history, logs, screenshots, or exception messages.
Failure behavior
Policy and review calls have different safety requirements from telemetry delivery. Follow the language SDK’s documented fail-closed, retry, idempotency, and cancellation behavior.
A denied or degraded result does not terminate the application process. Verify that the protected operation cannot execute when authorization is denied or cannot be confirmed.
Use VERIPROOF_EDGE_ENDPOINT for the entitled local path. The SDK does not support DeploymentMode.LocalFirst, DeploymentMode.Disconnected, CommitmentOnlyEndpoint, or direct writes to a local VeriProof database.