Match API
Compare two records and return a confidence that they represent the same entity, with contributing factors.
What it does
Decide whether two records refer to the same real-world entity.
When to use it
Reach for Match when you need to answer: “Are these records the same thing?” It sits in the Understand stage of the catalog — compare records and explain results.
Endpoint & cost
POST /api/v1/match
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/match \
-H "Authorization: Bearer zap_live_••••••" \
-H "Content-Type: application/json" \
-d '{"left":{"customer_name":"Acme Incorporated","email":"billing@acme.com"},"right":{"customer_name":"ACME Inc.","email":"billing@acme.com"}}'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 Match in the playground to see the request, or run it live with your API key.