Reference Data

Browse or search canonical eligibility organizations

Browses or searches only organizations named by positive conditions in current active eligibility publications. Omit query to retrieve the most connected organizations for the requested types; this browse order reflects graph connectivity, not popularity, quality, or a recommendation. Results are organization identities for caller confirmation—not proof that the person has the relationship and not an eligibility verdict. Queries are private, never body-logged, and returned with Cache-Control: no-store.

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

post/v1/eligibility/entities/search

Request

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

Request body

querystring

Optional organization name or prefix. Omit to browse the most connected active-publication organizations for the requested types.

typesstring[]

Optional organization types to search; omitting it searches all supported types.

limitinteger

Maximum ranked entities returned for this bounded query.

Response

Bounded canonical organizations ranked by normalized exact/prefix match for search, or active-publication connectivity for browse.

querystring nullable required

Caller query returned for this no-store response, or null in browse mode.

normalized_querystring nullable required

Normalized comparison key used for exact and prefix search, or null in browse mode.

query_truncatedunknown required
result_mode'search' | 'most_connected' required

Whether results follow text-match ranking or query-less graph-connectivity ranking. Most-connected is not a popularity or recommendation signal.

typesstring[] required

Organization types searched by this request.

result_limitinteger required

Bound applied to the visible result list.

results_truncatedboolean required

Whether more ranked matches existed beyond result_limit.

semantics'organization_discovery_not_eligibility' required

Explicit guard that discovery is not a membership decision.

disclosurestring required

Required explanation of confirmation, evidence, and eligibility boundaries.

Changes

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