Skip to content

Person not enrolled in benefit

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

The opposite of PersonEnrolledInBenefit: passes when situation.enrollments does not list the person as enrolled in the named benefit, and fails when it does. Returns no result when the enrollments list is missing, or when the personId or benefit parameter is missing. Benefits use it to leave out people who already receive them.

API endpoint
POST /api/v1/checks/enrollment/person-not-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

EnrolledFails

Person p1 is enrolled in the named benefit, so the check fails.

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

NOT Enrolled in Bogus BenefitPasses

Only a different person is enrolled in the named benefit, so the check passes for person p1.

Request
{
  "parameters": {
    "benefit": "bogus",
    "personId": "p1"
  },
  "situation": {
    "enrollments": [
      {
        "benefit": "bogus",
        "personId": "p2"
      }
    ],
    "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