Getting Started

Authentication

Secure Access with Bearer Authentication

DeepEnrich API protects your data with Bearer Authentication. Simply include your valid API key in the Authorization header of every request to authenticate securely.Ensure every API request contains this authorization header for seamless access to DeepEnrich services.

How to Include Your API Key in a Request:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Your API key can be found on you API Dashboard

  • API Dashboard Sign up for a DeepEnrich account and try the API for free today!
Using Your API Key Securely

To authenticate, replace YOUR_API_KEY with the actual key from your dashboard. Every endpoint requires it — requests without a valid key are rejected before any work is done.

Failure Modes
  • 400 Bad Request
    The header is missing, is not in the form Bearer < key >, or the key is not recognised.
    Body: { "message": "Please provide valid api key" }
  • 404 Not Found
    The key is valid but the owning account is missing.
    Body: { "message": "User not found" }
  • An unknown key and a malformed header return the same response, deliberately. Do not branch on the difference.
Purchase Permission

Beyond a valid key, your account must hold the Purchase and API permission. Without it a request is still accepted, but the worker ends it with status interrupted and reason no purchase permission — no data and no charge. Treat this as a provisioning prerequisite rather than an API error, and check it before going live.

Security Best Practices
  • Keep it private – Never share your API key publicly.
  • Regenerate if compromised – If you suspect unauthorized access, immediately generate a new key from your dashboard.
  • Verify before you integrate – Call GET /v1/account/profile/verify to confirm a key is live.