POST /v1/enrich/async, use this endpoint to check the progress of your job and retrieve enriched results once processing is complete. You authenticate with the same API key used to create the job — the API will return 401 if the keys don’t match. Poll this endpoint until the status field is either complete or failed; at that point, no further polling is needed.
Path Parameters
The UUID of the async enrichment job, as returned in the
job_id field of the POST /v1/enrich/async response (e.g. "84c8a82d-1234-5678-abcd-ef0123456789").Job Status Values
| Status | Meaning |
|---|---|
queued | The job has been accepted but has not yet started processing. |
processing | Enrichment is actively running. Results are not yet available. |
complete | All items have been processed. The results array is fully populated. |
failed | A fatal error occurred. Contact support with your job_id for investigation. |
Response Schema
The response shape is consistent across all job states. Theresults array is empty while the job is queued or processing, and fully populated once it reaches complete.
The job UUID, matching the
id path parameter you requested.The current job status:
queued, processing, complete, or failed.The total number of transaction strings submitted in the original batch. Present once the job has been picked up for processing.
An empty array
[] while the job is queued or processing. When status is complete, this array contains one result object per submitted transaction, in the same order as originally submitted.ISO 8601 timestamp of when the job was submitted.
ISO 8601 timestamp of the most recent status update.
Polling Best Practices
Stop polling as soon asstatus is complete or failed — the job state will not change after reaching either terminal state.
Error Responses
| HTTP Status | Condition | Response Body |
|---|---|---|
401 Unauthorized | X-API-Key header is missing or empty | {"error": "Missing API key. Provide your key via the X-API-Key header."} |
401 Unauthorized | Key does not match the key used to create the job, or key is revoked | {"error": "Invalid or revoked API key."} |
404 Not Found | No job exists with the provided UUID | {"error": "Job not found."} |
500 Internal Server Error | Unexpected server-side failure | {"error": "Internal Server Error"} |