Primary - Decisions

Compare how confirmed person facts change reachable offers

Evaluates a baseline and candidate person against the same immutable full-fleet eligibility graph, exact product request, and union rate read. The response reports newly reachable, no-longer-reachable, preserved, membership-path changes, and best-offer movement without treating unknown as rejection. Both profiles and all resulting paths are private and returned with Cache-Control: no-store.

Authentication required: Pass your API key in the X-API-Key header.

post/v1/reachable-offers/compare

Request

  • Base URL: https://api.rateapi.dev
  • URL: https://api.rateapi.dev/v1/reachable-offers/compare
  • Auth: API key in header X-API-Key

Request body

baseline_personPerson required(unresolved $ref)
candidate_personPerson required(unresolved $ref)
productProduct required(unresolved $ref)
limitinteger

Visible rows per comparison bucket after both profiles have been evaluated against the full shared graph snapshot.

Response

Snapshot-consistent before/after comparison with source-backed offers and publication identities.

productProduct required(unresolved $ref)
baselineobject required

Bounded baseline reachable-offers summary.

candidateobject required

Bounded candidate reachable-offers summary.

deltasobject required

Stable-institution before/after changes; source evidence remains on each underlying offer.

snapshotobject required

Shared graph/rate-read boundaries and publication identities used for the comparison.

semanticsstring required

Positive-evidence comparison semantics, including that unknown is never ineligible.

disclosurestring required

Required explanation of what changed reachability does and does not prove.

Changes

No recorded changes to this operation across all 1 revision of this API.