aVenture APISEC

Add a company's SEC legal and former names as entity aliases

View as Markdown

Resolves a public company by ticker (preferred) or name and adds its SEC legal name and former names to the target entity as relatedLegal aliases, stamped source sec-edgar. Names already present as the entity’s brand/legal name or an existing alias are skipped. Returns the aliases newly added.

Authentication

AuthorizationBearer

User bearer token: Supabase or Clerk session JWT, Clerk OAuth access token, or Clerk personal API key

OR
X-API-Keystring

Admin API key for system-to-system write operations

Path parameters

entityIdstringRequiredformat: "uuid"
Canonical entity UUID to add aliases to

Query parameters

tickerstringOptional

Trading ticker symbol (preferred resolver)

namestringOptional

Company name query (used when no ticker is given)

sourceTypeenumRequired
Write provenance source type.
sourceDetailstringRequired
Source detail or reviewer reference for the write.
sourceProviderstringOptional

Provider name for provider-native IDs or slugs.

sourceProviderIdstringOptional

Provider-native source ID.

sourceProviderSlugstringOptional

Provider-native source slug.

actorTypeenumOptional

Actor type; inferred as agent when agentChassis and agentModel are supplied, or as employee from an authenticated user JWT session.

Allowed values:
agentChassisstringOptional

Agent chassis token for agent-authored writes.

agentModelstringOptional

Agent model id for agent-authored writes.

Response

Created
namestring
Alternate name text
displayableboolean or nullOptional
Show this alias in public name displays.
typeenum or nullOptional
Alias type classification

Errors

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