Skip to navigation

Read a company or person identity without scheduling enrichment

View as Markdown

Runs the existing company and person identification ladders and returns MATCHED, NO_MATCH, or NEEDS_REVIEW within the caller’s visibility. This read never schedules background enrichment or repair. Name-identification quota and live deadlines apply.

Authentication

AuthorizationBearer

Your aVenture API key (https://aventure.vc/settings/api-keys) or OAuth access token

Query parameters

namestringRequired0-200 characters

Name exactly as the source writes it, such as Acme AI or Jane Doe. Required even when url is sent; to read a record from only a URL (an aVenture page, website, or domain) use the exact read instead: entities lookup-exact get --url, or people lookup-exact get --url for a person.

urllist of stringsOptional

URLs the subject owns: its website, its LinkedIn company or person profile, or a registry page. At most 10. Put articles in sourceUrl.

locationstringOptional0-2000 characters

City, region, or country, such as Austin, TX. Tells namesakes apart; not proof on its own.

contextstringOptional0-2000 characters

Specific facts in plain words: product, industry, employer and title, or founder names. Generic words like startup add nothing.

sourceNewsIdintegerOptional

aVenture news id of the article that mentions the subject; an unknown id is a 400.

sourceUrlstringOptional0-2000 characters

URL of the article that mentions the subject; read from aVenture news when stored there, otherwise fetched.

includePrivatebooleanOptional

Also considers hidden and unpublished records; needs private-visibility authority. Without it, NO_MATCH covers only records you can see.

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
candidatelist of objects
Records considered, most probable first.
detailstring
One sentence naming what settled the answer or what the user must decide.
duplicatelist of objects

Other stored records judged to be this same subject stored again: likely duplicate records to merge into match. Empty when none were found.

stageenum
The ladder step that settled the answer.
Allowed values:
statusenum

What the caller does next: act on match, create, or ask the user.

Allowed values:
matchobject or nullOptional
The matched record when status is MATCHED.
matchConfidencedouble or nullOptional

Decision-model confidence, 0 to 1, in its pick: the candidate it named as the subject, or, when it picked none, that no candidate is. Present whenever a judgment ran, including a none pick; absent when no judgment ran. The kind-agnostic lookup reports the side whose answer it returns.

matchEvidenceProbabilitydouble or nullOptional

Decision-model probability, 0 to 1, that the evidence can tell the subject apart from namesakes. Absent when no judgment ran. The kind-agnostic lookup reports the side whose answer it returns.

officialUrlstring or nullOptional
The subject's own website or profile page found in web search. Use it as the website when creating the record only if it is the subject's own domain, not a LinkedIn, Crunchbase, or other profile page.

Errors

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