Skip to Content
GuidesSet Up Your First Integration

Set Up Your First VeriProof Integration

This guide takes a new developer account from zero to a visible governance trace in the Customer Portal. It covers only the steps required for initial setup — no optional annotations or compliance configuration.

Time required: approximately 2 minutes.

Sign in to the Customer Portal

Go to your organisation’s Customer Portal URL (typically https://my.veriproof.app or your tenant’s custom domain) and sign in with your credentials.

If your organisation uses SSO, use the Sign in with your identity provider button on the login screen.

Create your first application

  1. In the left sidebar, click Applications.
  2. Click New Application.
  3. Enter a name that identically matches the application_id you will pass to the SDK in your code (for example, loan-review-agent or support-chat).
  4. Select a regulatory framework if applicable; you can change this later.
  5. Click Create Application.

After saving, you are taken directly to the Config tab for the new application. Keep this tab open.

Issue an API key

On the Config tab, in the SDK Integration Guide section:

  1. Click Generate Application Key.
  2. Copy the full key value immediately — it is shown only once and cannot be retrieved after this step.
  3. Store it in your secret manager before continuing.

Never commit API keys to source control. Use environment variables or your platform’s secret store (Azure Key Vault, AWS Secrets Manager, 1Password Secrets Automation, Kubernetes Secrets).

If you prefer the CLI:

pip install veriproof-cli veriproof auth login veriproof apps create --name "loan-review-agent" # note the App ID in the output veriproof keys create --app-id <APP_ID> # note the key value

Configure the SDK

Set the environment variables in your local development environment:

export VERIPROOF_API_KEY="<your key from step 3>" export VERIPROOF_APPLICATION_ID="<your application name from step 2>"

Then initialise the SDK at application startup:

import os from veriproof_sdk import VeriproofClientOptions, configure_veriproof configure_veriproof( VeriproofClientOptions( api_key=os.environ["VERIPROOF_API_KEY"], application_id=os.environ["VERIPROOF_APPLICATION_ID"], ), service_name=os.environ["VERIPROOF_APPLICATION_ID"], set_global=True, )

Send your first instrumented session

Run any AI call wrapped in a VeriProof session. A minimal example:

import os from veriproof_sdk import ( VeriproofClient, VeriproofClientOptions, VeriproofSession, SessionOutcome, RiskLevel, StartSessionOptions, ) client = VeriproofClient( VeriproofClientOptions( api_key=os.environ["VERIPROOF_API_KEY"], application_id=os.environ["VERIPROOF_APPLICATION_ID"], ) ) async def demo_session(): session = VeriproofSession( client, "setup-verification", StartSessionOptions(session_id="setup-verification-001"), ) async with session: session.add_chat_turn( "Is this integration working?", "Yes — trace is live.", "gpt-4o", ) session.set_outcome(SessionOutcome.SUCCESS) session.set_risk_level(RiskLevel.LOW)

Verify the trace in the portal

  1. Open the Customer Portal and go to Decisions.
  2. Your session should appear within 10–30 seconds.
  3. Click into the session to confirm the step timeline and governance attributes are visible.

A green trace entry in Decisions means your setup is working correctly.

Trace not appearing? The most common causes are an invalid or revoked API key, a mismatched Application ID, or a network issue. Run veriproof status --app-id <APP_ID> to check connectivity, or see the SDK Troubleshooting Guide.


What’s next?

Now that your initial setup is verified:

Last updated on