# deepidv

- [Introduction](https://docs.deepidv.com/introduction.md): The New Standard of Verification for Humans + AI
- [Quick Start](https://docs.deepidv.com/quickstart.md): Get up and running with deepidv in minutes
- [API Authentication](https://docs.deepidv.com/authentication.md): Learn how to authenticate with the deepidv API
- [Services](https://docs.deepidv.com/services.md): Identity verification and financial data services offered by deepidv
- [Sandbox Mode](https://docs.deepidv.com/sandbox.md): Test your deepidv integration without consuming tokens or creating real sessions
- [Pricing](https://docs.deepidv.com/pricing.md): deepidv token-based pricing
- [Workflows](https://docs.deepidv.com/workflows/workflows.md): Configure and manage verification workflows
- [Verification Links](https://docs.deepidv.com/workflows/verification-links.md): Generate and manage verification links
- [Webhooks](https://docs.deepidv.com/webhooks/overview.md): Listen for events from deepidv so your integration can automatically trigger reactions
- [Event Object](https://docs.deepidv.com/webhooks/event-object.md): Structure of the webhook event payload sent to your endpoint
- [Manual Review](https://docs.deepidv.com/review/manual-review.md): Manually review and manage verification sessions
- [Export to PDF or CSV](https://docs.deepidv.com/review/export.md): Export verification data to PDF or CSV formats
- [Analytics](https://docs.deepidv.com/settings/analytics.md): View and analyze verification metrics
- [White Label](https://docs.deepidv.com/settings/white-label.md): Customize the verification experience with your brand
- [Audit Logs](https://docs.deepidv.com/settings/audit-logs.md): Track and review all activity in your organization
- [Security & Compliance](https://docs.deepidv.com/security/security-compliance.md): How deepidv protects your data and meets compliance standards
- [Terms of Service](https://docs.deepidv.com/security/terms-of-service.md): deepidv Terms of Service and Privacy Policy
- [OpenAPI Specification](https://docs.deepidv.com/api-reference/openapi-spec.md): Download the full deepidv API contract as an OpenAPI 3.1 specification
- [Create Session](https://docs.deepidv.com/api-reference/sessions/create-session.md): Create a new identity verification session
- [Retrieve Session](https://docs.deepidv.com/api-reference/sessions/retrieve-session.md): Retrieve a session by its ID
- [List Sessions](https://docs.deepidv.com/api-reference/sessions/list-sessions.md): List verification sessions with flexible filtering
- [Update Session Status](https://docs.deepidv.com/api-reference/sessions/update-session-status.md): Manually update a session's status to VERIFIED or REJECTED
- [Create Credit Check](https://docs.deepidv.com/api-reference/credit-check/create-credit-check.md): Create a soft or hard credit check session for an applicant
- [Retrieve Bank Statement](https://docs.deepidv.com/api-reference/financial/retrieve-bank-statement.md): Retrieve a bank statement request by ID
- [List Bank Statements](https://docs.deepidv.com/api-reference/financial/list-bank-statements.md): List all bank statement requests for your organization
- [List Bank Statements by External ID](https://docs.deepidv.com/api-reference/financial/retrieve-bank-statement-by-external-id.md): List bank statement requests by your external reference ID
- [Create Workflow](https://docs.deepidv.com/api-reference/workflows/create-workflow.md): Create a new verification workflow
- [List Workflows](https://docs.deepidv.com/api-reference/workflows/list-workflows.md): List all workflows for your organization
- [Retrieve Workflow](https://docs.deepidv.com/api-reference/workflows/retrieve-workflow.md): Retrieve a workflow by ID
- [Create Workflow Session](https://docs.deepidv.com/api-reference/workflow-runner/create-workflow-session.md): Create a headless session that runs a workflow through the Workflow Runner API
- [Get Workflow State](https://docs.deepidv.com/api-reference/workflow-runner/get-workflow-state.md): Read the current execution state of a workflow session
- [Start Workflow](https://docs.deepidv.com/api-reference/workflow-runner/start-workflow.md): Hand off an un-started workflow session to an SDK runner
- [Create Session Uploads](https://docs.deepidv.com/api-reference/workflow-runner/create-session-uploads.md): Get presigned URLs to upload document and selfie images for a workflow session
- [Submit Workflow Step](https://docs.deepidv.com/api-reference/workflow-runner/submit-workflow-step.md): Submit and execute one step of a workflow session
- [PEP & Sanctions](https://docs.deepidv.com/api-reference/silent-screening/pep-sanctions.md): Screen individuals against global PEP and sanctions lists
- [Adverse Media](https://docs.deepidv.com/api-reference/silent-screening/adverse-media.md): Screen individuals for negative news and legal mentions
- [Title Check](https://docs.deepidv.com/api-reference/silent-screening/title-check.md): Look up property title records, ownership history, and lien data
- [Overview](https://docs.deepidv.com/api-reference/carrier-intelligence/overview.md): Passive phone checks answered directly by the applicant's mobile carrier
- [Phone Trust](https://docs.deepidv.com/api-reference/carrier-intelligence/phone-trust.md): Ask the mobile carrier for SIM-swap and call-forwarding signals on a phone number
- [Carrier Age Gate](https://docs.deepidv.com/api-reference/carrier-intelligence/carrier-age-gate.md): Confirm with the mobile carrier that a phone number's account holder is 18 or over
- [Phone Ownership](https://docs.deepidv.com/api-reference/carrier-intelligence/phone-ownership.md): Ask the mobile carrier how well a name matches the subscriber on record for a phone number
- [Get Async Job](https://docs.deepidv.com/api-reference/async-jobs/get-async-job.md): Poll the status and result of a long-running async job
- [Overview](https://docs.deepidv.com/api-reference/server-to-server/overview.md): Server-to-server API integrations for direct backend verification
- [Scan Document](https://docs.deepidv.com/api-reference/server-to-server/document-scan.md): Extract fields from a government-issued ID and run authenticity checks
- [Detect Face](https://docs.deepidv.com/api-reference/server-to-server/face-detect.md): Detect a face in an image and return bounding box and landmarks
- [Compare Faces](https://docs.deepidv.com/api-reference/server-to-server/face-compare.md): Compare two faces and return a similarity score
- [Estimate Age](https://docs.deepidv.com/api-reference/server-to-server/face-estimate-age.md): Estimate the age range and gender from a single face image
- [Verify Identity](https://docs.deepidv.com/api-reference/server-to-server/identity-verify.md): Run document scan, face detect, and face compare in a single call
- [Overview](https://docs.deepidv.com/api-reference/igaming/overview.md): Real-time iGaming anti-fraud checks on a verification session
- [Injection Detection](https://docs.deepidv.com/api-reference/igaming/injection.md): Detect virtual cameras, emulators, and injected media during liveness capture
- [VPN Detection](https://docs.deepidv.com/api-reference/igaming/vpn-detection.md): Detect VPNs, proxies, Tor exit nodes, and datacenter IPs
- [IP Jurisdiction](https://docs.deepidv.com/api-reference/igaming/ip-jurisdiction.md): Resolve the applicant's IP to a jurisdiction and check it against allow/block lists
- [Anti-Cheat](https://docs.deepidv.com/api-reference/igaming/anti-cheat.md): Face-based dedup, multi-accounting, and self-exclusion enforcement
- [Overview](https://docs.deepidv.com/api-reference/igaming/self-exclusion-overview.md): Manage your organization's self-exclusion registry
- [Add Identity](https://docs.deepidv.com/api-reference/igaming/add-identity.md): Add one or more document numbers to the self-exclusion registry
- [Remove Identity](https://docs.deepidv.com/api-reference/igaming/remove-identity.md): Remove a document number from the self-exclusion registry
- [Exclude Face](https://docs.deepidv.com/api-reference/igaming/exclude-face.md): Flag a session's enrolled face as excluded
- [Clear Face](https://docs.deepidv.com/api-reference/igaming/clear-face.md): Remove a face exclusion for a session
- [List Registry](https://docs.deepidv.com/api-reference/igaming/list-registry.md): List all identity and face entries in the self-exclusion registry
- [Exclude Applicant](https://docs.deepidv.com/api-reference/igaming/exclude-applicant.md): Exclude a session's face and linked identity in a single call
- [Purge Enrollment](https://docs.deepidv.com/api-reference/igaming/purge-enrollment.md): Delete a session's enrolled face data
- [Sandbox Models](https://docs.deepidv.com/api-reference/sandbox/models.md): Test data models and response examples for sandbox API keys
- [AI Agent Integration (MCP Server)](https://docs.deepidv.com/integrate/ai-agent-integration.md): deepidv's hosted MCP server brings identity verification and anti-fraud workflows directly into your AI agents — no API wiring required.
- [Identity Verification Skill](https://docs.deepidv.com/integrate/verify-skill.md): Use the deepidv Verify skill to let compatible AI agents call deepidv verification APIs directly
- [deepAI Assistant Skill](https://docs.deepidv.com/integrate/deepai-assistant-skill.md): Use the deepAI Assistant skill to help coding agents build deepidv integrations correctly with the TypeScript server SDK, REST API, and hosted MCP guidance.
- [Server SDK Overview](https://docs.deepidv.com/integrate/sdks/typescript/server/overview.md): @deepidv/server is a typed, backend-first TypeScript SDK for the deepidv identity verification API — sessions, document and face primitives, identity verification, and silent screening.
- [Quickstart](https://docs.deepidv.com/integrate/sdks/typescript/server/quickstart.md): Install @deepidv/server, initialize the client, and get identity verification results in under two minutes.
- [Authentication](https://docs.deepidv.com/integrate/sdks/typescript/server/authentication.md): How the @deepidv/server SDK authenticates with an x-api-key header — env vars, key redaction, rotation, and custom fetch for proxies and mTLS.
- [Configuration](https://docs.deepidv.com/integrate/sdks/typescript/server/configuration.md): Every @deepidv/server client option — baseUrl, timeouts, retries, and custom fetch — with defaults, retry/timeout behavior, and validation rules.
- [Session Verification](https://docs.deepidv.com/integrate/sdks/typescript/server/session-verification.md): Use the SDK's hosted verification flow — create a session, send the user to a hosted page, and retrieve the analysis results when they finish.
- [Server-to-Server](https://docs.deepidv.com/integrate/sdks/typescript/server/server-to-server.md): Build a custom verification pipeline from the SDK primitives — scan documents, detect and compare faces, estimate age, or run the orchestrated identity.verify shortcut.
- [Error Handling](https://docs.deepidv.com/integrate/sdks/typescript/server/error-handling.md): Every error the @deepidv/server SDK throws is a typed DeepIDVError subclass — the full error catalog, a decision tree, retry semantics, and structured logging.
- [Reference: Sessions](https://docs.deepidv.com/integrate/sdks/typescript/server/reference/sessions.md): client.sessions reference — create, retrieve, list, and updateStatus, with inline types and runnable examples.
- [Reference: Document, Face & Identity](https://docs.deepidv.com/integrate/sdks/typescript/server/reference/document-face-identity.md): client.document, client.face, and client.identity reference — scan, detect, compare, estimateAge, and verify, with inline types and runnable examples.
- [Reference: Screening](https://docs.deepidv.com/integrate/sdks/typescript/server/reference/screening.md): client.screening reference — pepSanctions, adverseMedia (async handle), and titleCheck, with inline types, the AdverseMediaHandle API, and runnable examples.
- [Reference: Async Jobs & Events](https://docs.deepidv.com/integrate/sdks/typescript/server/reference/async-jobs-events.md): client.asyncJobs.get for polling long-running jobs, and client.on(...) lifecycle events for observability and APM integration.
- [Overview](https://docs.deepidv.com/chain-layer/overview.md): The cryptographic transparency log behind every deepidv verification
- [How It Works](https://docs.deepidv.com/chain-layer/how-it-works.md): Envelopes, segments, STHs, and on-chain anchoring
- [The Explorer](https://docs.deepidv.com/chain-layer/explorer.md): A public, no-login-required view of the chain layer at proof.deepidv.com
- [The Registry](https://docs.deepidv.com/chain-layer/registry.md): Browse, filter, and search every attestation in the chain layer
- [The Log](https://docs.deepidv.com/chain-layer/log.md): The macro view of the transparency log — STHs, tree growth, and the master public key
- [Attestation Detail Pages](https://docs.deepidv.com/chain-layer/attestation-detail.md): Reading the full six-step proof pipeline for a single verification
- [Proof Bundles](https://docs.deepidv.com/chain-layer/proof-bundles.md): Downloadable .dpiv archives that verify one attestation end-to-end, offline
- [SDKs](https://docs.deepidv.com/chain-layer/sdks.md): Officially supported Node.js and Python SDKs for the chain layer
- [Trust Model](https://docs.deepidv.com/chain-layer/trust-model.md): What you verify independently of deepidv — and what you trust
- [The Governance Console](https://docs.deepidv.com/chain-layer/governance.md): SSO-gated operational control plane for the chain layer
- [FAQ](https://docs.deepidv.com/chain-layer/faq.md): Common questions about the chain layer
- [Reference](https://docs.deepidv.com/chain-layer/reference.md): API endpoints, SDK sources, public surfaces, and standards
- [Workflow Builder](https://docs.deepidv.com/workflow-builder.md): Build a deepidv verification workflow visually — drag services in, order them, configure each step, and get the API calls needed to run it in your own integration

## OpenAPI Specs

- [openapi](/assets/openapi.yaml)

## Optional

- [Admin Console](https://app.deepidv.com)
- [Agent Skills](https://github.com/Deep-Identity-Inc/agent-skills)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.