Skip to content
EnrichedYak

Documentation

API reference

Base URL https://enriched.yakware.com/api/v1. JSON in and out. Authenticate with Authorization: Bearer ey_…. Writes accept an Idempotency-Key header (8–255 characters, kept 24 hours). Machine-readable spec: openapi.yaml.

Method Path Scope What it does
POST /enrich/company enrich:write Enrich by domain (or name for a company already in the graph). 200 cached, 202 queued, 422 needs a domain.
POST /enrich/person enrich:write Find a named person at a company domain from its published team pages.
GET /enrich/requests/{id} enrich:read Status of a request, and the company once done.
GET /companies/{id} enrich:read Profile. include=provenance, min_confidence.
GET /companies/{id}/events enrich:read Change events, newest first. since (ISO 8601).
POST /search enrich:read query (natural language) or filters; limit, offset.
GET /industries, /industries/{slug} enrich:read The ontology, code mappings (NAICS, SIC, UK SIC, NACE) and relationships.
GET /technologies enrich:read The technology catalogue.
GET /usage enrich:read Plan, credits used and remaining, watch slots.
GET/POST /watchlists enrich:read / watchlists:write List or create watchlists.
GET/PATCH/DELETE /watchlists/{id} enrich:read / watchlists:write Read, update or delete one.
POST/DELETE /watchlists/{id}/items watchlists:write Add a company by domain; remove by item id.

Errors

Errors are {"error": {"code": "…", "message": "…"}}.

Status Code Meaning
401 unauthorized Missing or revoked key.
403 insufficient_scope The key lacks the scope this route needs.
402 credits_exhausted, watch_limit, webhooks_not_in_plan Your plan does not cover this; upgrade or wait for the next period.
404 not_found Unknown, or not yet enriched by your account.
409 idempotency_* Key in flight, or reused with a different request.
422 invalid_domain, blank_input, needs_domain Fix the input.