Skip to navigation
Identity verification APIEntities

Retrieve an import job

Returns the progress of a bulk import and its first 50 failures.

Error codes

errorStatusMeaning
import_job_not_found404No import job has this identifier in this organisation and environment.
secret_key_required403A publishable key was used. This API accepts secret keys only.
environment_mismatch403The key belongs to an environment this host does not serve.
rate_limited429The request rate limit for this key was reached. Retry after a short wait.
rate_limit_store_unavailable503Rate limiting is temporarily unavailable. Retry shortly.

A missing or unknown key returns 401 with a plain sentence in error rather than a code.

Requires a secret (sk_) key. A publishable key receives 403 secret_key_required.

Authentication

AuthorizationBearer
Send the API key as a Bearer token. Each operation states whether a publishable key is enough or a secret key is required.

Path parameters

jobIdstringRequired

The jobId returned when the import was accepted.

Response

Success
jobIdstring
The identifier of the import job.
statusenum

The state of the job. COMPLETED means every item has been attempted, including any that failed.

Allowed values:
totalCountinteger
How many entities the job holds.
succeededCountinteger
How many entities were registered.
failedCountinteger
How many entities could not be registered.
pendingCountinteger
How many entities are still waiting to be processed.
createdAtdatetime
When the job was accepted.
completedAtdatetime or null
When the last item was processed.
failureslist of objects
The first 50 failed items, so they can be corrected and sent again.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
503
Service Unavailable Error