Docs

API reference

Every endpoint is described in the OpenAPI 3.1 document at /openapi.json, which is the authoritative contract. This page is an index.

Authentication

Send your key as "Authorization: Bearer <key>" or in the X-API-Key header. Each key is limited to 10,000 requests per 24 hours.

Endpoints

Method and pathPurpose
POST /api/v1/verify/singleVerify one address
POST /api/v1/verify/bulkVerify up to 50 addresses synchronously
GET|POST /api/v1/verify/disposableFree disposable-domain lookup
POST /api/v1/verify/fileUpload a list (.csv, .txt, .tsv, .xlsx)
GET /api/v1/verify/file/{taskId}Job status; timeout=N long-polls up to 300 s
GET /api/v1/verify/file/{taskId}/resultsResults as CSV (default) or JSON
DELETE /api/v1/verify/file/{taskId}Delete a finished job’s results and file
POST|GET /api/v1/webhooks, DELETE /api/v1/webhooks/{id}Manage webhooks
GET /api/v1/creditsCredit balance

Errors

Errors return success false with a numeric code and an error object holding a stable code and a message.

codeHTTPMeaning
4000400Bad request
4010401Unauthorized
4020402Insufficient credits
4040404Not found
4130413File too large
4290429Rate limited
10005xxInternal error