deepAI Assistant Skill

Use the deepAI Assistant skill when you want an AI coding agent to help you implement a deepidv integration correctly. Unlike the Verify skill, this skill is not for running live verification actions on your behalf. It helps the agent choose the right package, auth model, method namespace, and error handling pattern while you build.

​

Overview

• @deepidv/server as the canonical TypeScript package
• DeepIDV as the single SDK client entry point
• client.sessions, client.document, client.face, client.identity, client.screening, and client.asyncJobs as the documented method surfaces
• x-api-key auth for SDK and REST usage
• hosted OAuth with PKCE for MCP usage

• Claude Code
• Codex
• Cursor
• Windsurf
• OpenCode

​

What Success Looks Like

• install and initialize @deepidv/server correctly
• keep the SDK on a trusted backend instead of suggesting browser-side usage
• choose between hosted sessions, server-to-server primitives, screening, and MCP based on the integration goal
• handle async adverse-media screening and typed SDK errors correctly
• avoid inventing undocumented SDK namespaces or stale package names

​

Before You Start

• a deepidv account with an active API key
• an agent that supports repository-based skills
• a backend TypeScript runtime if you’re following the SDK path
• a secure place to store the API key in your environment

​

Install the Skill

npx skills add Deep-Identity-Inc/agent-skills@deepai-assistant -g -y

• pulls the deepai-assistant skill from the public deepidv agent-skills repository
• installs it at the user level with -g
• skips the interactive confirmation prompt with -y

1. Restart your agent or editor if it does not reload automatically.
2. Confirm the skill is active by asking your agent to help with a deepidv TypeScript integration, or run npx skills check to verify the install.

​

Use It With the TypeScript SDK

​

Install the package

npm install @deepidv/server

​

Initialize the client

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

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

​

Use the documented namespaces

​

Start With the Right Flow

​

Hosted session flow

1. Create a session with client.sessions.create(...).
2. Send the user to session.sessionUrl.
3. Retrieve results with client.sessions.retrieve(session.id).
4. Update the final status with client.sessions.updateStatus(...) if your review process requires it.

​

Server-to-server flow

• client.document.scan(...)
• client.face.detect(...)
• client.face.compare(...)
• client.face.estimateAge(...)
• client.identity.verify(...)

​

Screening flow

• client.screening.pepSanctions(...) for synchronous watchlist screening
• client.screening.titleCheck(...) for synchronous title or ownership search
• client.screening.adverseMedia(...) for async adverse-media screening
• client.asyncJobs.get(jobId) or the returned handle for polling

​

Keep the Auth Models Separate

​

TypeScript SDK and REST API

• REST base URL: https://api.deepidv.com/v1
• SDK default baseUrl: https://api.deepidv.com

​

Hosted MCP

• server URL: https://mcp.deepidv.com/v1/mcp
• client_id: deepidv only if the client explicitly asks for it
• client_secret: not used
• sign-in: deepidv email and password, with MFA when required

​

Avoid the Most Common Mistakes

• suggesting @deepidv/sdk instead of @deepidv/server
• treating the server SDK as a browser package
• inventing undocumented SDK namespaces such as client.workflows.*
• forgetting that adverse-media screening is async
• retrying pepSanctions or titleCheck aggressively after a 503
• mixing REST API key auth with hosted MCP OAuth instructions

​

Prompt Patterns That Work Well

• “Help me initialize @deepidv/server in a Node.js backend.”
• “Show me how to create a hosted verification session and read the result.”
• “Help me wire client.identity.verify() into our onboarding flow.”
• “How should I handle RateLimitError and TimeoutError from the SDK?”
• “Show me the correct pattern for async adverse-media screening.”
• “Help me connect deepidv MCP in a client that supports remote OAuth.”

​

Choose the Right Integration Path

• you want a coding agent to help you implement or debug deepidv integration code
• you want the agent to stay aligned with the published TypeScript SDK docs
• you need help picking between SDK, REST, and MCP integration patterns

• you want a compatible AI agent to call deepidv verification and screening APIs directly
• you want skill-driven API execution rather than coding assistance

• your client supports remote MCP
• you want hosted tools with OAuth-based access
• you prefer structured remote tools over direct API integration code

​

Related Links