API Documentation

Welcome to the DeepIDV API documentation. This guide will help you integrate DeepIDV's identity verification services into your application.

Table of Contents

• Overview
• Getting Started
• Base URL
• Authentication
• Rate Limiting
• Error Handling
• Support

Overview

The DeepIDV API provides a comprehensive set of endpoints for creating and managing identity verification sessions. With our API, you can:

• 📨 Create IDV sessions for your applicants
• 📋 Retrieve session information and status
• 🔍 Retrieve sessions under an organization
• 🔐 Manage authentication with API keys

Getting Started

To begin using the DeepIDV API:

1. 🔐 Authentication - Learn how to authenticate your API requests
2. 🔍 Verification Methods - Manage and verify sessions
3. 📌 Workflows Methods - Manage predefined workflows
4. 🏦 Financial Methods - Manage bank statement requests and sessions
5. 💳 Credit Terms - Manage credit terms requests and sessions

Base URL

All API requests should be made to:

https://api.deepidv.com/v1

Authentication

All API requests require authentication using an API key. See the Authentication section for details on how to obtain and use your API key.

Rate Limiting

The DeepIDV API implements rate limiting to ensure fair usage. If you exceed the rate limits, you will receive a 429 (Too Many Requests) response.

Error Handling

The API uses standard HTTP status codes to indicate the success or failure of requests. See individual endpoint documentation for details on specific error responses.

For a comprehensive list of possible error responses, see our Error Status Reference.

Error Status Reference

The following table describes the possible error responses you may encounter when using the DeepIDV API:

Status Code	Description	Example
400	Bad Request - Invalid request parameters	{"error": "Invalid Body object.", "hints": []}
401	Unauthorized - Invalid API key	{"error": "Invalid API key."}
402	Unauthorized - Payment required	{"error": "Insufficient funds or subscription."}
403	Forbidden - API key is missing	{"error": "API key is missing."}
429	Too Many Requests - Rate limit exceeded	{"error": "Rate limit exceeded."}
500	Internal Server Error - Something went wrong	{"error": "Something went wrong."}

Support

If you have questions or need assistance with the API, please contact DeepIDV Support.