Docs Master data

Golden-record API

Lookup, read, related facts, propose, changes since and bulk lookup, with confidence and rule in every answer.

Lookup

POST /golden/{domain}/lookup
{ "legal_name": "Acme Comp.", "country": "DE", "vat_id": "DE 812 345 678", "create": false, "expand": ["xref", "open_pos"] }

200 { "golden_id": "L-00731", "confidence": 0.97, "rule": "R-supplier-04 v3", "status": "match", ... }
200 { "status": "review", "proposal": 4118, "candidates": [ ... ] }
200 { "status": "no_match" }            -- with create: true → 201 and the new golden_id

Read

GET /golden/{domain}/{id}?fields=legal_name,vat_id,sites.address.postcode&as_of=2026-03-31
GET /golden/{domain}/by-source/{system}/{key}
GET /golden/{domain}/{id}/related/{object}?since=2026-07-01&page=2

Propose and changes

POST /golden/{domain}/{id}/propose   { "field": "payment_terms", "value": "Net 45", "evidence": "AG-4409" }
GET  /golden/{domain}/changes?since=2026-09-01T00:00:00Z   -- no cap; cursor-paged

Limits

page sizedefault 100, maximum 1,000; related facts default 60
rate limitper client per endpoint, in the response headers
bulk lookupPOST /golden/{domain}/bulk-lookup with a file; asynchronous; results per row
freshnesseach expanded object carries its contract: live, cached N min, replica batch