aVenture APIUnique I Ds

Attach a unique id to an entity

View as Markdown

Attaches an external identifier to the owner. idType accepts a canonical token or alias; the value is normalized and validated against the type’s format pattern and owner scope. Rejects a duplicate (idType, identifier) already mapped to this owner. Provenance query parameters are required for audit.

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.

Query parameters

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.

Request

This endpoint expects an object.
idTypestring or nullOptional
Identifier type token, for example ein, secCik, or ticker.
identifierstring or nullOptional
Identifier value as issued by the registry.
sourcestring or nullOptional
Optional attribution source label for the mapping.

Response

Created
createdAtdatetime
Row creation timestamp.
idinteger

Unique-id row id.

idTypeenum
Identifier type.
identifierstring

Identifier value as issued by the registry (normalized per type).

ownerobject

Owning entity or person id; exactly one nested id is present.

updatedAtdatetime
Row update timestamp.
sourcestring or nullOptional
Attribution source label for the mapping, when recorded.

Errors

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