Quickstart

Your First API Key

View as Markdown

Every request to the ApexVerify API must be authenticated with an API key. This guide walks you through creating your account, generating your first key, and verifying it works — in under 2 minutes.

ApexVerify uses a custom HTTP header for authentication: X-Api-Key: YOUR_API_KEY. Include this header on every API request. Requests without a valid key return 401 Unauthorized.

Steps

1

Create your account

Go to apexverify.com and sign up for a free account. You’ll receive a confirmation email — click the link to activate.

2

Open the Dashboard

Log in at app.apexverify.com. The dashboard is your control center for API keys, batches, credit usage, and settings.

3

Generate your API key

Navigate to Settings → API Keys and click Generate New Key.

Give the key a descriptive label (e.g. production, dev-local, or ci-pipeline) so you can identify it later. Copy the key immediately — it is only shown once.

4

Test your key

Run the following request to confirm the key is working. It fetches your current credit balance:

$curl -X GET https://api.apexverify.com/v1/account/credits \
>  -H "X-Api-Key: YOUR_API_KEY"

A successful response looks like this:

1{
2  "email_credit": 1000.0,
3  "phone_credit": 500.0
4}

If you receive 401 Unauthorized, double-check that the key was copied correctly and the header name is exactly X-Api-Key.

Never expose your API key in client-side code, public repositories, or unsecured environments. Treat it like a password. If a key is compromised, revoke it immediately from the Dashboard and generate a replacement.

See Creating Additional API Keys for key rotation best practices.

What’s Next?

Your First Upload

Learn how to upload a TXT file of emails or phone numbers to create your first batch.

Your First Verification

Walk through the complete lifecycle from upload to exported results.