REST API Reference

Complete reference for the DeepV-ADK REST API.

Base URL


https://api.deepv36.com/v1



Authentication

All requests require authentication via API key:

bash
Authorization: Bearer YOUR_API_KEY



Endpoints

Analyze Applicant

Perform risk analysis on an applicant.

Endpoint:

POST /analyze



Request Body:

json
{
  "applicantData": {
    "firstName": "John",
    "lastName": "Doe",
    "ssn": "123-45-6789",
    "email": "john.doe@example.com",
    "phone": "555-0123",
    "address": {
      "street": "123 Main St",
      "city": "Anytown",
      "state": "CA",
      "zip": "12345"
    }
  },
  "options": {
    "includeReasons": true,
    "riscScoring": true
  }
}



Response:

json
{
  "success": true,
  "riskScore": 750,
  "riscScore": {
    "total": 850,
    "components": {
      "identity": 200,
      "credit": 300,
      "fraud": 350
    }
  },
  "decision": "APPROVE",
  "reasons": [
    "Strong credit history",
    "Verified identity",
    "No fraud indicators"
  ],
  "requestId": "req_1234567890"
}



Get Analysis

Retrieve a previous analysis by ID.

Endpoint:

GET /analyze/:id



Response:

json
{
  "id": "req_1234567890",
  "status": "completed",
  "result": {
    "riskScore": 750,
    "decision": "APPROVE"
  },
  "createdAt": "2025-11-23T10:30:00Z"
}



Batch Analysis

Process multiple applicants in a single request.

Endpoint:

POST /analyze/batch



Request Body:

json
{
  "applicants": [
    {
      "id": "applicant-1",
      "data": { / applicant data / }
    },
    {
      "id": "applicant-2",
      "data": { / applicant data / }
    }
  ]
}



Response:

json
{
  "batchId": "batch_1234567890",
  "status": "processing",
  "totalCount": 2,
  "processedCount": 0
}



Error Codes

| Code | Description |
|------|-------------|
| 400 | Bad Request - Invalid input |
| 401 | Unauthorized - Invalid API key |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not Found - Resource doesn't exist |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Internal Server Error |

Rate Limits

Requests are limited based on your plan:

Headers include: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset



Webhooks

Configure webhooks to receive real-time updates:

json
{
  "url": "https://your-domain.com/webhook",
  "events": ["analysis.completed", "batch.finished"],
  "secret": "webhook_secret_key"
}

Next Steps

GraphQL API
Webhooks