API Authentication

View as Markdown

The ApexVerify API uses API keys to authenticate and authorize requests. You must include your unique API key with every request made to our endpoints to identify your client application.

Security Recommendation: Keep your API key confidential. Never expose it in client-side application code, public repositories, or unsecured environments.

Authenticating Requests

To authenticate, pass your API key as a custom HTTP header named X-Api-Key in all your HTTP requests.

1GET /v1/account/credits HTTP/1.1
2Host: api.apexverify.com
3X-Api-Key: YOUR_API_KEY

Authentication Errors

If an API request is submitted without the X-Api-Key header, or if the provided key is invalid or revoked, the server will block the request and return a standard 401 Unauthorized HTTP status code.

1HTTP/1.1 401 Unauthorized
2Content-Type: application/json
3
4{
5 "message": "Unauthorized"
6}