Skip to main content
GET
Get Single Email Request Status and Enrichment Result
Poll the status of a previously submitted single NPI enrichment request. The response includes a unified envelope with batch metadata, webhook details, your custom_data, credit usage, and the per-request result. Prefer webhooks over polling to avoid hitting rate limits.

Path parameters

string
required
The request ID returned by POST /api/v1/email.

Header parameters

string
required
Bearer <your_api_key>
string
Optional alternative to the Authorization Bearer scheme. Your API key sent as a header.

Request example

Response

object
required
Batch metadata for this request.
object | null
Webhook configuration and delivery status. null when no webhook was provided at submission.
object | null
The exact JSON object you provided in the submission request.
object | null
Credit usage for this response.
object[]
required
Array of per-request results. For a single request this contains one item.

Status values

Example response

Errors

  • Missing or invalid API keys are rejected.
  • 403: Revoked or inactive API key.
  • 422: Validation error, with a response body like:

Tips

  • Use webhooks as your primary notification mechanism and poll only as a fallback if a webhook does not arrive.
  • Dedupe updates by request_id so replays and retries do not create duplicate records in your system.