Authentication
For a secure connection and access to DeepIDV features, each registered DeepIDV Admin or Agent User type can generate and manage their API keys within the DeepIDV application.
Table of Contents
API Key Usage
This API key will be used to:
- Authenticate the request to the DeepIDV API Endpoint
- Identify the User making the request
Required Development Tasks
API Key Management
- Allow the User to enter their DeepIDV API within the system
- The system will need to securely store and manage the API Key for the user who entered it
Authentication Header
All API calls made by the system to DeepIDV will need to include the Authentication token in a designated HTTP header.
Authentication Header Format
| Type | Params | Values | Description |
|---|---|---|---|
| HEADER* | x-api-key | string | The Users API Key |
Example
x-api-key: YOUR_API_KEY_HERE
Important Security Notes
- Never expose your API key in client-side code
- Use environment variables or secure storage for API key management
- Regenerate API keys immediately if you suspect they have been compromised
Error Responses
| Status Code | Error Message | Description |
|---|---|---|
| 403 | {"error": "API key is missing."} | No API key was provided in the request |
| 401 | {"error": "Invalid API key."} | The provided API key is invalid or expired |