Skip to content

Person enrolled in benefit

Verify that a specified person is enrolled in a specified benefit program.

Passes when situation.enrollments lists the person as enrolled in the named benefit, and fails when it does not. Returns no result when the enrollments list is missing, or when the personId or benefit parameter is missing.

API endpoint
POST /api/v1/checks/enrollment/person-enrolled-in-benefit
Last reviewed
November 19, 2026

Parameters

NameTypeDescription
personIdstringId of the person to look for in situation.enrollments.
benefitstringName of the benefit as recorded in situation.enrollments, for example PhlHomesteadExemption.

Inputs

The screener answers this check reads:

FieldType
situation.enrollments[].benefitstring
situation.enrollments[].personIdstring

Examples

Enrolled in Bogus BenefitPasses

The enrollments list shows person p1 in the named benefit, so the check passes.

Request
{
  "parameters": {
    "benefit": "bogus",
    "personId": "p1"
  },
  "situation": {
    "enrollments": [
      {
        "benefit": "bogus",
        "personId": "p1"
      }
    ],
    "people": [
      {
        "id": "p1"
      }
    ]
  }
}

Limitations

  • Relies on the enrollments the screener reports. It does not look up enrollment with the agency.
  • Benefit names must match exactly.

Sources