Quickstart

Your First Verification

View as Markdown

This guide walks through the complete batch verification lifecycle — from uploading a file to downloading your results — in five steps.

Prerequisites: an API key and a .txt file ready to upload. For a deeper dive into every step, see the API Verification Workflow guide.

Steps

1

Upload your file

Create a batch by uploading your .txt file. Save the batch_uuid from the response — you’ll need it for every subsequent call.

$curl -X POST https://api.apexverify.com/v1/batch \
>  -H "X-Api-Key: YOUR_API_KEY" \
>  -F "file=@emails.txt" \
>  -F "name=My First Batch" \
>  -F "type=email" \
>  -F "target_country=US"
1{
2  "status": "ok",
3  "batch_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
4  "created_at": "2026-04-06T10:00:00Z"
5}
2

Configure parameters

Set or confirm the verification parameters. type and target_country are required; all other fields are optional.

$curl -X PUT https://api.apexverify.com/v1/batch/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
>  -H "X-Api-Key: YOUR_API_KEY" \
>  -H "Content-Type: application/json" \
>  -d '{
>    "type": "email",
>    "target_country": "US",
>    "use_account_cache": true,
>    "use_global_cache": true
>  }'
1{ "message": "Success" }
3

Trigger parsing

Tell ApexVerify to parse and prepare the batch. The server validates rows, removes duplicates (if enabled), and calculates verification cost.

$curl -X PATCH https://api.apexverify.com/v1/batch/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
>  -H "X-Api-Key: YOUR_API_KEY"
1{ "status": "ok" }

Poll GET /v1/batch/{uuid} until the status reaches ready_for_verification before proceeding.

4

Launch verification

Once the batch is ready_for_verification, start the verification job:

$curl -X POST https://api.apexverify.com/v1/batch/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
>  -H "X-Api-Key: YOUR_API_KEY"
1{ "status": "ok" }

Poll GET /v1/batch/{uuid} periodically until the status changes to verification_done.

5

Export your results

Download results once verification is complete. Choose XLSX for a spreadsheet or JSON for programmatic access:

$# JSON export (full result data)
$curl -X GET "https://api.apexverify.com/v1/batch/a1b2c3d4-e5f6-7890-abcd-ef1234567890/export?format=json" \
>  -H "X-Api-Key: YOUR_API_KEY"
$
$# XLSX export (Excel file)
$curl -X GET "https://api.apexverify.com/v1/batch/a1b2c3d4-e5f6-7890-abcd-ef1234567890/export?format=xlsx" \
>  -H "X-Api-Key: YOUR_API_KEY" \
>  -o results.xlsx

You’re done! When the export returns your results, your first batch verification is complete. Each email or phone in the response includes quality signals, validity flags, and detailed metadata.

What’s Next?

API Verification Workflow

The complete reference — every endpoint, every parameter, every response shape explained in full.

List Verification

Best practices for preparing and verifying large contact lists efficiently.