Get a lookup job's state and the records its article names

View as Markdown
Returns the job state and, once COMPLETED, one mention per company or person the article names: its identification (MATCHED gives the stored record, NEEDS_REVIEW the candidates) and, for NO_MATCH, the hidden shell record created for it or shellDetail saying why none was. A name whose lookup failed carries failureReason instead; send it alone to POST /v1/lookup. Only the caller that started the job can read it.

Authentication

AuthorizationBearer

User bearer token: an aVenture API key, an OAuth access token, or a signed-in session token

Path parameters

jobIdstringRequiredformat: "uuid"
Lookup job id from the create response.

Response headers

X-RateLimit-Limitinteger

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-Remaininginteger

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-Resetinteger

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

OK
createdAtdatetime
When the job was requested.
jobIdstringformat: "uuid"
Lookup job id.
mentionlist of objects

Each distinct company and person the article names; empty until COMPLETED.

sourceobject
The article the job reads.
stateenum
Current job state.
updatedAtdatetime
When the job last changed state.
failureReasonstring or nullOptional

Why the job failed; absent unless state is FAILED.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
406
Not Acceptable Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error