Reference Data

Which credit unions' published membership area reaches this place?

The place-based inverse lookup, and the data source behind the public /who-can-join/* pages. Given a state (and optionally a county), returns positive-evidence matches ranked county-specific evidence first, then state-wide, then open-to-anyone.

Unlike POST /v1/eligibility/search, this asks nothing about a person: it reports which institutions' published criteria reach a PLACE, with per-row provenance. The result set is explicitly non-exhaustive: absence is not ineligibility.

Matching stance: a credit union whose record names the state but carries no county detail serves the whole state and is reported as matched: "state" — it is never dropped from a county for lacking county detail. When a non-empty county list omits the requested county, the institution is returned in unknown, because the record cannot prove no other geographic or non-geographic membership path exists. open_to_anyone records match everywhere.

Set open_to_anyone=true to list the nationally-joinable credit unions; in that mode state is optional, because scoping an open-membership list to a state would be false.

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

get/v1/eligibility/search

Request

  • Base URL: https://api.rateapi.dev
  • URL: https://api.rateapi.dev/v1/eligibility/search
  • Auth: API key in header X-API-Key

Query parameters

statestring

2-letter US state code. Required unless open_to_anyone=true.

countystring

County name. A county-type suffix (e.g. ' County', ' Parish') is stripped during matching.

open_to_anyone'true' | 'false'

When true, search open-membership flat candidates and make state optional. Legacy positives remain in results; active graph publications are withheld in unknown until full graph evaluation confirms the composed path.

Response

Positive-evidence place matches — from exact active eligibility publications when available, otherwise from live compatibility graph rules or the legacy flat record — plus unknown non-matches. Only pure place/open graph paths are eligible for a positive GET match; compound paths remain unknown. Non-exhaustive; absence is not ineligibility.

statestring

Echo of the requested state. Omitted when none was supplied.

countystring

Echo of the requested county, normalized. Omitted when none was supplied.

open_to_anyone_onlyboolean

Present and true when the open-membership filter was applied.

result_semantics'positive_evidence_only' required

The positive results are non-exhaustive. A missing credit union, or a row in unknown, must not be interpreted as ineligible.

countinteger required

Number of matching credit unions returned.

unknown_countinteger required

Number of non-positive rows whose held rules do not prove a pure place/open match.

disclosurestring required

Statement that must be shown to a consumer alongside this result.

Changes

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