API reference / Email verification
Get a verification job
Written and maintained by The ProspectAPIs team
GET/v1/email/verify/jobs/:id
GET /v1/email/verify/jobs/:id is the ProspectAPIs operation getEmailVerifyJob, in the Email verification group of the REST API. Progress and cost of one of your jobs. Free. Cost: free. Send your API key as a Bearer token in the Authorization header.
How this fits with the rest of the email verification API, with worked examples, is in the email verification guide.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| id required | path | string (uuid) |
Responses
| Status | Meaning |
|---|---|
| 200 | The job. |
| 401 | The API key is missing or invalid. |
| 404 | No such job on this account. |
Every error answers with the same JSON body, an error string and sometimes a code; the errors page lists each status and when it happens.
200 response fields
The job. The body is a EmailVerifyJob.
| Field | Type | Description |
|---|---|---|
| id required | string (uuid) | |
| status required | string: queued, running, completed, cancelled | |
| total required | integer | |
| done required | integer | |
| charged_count required | integer | |
| amount_usd required | number | |
| callback_url | string or null | |
| callback_status | string or null: delivered, failed, | |
| created_at required | string (date-time) | |
| completed_at | string (date-time) or null | |
| secret | string | Only in the 202 create response: the HMAC key for the completion callback's Prospect-Signature header. |
Code samples
Each sample sends the same request. Set PROSPECTAPIS_KEY in your environment first. Values come from the spec's examples; replace them with your own.
curl https://api.prospectapis.com/v1/email/verify/jobs/3f6c1d2e-8b4a-4f7e-9c21-5a0d7e9b4c13 \
-H "Authorization: Bearer $PROSPECTAPIS_KEY"const res = await fetch("https://api.prospectapis.com/v1/email/verify/jobs/3f6c1d2e-8b4a-4f7e-9c21-5a0d7e9b4c13", {
headers: { Authorization: `Bearer ${process.env.PROSPECTAPIS_KEY}` },
});
if (!res.ok) throw new Error(`${res.status}: ${(await res.json().catch(() => ({}))).error ?? res.statusText}`);
const data = await res.json();
console.log(data);import os, requests
res = requests.get(
"https://api.prospectapis.com/v1/email/verify/jobs/3f6c1d2e-8b4a-4f7e-9c21-5a0d7e9b4c13",
headers={"Authorization": f"Bearer {os.environ['PROSPECTAPIS_KEY']}"},
timeout=30,
)
res.raise_for_status()
data = res.json()
print(data)Billing
This call is free: it never spends credits, so you can call it as often as the rate limit allows. Metered calls on the same key report your balance after each response in X-Credits-Remaining, and GET /v1/account shows it at any time.
Related
The email verification guide covers this area end to end. Previous operation: Start a verification job. Next operation: Get a job's results. Every operation, grouped by area, is on the API reference index.
Create a free account to get a key, then run the samples above with your own values.
Was this page helpful?