Skip to main content
For normal SDK usage, VERIFIEDX_API_KEY is the only environment variable you need. Both SDKs read it automatically:
  • Python: init_verifiedx()
  • TypeScript: initVerifiedX()

Required

VariableRequiredDefaultDescription
VERIFIEDX_API_KEYYesYour VerifiedX runtime API key

Minimal .env

.env
VERIFIEDX_API_KEY=your_runtime_key
That is enough for a normal integration.
You do not need extra config code just to use VERIFIEDX_API_KEY. The SDKs pick it up automatically from os.environ in Python and process.env in TypeScript.

Optional

Most builders can ignore this section. These are the only optional variables most teams are likely to care about:
VariableDefaultWhen to use it
VERIFIEDX_ENVIRONMENTprodSeparate production from staging or dev traffic
VERIFIEDX_PROJECT_IDSDK defaultSplit logs across multiple projects or services
VERIFIEDX_BASE_URLhttps://api.verifiedx.mePoint the SDK at a non-default VerifiedX API endpoint

Practical example

.env
VERIFIEDX_API_KEY=your_runtime_key
VERIFIEDX_ENVIRONMENT=staging
VERIFIEDX_PROJECT_ID=workflow-ops

Notes

  • Set VERIFIEDX_ENVIRONMENT to something like staging or dev outside production so your logs stay clearly separated.
  • Use VERIFIEDX_PROJECT_ID if multiple apps or workflows share the same VerifiedX account.
  • Use VERIFIEDX_BASE_URL only if you have been told to point at a different VerifiedX API endpoint.
The SDKs also support additional advanced runtime and debug environment variables, but most builders never need them. This page intentionally keeps the main setup surface small.