Access and authentication
To use the DeepVerify API, you must authenticate your requests using an API key, ensuring secure access to our services. Here's how to get started:
DeepVerify API is currently in Alpha. While we don't anticipate the API format to change, it might. Contact us to get a alpha access and heads up on breaking changes.
Getting your API Key
Sign Up: Create an account on the Factagora developer portal.
Generate API Key: After registering, navigate to the API section of your dashboard and generate your unique API key. This key will be required for authenticating all API requests.
Secure Your API Key: Treat your API key like a password—do not share it publicly or expose it in client-side code. If your key is compromised, you can regenerate it from the dashboard.
Authentication Process
The DeepVerify API uses token-based authentication. Include your API key in the Authorization header of each request using the following format:
Making an Authenticated API Request
Here’s an example of how to send a request with your API key:
In this example:
YOUR_API_KEY should be replaced with your actual API key.
input_text is the text or data you want to submit for verification.
Error Handling
If your API key is missing, invalid, or expired, the API will return an error message like the following:
Make sure your API key is correct and active to avoid authentication errors.
Best Practices
Rotate Your API Keys: Regularly rotate your API keys to ensure security.
Limit Permissions: If your API supports scopes, limit the permissions of your API key to only the necessary services.
Monitor Usage: Use the Factagora dashboard to monitor your API key usage and track potential misuse.
Last updated