API Documentation

The IDVerse API provides a unified interface for identity verification across 38+ government-backed digital identity systems worldwide. All endpoints require authentication via API key unless otherwise noted.

Quick Start

1. Create an API key from the API Keys page.

2. Set the Authorization: Bearer YOUR_API_KEY header on all requests.

3. Create a session, redirect the user, and retrieve verified identity data.

import { IDverse } from '@idverse/sdk';

const client = new IDverse({ apiKey: 'did_live_...' });

// Create a verification session
const session = await client.sessions.createDirect({
  provider: 'se-bankid',
  redirectUrl: 'https://myapp.com/callback',
});

// After user completes verification, get results
const result = await client.sessions.getResults(
  session.id,
  { resultsAccessKey: session.resultsAccessKey }
);

console.log(result.identity.person.givenName);
console.log(result.identity.proofChain.steps);

Sessions

Identity verification sessions. Three modes: direct (you handle redirects), hosted (we handle redirects), and widget (embeddable UI).

Providers

Browse and manage identity verification providers across 38+ government systems worldwide.

Verification Profiles

Reusable verification configurations with provider preferences, branding, and data handling rules.

Analytics

Real-time verification analytics: volume, latency, provider usage, geographic distribution, and conversion funnels.

API Keys

Create and manage API keys with scoped permissions, IP allowlists, and usage tracking.

Authentication

Dashboard authentication with email/password, TOTP MFA, and role-based access control.