Class HouseholdDataResponse

Namespace

SEBT.Portal.Api.Models.Household

Assembly

SEBT.Portal.Api.dll

API response model for household data.

public record HouseholdDataResponse

Inheritance

object

HouseholdDataResponse

Properties

AddressOnFile

The address on file. Only populated when ID verification is completed.

public AddressResponse? AddressOnFile { get; init; }

Property Value

AddressResponse

AllowedActions

Computed permissions for self-service portal actions.

public AllowedActionsResponse? AllowedActions { get; init; }

Property Value

AllowedActionsResponse

Applications

The list of applications for this household.

public IReadOnlyList<ApplicationResponse> Applications { get; init; }

Property Value

IReadOnlyList<ApplicationResponse>

BenefitIssuanceType

The type of benefit issuance for this household.

public BenefitIssuanceType BenefitIssuanceType { get; init; }

Property Value

BenefitIssuanceType

CoLoadedCohort

Classification of this household relative to co-loaded benefits. Used by the frontend to emit a standardized analytics dimension so the mixed-eligibility/applicant exclusion cohort can be segmented from non-co-loaded and co-loaded-only households.

public CoLoadedCohort CoLoadedCohort { get; init; }

Property Value

CoLoadedCohort

Email

The email address on file for the household. Null when excluded due to ID proofing requirements.

public string? Email { get; init; }

Property Value

string

HashedAppId

HMAC-SHA256 digest of the SEBT App ID, lowercase hex. Surfaced for analytics so CO/CfA can join vendor exports (Mixpanel/Amplitude) back to state program data via a shared deterministic hash without exposing raw identifiers. Populated only when the active state is configured to emit it (CO today) and an App ID exists for the household; null otherwise. See docs/analytics/hashed-sebt-app-id.md.

public string? HashedAppId { get; init; }

Property Value

string

HashedAppIds

Sorted, comma-joined 16-character digest prefixes of every state application id in the household, including directly certified children's. Gated like HashedAppId.

public string? HashedAppIds { get; init; }

Property Value

string

HashedCaseIds

Sorted, comma-joined 16-character digest prefixes of every child's state case id, including children known only through a pending application. Gated like HashedAppId.

public string? HashedCaseIds { get; init; }

Property Value

string

Phone

The phone number on file for the household.

public string? Phone { get; init; }

Property Value

string

SummerEbtCases

The list of Summer EBT cases (per-child) for this household.

public IReadOnlyList<SummerEbtCaseResponse> SummerEbtCases { get; init; }

Property Value

IReadOnlyList<SummerEbtCaseResponse>

UserProfile

The logged-in user's profile (first, middle, last name) for display.

public UserProfileResponse? UserProfile { get; init; }

Property Value

UserProfileResponse