Compare API

Return a structured diff of two records or datasets so you can see exactly what changed.

What it does

Surface the differences between two records or datasets.

When to use it

Reach for Compare when you need to answer: “What changed between these two?” It sits in the Understand stage of the catalog — compare records and explain results.

Endpoint & cost

POST /api/v1/compare

Cost: 1 Zap. 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://api.zapiit.com/v1/compare \
  -H "Authorization: Bearer zap_live_••••••" \
  -H "Content-Type: application/json" \
  -d '{"before":{"status":"open","total":12500},"after":{"status":"paid","total":11840}}'

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

The TypeScript SDK (@zapiit/sdk) is coming soon. Until it ships, call the endpoint over HTTPS with the example above — the API is plain JSON and needs no dependency.

Try it

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

Match — Decide whether two records refer to the same real-world entity.
Explain — Get a structured, factor-by-factor explanation of a result.