REST API for querying eligibility determinations and decisions. Determinations and Decisions are created and updated by internal event handlers — this API is read-only for external consumers.
https://api.example.com/eligibilityDeterminations
Query eligibility determinations and their decisions.
▶
GET
/determinations
List determinations
#
Retrieve a paginated list of determinations. Filter by applicationId to get the determination for a specific application.
| Name | Type | In | Req | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| applicationId | string | query | Filter by application identifier. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ▶q | string | query | Search query using field:value syntax. Multiple conditions separated by | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Search query using field:value syntax. Multiple conditions separated by spaces are ANDed together. URL Encoding: This parameter must be URL-encoded when sent over HTTP. Most HTTP clients handle this automatically. Examples in this documentation show human-readable syntax for clarity. Syntax
ListsA condition on a list matches when any item matches. That holds for a list of values ( Each condition is checked on its own. Examples
URL Encoding ReferenceWhen manually constructing URLs, encode these characters:
Example: `` | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| limit | integer | query | Maximum number of items to return (1-100). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| offset | integer | query | Number of items to skip before collecting results. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ▶sort | string | query | Comma-separated list of fields to sort the response by. Prefix a field | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comma-separated list of fields to sort the response by. Prefix a field with URL Encoding: This parameter must be URL-encoded when sent over HTTP. Most HTTP clients handle this automatically. Examples below show human-readable syntax for clarity. Which fields a given list endpoint allows is declared in the operation's See Syntax
Examples
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
▶ DeterminationList
▶ items array[Determination] required
▶ status DeterminationStatus required Lifecycle status of the determination. `pending` — created at submission, awaiting processing. `in_progress` — at least one Decision has been resolved. `completed` — all Decisions have reached a terminal state. `withdrawn` — the application was withdrawn before determination completed.
▶ BadRequest
▶ InternalError
▶
GET
/determinations/{determinationId}
Get determination
#
Retrieve a single determination by identifier.
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| determinationId | string | path | ✓ | Unique identifier of the determination. |
▶ Determination
▶ status DeterminationStatus required Lifecycle status of the determination. `pending` — created at submission, awaiting processing. `in_progress` — at least one Decision has been resolved. `completed` — all Decisions have reached a terminal state. `withdrawn` — the application was withdrawn before determination completed.
▶ NotFound
▶ InternalError
▶
GET
/determinations/{determinationId}/decisions
List decisions
#
Retrieve all decisions for a determination.
| Name | Type | In | Req | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| determinationId | string | path | ✓ | Unique identifier of the determination. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ▶q | string | query | Search query using field:value syntax. Multiple conditions separated by | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Search query using field:value syntax. Multiple conditions separated by spaces are ANDed together. URL Encoding: This parameter must be URL-encoded when sent over HTTP. Most HTTP clients handle this automatically. Examples in this documentation show human-readable syntax for clarity. Syntax
ListsA condition on a list matches when any item matches. That holds for a list of values ( Each condition is checked on its own. Examples
URL Encoding ReferenceWhen manually constructing URLs, encode these characters:
Example: `` | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| limit | integer | query | Maximum number of items to return (1-100). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| offset | integer | query | Number of items to skip before collecting results. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ▶sort | string | query | Comma-separated list of fields to sort the response by. Prefix a field | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comma-separated list of fields to sort the response by. Prefix a field with URL Encoding: This parameter must be URL-encoded when sent over HTTP. Most HTTP clients handle this automatically. Examples below show human-readable syntax for clarity. Which fields a given list endpoint allows is declared in the operation's See Syntax
Examples
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
▶ DecisionList
▶ items array[Decision] required
▶ program Program required The program this decision covers.
▶ status DecisionStatus required Outcome status of a single program eligibility decision. `pending` — not yet evaluated, or deferred to caseworker review by the rules engine. `approved` — member meets program requirements. `denied` — member does not meet requirements based on provided information. `ineligible` — member cannot qualify for this program (e.g., citizenship bar, age limit).
▶ path DecisionPath Whether the decision was made automatically or by a caseworker.
▶ electronicChecks array[ElectronicCheckSummary] Summary of electronic checks that informed this decision.
▶ NotFound
▶ InternalError
▶
POST
/determinations/{determinationId}/decisions
Create a decision
#
Create a decision for one household member and program. The system creates these when a determination is created, one per member per program the member applied for. Clients must not call this operation; it will be limited to the system.
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| determinationId | string | path | ✓ | Unique identifier of the determination. |
▶ Decision
▶ program Program required The program this decision covers.
▶ status DecisionStatus required Outcome status of a single program eligibility decision. `pending` — not yet evaluated, or deferred to caseworker review by the rules engine. `approved` — member meets program requirements. `denied` — member does not meet requirements based on provided information. `ineligible` — member cannot qualify for this program (e.g., citizenship bar, age limit).
▶ path DecisionPath Whether the decision was made automatically or by a caseworker.
▶ electronicChecks array[ElectronicCheckSummary] Summary of electronic checks that informed this decision.
▶ Decision
▶ program Program required The program this decision covers.
▶ status DecisionStatus required Outcome status of a single program eligibility decision. `pending` — not yet evaluated, or deferred to caseworker review by the rules engine. `approved` — member meets program requirements. `denied` — member does not meet requirements based on provided information. `ineligible` — member cannot qualify for this program (e.g., citizenship bar, age limit).
▶ path DecisionPath Whether the decision was made automatically or by a caseworker.
▶ electronicChecks array[ElectronicCheckSummary] Summary of electronic checks that informed this decision.
▶ BadRequest
▶ NotFound
▶ UnprocessableEntity
▶ InternalError
▶
GET
/determinations/{determinationId}/decisions/{decisionId}
Get decision
#
Retrieve a single decision by identifier.
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| determinationId | string | path | ✓ | Unique identifier of the determination. |
| decisionId | string | path | ✓ | Unique identifier of the decision. |
▶ Decision
▶ program Program required The program this decision covers.
▶ status DecisionStatus required Outcome status of a single program eligibility decision. `pending` — not yet evaluated, or deferred to caseworker review by the rules engine. `approved` — member meets program requirements. `denied` — member does not meet requirements based on provided information. `ineligible` — member cannot qualify for this program (e.g., citizenship bar, age limit).
▶ path DecisionPath Whether the decision was made automatically or by a caseworker.
▶ electronicChecks array[ElectronicCheckSummary] Summary of electronic checks that informed this decision.
▶ NotFound
▶ InternalError
▶
POST
/determinations/{determinationId}/flag-expedited
Flag expedited determination
State machine →
#
POST /determinations/{determinationId}/flag-expedited — System flags a Determination as qualifying for expedited SNAP processing
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| determinationId | string | path | ✓ |
▶ Determination
▶ status DeterminationStatus required Lifecycle status of the determination. `pending` — created at submission, awaiting processing. `in_progress` — at least one Decision has been resolved. `completed` — all Decisions have reached a terminal state. `withdrawn` — the application was withdrawn before determination completed.
▶ BadRequest
▶ Forbidden
▶ NotFound
▶ InternalError
▶
POST
/determinations/{determinationId}/complete
Complete determination
State machine →
#
POST /determinations/{determinationId}/complete — System marks a Determination as complete after all program Decisions are resolved
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| determinationId | string | path | ✓ |
▶ Determination
▶ status DeterminationStatus required Lifecycle status of the determination. `pending` — created at submission, awaiting processing. `in_progress` — at least one Decision has been resolved. `completed` — all Decisions have reached a terminal state. `withdrawn` — the application was withdrawn before determination completed.
▶ BadRequest
▶ Forbidden
▶ NotFound
▶ InternalError
▶
POST
/determinations/{determinationId}/withdraw
Withdraw determination
State machine →
#
POST /determinations/{determinationId}/withdraw — System withdraws a Determination when the associated application is withdrawn
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| determinationId | string | path | ✓ |
▶ Determination
▶ status DeterminationStatus required Lifecycle status of the determination. `pending` — created at submission, awaiting processing. `in_progress` — at least one Decision has been resolved. `completed` — all Decisions have reached a terminal state. `withdrawn` — the application was withdrawn before determination completed.
▶ BadRequest
▶ Forbidden
▶ NotFound
▶ InternalError
▶
POST
/determinations/{determinationId}/decisions/{decisionId}/approve
Approve decision
State machine →
#
POST /determinations/{determinationId}/decisions/{decisionId}/approve — System approves a Decision after automatic or caseworker review
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| determinationId | string | path | ✓ | |
| decisionId | string | path | ✓ |
▶ ApproveDecisionRequest
auto manual▶ Decision
▶ program Program required The program this decision covers.
▶ status DecisionStatus required Outcome status of a single program eligibility decision. `pending` — not yet evaluated, or deferred to caseworker review by the rules engine. `approved` — member meets program requirements. `denied` — member does not meet requirements based on provided information. `ineligible` — member cannot qualify for this program (e.g., citizenship bar, age limit).
▶ path DecisionPath Whether the decision was made automatically or by a caseworker.
▶ electronicChecks array[ElectronicCheckSummary] Summary of electronic checks that informed this decision.
▶ BadRequest
▶ Forbidden
▶ NotFound
▶ UnprocessableEntity
▶ InternalError
▶
POST
/determinations/{determinationId}/decisions/{decisionId}/deny
Deny decision
State machine →
#
POST /determinations/{determinationId}/decisions/{decisionId}/deny — System denies a Decision based on failing eligibility criteria
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| determinationId | string | path | ✓ | |
| decisionId | string | path | ✓ |
▶ DenyDecisionRequest
auto manual▶ Decision
▶ program Program required The program this decision covers.
▶ status DecisionStatus required Outcome status of a single program eligibility decision. `pending` — not yet evaluated, or deferred to caseworker review by the rules engine. `approved` — member meets program requirements. `denied` — member does not meet requirements based on provided information. `ineligible` — member cannot qualify for this program (e.g., citizenship bar, age limit).
▶ path DecisionPath Whether the decision was made automatically or by a caseworker.
▶ electronicChecks array[ElectronicCheckSummary] Summary of electronic checks that informed this decision.
▶ BadRequest
▶ Forbidden
▶ NotFound
▶ UnprocessableEntity
▶ InternalError
▶
POST
/determinations/{determinationId}/decisions/{decisionId}/mark-ineligible
Mark ineligible decision
State machine →
#
POST /determinations/{determinationId}/decisions/{decisionId}/mark-ineligible — System marks a Decision as categorically ineligible
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| determinationId | string | path | ✓ | |
| decisionId | string | path | ✓ |
▶ MarkIneligibleRequest
auto manual