Link API

Links records across two datasets by field-level similarity, returning matched pairs with their score and matching fields plus the unmatched rows on each side. Deterministic greedy matching above a threshold.

What it does

Record linkage across two datasets.

When to use it

Reach for Link when you need to answer: “Which records in dataset A correspond to records in dataset B?” It sits in the Reconcile stage of the catalog — match expected against actual.

Endpoint & cost

POST /api/v1/link

Cost: Per credit. Zaps draw down your shared monthly allowance; requests that fail validation are not charged.

Authentication

Send your key as a bearer token: Authorization: Bearer zap_live_…. See Authentication for key management and the alternate header.

Example request

curl https://zapinner.com/api/v1/link \
  -H "Authorization: Bearer zap_live_••••••" \
  -H "Content-Type: application/json" \
  -d '{"source_a":[{"email":"alan@example.com","name":"Alan"}],"source_b":[{"email":"alan@example.com","name":"Alan"}],"options":{"threshold":0.8}}'

Every response is structured JSON and includes a request_id. Full field-level request and response schemas for this endpoint live in the OpenAPI spec and the API reference.

Errors & limits

Errors use one consistent shape ( error.code, error.message, request_id). See Errors and Rate limits.

SDK

Link has typed methods in both the JavaScript and Python SDKs. Both are implemented and package-ready but not yet published to npm / PyPI — until they ship, vendor the package source or install from a git ref, or call the endpoint over HTTPS with the example above.

Try it

Select Link in the playground to see the request, or run it live with your API key.

Reconciliation — Compare two datasets and surface mismatches, duplicates, and missing records.
Entity Resolution — Cluster records into entities and emit one canonical record each.
Conflicts — Find fields whose values disagree across records sharing a key.
Merge — Collapse duplicate records into one golden record with provenance.
Survivorship — Collapse keyed groups into golden records with survivorship rules.
Similarity — Score pairwise similarity within one record set.