Capabilities Headless API

Pass the keys you know. Get the golden record back.

A satellite application, a portal, a planning system or an agent sends the attributes it has (a name, a country, a tax number, a part number) and receives the golden id, the record, the cross-reference and, on request, live related facts such as open orders.

Supplier portalor any applicationOnboarding formname · country · VATLIMA GOLDEN-RECORD SERVICEPOST /api/v1/golden/supplier/lookup1 · standardise the payload2 · run the domain match rules3 · score every candidate4 · answer: golden id, record, xref, confidencekeys ingolden outGolden recordL-00731 · 0.97Or: no matchcreate with the same callsame policy and same audit as the steward screen · rate limit and page size published per endpoint
The lookup: keys in, golden record out, with the same policy and audit as the steward's screen.
84 ms
median answer on the showcase estate, four systems behind it
showcase
1
call to look up or create
product
100%
of lookups logged with the caller and the policy
product
published
page sizes and rate limits per endpoint
product
The call

Request and response

request
# the portal asks with what it knows
POST /api/v1/golden/supplier/lookup
{
  "legal_name": "Acme Comp.",
  "country": "DE",
  "vat_id": "DE 812 345 678",
  "postcode": "71034",
  "expand": ["xref", "open_pos"]
}
response
# Lima answers with the golden record
200 OK · 84 ms
{
  "golden_id": "L-00731",
  "confidence": 0.97, "rule": "R-supplier-04 v3",
  "legal_name": "Acme Components GmbH",
  "lifecycle": "active",
  "xref": {"sap": "0000104471", "oracle": "300000098", "portal": "SUP-88213"},
  "open_pos": {"count": 62, "value": 1200000, "currency": "EUR"}
}

Confidence, rule and version are in every answer, so the caller can decide what to do below a score. Related facts come from the same bed through the cross-reference, live. The answer carries only the columns the caller's identity may see.

Step by step

What happens between the request and the answer

Standardise the payloadThe name is cased, the legal form recognised, the VAT ID normalised, the postcode checked against the country.
Endpoints

The golden-record family

EndpointDoesNotes
POST /golden/{domain}/lookupmatch a payload; optionally createconfidence, rule, version; expand facts
GET /golden/{domain}/{id}read a golden recordfields= selects any combination; as_of= for point in time
GET /golden/{domain}/by-source/{system}/{key}read by a source keythe cross-reference resolves it
GET /golden/{domain}/{id}/related/{object}live related factsorders, invoices, tickets, hierarchy position
POST /golden/{domain}/{id}/proposepropose a change with evidenceenters the steward queue or applies within its allowed range
GET /golden/{domain}/changes?since=changes since a timefor consumers that sync; no cap
POST /golden/{domain}/bulk-lookupmatch a file of payloadsasynchronous; results per row with confidence

Every endpoint publishes its page size, its rate limit and its freshness contract. Callers authenticate with OAuth 2.0 client credentials or a delegated user token, and the twelve security layers apply to the identity that calls.

Who calls it

Five callers on the showcase estate

Supplier portal

Searches before it creates; shows the applicant whether the company is already a supplier.

Planning system

Resolves item and site keys to golden ids before a load; asks for hierarchy positions.

SmartApps

Every screen bound to a golden record reads it through the same call, with the user's identity.

Agents

Ask for the golden record before acting; propose changes through the propose endpoint, logged at their level.

Spreadsheets and BI

Look up a golden id from a name column; join live facts through SQL.

Terms on this page

HeadlessUsing master data through APIs, with no Lima screen involved.
Search before createCalling the lookup before creating a record anywhere, so duplicates stop at the door.
ExpandAsking the lookup to include related facts through the cross-reference.
Questions

Is the answer always live?

The golden record and the cross-reference are live; related facts follow their column's freshness contract (live, cached or replica), which the answer states.

What about SOAP?

The same operations are published as a WSDL generated from the domain model; see data services.

How are rate limits set?

Per client, per endpoint, published in the developer portal; a client above its limit receives a clear answer and a retry time.

See your first domain built on your data

Bring two systems that hold the same customers, suppliers or materials. In one working day we connect them, run the match on live rows, review the queue with your steward and publish the first golden view with its API.