aVenture APISEC

Attach a company's SEC identifiers to an entity

View as Markdown

Resolves a public company by ticker (preferred) or name and attaches its available SEC external identifiers (CIK, ticker, and EIN when SEC supplies one) to the target entity as res_unique_id rows — validated against the unique-id contract and stamped source sec-edgar. Idempotent: identifiers already mapped to the entity are reported, not re-written.

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 attach identifiers 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
alreadyPresentlist of objects

Unique-id rows already mapped to the entity and therefore skipped.

attachedlist of objects

Unique-id rows written to the entity by this call.

cikstring
SEC Central Index Key of the resolved company.

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