Get your API key
Sign in to the VerifiedX dashboard and open API keys. Create a new runtime key for your workspace. All VerifiedX API keys start withvxpk_.
Configure your environment
For the hosted service,VERIFIEDX_API_KEY is the only required variable.
.env
This is enough for the normal hosted setup. Most builders do not need any other auth or runtime configuration to get started.
Optional environment variables
Use these only if you need to override the default hosted setup or attach extra runtime metadata.| Variable | Required | Default | Description |
|---|---|---|---|
VERIFIEDX_BASE_URL | No | https://api.verifiedx.me | Override the VerifiedX API base URL. |
VERIFIEDX_ORG_ID | No | org_1 | Runtime org identifier. For hosted requests, the API key scope is authoritative. |
VERIFIEDX_PROJECT_ID | No | project_1 | Runtime project identifier. For hosted requests, the API key scope is authoritative. |
VERIFIEDX_ENVIRONMENT | No | prod | Runtime environment label, for example prod, staging, or dev. For hosted requests, the API key scope is authoritative. |
VERIFIEDX_AGENT_ID | No | Auto-generated | Agent identifier shown in runtime context and logs. |
VERIFIEDX_SOURCE_SYSTEM | No | SDK default | Source-system label for the runtime. |
For the hosted API, org, project, and environment are aligned to the API key scope server-side.
Missing or invalid keys
Missing and invalid keys do not behave exactly the same across SDKs.- In Python,
init_verifiedx()fails fast ifVERIFIEDX_API_KEYis missing from env. - Invalid, unrecognized, or revoked keys are rejected by the VerifiedX API on the first real request.
- In TypeScript, missing auth usually surfaces when the first VerifiedX request is made rather than at
initVerifiedX()time. - If you rotate a key in the dashboard, update the environment variable and restart your process.