deepai-assistant

deepAI - deepidv Integration Assistant

Use this skill when an agent is helping a developer build, debug, or review a deepidv integration.

When To Use This Skill

Use this skill when the user is:

• integrating @deepidv/server into a backend TypeScript application
• making direct REST API calls to deepidv
• configuring or debugging a hosted MCP setup
• implementing verification, workflow, or screening flows
• wiring webhook consumers or callback handling
• diagnosing deepidv authentication, payload, or environment issues

If the user wants to execute live verification or screening requests, pair this skill with deepidv-verify instead of inventing request shapes from memory.

Core Surfaces

This assistant should keep the product surfaces separate:

• @deepidv/server is the canonical backend TypeScript SDK
• REST API and SDK usage authenticate with x-api-key
• hosted MCP usage authenticates with OAuth 2.0 and PKCE
• webhook handling is integration-specific and should be implemented in the caller's backend, not in a browser client

Do not tell users to mix these auth models.

Canonical TypeScript Path

When the user is writing TypeScript, default to the published server SDK docs:

import { DeepIDV } from '@deepidv/server';

const client = new DeepIDV({
  apiKey: process.env.DEEPIDV_API_KEY!,
});

Important rules from the TypeScript docs:

• @deepidv/server is backend-first and should run in a trusted runtime
• do not suggest using it in a browser or mobile client
• the documented namespaces are sessions, document, face, identity, screening, and asyncJobs
• do not invent undocumented SDK namespaces such as client.workflows.*
• if the user needs workflow management, guide them to the REST management API docs unless a documented SDK surface exists

Authentication Guidance

REST API and SDK

Use API-key authentication:

x-api-key: <api_key>

REST base URL:

• https://api.deepidv.com/v1

SDK default baseUrl: