Quickstart

Your First Upload

View as Markdown

A batch upload is the entry point for all list-based verification. You create a batch by sending a TXT file to POST /v1/batch, which returns a batch_uuid you’ll use for every subsequent operation.

You’ll need a valid API key before uploading. If you haven’t created one yet, see Your First API Key.

Steps

1

Prepare your TXT file

Create a plain .txt file with one email or phone number per line, UTF-8 encoded. No headers, no commas, no extra formatting.

alice@example.com
bob@company.org
carol@domain.net
dave@webmail.io

Use E.164 format for phone numbers (+[country code][number]) to ensure accurate parsing. Numbers without a country code may be rejected or incorrectly routed.

2

Choose a name and description

Every batch requires a name (1–255 characters). A description is optional (up to 2,048 characters) but helps you identify batches later.

Good names: Q2 Customer Import, Newsletter List April, Lead Gen Campaign - US

3

Upload the file

Send a multipart/form-data POST request with your file and parameters:

$curl -X POST https://api.apexverify.com/v1/batch \
>  -H "X-Api-Key: YOUR_API_KEY" \
>  -F "file=@emails.txt" \
>  -F "name=Q2 Customer Import" \
>  -F "description=Quarterly CRM export for verification" \
>  -F "type=email" \
>  -F "target_country=US"

Required form fields:

FieldTypeDescription
filebinaryYour .txt file
namestringBatch display name (max 255 chars)
typeemail | phoneVerification type
target_countryISO2 stringCountry code (e.g. US, SG, GB)

Optional fields: description, target_audience, target_market_industry, target_objective, use_account_cache, use_global_cache. These can also be set or changed later via PUT /v1/batch/{uuid}.

4

Save your batch_uuid

On success, the API returns a batch_uuid. Save this value — it identifies your batch for all subsequent calls (parameters, parsing, launch, status, export, deletion).

1{
2  "status": "ok",
3  "batch_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
4  "created_at": "2026-04-06T10:00:00Z"
5}

What’s Next?

With your batch_uuid in hand, the next step is to configure verification parameters, trigger parsing, and launch the job.

Your First Verification

Walk through the complete lifecycle from upload to exported results.

API Verification Workflow

The full reference guide covering every API call in the batch verification lifecycle.