Member Eligibility Verification API contract

This OpenAPI 3.1 contract defines the integration boundary of the Member Eligibility reference implementation. It was written before the backend and Salesforce client were implemented, and automated contract-alignment tests kept the implementation and the document in agreement.

What the contract covers

• One operation: POST /api/v1/eligibility/verify with a required, non-empty memberId.
• Three successful business statuses: ELIGIBLE, INELIGIBLE, and UNABLE_TO_DETERMINE, with reason text and nullable coverage fields.
• Structured errors for HTTP 400, 404, and 500, each carrying code, message, timestamp, and correlationId.
• Complete request and response examples using synthetic member data only.

Who it is for

Engineers and architects designing contract-first integrations — particularly where a thin client (such as a Salesforce Lightning experience) delegates a business decision to a single authoritative service. The contract demonstrates precise enum modeling, nullable-field behavior, deliberate error translation, and example-driven documentation.

How to use it

Use the downloadable YAML as a reference structure for your own eligibility-style contracts, or load it into OpenAPI tooling to explore the schemas and examples. The reference implementation shows the contract driving both a FastAPI backend and a Salesforce client.

Limitations

• The contract defines no security scheme; Version 1 of the implementation deliberately used unauthenticated demonstration communication. Production use requires explicit authentication and authorization design.
• No live endpoint is offered. Do not call the operation against any published URL; the reference backend ran locally.
• All examples are synthetic. Workflow Insurance is a fictional organization.

Provenance

The authoritative contract lives at contracts/member-eligibility.yaml in the source repository. This copy was verified at commit 4ca20305 on 2026-08-08.