REST API for managing public assistance applications. Covers the full intake lifecycle: applications, household members, household data, income, jobs, assets, expenses, health plans, health enrollments, contacts, organizations, person relationships, authorized representatives, tax filers, sponsors, signatures, verifications, and interviews.

Status: Alpha — Breaking changes expected.
Base URL: https://api.example.com/intake

Applications

Manage public assistance applications.

▶ GET /applications List applications

Retrieve a paginated list of applications.

Parameters
Name Type In Req Description
▶q string query Search query using field:value syntax. Multiple conditions separated by
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
Responses
200 A paginated collection of applications.
▶ ApplicationList
total integer required Total number of items available.
limit integer required Maximum number of items requested.
offset integer required Number of items skipped before the current page.
hasNext boolean Whether more items are available beyond the current page.
▶ items array[Application] required
programsAppliedFor array[enum] Programs the household is applying for. At least one required at submission.
enumsnap medicaid chip tanf
channel enum How the application was filed.
enumonline in_person phone mail
▶ ebt Ebt EBT card preferences collected at the application level.
needsCard boolean Whether the household needs a new EBT card issued.
deliveryPreference enum How the household prefers to receive their EBT card.
enumby_mail in_person
registerToVote boolean Whether any household member would like to register to vote.
deniesIevsConsent boolean Whether the household denies consent for IEVS income verification.
▶ expeditedSnap ExpeditedSnap Financial information used for the SNAP expedited processing screening at application submission (7 CFR § 273.2(i)). This data is collected once and passed to the eligibility adapter; it is not updated during caseworker review.
totalMoneyExpectedThisMonth number (float) Total money the household expects to receive this month from all sources.
totalCashOnHand number (float) Total cash on hand and in bank accounts available to the household.
monthlyMortgage number (float) Monthly mortgage payment. Used in the expedited screening shelter cost calculation.
monthlyRent number (float) Monthly rent payment. Used in the expedited screening shelter cost calculation.
monthlyUtilities number (float) Monthly utility costs. Used in the expedited screening shelter cost calculation.
receivedSnapInLast30Days boolean Whether the household received SNAP benefits in the last 30 days. Affects expedited eligibility under 7 CFR § 273.2(i).
▶ utilities Utilities Utility information at the application level. Used to determine which SNAP standard utility allowance (SUA) applies. States set their own SUA amounts; the method of heating/cooling determines which SUA tier the household qualifies for (7 CFR § 273.9(d)(6)).
heatCoolMethod enum Primary method used to heat or cool the home. Determines which utility standard applies.
enumgas electric oil propane other
heatCoolMethodOther string Free-text description when heatCoolMethod is other.
receivesLiheap boolean Whether the household receives Low Income Home Energy Assistance Program (LIHEAP) benefits. Households receiving LIHEAP may be eligible for the full SUA.
id string (uuid) required read-only Unique identifier for the application.
status enum required read-only Current lifecycle status of the application.
enumdraft submitted under_review pending_approval withdrawn closed
isExpedited boolean read-only Whether the application qualifies for expedited processing (e.g., SNAP 7-day track). Set during caseworker expedited screening after submission. Null until screening is complete.
submittedAt string (date-time) read-only When the application was formally submitted. Null until submitted.
withdrawnAt string (date-time) read-only When the application was withdrawn. Null unless withdrawn.
closedAt string (date-time) read-only When the intake phase closed. Null until closed.
createdAt string (date-time) required read-only When the application record was created.
updatedAt string (date-time) required read-only When the application record was last modified.
_links object read-only Generated composition links.
applicationReview object Link to the applicationReview composition.
href string (uri-reference) read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications Create an application

Create a new public assistance application in draft status.

Request body required
▶ ApplicationCreate
programsAppliedFor array[enum] Programs the household is applying for. At least one required at submission.
enumsnap medicaid chip tanf
channel enum How the application was filed.
enumonline in_person phone mail
▶ ebt Ebt EBT card preferences collected at the application level.
needsCard boolean Whether the household needs a new EBT card issued.
deliveryPreference enum How the household prefers to receive their EBT card.
enumby_mail in_person
registerToVote boolean Whether any household member would like to register to vote.
deniesIevsConsent boolean Whether the household denies consent for IEVS income verification.
▶ expeditedSnap ExpeditedSnap Financial information used for the SNAP expedited processing screening at application submission (7 CFR § 273.2(i)). This data is collected once and passed to the eligibility adapter; it is not updated during caseworker review.
totalMoneyExpectedThisMonth number (float) Total money the household expects to receive this month from all sources.
totalCashOnHand number (float) Total cash on hand and in bank accounts available to the household.
monthlyMortgage number (float) Monthly mortgage payment. Used in the expedited screening shelter cost calculation.
monthlyRent number (float) Monthly rent payment. Used in the expedited screening shelter cost calculation.
monthlyUtilities number (float) Monthly utility costs. Used in the expedited screening shelter cost calculation.
receivedSnapInLast30Days boolean Whether the household received SNAP benefits in the last 30 days. Affects expedited eligibility under 7 CFR § 273.2(i).
▶ utilities Utilities Utility information at the application level. Used to determine which SNAP standard utility allowance (SUA) applies. States set their own SUA amounts; the method of heating/cooling determines which SUA tier the household qualifies for (7 CFR § 273.9(d)(6)).
heatCoolMethod enum Primary method used to heat or cool the home. Determines which utility standard applies.
enumgas electric oil propane other
heatCoolMethodOther string Free-text description when heatCoolMethod is other.
receivesLiheap boolean Whether the household receives Low Income Home Energy Assistance Program (LIHEAP) benefits. Households receiving LIHEAP may be eligible for the full SUA.
id string (uuid) The new record's id, a UUID (RFC 9562).
Responses
201 Application created successfully.
▶ Application
programsAppliedFor array[enum] Programs the household is applying for. At least one required at submission.
enumsnap medicaid chip tanf
channel enum How the application was filed.
enumonline in_person phone mail
▶ ebt Ebt EBT card preferences collected at the application level.
needsCard boolean Whether the household needs a new EBT card issued.
deliveryPreference enum How the household prefers to receive their EBT card.
enumby_mail in_person
registerToVote boolean Whether any household member would like to register to vote.
deniesIevsConsent boolean Whether the household denies consent for IEVS income verification.
▶ expeditedSnap ExpeditedSnap Financial information used for the SNAP expedited processing screening at application submission (7 CFR § 273.2(i)). This data is collected once and passed to the eligibility adapter; it is not updated during caseworker review.
totalMoneyExpectedThisMonth number (float) Total money the household expects to receive this month from all sources.
totalCashOnHand number (float) Total cash on hand and in bank accounts available to the household.
monthlyMortgage number (float) Monthly mortgage payment. Used in the expedited screening shelter cost calculation.
monthlyRent number (float) Monthly rent payment. Used in the expedited screening shelter cost calculation.
monthlyUtilities number (float) Monthly utility costs. Used in the expedited screening shelter cost calculation.
receivedSnapInLast30Days boolean Whether the household received SNAP benefits in the last 30 days. Affects expedited eligibility under 7 CFR § 273.2(i).
▶ utilities Utilities Utility information at the application level. Used to determine which SNAP standard utility allowance (SUA) applies. States set their own SUA amounts; the method of heating/cooling determines which SUA tier the household qualifies for (7 CFR § 273.9(d)(6)).
heatCoolMethod enum Primary method used to heat or cool the home. Determines which utility standard applies.
enumgas electric oil propane other
heatCoolMethodOther string Free-text description when heatCoolMethod is other.
receivesLiheap boolean Whether the household receives Low Income Home Energy Assistance Program (LIHEAP) benefits. Households receiving LIHEAP may be eligible for the full SUA.
id string (uuid) required read-only Unique identifier for the application.
status enum required read-only Current lifecycle status of the application.
enumdraft submitted under_review pending_approval withdrawn closed
isExpedited boolean read-only Whether the application qualifies for expedited processing (e.g., SNAP 7-day track). Set during caseworker expedited screening after submission. Null until screening is complete.
submittedAt string (date-time) read-only When the application was formally submitted. Null until submitted.
withdrawnAt string (date-time) read-only When the application was withdrawn. Null unless withdrawn.
closedAt string (date-time) read-only When the intake phase closed. Null until closed.
createdAt string (date-time) required read-only When the application record was created.
updatedAt string (date-time) required read-only When the application record was last modified.
_links object read-only Generated composition links.
applicationReview object Link to the applicationReview composition.
href string (uri-reference) read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId} Get an application

Retrieve a single application by identifier.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Responses
200 Application retrieved successfully.
▶ Application
programsAppliedFor array[enum] Programs the household is applying for. At least one required at submission.
enumsnap medicaid chip tanf
channel enum How the application was filed.
enumonline in_person phone mail
▶ ebt Ebt EBT card preferences collected at the application level.
needsCard boolean Whether the household needs a new EBT card issued.
deliveryPreference enum How the household prefers to receive their EBT card.
enumby_mail in_person
registerToVote boolean Whether any household member would like to register to vote.
deniesIevsConsent boolean Whether the household denies consent for IEVS income verification.
▶ expeditedSnap ExpeditedSnap Financial information used for the SNAP expedited processing screening at application submission (7 CFR § 273.2(i)). This data is collected once and passed to the eligibility adapter; it is not updated during caseworker review.
totalMoneyExpectedThisMonth number (float) Total money the household expects to receive this month from all sources.
totalCashOnHand number (float) Total cash on hand and in bank accounts available to the household.
monthlyMortgage number (float) Monthly mortgage payment. Used in the expedited screening shelter cost calculation.
monthlyRent number (float) Monthly rent payment. Used in the expedited screening shelter cost calculation.
monthlyUtilities number (float) Monthly utility costs. Used in the expedited screening shelter cost calculation.
receivedSnapInLast30Days boolean Whether the household received SNAP benefits in the last 30 days. Affects expedited eligibility under 7 CFR § 273.2(i).
▶ utilities Utilities Utility information at the application level. Used to determine which SNAP standard utility allowance (SUA) applies. States set their own SUA amounts; the method of heating/cooling determines which SUA tier the household qualifies for (7 CFR § 273.9(d)(6)).
heatCoolMethod enum Primary method used to heat or cool the home. Determines which utility standard applies.
enumgas electric oil propane other
heatCoolMethodOther string Free-text description when heatCoolMethod is other.
receivesLiheap boolean Whether the household receives Low Income Home Energy Assistance Program (LIHEAP) benefits. Households receiving LIHEAP may be eligible for the full SUA.
id string (uuid) required read-only Unique identifier for the application.
status enum required read-only Current lifecycle status of the application.
enumdraft submitted under_review pending_approval withdrawn closed
isExpedited boolean read-only Whether the application qualifies for expedited processing (e.g., SNAP 7-day track). Set during caseworker expedited screening after submission. Null until screening is complete.
submittedAt string (date-time) read-only When the application was formally submitted. Null until submitted.
withdrawnAt string (date-time) read-only When the application was withdrawn. Null unless withdrawn.
closedAt string (date-time) read-only When the intake phase closed. Null until closed.
createdAt string (date-time) required read-only When the application record was created.
updatedAt string (date-time) required read-only When the application record was last modified.
_links object read-only Generated composition links.
applicationReview object Link to the applicationReview composition.
href string (uri-reference) read-only
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId} Update an application

Apply partial updates to a draft or under-review application.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Request body required
▶ ApplicationUpdate
programsAppliedFor array[enum] Programs the household is applying for. At least one required at submission.
enumsnap medicaid chip tanf
channel enum How the application was filed.
enumonline in_person phone mail
▶ ebt Ebt EBT card preferences collected at the application level.
needsCard boolean Whether the household needs a new EBT card issued.
deliveryPreference enum How the household prefers to receive their EBT card.
enumby_mail in_person
registerToVote boolean Whether any household member would like to register to vote.
deniesIevsConsent boolean Whether the household denies consent for IEVS income verification.
▶ expeditedSnap ExpeditedSnap Financial information used for the SNAP expedited processing screening at application submission (7 CFR § 273.2(i)). This data is collected once and passed to the eligibility adapter; it is not updated during caseworker review.
totalMoneyExpectedThisMonth number (float) Total money the household expects to receive this month from all sources.
totalCashOnHand number (float) Total cash on hand and in bank accounts available to the household.
monthlyMortgage number (float) Monthly mortgage payment. Used in the expedited screening shelter cost calculation.
monthlyRent number (float) Monthly rent payment. Used in the expedited screening shelter cost calculation.
monthlyUtilities number (float) Monthly utility costs. Used in the expedited screening shelter cost calculation.
receivedSnapInLast30Days boolean Whether the household received SNAP benefits in the last 30 days. Affects expedited eligibility under 7 CFR § 273.2(i).
▶ utilities Utilities Utility information at the application level. Used to determine which SNAP standard utility allowance (SUA) applies. States set their own SUA amounts; the method of heating/cooling determines which SUA tier the household qualifies for (7 CFR § 273.9(d)(6)).
heatCoolMethod enum Primary method used to heat or cool the home. Determines which utility standard applies.
enumgas electric oil propane other
heatCoolMethodOther string Free-text description when heatCoolMethod is other.
receivesLiheap boolean Whether the household receives Low Income Home Energy Assistance Program (LIHEAP) benefits. Households receiving LIHEAP may be eligible for the full SUA.
Responses
200 Application updated successfully.
▶ Application
programsAppliedFor array[enum] Programs the household is applying for. At least one required at submission.
enumsnap medicaid chip tanf
channel enum How the application was filed.
enumonline in_person phone mail
▶ ebt Ebt EBT card preferences collected at the application level.
needsCard boolean Whether the household needs a new EBT card issued.
deliveryPreference enum How the household prefers to receive their EBT card.
enumby_mail in_person
registerToVote boolean Whether any household member would like to register to vote.
deniesIevsConsent boolean Whether the household denies consent for IEVS income verification.
▶ expeditedSnap ExpeditedSnap Financial information used for the SNAP expedited processing screening at application submission (7 CFR § 273.2(i)). This data is collected once and passed to the eligibility adapter; it is not updated during caseworker review.
totalMoneyExpectedThisMonth number (float) Total money the household expects to receive this month from all sources.
totalCashOnHand number (float) Total cash on hand and in bank accounts available to the household.
monthlyMortgage number (float) Monthly mortgage payment. Used in the expedited screening shelter cost calculation.
monthlyRent number (float) Monthly rent payment. Used in the expedited screening shelter cost calculation.
monthlyUtilities number (float) Monthly utility costs. Used in the expedited screening shelter cost calculation.
receivedSnapInLast30Days boolean Whether the household received SNAP benefits in the last 30 days. Affects expedited eligibility under 7 CFR § 273.2(i).
▶ utilities Utilities Utility information at the application level. Used to determine which SNAP standard utility allowance (SUA) applies. States set their own SUA amounts; the method of heating/cooling determines which SUA tier the household qualifies for (7 CFR § 273.9(d)(6)).
heatCoolMethod enum Primary method used to heat or cool the home. Determines which utility standard applies.
enumgas electric oil propane other
heatCoolMethodOther string Free-text description when heatCoolMethod is other.
receivesLiheap boolean Whether the household receives Low Income Home Energy Assistance Program (LIHEAP) benefits. Households receiving LIHEAP may be eligible for the full SUA.
id string (uuid) required read-only Unique identifier for the application.
status enum required read-only Current lifecycle status of the application.
enumdraft submitted under_review pending_approval withdrawn closed
isExpedited boolean read-only Whether the application qualifies for expedited processing (e.g., SNAP 7-day track). Set during caseworker expedited screening after submission. Null until screening is complete.
submittedAt string (date-time) read-only When the application was formally submitted. Null until submitted.
withdrawnAt string (date-time) read-only When the application was withdrawn. Null unless withdrawn.
closedAt string (date-time) read-only When the intake phase closed. Null until closed.
createdAt string (date-time) required read-only When the application record was created.
updatedAt string (date-time) required read-only When the application record was last modified.
_links object read-only Generated composition links.
applicationReview object Link to the applicationReview composition.
href string (uri-reference) read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ DELETE /applications/{applicationId} Delete an application

Permanently remove a draft application record.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Responses
204 Application deleted successfully.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/submit Submit application State machine →

POST /applications/{applicationId}/submit — Formally submits a draft application, starting the regulatory processing clock

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Responses
200 Transition applied successfully.
▶ Application
programsAppliedFor array[enum] Programs the household is applying for. At least one required at submission.
enumsnap medicaid chip tanf
channel enum How the application was filed.
enumonline in_person phone mail
▶ ebt Ebt EBT card preferences collected at the application level.
needsCard boolean Whether the household needs a new EBT card issued.
deliveryPreference enum How the household prefers to receive their EBT card.
enumby_mail in_person
registerToVote boolean Whether any household member would like to register to vote.
deniesIevsConsent boolean Whether the household denies consent for IEVS income verification.
▶ expeditedSnap ExpeditedSnap Financial information used for the SNAP expedited processing screening at application submission (7 CFR § 273.2(i)). This data is collected once and passed to the eligibility adapter; it is not updated during caseworker review.
totalMoneyExpectedThisMonth number (float) Total money the household expects to receive this month from all sources.
totalCashOnHand number (float) Total cash on hand and in bank accounts available to the household.
monthlyMortgage number (float) Monthly mortgage payment. Used in the expedited screening shelter cost calculation.
monthlyRent number (float) Monthly rent payment. Used in the expedited screening shelter cost calculation.
monthlyUtilities number (float) Monthly utility costs. Used in the expedited screening shelter cost calculation.
receivedSnapInLast30Days boolean Whether the household received SNAP benefits in the last 30 days. Affects expedited eligibility under 7 CFR § 273.2(i).
▶ utilities Utilities Utility information at the application level. Used to determine which SNAP standard utility allowance (SUA) applies. States set their own SUA amounts; the method of heating/cooling determines which SUA tier the household qualifies for (7 CFR § 273.9(d)(6)).
heatCoolMethod enum Primary method used to heat or cool the home. Determines which utility standard applies.
enumgas electric oil propane other
heatCoolMethodOther string Free-text description when heatCoolMethod is other.
receivesLiheap boolean Whether the household receives Low Income Home Energy Assistance Program (LIHEAP) benefits. Households receiving LIHEAP may be eligible for the full SUA.
id string (uuid) required read-only Unique identifier for the application.
status enum required read-only Current lifecycle status of the application.
enumdraft submitted under_review pending_approval withdrawn closed
isExpedited boolean read-only Whether the application qualifies for expedited processing (e.g., SNAP 7-day track). Set during caseworker expedited screening after submission. Null until screening is complete.
submittedAt string (date-time) read-only When the application was formally submitted. Null until submitted.
withdrawnAt string (date-time) read-only When the application was withdrawn. Null unless withdrawn.
closedAt string (date-time) read-only When the intake phase closed. Null until closed.
createdAt string (date-time) required read-only When the application record was created.
updatedAt string (date-time) required read-only When the application record was last modified.
_links object read-only Generated composition links.
applicationReview object Link to the applicationReview composition.
href string (uri-reference) read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
403 The authenticated user does not have permission to perform this action.
▶ Forbidden
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 The record is in a state this action can't start from, or one of its guards isn't met.
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/open Open application State machine →

POST /applications/{applicationId}/open — System marks a submitted application as under active caseworker review

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Responses
200 Transition applied successfully.
▶ Application
programsAppliedFor array[enum] Programs the household is applying for. At least one required at submission.
enumsnap medicaid chip tanf
channel enum How the application was filed.
enumonline in_person phone mail
▶ ebt Ebt EBT card preferences collected at the application level.
needsCard boolean Whether the household needs a new EBT card issued.
deliveryPreference enum How the household prefers to receive their EBT card.
enumby_mail in_person
registerToVote boolean Whether any household member would like to register to vote.
deniesIevsConsent boolean Whether the household denies consent for IEVS income verification.
▶ expeditedSnap ExpeditedSnap Financial information used for the SNAP expedited processing screening at application submission (7 CFR § 273.2(i)). This data is collected once and passed to the eligibility adapter; it is not updated during caseworker review.
totalMoneyExpectedThisMonth number (float) Total money the household expects to receive this month from all sources.
totalCashOnHand number (float) Total cash on hand and in bank accounts available to the household.
monthlyMortgage number (float) Monthly mortgage payment. Used in the expedited screening shelter cost calculation.
monthlyRent number (float) Monthly rent payment. Used in the expedited screening shelter cost calculation.
monthlyUtilities number (float) Monthly utility costs. Used in the expedited screening shelter cost calculation.
receivedSnapInLast30Days boolean Whether the household received SNAP benefits in the last 30 days. Affects expedited eligibility under 7 CFR § 273.2(i).
▶ utilities Utilities Utility information at the application level. Used to determine which SNAP standard utility allowance (SUA) applies. States set their own SUA amounts; the method of heating/cooling determines which SUA tier the household qualifies for (7 CFR § 273.9(d)(6)).
heatCoolMethod enum Primary method used to heat or cool the home. Determines which utility standard applies.
enumgas electric oil propane other
heatCoolMethodOther string Free-text description when heatCoolMethod is other.
receivesLiheap boolean Whether the household receives Low Income Home Energy Assistance Program (LIHEAP) benefits. Households receiving LIHEAP may be eligible for the full SUA.
id string (uuid) required read-only Unique identifier for the application.
status enum required read-only Current lifecycle status of the application.
enumdraft submitted under_review pending_approval withdrawn closed
isExpedited boolean read-only Whether the application qualifies for expedited processing (e.g., SNAP 7-day track). Set during caseworker expedited screening after submission. Null until screening is complete.
submittedAt string (date-time) read-only When the application was formally submitted. Null until submitted.
withdrawnAt string (date-time) read-only When the application was withdrawn. Null unless withdrawn.
closedAt string (date-time) read-only When the intake phase closed. Null until closed.
createdAt string (date-time) required read-only When the application record was created.
updatedAt string (date-time) required read-only When the application record was last modified.
_links object read-only Generated composition links.
applicationReview object Link to the applicationReview composition.
href string (uri-reference) read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
403 The authenticated user does not have permission to perform this action.
▶ Forbidden
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 The record is in a state this action can't start from, or one of its guards isn't met.
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/complete-review Complete review application State machine →

POST /applications/{applicationId}/complete-review — Caseworker signals data collection is complete and the application is ready for determination

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Responses
200 Transition applied successfully.
▶ Application
programsAppliedFor array[enum] Programs the household is applying for. At least one required at submission.
enumsnap medicaid chip tanf
channel enum How the application was filed.
enumonline in_person phone mail
▶ ebt Ebt EBT card preferences collected at the application level.
needsCard boolean Whether the household needs a new EBT card issued.
deliveryPreference enum How the household prefers to receive their EBT card.
enumby_mail in_person
registerToVote boolean Whether any household member would like to register to vote.
deniesIevsConsent boolean Whether the household denies consent for IEVS income verification.
▶ expeditedSnap ExpeditedSnap Financial information used for the SNAP expedited processing screening at application submission (7 CFR § 273.2(i)). This data is collected once and passed to the eligibility adapter; it is not updated during caseworker review.
totalMoneyExpectedThisMonth number (float) Total money the household expects to receive this month from all sources.
totalCashOnHand number (float) Total cash on hand and in bank accounts available to the household.
monthlyMortgage number (float) Monthly mortgage payment. Used in the expedited screening shelter cost calculation.
monthlyRent number (float) Monthly rent payment. Used in the expedited screening shelter cost calculation.
monthlyUtilities number (float) Monthly utility costs. Used in the expedited screening shelter cost calculation.
receivedSnapInLast30Days boolean Whether the household received SNAP benefits in the last 30 days. Affects expedited eligibility under 7 CFR § 273.2(i).
▶ utilities Utilities Utility information at the application level. Used to determine which SNAP standard utility allowance (SUA) applies. States set their own SUA amounts; the method of heating/cooling determines which SUA tier the household qualifies for (7 CFR § 273.9(d)(6)).
heatCoolMethod enum Primary method used to heat or cool the home. Determines which utility standard applies.
enumgas electric oil propane other
heatCoolMethodOther string Free-text description when heatCoolMethod is other.
receivesLiheap boolean Whether the household receives Low Income Home Energy Assistance Program (LIHEAP) benefits. Households receiving LIHEAP may be eligible for the full SUA.
id string (uuid) required read-only Unique identifier for the application.
status enum required read-only Current lifecycle status of the application.
enumdraft submitted under_review pending_approval withdrawn closed
isExpedited boolean read-only Whether the application qualifies for expedited processing (e.g., SNAP 7-day track). Set during caseworker expedited screening after submission. Null until screening is complete.
submittedAt string (date-time) read-only When the application was formally submitted. Null until submitted.
withdrawnAt string (date-time) read-only When the application was withdrawn. Null unless withdrawn.
closedAt string (date-time) read-only When the intake phase closed. Null until closed.
createdAt string (date-time) required read-only When the application record was created.
updatedAt string (date-time) required read-only When the application record was last modified.
_links object read-only Generated composition links.
applicationReview object Link to the applicationReview composition.
href string (uri-reference) read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
403 The authenticated user does not have permission to perform this action.
▶ Forbidden
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 The record is in a state this action can't start from, or one of its guards isn't met.
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/submit-for-approval Submit for approval application State machine →

POST /applications/{applicationId}/submit-for-approval — System routes the application to supervisor review when state-configured approval thresholds are met

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Responses
200 Transition applied successfully.
▶ Application
programsAppliedFor array[enum] Programs the household is applying for. At least one required at submission.
enumsnap medicaid chip tanf
channel enum How the application was filed.
enumonline in_person phone mail
▶ ebt Ebt EBT card preferences collected at the application level.
needsCard boolean Whether the household needs a new EBT card issued.
deliveryPreference enum How the household prefers to receive their EBT card.
enumby_mail in_person
registerToVote boolean Whether any household member would like to register to vote.
deniesIevsConsent boolean Whether the household denies consent for IEVS income verification.
▶ expeditedSnap ExpeditedSnap Financial information used for the SNAP expedited processing screening at application submission (7 CFR § 273.2(i)). This data is collected once and passed to the eligibility adapter; it is not updated during caseworker review.
totalMoneyExpectedThisMonth number (float) Total money the household expects to receive this month from all sources.
totalCashOnHand number (float) Total cash on hand and in bank accounts available to the household.
monthlyMortgage number (float) Monthly mortgage payment. Used in the expedited screening shelter cost calculation.
monthlyRent number (float) Monthly rent payment. Used in the expedited screening shelter cost calculation.
monthlyUtilities number (float) Monthly utility costs. Used in the expedited screening shelter cost calculation.
receivedSnapInLast30Days boolean Whether the household received SNAP benefits in the last 30 days. Affects expedited eligibility under 7 CFR § 273.2(i).
▶ utilities Utilities Utility information at the application level. Used to determine which SNAP standard utility allowance (SUA) applies. States set their own SUA amounts; the method of heating/cooling determines which SUA tier the household qualifies for (7 CFR § 273.9(d)(6)).
heatCoolMethod enum Primary method used to heat or cool the home. Determines which utility standard applies.
enumgas electric oil propane other
heatCoolMethodOther string Free-text description when heatCoolMethod is other.
receivesLiheap boolean Whether the household receives Low Income Home Energy Assistance Program (LIHEAP) benefits. Households receiving LIHEAP may be eligible for the full SUA.
id string (uuid) required read-only Unique identifier for the application.
status enum required read-only Current lifecycle status of the application.
enumdraft submitted under_review pending_approval withdrawn closed
isExpedited boolean read-only Whether the application qualifies for expedited processing (e.g., SNAP 7-day track). Set during caseworker expedited screening after submission. Null until screening is complete.
submittedAt string (date-time) read-only When the application was formally submitted. Null until submitted.
withdrawnAt string (date-time) read-only When the application was withdrawn. Null unless withdrawn.
closedAt string (date-time) read-only When the intake phase closed. Null until closed.
createdAt string (date-time) required read-only When the application record was created.
updatedAt string (date-time) required read-only When the application record was last modified.
_links object read-only Generated composition links.
applicationReview object Link to the applicationReview composition.
href string (uri-reference) read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
403 The authenticated user does not have permission to perform this action.
▶ Forbidden
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 The record is in a state this action can't start from, or one of its guards isn't met.
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/approve-determination Approve determination application State machine →

POST /applications/{applicationId}/approve-determination — Supervisor approves the determination; closes the application and triggers NOA and case creation

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Responses
200 Transition applied successfully.
▶ Application
programsAppliedFor array[enum] Programs the household is applying for. At least one required at submission.
enumsnap medicaid chip tanf
channel enum How the application was filed.
enumonline in_person phone mail
▶ ebt Ebt EBT card preferences collected at the application level.
needsCard boolean Whether the household needs a new EBT card issued.
deliveryPreference enum How the household prefers to receive their EBT card.
enumby_mail in_person
registerToVote boolean Whether any household member would like to register to vote.
deniesIevsConsent boolean Whether the household denies consent for IEVS income verification.
▶ expeditedSnap ExpeditedSnap Financial information used for the SNAP expedited processing screening at application submission (7 CFR § 273.2(i)). This data is collected once and passed to the eligibility adapter; it is not updated during caseworker review.
totalMoneyExpectedThisMonth number (float) Total money the household expects to receive this month from all sources.
totalCashOnHand number (float) Total cash on hand and in bank accounts available to the household.
monthlyMortgage number (float) Monthly mortgage payment. Used in the expedited screening shelter cost calculation.
monthlyRent number (float) Monthly rent payment. Used in the expedited screening shelter cost calculation.
monthlyUtilities number (float) Monthly utility costs. Used in the expedited screening shelter cost calculation.
receivedSnapInLast30Days boolean Whether the household received SNAP benefits in the last 30 days. Affects expedited eligibility under 7 CFR § 273.2(i).
▶ utilities Utilities Utility information at the application level. Used to determine which SNAP standard utility allowance (SUA) applies. States set their own SUA amounts; the method of heating/cooling determines which SUA tier the household qualifies for (7 CFR § 273.9(d)(6)).
heatCoolMethod enum Primary method used to heat or cool the home. Determines which utility standard applies.
enumgas electric oil propane other
heatCoolMethodOther string Free-text description when heatCoolMethod is other.
receivesLiheap boolean Whether the household receives Low Income Home Energy Assistance Program (LIHEAP) benefits. Households receiving LIHEAP may be eligible for the full SUA.
id string (uuid) required read-only Unique identifier for the application.
status enum required read-only Current lifecycle status of the application.
enumdraft submitted under_review pending_approval withdrawn closed
isExpedited boolean read-only Whether the application qualifies for expedited processing (e.g., SNAP 7-day track). Set during caseworker expedited screening after submission. Null until screening is complete.
submittedAt string (date-time) read-only When the application was formally submitted. Null until submitted.
withdrawnAt string (date-time) read-only When the application was withdrawn. Null unless withdrawn.
closedAt string (date-time) read-only When the intake phase closed. Null until closed.
createdAt string (date-time) required read-only When the application record was created.
updatedAt string (date-time) required read-only When the application record was last modified.
_links object read-only Generated composition links.
applicationReview object Link to the applicationReview composition.
href string (uri-reference) read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
403 The authenticated user does not have permission to perform this action.
▶ Forbidden
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 The record is in a state this action can't start from, or one of its guards isn't met.
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/reject-determination Reject determination application State machine →

POST /applications/{applicationId}/reject-determination — Supervisor rejects the determination and returns the application to the caseworker for revision

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Responses
200 Transition applied successfully.
▶ Application
programsAppliedFor array[enum] Programs the household is applying for. At least one required at submission.
enumsnap medicaid chip tanf
channel enum How the application was filed.
enumonline in_person phone mail
▶ ebt Ebt EBT card preferences collected at the application level.
needsCard boolean Whether the household needs a new EBT card issued.
deliveryPreference enum How the household prefers to receive their EBT card.
enumby_mail in_person
registerToVote boolean Whether any household member would like to register to vote.
deniesIevsConsent boolean Whether the household denies consent for IEVS income verification.
▶ expeditedSnap ExpeditedSnap Financial information used for the SNAP expedited processing screening at application submission (7 CFR § 273.2(i)). This data is collected once and passed to the eligibility adapter; it is not updated during caseworker review.
totalMoneyExpectedThisMonth number (float) Total money the household expects to receive this month from all sources.
totalCashOnHand number (float) Total cash on hand and in bank accounts available to the household.
monthlyMortgage number (float) Monthly mortgage payment. Used in the expedited screening shelter cost calculation.
monthlyRent number (float) Monthly rent payment. Used in the expedited screening shelter cost calculation.
monthlyUtilities number (float) Monthly utility costs. Used in the expedited screening shelter cost calculation.
receivedSnapInLast30Days boolean Whether the household received SNAP benefits in the last 30 days. Affects expedited eligibility under 7 CFR § 273.2(i).
▶ utilities Utilities Utility information at the application level. Used to determine which SNAP standard utility allowance (SUA) applies. States set their own SUA amounts; the method of heating/cooling determines which SUA tier the household qualifies for (7 CFR § 273.9(d)(6)).
heatCoolMethod enum Primary method used to heat or cool the home. Determines which utility standard applies.
enumgas electric oil propane other
heatCoolMethodOther string Free-text description when heatCoolMethod is other.
receivesLiheap boolean Whether the household receives Low Income Home Energy Assistance Program (LIHEAP) benefits. Households receiving LIHEAP may be eligible for the full SUA.
id string (uuid) required read-only Unique identifier for the application.
status enum required read-only Current lifecycle status of the application.
enumdraft submitted under_review pending_approval withdrawn closed
isExpedited boolean read-only Whether the application qualifies for expedited processing (e.g., SNAP 7-day track). Set during caseworker expedited screening after submission. Null until screening is complete.
submittedAt string (date-time) read-only When the application was formally submitted. Null until submitted.
withdrawnAt string (date-time) read-only When the application was withdrawn. Null unless withdrawn.
closedAt string (date-time) read-only When the intake phase closed. Null until closed.
createdAt string (date-time) required read-only When the application record was created.
updatedAt string (date-time) required read-only When the application record was last modified.
_links object read-only Generated composition links.
applicationReview object Link to the applicationReview composition.
href string (uri-reference) read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
403 The authenticated user does not have permission to perform this action.
▶ Forbidden
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 The record is in a state this action can't start from, or one of its guards isn't met.
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/close Close application State machine →

POST /applications/{applicationId}/close — Marks a reviewed application as closed after all determinations are complete

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Responses
200 Transition applied successfully.
▶ Application
programsAppliedFor array[enum] Programs the household is applying for. At least one required at submission.
enumsnap medicaid chip tanf
channel enum How the application was filed.
enumonline in_person phone mail
▶ ebt Ebt EBT card preferences collected at the application level.
needsCard boolean Whether the household needs a new EBT card issued.
deliveryPreference enum How the household prefers to receive their EBT card.
enumby_mail in_person
registerToVote boolean Whether any household member would like to register to vote.
deniesIevsConsent boolean Whether the household denies consent for IEVS income verification.
▶ expeditedSnap ExpeditedSnap Financial information used for the SNAP expedited processing screening at application submission (7 CFR § 273.2(i)). This data is collected once and passed to the eligibility adapter; it is not updated during caseworker review.
totalMoneyExpectedThisMonth number (float) Total money the household expects to receive this month from all sources.
totalCashOnHand number (float) Total cash on hand and in bank accounts available to the household.
monthlyMortgage number (float) Monthly mortgage payment. Used in the expedited screening shelter cost calculation.
monthlyRent number (float) Monthly rent payment. Used in the expedited screening shelter cost calculation.
monthlyUtilities number (float) Monthly utility costs. Used in the expedited screening shelter cost calculation.
receivedSnapInLast30Days boolean Whether the household received SNAP benefits in the last 30 days. Affects expedited eligibility under 7 CFR § 273.2(i).
▶ utilities Utilities Utility information at the application level. Used to determine which SNAP standard utility allowance (SUA) applies. States set their own SUA amounts; the method of heating/cooling determines which SUA tier the household qualifies for (7 CFR § 273.9(d)(6)).
heatCoolMethod enum Primary method used to heat or cool the home. Determines which utility standard applies.
enumgas electric oil propane other
heatCoolMethodOther string Free-text description when heatCoolMethod is other.
receivesLiheap boolean Whether the household receives Low Income Home Energy Assistance Program (LIHEAP) benefits. Households receiving LIHEAP may be eligible for the full SUA.
id string (uuid) required read-only Unique identifier for the application.
status enum required read-only Current lifecycle status of the application.
enumdraft submitted under_review pending_approval withdrawn closed
isExpedited boolean read-only Whether the application qualifies for expedited processing (e.g., SNAP 7-day track). Set during caseworker expedited screening after submission. Null until screening is complete.
submittedAt string (date-time) read-only When the application was formally submitted. Null until submitted.
withdrawnAt string (date-time) read-only When the application was withdrawn. Null unless withdrawn.
closedAt string (date-time) read-only When the intake phase closed. Null until closed.
createdAt string (date-time) required read-only When the application record was created.
updatedAt string (date-time) required read-only When the application record was last modified.
_links object read-only Generated composition links.
applicationReview object Link to the applicationReview composition.
href string (uri-reference) read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
403 The authenticated user does not have permission to perform this action.
▶ Forbidden
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 The record is in a state this action can't start from, or one of its guards isn't met.
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/withdraw Withdraw application State machine →

POST /applications/{applicationId}/withdraw — Applicant or caseworker withdraws the application before a decision is made

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Request body required
▶ WithdrawApplicationRequest
reason string required Why the application is being withdrawn
Responses
200 Transition applied successfully.
▶ Application
programsAppliedFor array[enum] Programs the household is applying for. At least one required at submission.
enumsnap medicaid chip tanf
channel enum How the application was filed.
enumonline in_person phone mail
▶ ebt Ebt EBT card preferences collected at the application level.
needsCard boolean Whether the household needs a new EBT card issued.
deliveryPreference enum How the household prefers to receive their EBT card.
enumby_mail in_person
registerToVote boolean Whether any household member would like to register to vote.
deniesIevsConsent boolean Whether the household denies consent for IEVS income verification.
▶ expeditedSnap ExpeditedSnap Financial information used for the SNAP expedited processing screening at application submission (7 CFR § 273.2(i)). This data is collected once and passed to the eligibility adapter; it is not updated during caseworker review.
totalMoneyExpectedThisMonth number (float) Total money the household expects to receive this month from all sources.
totalCashOnHand number (float) Total cash on hand and in bank accounts available to the household.
monthlyMortgage number (float) Monthly mortgage payment. Used in the expedited screening shelter cost calculation.
monthlyRent number (float) Monthly rent payment. Used in the expedited screening shelter cost calculation.
monthlyUtilities number (float) Monthly utility costs. Used in the expedited screening shelter cost calculation.
receivedSnapInLast30Days boolean Whether the household received SNAP benefits in the last 30 days. Affects expedited eligibility under 7 CFR § 273.2(i).
▶ utilities Utilities Utility information at the application level. Used to determine which SNAP standard utility allowance (SUA) applies. States set their own SUA amounts; the method of heating/cooling determines which SUA tier the household qualifies for (7 CFR § 273.9(d)(6)).
heatCoolMethod enum Primary method used to heat or cool the home. Determines which utility standard applies.
enumgas electric oil propane other
heatCoolMethodOther string Free-text description when heatCoolMethod is other.
receivesLiheap boolean Whether the household receives Low Income Home Energy Assistance Program (LIHEAP) benefits. Households receiving LIHEAP may be eligible for the full SUA.
id string (uuid) required read-only Unique identifier for the application.
status enum required read-only Current lifecycle status of the application.
enumdraft submitted under_review pending_approval withdrawn closed
isExpedited boolean read-only Whether the application qualifies for expedited processing (e.g., SNAP 7-day track). Set during caseworker expedited screening after submission. Null until screening is complete.
submittedAt string (date-time) read-only When the application was formally submitted. Null until submitted.
withdrawnAt string (date-time) read-only When the application was withdrawn. Null unless withdrawn.
closedAt string (date-time) read-only When the intake phase closed. Null until closed.
createdAt string (date-time) required read-only When the application record was created.
updatedAt string (date-time) required read-only When the application record was last modified.
_links object read-only Generated composition links.
applicationReview object Link to the applicationReview composition.
href string (uri-reference) read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
403 The authenticated user does not have permission to perform this action.
▶ Forbidden
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 The record is in a state this action can't start from, or one of its guards isn't met.
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/verifications/{verificationId}/satisfy Satisfy verification State machine →

POST /applications/verifications/{verificationId}/satisfy — System marks an obligation as satisfied after receiving conclusive service call or document evidence

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

verificationId string path ✓

Unique identifier of the verification obligation.

Responses
200 Transition applied successfully.
▶ Verification
applicationId string (uuid) read-only
status enum read-only Current status of the verification obligation.
enumpending inconclusive satisfied waived cannot_verify
▶ evidence array[VerificationEvidenceItem] read-only Electronic and document evidence items accumulated against this obligation.
▶ (one of) VerificationEvidenceItem
▶ VerificationElectronicEvidence
type enum required
enumelectronic
source enum required The external service that produced this result.
enumfdsh_fti fdsh_ssa fdsh_vlp irs_ievs save ssa_ievs swica uib
result enum required Whether the service check confirmed the obligation.
enumconclusive error inconclusive partial
serviceCallId string (uuid) ID of the data-exchange service call that produced this result.
receivedAt string (date-time) required When the result was received.
reviewedAt string (date-time) When a caseworker reviewed and accepted the electronic result.
reviewedBy string (uuid) ID of the caseworker who accepted the electronic result.
▶ VerificationDocumentEvidence
type enum required
enumdocument
documentId string (uuid) required ID of the verified document in the document-management domain.
receivedAt string (date-time) required When the document was received.
reviewedAt string (date-time) When a caseworker reviewed the document.
reviewedBy string (uuid) ID of the caseworker who reviewed the document.
▶ documentRequests array[VerificationDocumentRequest] read-only Outbound document request notices sent to the applicant for this obligation.
noticeId string (uuid) required ID of the notice in the communication domain.
type enum required Template identifier for the notice. Matches the type field on the communication.notice.sent event.
enumdocument_request_citizenship_verification document_request_identity_verification document_request_immigration_verification document_request_income_verification document_request_residency_verification
sentAt string (date-time) required When the notice was sent.
dueAt string (date-time) Deadline by which the applicant must respond.
channel string Channel through which the notice was sent.
enumemail in_person mail portal null
sourceId string (uuid) ID of the subject being verified. Points to an ApplicationMember when sourceType is `member`, or to an income record when sourceType is `income`. Null for household-level obligations (e.g., proof of residency).
sourceType string Identifies what sourceId refers to. Required when sourceId is set; null for household-level obligations.
enummember income
category enum Verification obligation category.
enumcitizenship identity immigration income residency
verificationType enum How this verification obligation is to be fulfilled.
enumdocument electronic
reviewedAt string (date-time) read-only When a caseworker accepted this verification obligation.
reviewedBy string (uuid) read-only ID of the caseworker who accepted this verification obligation.
id string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
403 The authenticated user does not have permission to perform this action.
▶ Forbidden
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 The record is in a state this action can't start from, or one of its guards isn't met.
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/verifications/{verificationId}/mark-inconclusive Mark inconclusive verification State machine →

POST /applications/verifications/{verificationId}/mark-inconclusive — System records that a service call returned inconclusive, triggering document fallback

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

verificationId string path ✓

Unique identifier of the verification obligation.

Responses
200 Transition applied successfully.
▶ Verification
applicationId string (uuid) read-only
status enum read-only Current status of the verification obligation.
enumpending inconclusive satisfied waived cannot_verify
▶ evidence array[VerificationEvidenceItem] read-only Electronic and document evidence items accumulated against this obligation.
▶ (one of) VerificationEvidenceItem
▶ VerificationElectronicEvidence
type enum required
enumelectronic
source enum required The external service that produced this result.
enumfdsh_fti fdsh_ssa fdsh_vlp irs_ievs save ssa_ievs swica uib
result enum required Whether the service check confirmed the obligation.
enumconclusive error inconclusive partial
serviceCallId string (uuid) ID of the data-exchange service call that produced this result.
receivedAt string (date-time) required When the result was received.
reviewedAt string (date-time) When a caseworker reviewed and accepted the electronic result.
reviewedBy string (uuid) ID of the caseworker who accepted the electronic result.
▶ VerificationDocumentEvidence
type enum required
enumdocument
documentId string (uuid) required ID of the verified document in the document-management domain.
receivedAt string (date-time) required When the document was received.
reviewedAt string (date-time) When a caseworker reviewed the document.
reviewedBy string (uuid) ID of the caseworker who reviewed the document.
▶ documentRequests array[VerificationDocumentRequest] read-only Outbound document request notices sent to the applicant for this obligation.
noticeId string (uuid) required ID of the notice in the communication domain.
type enum required Template identifier for the notice. Matches the type field on the communication.notice.sent event.
enumdocument_request_citizenship_verification document_request_identity_verification document_request_immigration_verification document_request_income_verification document_request_residency_verification
sentAt string (date-time) required When the notice was sent.
dueAt string (date-time) Deadline by which the applicant must respond.
channel string Channel through which the notice was sent.
enumemail in_person mail portal null
sourceId string (uuid) ID of the subject being verified. Points to an ApplicationMember when sourceType is `member`, or to an income record when sourceType is `income`. Null for household-level obligations (e.g., proof of residency).
sourceType string Identifies what sourceId refers to. Required when sourceId is set; null for household-level obligations.
enummember income
category enum Verification obligation category.
enumcitizenship identity immigration income residency
verificationType enum How this verification obligation is to be fulfilled.
enumdocument electronic
reviewedAt string (date-time) read-only When a caseworker accepted this verification obligation.
reviewedBy string (uuid) read-only ID of the caseworker who accepted this verification obligation.
id string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
403 The authenticated user does not have permission to perform this action.
▶ Forbidden
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 The record is in a state this action can't start from, or one of its guards isn't met.
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/verifications/{verificationId}/waive Waive verification State machine →

POST /applications/verifications/{verificationId}/waive — Caseworker grants a waiver for an obligation that cannot be satisfied through normal means

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

verificationId string path ✓

Unique identifier of the verification obligation.

Request body required
▶ WaiveVerificationRequest
reason string required Why the verification requirement is being waived
Responses
200 Transition applied successfully.
▶ Verification
applicationId string (uuid) read-only
status enum read-only Current status of the verification obligation.
enumpending inconclusive satisfied waived cannot_verify
▶ evidence array[VerificationEvidenceItem] read-only Electronic and document evidence items accumulated against this obligation.
▶ (one of) VerificationEvidenceItem
▶ VerificationElectronicEvidence
type enum required
enumelectronic
source enum required The external service that produced this result.
enumfdsh_fti fdsh_ssa fdsh_vlp irs_ievs save ssa_ievs swica uib
result enum required Whether the service check confirmed the obligation.
enumconclusive error inconclusive partial
serviceCallId string (uuid) ID of the data-exchange service call that produced this result.
receivedAt string (date-time) required When the result was received.
reviewedAt string (date-time) When a caseworker reviewed and accepted the electronic result.
reviewedBy string (uuid) ID of the caseworker who accepted the electronic result.
▶ VerificationDocumentEvidence
type enum required
enumdocument
documentId string (uuid) required ID of the verified document in the document-management domain.
receivedAt string (date-time) required When the document was received.
reviewedAt string (date-time) When a caseworker reviewed the document.
reviewedBy string (uuid) ID of the caseworker who reviewed the document.
▶ documentRequests array[VerificationDocumentRequest] read-only Outbound document request notices sent to the applicant for this obligation.
noticeId string (uuid) required ID of the notice in the communication domain.
type enum required Template identifier for the notice. Matches the type field on the communication.notice.sent event.
enumdocument_request_citizenship_verification document_request_identity_verification document_request_immigration_verification document_request_income_verification document_request_residency_verification
sentAt string (date-time) required When the notice was sent.
dueAt string (date-time) Deadline by which the applicant must respond.
channel string Channel through which the notice was sent.
enumemail in_person mail portal null
sourceId string (uuid) ID of the subject being verified. Points to an ApplicationMember when sourceType is `member`, or to an income record when sourceType is `income`. Null for household-level obligations (e.g., proof of residency).
sourceType string Identifies what sourceId refers to. Required when sourceId is set; null for household-level obligations.
enummember income
category enum Verification obligation category.
enumcitizenship identity immigration income residency
verificationType enum How this verification obligation is to be fulfilled.
enumdocument electronic
reviewedAt string (date-time) read-only When a caseworker accepted this verification obligation.
reviewedBy string (uuid) read-only ID of the caseworker who accepted this verification obligation.
id string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
403 The authenticated user does not have permission to perform this action.
▶ Forbidden
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 The record is in a state this action can't start from, or one of its guards isn't met.
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/verifications/{verificationId}/mark-cannot-verify Mark cannot verify verification State machine →

POST /applications/verifications/{verificationId}/mark-cannot-verify — Caseworker closes an obligation when all available verification methods are exhausted

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

verificationId string path ✓

Unique identifier of the verification obligation.

Request body required
▶ MarkCannotVerifyRequest
reason string required Why the obligation cannot be satisfied after exhausting available options
Responses
200 Transition applied successfully.
▶ Verification
applicationId string (uuid) read-only
status enum read-only Current status of the verification obligation.
enumpending inconclusive satisfied waived cannot_verify
▶ evidence array[VerificationEvidenceItem] read-only Electronic and document evidence items accumulated against this obligation.
▶ (one of) VerificationEvidenceItem
▶ VerificationElectronicEvidence
type enum required
enumelectronic
source enum required The external service that produced this result.
enumfdsh_fti fdsh_ssa fdsh_vlp irs_ievs save ssa_ievs swica uib
result enum required Whether the service check confirmed the obligation.
enumconclusive error inconclusive partial
serviceCallId string (uuid) ID of the data-exchange service call that produced this result.
receivedAt string (date-time) required When the result was received.
reviewedAt string (date-time) When a caseworker reviewed and accepted the electronic result.
reviewedBy string (uuid) ID of the caseworker who accepted the electronic result.
▶ VerificationDocumentEvidence
type enum required
enumdocument
documentId string (uuid) required ID of the verified document in the document-management domain.
receivedAt string (date-time) required When the document was received.
reviewedAt string (date-time) When a caseworker reviewed the document.
reviewedBy string (uuid) ID of the caseworker who reviewed the document.
▶ documentRequests array[VerificationDocumentRequest] read-only Outbound document request notices sent to the applicant for this obligation.
noticeId string (uuid) required ID of the notice in the communication domain.
type enum required Template identifier for the notice. Matches the type field on the communication.notice.sent event.
enumdocument_request_citizenship_verification document_request_identity_verification document_request_immigration_verification document_request_income_verification document_request_residency_verification
sentAt string (date-time) required When the notice was sent.
dueAt string (date-time) Deadline by which the applicant must respond.
channel string Channel through which the notice was sent.
enumemail in_person mail portal null
sourceId string (uuid) ID of the subject being verified. Points to an ApplicationMember when sourceType is `member`, or to an income record when sourceType is `income`. Null for household-level obligations (e.g., proof of residency).
sourceType string Identifies what sourceId refers to. Required when sourceId is set; null for household-level obligations.
enummember income
category enum Verification obligation category.
enumcitizenship identity immigration income residency
verificationType enum How this verification obligation is to be fulfilled.
enumdocument electronic
reviewedAt string (date-time) read-only When a caseworker accepted this verification obligation.
reviewedBy string (uuid) read-only ID of the caseworker who accepted this verification obligation.
id string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
403 The authenticated user does not have permission to perform this action.
▶ Forbidden
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 The record is in a state this action can't start from, or one of its guards isn't met.
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/verifications/{verificationId}/mark-accept Mark accept verification State machine →

POST /applications/verifications/{verificationId}/mark-accept — Caseworker accepts an electronic result as sufficient to satisfy the obligation, with a required justification

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

verificationId string path ✓

Unique identifier of the verification obligation.

Request body required
▶ MarkAcceptVerificationRequest
reason string required Why the caseworker is accepting the electronic result as sufficient to satisfy the obligation
Responses
200 Transition applied successfully.
▶ Verification
applicationId string (uuid) read-only
status enum read-only Current status of the verification obligation.
enumpending inconclusive satisfied waived cannot_verify
▶ evidence array[VerificationEvidenceItem] read-only Electronic and document evidence items accumulated against this obligation.
▶ (one of) VerificationEvidenceItem
▶ VerificationElectronicEvidence
type enum required
enumelectronic
source enum required The external service that produced this result.
enumfdsh_fti fdsh_ssa fdsh_vlp irs_ievs save ssa_ievs swica uib
result enum required Whether the service check confirmed the obligation.
enumconclusive error inconclusive partial
serviceCallId string (uuid) ID of the data-exchange service call that produced this result.
receivedAt string (date-time) required When the result was received.
reviewedAt string (date-time) When a caseworker reviewed and accepted the electronic result.
reviewedBy string (uuid) ID of the caseworker who accepted the electronic result.
▶ VerificationDocumentEvidence
type enum required
enumdocument
documentId string (uuid) required ID of the verified document in the document-management domain.
receivedAt string (date-time) required When the document was received.
reviewedAt string (date-time) When a caseworker reviewed the document.
reviewedBy string (uuid) ID of the caseworker who reviewed the document.
▶ documentRequests array[VerificationDocumentRequest] read-only Outbound document request notices sent to the applicant for this obligation.
noticeId string (uuid) required ID of the notice in the communication domain.
type enum required Template identifier for the notice. Matches the type field on the communication.notice.sent event.
enumdocument_request_citizenship_verification document_request_identity_verification document_request_immigration_verification document_request_income_verification document_request_residency_verification
sentAt string (date-time) required When the notice was sent.
dueAt string (date-time) Deadline by which the applicant must respond.
channel string Channel through which the notice was sent.
enumemail in_person mail portal null
sourceId string (uuid) ID of the subject being verified. Points to an ApplicationMember when sourceType is `member`, or to an income record when sourceType is `income`. Null for household-level obligations (e.g., proof of residency).
sourceType string Identifies what sourceId refers to. Required when sourceId is set; null for household-level obligations.
enummember income
category enum Verification obligation category.
enumcitizenship identity immigration income residency
verificationType enum How this verification obligation is to be fulfilled.
enumdocument electronic
reviewedAt string (date-time) read-only When a caseworker accepted this verification obligation.
reviewedBy string (uuid) read-only ID of the caseworker who accepted this verification obligation.
id string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
403 The authenticated user does not have permission to perform this action.
▶ Forbidden
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 The record is in a state this action can't start from, or one of its guards isn't met.
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/review Get applicationReview Composition
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Responses
200 applicationReview retrieved successfully.
▶ ApplicationReviewResponse
object
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.

Members

Household members included in an application.

▶ GET /applications/{applicationId}/members List application members

Retrieve all household members linked to this application.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
Responses
200 A paginated list of application members.
▶ ApplicationMemberList
total integer required Total number of items available.
limit integer required Maximum number of items requested.
offset integer required Number of items skipped before the current page.
hasNext boolean Whether more items are available beyond the current page.
▶ items array[ApplicationMember] required
roles array[enum] Roles this person plays in the application.
enumprimary_applicant household_member non_applying_member authorized_representative absent_parent
programsAppliedFor array[enum] Programs this member is applying for.
enumsnap medicaid chip tanf
purchasesAndPreparesFood boolean Whether this member purchases and prepares food separately from the rest of the household.
isMigrantFarmWorker boolean Whether this member is a migrant or seasonal farm worker.
hasThirdPartyLiabilityClaim boolean Whether this member has a third-party liability claim that could cover medical costs.
personId string (uuid) Resolved person record ID. Auto-set on a confirmed match; caseworker can set it manually when selecting from match candidates or correcting a bad link.
▶ personalInformation PersonalInformation Core demographic and identity fields for a household member. Collected for all applying members. Used in identity verification, program eligibility calculations, and federal reporting.
ssn string Social Security Number. Required for most program eligibility determinations and SSA/FDSH identity verification.
dateOfBirth string (date) Date of birth. Used in age-based eligibility criteria and as a core identity-matching field for verification calls.
sexAssignedAtBirth enum Sex assigned at birth. Used in some program eligibility and reporting contexts.
enummale female intersex unknown
genderIdentity enum Member's self-reported gender identity. Collected for reporting; not used in eligibility calculations.
enumman woman non_binary transgender_man transgender_woman prefer_not_to_answer other
maritalStatus enum Current marital or partnership status. Affects household composition and tax filing status for Medicaid eligibility.
enumsingle married divorced separated widowed civil_union domestic_partnership
races array[enum] Self-reported racial categories. Collected for federal civil rights reporting. Not used in eligibility calculations.
enumamerican_indian_alaskan_native asian black_african_american native_hawaiian_pacific_islander white
isHispanicOrLatino boolean Whether the member identifies as Hispanic or Latino. Collected for federal civil rights reporting.
preferredSpokenLanguage string BCP 47 language tag for the member's preferred spoken language. Used to route interpreter services.
preferredWrittenLanguage string BCP 47 language tag for the member's preferred written language. Used for notice generation.
▶ contact MemberContact Contact and address information for a household member. Extends the base Contact type with member-specific fields: mailing address, homelessness flag, notice preferences, and alternate notice address. primaryAddress is used to determine county jurisdiction.
name object required Legal name of a person.
firstName string required First name.
middleName string Middle name.
middleInitial string Middle initial.
lastName string required Last name.
maidenName string Maiden name if applicable.
suffix string Name suffix such as Jr., Sr., III, etc.
primaryAddress object Primary address for this contact.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
primaryPhone string Primary phone number.
email string (email) Email address.
mailingAddress object Mailing address if different from primary address. Overrides primaryAddress for notice delivery.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
alternatePhone string Secondary phone number for the member.
isExperiencingHomelessness boolean Whether the member lacks a fixed, regular, and adequate nighttime residence.
noticePreference enum Preferred method for receiving program notices.
enumpaper email both
alternateNoticeAddress object Address for notices when privacy concerns exist (e.g., domestic violence situations).
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
▶ residency Residency State residency information for a household member. States must verify residency for most benefit programs. SNAP does not require a minimum residency period (7 CFR § 273.3).
isStateResident boolean Whether the member currently resides in the state.
stateResidencyDate string (date) Date the member established residency in the state. Used for programs with residency waiting periods.
▶ citizenship Citizenship Citizenship and immigration status for a household member. Determines whether immigration verification checks are required and which federal benefit waiting periods apply. Non-citizens face a 5-year bar for SNAP in most cases (8 U.S.C. § 1612) and Medicaid (42 CFR § 435.406).
citizenshipStatus enum The member's citizenship status. Determines whether immigration status checks are required via FDSH VLP or USCIS SAVE.
enumus_citizen us_national non_citizen
certificateNumber string U.S. certificate of citizenship or naturalization number. Present when citizenshipStatus is us_citizen and naturalized.
immigrantStatus enum Specific immigration status per 8 U.S.C. § 1641. Required when citizenshipStatus is non_citizen.
enumlawful_permanent_resident refugee asylee deportation_withheld parolee conditional_entrant cuban_haitian_entrant amerasian battered_non_citizen trafficking_victim temporary_protected_status other
uscisNumberOrI94 string USCIS alien registration number or I-94 admission number. Used for FDSH VLP verification.
document object Immigration document details. Present when citizenshipStatus is non_citizen.
type enum Type of immigration document. Determines which fields FDSH VLP requires.
enumi_551 i_766 i_94 i_327 i_571 foreign_passport machine_readable_immigrant_visa other
number string Document number (card number, I-94 number, etc.).
expirationDate string (date) Document expiration date.
countryOfIssuance string ISO 3166-1 alpha-2 country code of the issuing country.
residedInUsSince1996 boolean Whether the member has resided in the U.S. continuously since August 22, 1996. Relevant to the 5-year bar under PRWORA.
hasQualifyingMilitaryConnection boolean Whether the member or a spouse/parent served honorably in the U.S. military. Exempts from certain waiting periods.
sponsored object Sponsor deeming information. Present when the member entered the U.S. as a sponsored immigrant.
hasBeenAbandonedBySponsor boolean Whether the sponsor has abandoned the member. Exempts from sponsor deeming.
hasBeenMistreatedBySponsor boolean Whether the member has been subjected to battery or extreme cruelty by the sponsor or sponsor's household. Exempts from sponsor deeming under VAWA provisions.
qualifiesForSponsorDeemingException boolean Whether any other sponsor deeming exception applies (e.g., member is indigent).
receivesInKindSupport boolean Whether the sponsor is currently providing in-kind support to the member.
▶ retroactiveMedicalCoverage RetroactiveMedicalCoverage Retroactive Medicaid coverage request for a household member. Medicaid may cover medical expenses incurred up to 3 months before the application date if the member would have been eligible (42 CFR § 435.914).
isRequested boolean Whether the member is requesting retroactive Medicaid coverage.
periods array[object] Months for which retroactive coverage is requested, with household income for each.
month string required The month for which coverage is requested, in YYYY-MM format.
householdIncome number (float) Total household income for this month. Used to assess eligibility for the retroactive period.
▶ disability Disability Disability status for a household member. Affects SNAP medical expense deductions for elderly or disabled members (7 CFR § 273.9(d)(3)), TANF exemptions from work requirements, and Medicaid disability pathways.
isDisabled boolean Whether the member has a disability as defined by the applying program.
hasLongTermCondition boolean Whether the disability or health condition is expected to last 12 months or more.
hasPhysicalDisability boolean Whether the member has a physical disability.
hasMentalDisability boolean Whether the member has a mental health condition or intellectual disability.
needsHelpWithSelfCare boolean Whether the member needs assistance with activities of daily living.
▶ studentStatus StudentStatus Student enrollment information for a household member. Affects SNAP eligibility — most students enrolled at least half-time at an institution of higher education are ineligible unless they meet an exemption (7 CFR § 273.5).
enrollmentStatus enum Current enrollment status at an educational institution.
enumfull_time part_time not_enrolled
institutionType enum Type of educational institution attended.
enumhigher_education vocational other
schoolName string Name of the school or institution.
isParticipatingInWorkStudy boolean Whether the member is participating in a federal work-study program. Exempts from the SNAP student rule.
▶ pregnancy Pregnancy Pregnancy information for a household member. Affects household size calculations for some programs and Medicaid presumptive eligibility.
isPregnant boolean Whether the member is currently pregnant.
dueDate string (date) Expected due date.
numberOfBabiesExpected integer Number of babies expected. Used when calculating household size for programs that count unborn children.
▶ fosterCare FosterCare Foster care history for a household member. Young adults who aged out of foster care may qualify for Medicaid coverage up to age 26 regardless of income under the Fostering Connections Act (42 U.S.C. § 675a).
startDate string (date) Date the member entered foster care.
endDate string (date) Date the member exited foster care.
exitReason enum Reason the member exited foster care. aged_out is the primary qualifier for extended Medicaid.
enumadopted reunified aged_out emancipated
exitState string USPS postal abbreviation of the state from which the member exited foster care. Relevant for interstate Medicaid coordination.
receivedMedicaidAtAge18 boolean Whether the member was receiving Medicaid when they turned 18. Required for the Fostering Connections Medicaid pathway.
returnedAfterAdoption boolean Whether the member returned to foster care after an adoption that was subsequently dissolved.
returnDate string (date) Date the member returned to foster care after dissolved adoption.
▶ military Military Military service information for a household member. Veterans and their families may qualify for additional program pathways. Active duty affects household composition rules for some programs.
isVeteran boolean Whether the member has served in the U.S. armed forces and has been discharged.
isActiveDuty boolean Whether the member is currently on active duty.
dischargeStatus enum Character of discharge. Affects eligibility for VA benefits and some state programs.
enumhonorable general other_than_honorable bad_conduct dishonorable uncharacterized
▶ institutionalStatus InstitutionalStatus Institutional living status for a household member. Members residing in certain institutions are ineligible for SNAP (7 CFR § 273.1(b)) and may have modified Medicaid eligibility.
livesInInstitution boolean Whether the member currently resides in an institution.
facilityName string Name of the institution.
facilityType enum Type of institution. Determines which program exclusions and rules apply.
enumnursing_home hospital incarceration other
dateEntered string (date) Date the member entered the institution.
pendingDispositionOfCharges boolean Whether the member is a pre-trial detainee (charges pending). Affects SNAP and Medicaid eligibility differently than conviction.
mealsProvided boolean Whether the institution provides meals as part of the living arrangement.
▶ priorConvictions PriorConvictions Criminal history fields affecting program eligibility. Certain drug felony convictions and other offenses create disqualifications or require additional review under federal law.
isFleeingFelon boolean Whether the member is fleeing prosecution, custody, or confinement for a felony. Disqualifies from SNAP (7 CFR § 273.11(n)) and TANF (45 CFR § 261.55).
convictedOfDrugRelatedFelony boolean Whether the member has a state or federal drug-related felony conviction. States may apply a lifetime ban or modified rules under 21 U.S.C. § 862a.
convictedDuplicateSnapBenefits boolean Whether the member has been convicted of fraudulently obtaining SNAP benefits in multiple jurisdictions simultaneously (7 CFR § 273.11(c)).
convictedOfSnapTrafficking boolean Whether the member has been convicted of SNAP benefit trafficking. Permanent disqualification (7 CFR § 273.11(b)).
convictedTradingSnapForFirearmsOrExplosives boolean Whether the member has been convicted of trading SNAP benefits for firearms, ammunition, or explosives. Permanent disqualification (7 CFR § 273.11(b)).
convictedOfDisqualifyingViolentCrime boolean Whether the member has a conviction for a disqualifying violent crime under state law.
disqualifiedForIPV boolean Whether the member has been disqualified for an Intentional Program Violation (IPV) under 7 CFR § 273.16.
isViolatingProbationOrParole boolean Whether the member is in violation of a condition of probation or parole. Disqualifies from SNAP (7 CFR § 273.11(n)).
▶ tribalStatus TribalStatus Tribal membership and affiliation information. Members of federally recognized tribes may have access to tribal food programs that interact with SNAP eligibility. Some states provide additional benefits to tribal members.
isAmericanIndianOrAlaskaNative boolean Whether the member is a member of a federally recognized tribe or is an Alaska Native.
tribeName string Name of the federally recognized tribe.
tribeState string USPS postal abbreviation of the state where the tribe is headquartered.
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
personMatch anyOf read-only
▶ (one of)
▶ PersonMatch
matchStatus enum
enumconfirmed review_required no_match
candidates array[object] Match candidates. Populated for review_required; empty otherwise.
personId string (uuid) required The candidate person record ID.
confidenceScore number (float) required Match confidence score from 0 (no confidence) to 1 (certain).
▶ Variant
No additional fields
▶ programDeterminations array[ApplicationMemberProgramDetermination] read-only Per-program eligibility determination results, populated as decisions arrive from the eligibility domain.
program string required Program identifier (e.g., snap, medicaid, tanf).
outcome enum Determination outcome for this member/program combination.
enumapproved denied
determinedAt string (date-time) When the determination was recorded.
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/members Add a member

Add a household member to this application.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Request body required
▶ ApplicationMemberCreate
roles array[enum] Roles this person plays in the application.
enumprimary_applicant household_member non_applying_member authorized_representative absent_parent
programsAppliedFor array[enum] Programs this member is applying for.
enumsnap medicaid chip tanf
purchasesAndPreparesFood boolean Whether this member purchases and prepares food separately from the rest of the household.
isMigrantFarmWorker boolean Whether this member is a migrant or seasonal farm worker.
hasThirdPartyLiabilityClaim boolean Whether this member has a third-party liability claim that could cover medical costs.
personId string (uuid) Resolved person record ID. Auto-set on a confirmed match; caseworker can set it manually when selecting from match candidates or correcting a bad link.
▶ personalInformation PersonalInformation Core demographic and identity fields for a household member. Collected for all applying members. Used in identity verification, program eligibility calculations, and federal reporting.
ssn string Social Security Number. Required for most program eligibility determinations and SSA/FDSH identity verification.
dateOfBirth string (date) Date of birth. Used in age-based eligibility criteria and as a core identity-matching field for verification calls.
sexAssignedAtBirth enum Sex assigned at birth. Used in some program eligibility and reporting contexts.
enummale female intersex unknown
genderIdentity enum Member's self-reported gender identity. Collected for reporting; not used in eligibility calculations.
enumman woman non_binary transgender_man transgender_woman prefer_not_to_answer other
maritalStatus enum Current marital or partnership status. Affects household composition and tax filing status for Medicaid eligibility.
enumsingle married divorced separated widowed civil_union domestic_partnership
races array[enum] Self-reported racial categories. Collected for federal civil rights reporting. Not used in eligibility calculations.
enumamerican_indian_alaskan_native asian black_african_american native_hawaiian_pacific_islander white
isHispanicOrLatino boolean Whether the member identifies as Hispanic or Latino. Collected for federal civil rights reporting.
preferredSpokenLanguage string BCP 47 language tag for the member's preferred spoken language. Used to route interpreter services.
preferredWrittenLanguage string BCP 47 language tag for the member's preferred written language. Used for notice generation.
▶ contact MemberContact Contact and address information for a household member. Extends the base Contact type with member-specific fields: mailing address, homelessness flag, notice preferences, and alternate notice address. primaryAddress is used to determine county jurisdiction.
name object required Legal name of a person.
firstName string required First name.
middleName string Middle name.
middleInitial string Middle initial.
lastName string required Last name.
maidenName string Maiden name if applicable.
suffix string Name suffix such as Jr., Sr., III, etc.
primaryAddress object Primary address for this contact.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
primaryPhone string Primary phone number.
email string (email) Email address.
mailingAddress object Mailing address if different from primary address. Overrides primaryAddress for notice delivery.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
alternatePhone string Secondary phone number for the member.
isExperiencingHomelessness boolean Whether the member lacks a fixed, regular, and adequate nighttime residence.
noticePreference enum Preferred method for receiving program notices.
enumpaper email both
alternateNoticeAddress object Address for notices when privacy concerns exist (e.g., domestic violence situations).
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
▶ residency Residency State residency information for a household member. States must verify residency for most benefit programs. SNAP does not require a minimum residency period (7 CFR § 273.3).
isStateResident boolean Whether the member currently resides in the state.
stateResidencyDate string (date) Date the member established residency in the state. Used for programs with residency waiting periods.
▶ citizenship Citizenship Citizenship and immigration status for a household member. Determines whether immigration verification checks are required and which federal benefit waiting periods apply. Non-citizens face a 5-year bar for SNAP in most cases (8 U.S.C. § 1612) and Medicaid (42 CFR § 435.406).
citizenshipStatus enum The member's citizenship status. Determines whether immigration status checks are required via FDSH VLP or USCIS SAVE.
enumus_citizen us_national non_citizen
certificateNumber string U.S. certificate of citizenship or naturalization number. Present when citizenshipStatus is us_citizen and naturalized.
immigrantStatus enum Specific immigration status per 8 U.S.C. § 1641. Required when citizenshipStatus is non_citizen.
enumlawful_permanent_resident refugee asylee deportation_withheld parolee conditional_entrant cuban_haitian_entrant amerasian battered_non_citizen trafficking_victim temporary_protected_status other
uscisNumberOrI94 string USCIS alien registration number or I-94 admission number. Used for FDSH VLP verification.
document object Immigration document details. Present when citizenshipStatus is non_citizen.
type enum Type of immigration document. Determines which fields FDSH VLP requires.
enumi_551 i_766 i_94 i_327 i_571 foreign_passport machine_readable_immigrant_visa other
number string Document number (card number, I-94 number, etc.).
expirationDate string (date) Document expiration date.
countryOfIssuance string ISO 3166-1 alpha-2 country code of the issuing country.
residedInUsSince1996 boolean Whether the member has resided in the U.S. continuously since August 22, 1996. Relevant to the 5-year bar under PRWORA.
hasQualifyingMilitaryConnection boolean Whether the member or a spouse/parent served honorably in the U.S. military. Exempts from certain waiting periods.
sponsored object Sponsor deeming information. Present when the member entered the U.S. as a sponsored immigrant.
hasBeenAbandonedBySponsor boolean Whether the sponsor has abandoned the member. Exempts from sponsor deeming.
hasBeenMistreatedBySponsor boolean Whether the member has been subjected to battery or extreme cruelty by the sponsor or sponsor's household. Exempts from sponsor deeming under VAWA provisions.
qualifiesForSponsorDeemingException boolean Whether any other sponsor deeming exception applies (e.g., member is indigent).
receivesInKindSupport boolean Whether the sponsor is currently providing in-kind support to the member.
▶ retroactiveMedicalCoverage RetroactiveMedicalCoverage Retroactive Medicaid coverage request for a household member. Medicaid may cover medical expenses incurred up to 3 months before the application date if the member would have been eligible (42 CFR § 435.914).
isRequested boolean Whether the member is requesting retroactive Medicaid coverage.
periods array[object] Months for which retroactive coverage is requested, with household income for each.
month string required The month for which coverage is requested, in YYYY-MM format.
householdIncome number (float) Total household income for this month. Used to assess eligibility for the retroactive period.
▶ disability Disability Disability status for a household member. Affects SNAP medical expense deductions for elderly or disabled members (7 CFR § 273.9(d)(3)), TANF exemptions from work requirements, and Medicaid disability pathways.
isDisabled boolean Whether the member has a disability as defined by the applying program.
hasLongTermCondition boolean Whether the disability or health condition is expected to last 12 months or more.
hasPhysicalDisability boolean Whether the member has a physical disability.
hasMentalDisability boolean Whether the member has a mental health condition or intellectual disability.
needsHelpWithSelfCare boolean Whether the member needs assistance with activities of daily living.
▶ studentStatus StudentStatus Student enrollment information for a household member. Affects SNAP eligibility — most students enrolled at least half-time at an institution of higher education are ineligible unless they meet an exemption (7 CFR § 273.5).
enrollmentStatus enum Current enrollment status at an educational institution.
enumfull_time part_time not_enrolled
institutionType enum Type of educational institution attended.
enumhigher_education vocational other
schoolName string Name of the school or institution.
isParticipatingInWorkStudy boolean Whether the member is participating in a federal work-study program. Exempts from the SNAP student rule.
▶ pregnancy Pregnancy Pregnancy information for a household member. Affects household size calculations for some programs and Medicaid presumptive eligibility.
isPregnant boolean Whether the member is currently pregnant.
dueDate string (date) Expected due date.
numberOfBabiesExpected integer Number of babies expected. Used when calculating household size for programs that count unborn children.
▶ fosterCare FosterCare Foster care history for a household member. Young adults who aged out of foster care may qualify for Medicaid coverage up to age 26 regardless of income under the Fostering Connections Act (42 U.S.C. § 675a).
startDate string (date) Date the member entered foster care.
endDate string (date) Date the member exited foster care.
exitReason enum Reason the member exited foster care. aged_out is the primary qualifier for extended Medicaid.
enumadopted reunified aged_out emancipated
exitState string USPS postal abbreviation of the state from which the member exited foster care. Relevant for interstate Medicaid coordination.
receivedMedicaidAtAge18 boolean Whether the member was receiving Medicaid when they turned 18. Required for the Fostering Connections Medicaid pathway.
returnedAfterAdoption boolean Whether the member returned to foster care after an adoption that was subsequently dissolved.
returnDate string (date) Date the member returned to foster care after dissolved adoption.
▶ military Military Military service information for a household member. Veterans and their families may qualify for additional program pathways. Active duty affects household composition rules for some programs.
isVeteran boolean Whether the member has served in the U.S. armed forces and has been discharged.
isActiveDuty boolean Whether the member is currently on active duty.
dischargeStatus enum Character of discharge. Affects eligibility for VA benefits and some state programs.
enumhonorable general other_than_honorable bad_conduct dishonorable uncharacterized
▶ institutionalStatus InstitutionalStatus Institutional living status for a household member. Members residing in certain institutions are ineligible for SNAP (7 CFR § 273.1(b)) and may have modified Medicaid eligibility.
livesInInstitution boolean Whether the member currently resides in an institution.
facilityName string Name of the institution.
facilityType enum Type of institution. Determines which program exclusions and rules apply.
enumnursing_home hospital incarceration other
dateEntered string (date) Date the member entered the institution.
pendingDispositionOfCharges boolean Whether the member is a pre-trial detainee (charges pending). Affects SNAP and Medicaid eligibility differently than conviction.
mealsProvided boolean Whether the institution provides meals as part of the living arrangement.
▶ priorConvictions PriorConvictions Criminal history fields affecting program eligibility. Certain drug felony convictions and other offenses create disqualifications or require additional review under federal law.
isFleeingFelon boolean Whether the member is fleeing prosecution, custody, or confinement for a felony. Disqualifies from SNAP (7 CFR § 273.11(n)) and TANF (45 CFR § 261.55).
convictedOfDrugRelatedFelony boolean Whether the member has a state or federal drug-related felony conviction. States may apply a lifetime ban or modified rules under 21 U.S.C. § 862a.
convictedDuplicateSnapBenefits boolean Whether the member has been convicted of fraudulently obtaining SNAP benefits in multiple jurisdictions simultaneously (7 CFR § 273.11(c)).
convictedOfSnapTrafficking boolean Whether the member has been convicted of SNAP benefit trafficking. Permanent disqualification (7 CFR § 273.11(b)).
convictedTradingSnapForFirearmsOrExplosives boolean Whether the member has been convicted of trading SNAP benefits for firearms, ammunition, or explosives. Permanent disqualification (7 CFR § 273.11(b)).
convictedOfDisqualifyingViolentCrime boolean Whether the member has a conviction for a disqualifying violent crime under state law.
disqualifiedForIPV boolean Whether the member has been disqualified for an Intentional Program Violation (IPV) under 7 CFR § 273.16.
isViolatingProbationOrParole boolean Whether the member is in violation of a condition of probation or parole. Disqualifies from SNAP (7 CFR § 273.11(n)).
▶ tribalStatus TribalStatus Tribal membership and affiliation information. Members of federally recognized tribes may have access to tribal food programs that interact with SNAP eligibility. Some states provide additional benefits to tribal members.
isAmericanIndianOrAlaskaNative boolean Whether the member is a member of a federally recognized tribe or is an Alaska Native.
tribeName string Name of the federally recognized tribe.
tribeState string USPS postal abbreviation of the state where the tribe is headquartered.
id string (uuid) The new record's id, a UUID (RFC 9562).
Responses
201 Member added successfully.
▶ ApplicationMember
roles array[enum] Roles this person plays in the application.
enumprimary_applicant household_member non_applying_member authorized_representative absent_parent
programsAppliedFor array[enum] Programs this member is applying for.
enumsnap medicaid chip tanf
purchasesAndPreparesFood boolean Whether this member purchases and prepares food separately from the rest of the household.
isMigrantFarmWorker boolean Whether this member is a migrant or seasonal farm worker.
hasThirdPartyLiabilityClaim boolean Whether this member has a third-party liability claim that could cover medical costs.
personId string (uuid) Resolved person record ID. Auto-set on a confirmed match; caseworker can set it manually when selecting from match candidates or correcting a bad link.
▶ personalInformation PersonalInformation Core demographic and identity fields for a household member. Collected for all applying members. Used in identity verification, program eligibility calculations, and federal reporting.
ssn string Social Security Number. Required for most program eligibility determinations and SSA/FDSH identity verification.
dateOfBirth string (date) Date of birth. Used in age-based eligibility criteria and as a core identity-matching field for verification calls.
sexAssignedAtBirth enum Sex assigned at birth. Used in some program eligibility and reporting contexts.
enummale female intersex unknown
genderIdentity enum Member's self-reported gender identity. Collected for reporting; not used in eligibility calculations.
enumman woman non_binary transgender_man transgender_woman prefer_not_to_answer other
maritalStatus enum Current marital or partnership status. Affects household composition and tax filing status for Medicaid eligibility.
enumsingle married divorced separated widowed civil_union domestic_partnership
races array[enum] Self-reported racial categories. Collected for federal civil rights reporting. Not used in eligibility calculations.
enumamerican_indian_alaskan_native asian black_african_american native_hawaiian_pacific_islander white
isHispanicOrLatino boolean Whether the member identifies as Hispanic or Latino. Collected for federal civil rights reporting.
preferredSpokenLanguage string BCP 47 language tag for the member's preferred spoken language. Used to route interpreter services.
preferredWrittenLanguage string BCP 47 language tag for the member's preferred written language. Used for notice generation.
▶ contact MemberContact Contact and address information for a household member. Extends the base Contact type with member-specific fields: mailing address, homelessness flag, notice preferences, and alternate notice address. primaryAddress is used to determine county jurisdiction.
name object required Legal name of a person.
firstName string required First name.
middleName string Middle name.
middleInitial string Middle initial.
lastName string required Last name.
maidenName string Maiden name if applicable.
suffix string Name suffix such as Jr., Sr., III, etc.
primaryAddress object Primary address for this contact.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
primaryPhone string Primary phone number.
email string (email) Email address.
mailingAddress object Mailing address if different from primary address. Overrides primaryAddress for notice delivery.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
alternatePhone string Secondary phone number for the member.
isExperiencingHomelessness boolean Whether the member lacks a fixed, regular, and adequate nighttime residence.
noticePreference enum Preferred method for receiving program notices.
enumpaper email both
alternateNoticeAddress object Address for notices when privacy concerns exist (e.g., domestic violence situations).
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
▶ residency Residency State residency information for a household member. States must verify residency for most benefit programs. SNAP does not require a minimum residency period (7 CFR § 273.3).
isStateResident boolean Whether the member currently resides in the state.
stateResidencyDate string (date) Date the member established residency in the state. Used for programs with residency waiting periods.
▶ citizenship Citizenship Citizenship and immigration status for a household member. Determines whether immigration verification checks are required and which federal benefit waiting periods apply. Non-citizens face a 5-year bar for SNAP in most cases (8 U.S.C. § 1612) and Medicaid (42 CFR § 435.406).
citizenshipStatus enum The member's citizenship status. Determines whether immigration status checks are required via FDSH VLP or USCIS SAVE.
enumus_citizen us_national non_citizen
certificateNumber string U.S. certificate of citizenship or naturalization number. Present when citizenshipStatus is us_citizen and naturalized.
immigrantStatus enum Specific immigration status per 8 U.S.C. § 1641. Required when citizenshipStatus is non_citizen.
enumlawful_permanent_resident refugee asylee deportation_withheld parolee conditional_entrant cuban_haitian_entrant amerasian battered_non_citizen trafficking_victim temporary_protected_status other
uscisNumberOrI94 string USCIS alien registration number or I-94 admission number. Used for FDSH VLP verification.
document object Immigration document details. Present when citizenshipStatus is non_citizen.
type enum Type of immigration document. Determines which fields FDSH VLP requires.
enumi_551 i_766 i_94 i_327 i_571 foreign_passport machine_readable_immigrant_visa other
number string Document number (card number, I-94 number, etc.).
expirationDate string (date) Document expiration date.
countryOfIssuance string ISO 3166-1 alpha-2 country code of the issuing country.
residedInUsSince1996 boolean Whether the member has resided in the U.S. continuously since August 22, 1996. Relevant to the 5-year bar under PRWORA.
hasQualifyingMilitaryConnection boolean Whether the member or a spouse/parent served honorably in the U.S. military. Exempts from certain waiting periods.
sponsored object Sponsor deeming information. Present when the member entered the U.S. as a sponsored immigrant.
hasBeenAbandonedBySponsor boolean Whether the sponsor has abandoned the member. Exempts from sponsor deeming.
hasBeenMistreatedBySponsor boolean Whether the member has been subjected to battery or extreme cruelty by the sponsor or sponsor's household. Exempts from sponsor deeming under VAWA provisions.
qualifiesForSponsorDeemingException boolean Whether any other sponsor deeming exception applies (e.g., member is indigent).
receivesInKindSupport boolean Whether the sponsor is currently providing in-kind support to the member.
▶ retroactiveMedicalCoverage RetroactiveMedicalCoverage Retroactive Medicaid coverage request for a household member. Medicaid may cover medical expenses incurred up to 3 months before the application date if the member would have been eligible (42 CFR § 435.914).
isRequested boolean Whether the member is requesting retroactive Medicaid coverage.
periods array[object] Months for which retroactive coverage is requested, with household income for each.
month string required The month for which coverage is requested, in YYYY-MM format.
householdIncome number (float) Total household income for this month. Used to assess eligibility for the retroactive period.
▶ disability Disability Disability status for a household member. Affects SNAP medical expense deductions for elderly or disabled members (7 CFR § 273.9(d)(3)), TANF exemptions from work requirements, and Medicaid disability pathways.
isDisabled boolean Whether the member has a disability as defined by the applying program.
hasLongTermCondition boolean Whether the disability or health condition is expected to last 12 months or more.
hasPhysicalDisability boolean Whether the member has a physical disability.
hasMentalDisability boolean Whether the member has a mental health condition or intellectual disability.
needsHelpWithSelfCare boolean Whether the member needs assistance with activities of daily living.
▶ studentStatus StudentStatus Student enrollment information for a household member. Affects SNAP eligibility — most students enrolled at least half-time at an institution of higher education are ineligible unless they meet an exemption (7 CFR § 273.5).
enrollmentStatus enum Current enrollment status at an educational institution.
enumfull_time part_time not_enrolled
institutionType enum Type of educational institution attended.
enumhigher_education vocational other
schoolName string Name of the school or institution.
isParticipatingInWorkStudy boolean Whether the member is participating in a federal work-study program. Exempts from the SNAP student rule.
▶ pregnancy Pregnancy Pregnancy information for a household member. Affects household size calculations for some programs and Medicaid presumptive eligibility.
isPregnant boolean Whether the member is currently pregnant.
dueDate string (date) Expected due date.
numberOfBabiesExpected integer Number of babies expected. Used when calculating household size for programs that count unborn children.
▶ fosterCare FosterCare Foster care history for a household member. Young adults who aged out of foster care may qualify for Medicaid coverage up to age 26 regardless of income under the Fostering Connections Act (42 U.S.C. § 675a).
startDate string (date) Date the member entered foster care.
endDate string (date) Date the member exited foster care.
exitReason enum Reason the member exited foster care. aged_out is the primary qualifier for extended Medicaid.
enumadopted reunified aged_out emancipated
exitState string USPS postal abbreviation of the state from which the member exited foster care. Relevant for interstate Medicaid coordination.
receivedMedicaidAtAge18 boolean Whether the member was receiving Medicaid when they turned 18. Required for the Fostering Connections Medicaid pathway.
returnedAfterAdoption boolean Whether the member returned to foster care after an adoption that was subsequently dissolved.
returnDate string (date) Date the member returned to foster care after dissolved adoption.
▶ military Military Military service information for a household member. Veterans and their families may qualify for additional program pathways. Active duty affects household composition rules for some programs.
isVeteran boolean Whether the member has served in the U.S. armed forces and has been discharged.
isActiveDuty boolean Whether the member is currently on active duty.
dischargeStatus enum Character of discharge. Affects eligibility for VA benefits and some state programs.
enumhonorable general other_than_honorable bad_conduct dishonorable uncharacterized
▶ institutionalStatus InstitutionalStatus Institutional living status for a household member. Members residing in certain institutions are ineligible for SNAP (7 CFR § 273.1(b)) and may have modified Medicaid eligibility.
livesInInstitution boolean Whether the member currently resides in an institution.
facilityName string Name of the institution.
facilityType enum Type of institution. Determines which program exclusions and rules apply.
enumnursing_home hospital incarceration other
dateEntered string (date) Date the member entered the institution.
pendingDispositionOfCharges boolean Whether the member is a pre-trial detainee (charges pending). Affects SNAP and Medicaid eligibility differently than conviction.
mealsProvided boolean Whether the institution provides meals as part of the living arrangement.
▶ priorConvictions PriorConvictions Criminal history fields affecting program eligibility. Certain drug felony convictions and other offenses create disqualifications or require additional review under federal law.
isFleeingFelon boolean Whether the member is fleeing prosecution, custody, or confinement for a felony. Disqualifies from SNAP (7 CFR § 273.11(n)) and TANF (45 CFR § 261.55).
convictedOfDrugRelatedFelony boolean Whether the member has a state or federal drug-related felony conviction. States may apply a lifetime ban or modified rules under 21 U.S.C. § 862a.
convictedDuplicateSnapBenefits boolean Whether the member has been convicted of fraudulently obtaining SNAP benefits in multiple jurisdictions simultaneously (7 CFR § 273.11(c)).
convictedOfSnapTrafficking boolean Whether the member has been convicted of SNAP benefit trafficking. Permanent disqualification (7 CFR § 273.11(b)).
convictedTradingSnapForFirearmsOrExplosives boolean Whether the member has been convicted of trading SNAP benefits for firearms, ammunition, or explosives. Permanent disqualification (7 CFR § 273.11(b)).
convictedOfDisqualifyingViolentCrime boolean Whether the member has a conviction for a disqualifying violent crime under state law.
disqualifiedForIPV boolean Whether the member has been disqualified for an Intentional Program Violation (IPV) under 7 CFR § 273.16.
isViolatingProbationOrParole boolean Whether the member is in violation of a condition of probation or parole. Disqualifies from SNAP (7 CFR § 273.11(n)).
▶ tribalStatus TribalStatus Tribal membership and affiliation information. Members of federally recognized tribes may have access to tribal food programs that interact with SNAP eligibility. Some states provide additional benefits to tribal members.
isAmericanIndianOrAlaskaNative boolean Whether the member is a member of a federally recognized tribe or is an Alaska Native.
tribeName string Name of the federally recognized tribe.
tribeState string USPS postal abbreviation of the state where the tribe is headquartered.
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
personMatch anyOf read-only
▶ (one of)
▶ PersonMatch
matchStatus enum
enumconfirmed review_required no_match
candidates array[object] Match candidates. Populated for review_required; empty otherwise.
personId string (uuid) required The candidate person record ID.
confidenceScore number (float) required Match confidence score from 0 (no confidence) to 1 (certain).
▶ Variant
No additional fields
▶ programDeterminations array[ApplicationMemberProgramDetermination] read-only Per-program eligibility determination results, populated as decisions arrive from the eligibility domain.
program string required Program identifier (e.g., snap, medicaid, tanf).
outcome enum Determination outcome for this member/program combination.
enumapproved denied
determinedAt string (date-time) When the determination was recorded.
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/members/{memberId} Get a member

Retrieve a single household member by identifier.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

memberId string path ✓

Unique identifier of the application member.

Responses
200 Member retrieved successfully.
▶ ApplicationMember
roles array[enum] Roles this person plays in the application.
enumprimary_applicant household_member non_applying_member authorized_representative absent_parent
programsAppliedFor array[enum] Programs this member is applying for.
enumsnap medicaid chip tanf
purchasesAndPreparesFood boolean Whether this member purchases and prepares food separately from the rest of the household.
isMigrantFarmWorker boolean Whether this member is a migrant or seasonal farm worker.
hasThirdPartyLiabilityClaim boolean Whether this member has a third-party liability claim that could cover medical costs.
personId string (uuid) Resolved person record ID. Auto-set on a confirmed match; caseworker can set it manually when selecting from match candidates or correcting a bad link.
▶ personalInformation PersonalInformation Core demographic and identity fields for a household member. Collected for all applying members. Used in identity verification, program eligibility calculations, and federal reporting.
ssn string Social Security Number. Required for most program eligibility determinations and SSA/FDSH identity verification.
dateOfBirth string (date) Date of birth. Used in age-based eligibility criteria and as a core identity-matching field for verification calls.
sexAssignedAtBirth enum Sex assigned at birth. Used in some program eligibility and reporting contexts.
enummale female intersex unknown
genderIdentity enum Member's self-reported gender identity. Collected for reporting; not used in eligibility calculations.
enumman woman non_binary transgender_man transgender_woman prefer_not_to_answer other
maritalStatus enum Current marital or partnership status. Affects household composition and tax filing status for Medicaid eligibility.
enumsingle married divorced separated widowed civil_union domestic_partnership
races array[enum] Self-reported racial categories. Collected for federal civil rights reporting. Not used in eligibility calculations.
enumamerican_indian_alaskan_native asian black_african_american native_hawaiian_pacific_islander white
isHispanicOrLatino boolean Whether the member identifies as Hispanic or Latino. Collected for federal civil rights reporting.
preferredSpokenLanguage string BCP 47 language tag for the member's preferred spoken language. Used to route interpreter services.
preferredWrittenLanguage string BCP 47 language tag for the member's preferred written language. Used for notice generation.
▶ contact MemberContact Contact and address information for a household member. Extends the base Contact type with member-specific fields: mailing address, homelessness flag, notice preferences, and alternate notice address. primaryAddress is used to determine county jurisdiction.
name object required Legal name of a person.
firstName string required First name.
middleName string Middle name.
middleInitial string Middle initial.
lastName string required Last name.
maidenName string Maiden name if applicable.
suffix string Name suffix such as Jr., Sr., III, etc.
primaryAddress object Primary address for this contact.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
primaryPhone string Primary phone number.
email string (email) Email address.
mailingAddress object Mailing address if different from primary address. Overrides primaryAddress for notice delivery.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
alternatePhone string Secondary phone number for the member.
isExperiencingHomelessness boolean Whether the member lacks a fixed, regular, and adequate nighttime residence.
noticePreference enum Preferred method for receiving program notices.
enumpaper email both
alternateNoticeAddress object Address for notices when privacy concerns exist (e.g., domestic violence situations).
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
▶ residency Residency State residency information for a household member. States must verify residency for most benefit programs. SNAP does not require a minimum residency period (7 CFR § 273.3).
isStateResident boolean Whether the member currently resides in the state.
stateResidencyDate string (date) Date the member established residency in the state. Used for programs with residency waiting periods.
▶ citizenship Citizenship Citizenship and immigration status for a household member. Determines whether immigration verification checks are required and which federal benefit waiting periods apply. Non-citizens face a 5-year bar for SNAP in most cases (8 U.S.C. § 1612) and Medicaid (42 CFR § 435.406).
citizenshipStatus enum The member's citizenship status. Determines whether immigration status checks are required via FDSH VLP or USCIS SAVE.
enumus_citizen us_national non_citizen
certificateNumber string U.S. certificate of citizenship or naturalization number. Present when citizenshipStatus is us_citizen and naturalized.
immigrantStatus enum Specific immigration status per 8 U.S.C. § 1641. Required when citizenshipStatus is non_citizen.
enumlawful_permanent_resident refugee asylee deportation_withheld parolee conditional_entrant cuban_haitian_entrant amerasian battered_non_citizen trafficking_victim temporary_protected_status other
uscisNumberOrI94 string USCIS alien registration number or I-94 admission number. Used for FDSH VLP verification.
document object Immigration document details. Present when citizenshipStatus is non_citizen.
type enum Type of immigration document. Determines which fields FDSH VLP requires.
enumi_551 i_766 i_94 i_327 i_571 foreign_passport machine_readable_immigrant_visa other
number string Document number (card number, I-94 number, etc.).
expirationDate string (date) Document expiration date.
countryOfIssuance string ISO 3166-1 alpha-2 country code of the issuing country.
residedInUsSince1996 boolean Whether the member has resided in the U.S. continuously since August 22, 1996. Relevant to the 5-year bar under PRWORA.
hasQualifyingMilitaryConnection boolean Whether the member or a spouse/parent served honorably in the U.S. military. Exempts from certain waiting periods.
sponsored object Sponsor deeming information. Present when the member entered the U.S. as a sponsored immigrant.
hasBeenAbandonedBySponsor boolean Whether the sponsor has abandoned the member. Exempts from sponsor deeming.
hasBeenMistreatedBySponsor boolean Whether the member has been subjected to battery or extreme cruelty by the sponsor or sponsor's household. Exempts from sponsor deeming under VAWA provisions.
qualifiesForSponsorDeemingException boolean Whether any other sponsor deeming exception applies (e.g., member is indigent).
receivesInKindSupport boolean Whether the sponsor is currently providing in-kind support to the member.
▶ retroactiveMedicalCoverage RetroactiveMedicalCoverage Retroactive Medicaid coverage request for a household member. Medicaid may cover medical expenses incurred up to 3 months before the application date if the member would have been eligible (42 CFR § 435.914).
isRequested boolean Whether the member is requesting retroactive Medicaid coverage.
periods array[object] Months for which retroactive coverage is requested, with household income for each.
month string required The month for which coverage is requested, in YYYY-MM format.
householdIncome number (float) Total household income for this month. Used to assess eligibility for the retroactive period.
▶ disability Disability Disability status for a household member. Affects SNAP medical expense deductions for elderly or disabled members (7 CFR § 273.9(d)(3)), TANF exemptions from work requirements, and Medicaid disability pathways.
isDisabled boolean Whether the member has a disability as defined by the applying program.
hasLongTermCondition boolean Whether the disability or health condition is expected to last 12 months or more.
hasPhysicalDisability boolean Whether the member has a physical disability.
hasMentalDisability boolean Whether the member has a mental health condition or intellectual disability.
needsHelpWithSelfCare boolean Whether the member needs assistance with activities of daily living.
▶ studentStatus StudentStatus Student enrollment information for a household member. Affects SNAP eligibility — most students enrolled at least half-time at an institution of higher education are ineligible unless they meet an exemption (7 CFR § 273.5).
enrollmentStatus enum Current enrollment status at an educational institution.
enumfull_time part_time not_enrolled
institutionType enum Type of educational institution attended.
enumhigher_education vocational other
schoolName string Name of the school or institution.
isParticipatingInWorkStudy boolean Whether the member is participating in a federal work-study program. Exempts from the SNAP student rule.
▶ pregnancy Pregnancy Pregnancy information for a household member. Affects household size calculations for some programs and Medicaid presumptive eligibility.
isPregnant boolean Whether the member is currently pregnant.
dueDate string (date) Expected due date.
numberOfBabiesExpected integer Number of babies expected. Used when calculating household size for programs that count unborn children.
▶ fosterCare FosterCare Foster care history for a household member. Young adults who aged out of foster care may qualify for Medicaid coverage up to age 26 regardless of income under the Fostering Connections Act (42 U.S.C. § 675a).
startDate string (date) Date the member entered foster care.
endDate string (date) Date the member exited foster care.
exitReason enum Reason the member exited foster care. aged_out is the primary qualifier for extended Medicaid.
enumadopted reunified aged_out emancipated
exitState string USPS postal abbreviation of the state from which the member exited foster care. Relevant for interstate Medicaid coordination.
receivedMedicaidAtAge18 boolean Whether the member was receiving Medicaid when they turned 18. Required for the Fostering Connections Medicaid pathway.
returnedAfterAdoption boolean Whether the member returned to foster care after an adoption that was subsequently dissolved.
returnDate string (date) Date the member returned to foster care after dissolved adoption.
▶ military Military Military service information for a household member. Veterans and their families may qualify for additional program pathways. Active duty affects household composition rules for some programs.
isVeteran boolean Whether the member has served in the U.S. armed forces and has been discharged.
isActiveDuty boolean Whether the member is currently on active duty.
dischargeStatus enum Character of discharge. Affects eligibility for VA benefits and some state programs.
enumhonorable general other_than_honorable bad_conduct dishonorable uncharacterized
▶ institutionalStatus InstitutionalStatus Institutional living status for a household member. Members residing in certain institutions are ineligible for SNAP (7 CFR § 273.1(b)) and may have modified Medicaid eligibility.
livesInInstitution boolean Whether the member currently resides in an institution.
facilityName string Name of the institution.
facilityType enum Type of institution. Determines which program exclusions and rules apply.
enumnursing_home hospital incarceration other
dateEntered string (date) Date the member entered the institution.
pendingDispositionOfCharges boolean Whether the member is a pre-trial detainee (charges pending). Affects SNAP and Medicaid eligibility differently than conviction.
mealsProvided boolean Whether the institution provides meals as part of the living arrangement.
▶ priorConvictions PriorConvictions Criminal history fields affecting program eligibility. Certain drug felony convictions and other offenses create disqualifications or require additional review under federal law.
isFleeingFelon boolean Whether the member is fleeing prosecution, custody, or confinement for a felony. Disqualifies from SNAP (7 CFR § 273.11(n)) and TANF (45 CFR § 261.55).
convictedOfDrugRelatedFelony boolean Whether the member has a state or federal drug-related felony conviction. States may apply a lifetime ban or modified rules under 21 U.S.C. § 862a.
convictedDuplicateSnapBenefits boolean Whether the member has been convicted of fraudulently obtaining SNAP benefits in multiple jurisdictions simultaneously (7 CFR § 273.11(c)).
convictedOfSnapTrafficking boolean Whether the member has been convicted of SNAP benefit trafficking. Permanent disqualification (7 CFR § 273.11(b)).
convictedTradingSnapForFirearmsOrExplosives boolean Whether the member has been convicted of trading SNAP benefits for firearms, ammunition, or explosives. Permanent disqualification (7 CFR § 273.11(b)).
convictedOfDisqualifyingViolentCrime boolean Whether the member has a conviction for a disqualifying violent crime under state law.
disqualifiedForIPV boolean Whether the member has been disqualified for an Intentional Program Violation (IPV) under 7 CFR § 273.16.
isViolatingProbationOrParole boolean Whether the member is in violation of a condition of probation or parole. Disqualifies from SNAP (7 CFR § 273.11(n)).
▶ tribalStatus TribalStatus Tribal membership and affiliation information. Members of federally recognized tribes may have access to tribal food programs that interact with SNAP eligibility. Some states provide additional benefits to tribal members.
isAmericanIndianOrAlaskaNative boolean Whether the member is a member of a federally recognized tribe or is an Alaska Native.
tribeName string Name of the federally recognized tribe.
tribeState string USPS postal abbreviation of the state where the tribe is headquartered.
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
personMatch anyOf read-only
▶ (one of)
▶ PersonMatch
matchStatus enum
enumconfirmed review_required no_match
candidates array[object] Match candidates. Populated for review_required; empty otherwise.
personId string (uuid) required The candidate person record ID.
confidenceScore number (float) required Match confidence score from 0 (no confidence) to 1 (certain).
▶ Variant
No additional fields
▶ programDeterminations array[ApplicationMemberProgramDetermination] read-only Per-program eligibility determination results, populated as decisions arrive from the eligibility domain.
program string required Program identifier (e.g., snap, medicaid, tanf).
outcome enum Determination outcome for this member/program combination.
enumapproved denied
determinedAt string (date-time) When the determination was recorded.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId}/members/{memberId} Update a member

Apply partial updates to a household member record.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

memberId string path ✓

Unique identifier of the application member.

Request body required
▶ ApplicationMemberUpdate
roles array[enum] Roles this person plays in the application.
enumprimary_applicant household_member non_applying_member authorized_representative absent_parent
programsAppliedFor array[enum] Programs this member is applying for.
enumsnap medicaid chip tanf
purchasesAndPreparesFood boolean Whether this member purchases and prepares food separately from the rest of the household.
isMigrantFarmWorker boolean Whether this member is a migrant or seasonal farm worker.
hasThirdPartyLiabilityClaim boolean Whether this member has a third-party liability claim that could cover medical costs.
personId string (uuid) Resolved person record ID. Auto-set on a confirmed match; caseworker can set it manually when selecting from match candidates or correcting a bad link.
▶ personalInformation PersonalInformation Core demographic and identity fields for a household member. Collected for all applying members. Used in identity verification, program eligibility calculations, and federal reporting.
ssn string Social Security Number. Required for most program eligibility determinations and SSA/FDSH identity verification.
dateOfBirth string (date) Date of birth. Used in age-based eligibility criteria and as a core identity-matching field for verification calls.
sexAssignedAtBirth enum Sex assigned at birth. Used in some program eligibility and reporting contexts.
enummale female intersex unknown
genderIdentity enum Member's self-reported gender identity. Collected for reporting; not used in eligibility calculations.
enumman woman non_binary transgender_man transgender_woman prefer_not_to_answer other
maritalStatus enum Current marital or partnership status. Affects household composition and tax filing status for Medicaid eligibility.
enumsingle married divorced separated widowed civil_union domestic_partnership
races array[enum] Self-reported racial categories. Collected for federal civil rights reporting. Not used in eligibility calculations.
enumamerican_indian_alaskan_native asian black_african_american native_hawaiian_pacific_islander white
isHispanicOrLatino boolean Whether the member identifies as Hispanic or Latino. Collected for federal civil rights reporting.
preferredSpokenLanguage string BCP 47 language tag for the member's preferred spoken language. Used to route interpreter services.
preferredWrittenLanguage string BCP 47 language tag for the member's preferred written language. Used for notice generation.
▶ contact MemberContact Contact and address information for a household member. Extends the base Contact type with member-specific fields: mailing address, homelessness flag, notice preferences, and alternate notice address. primaryAddress is used to determine county jurisdiction.
name object required Legal name of a person.
firstName string required First name.
middleName string Middle name.
middleInitial string Middle initial.
lastName string required Last name.
maidenName string Maiden name if applicable.
suffix string Name suffix such as Jr., Sr., III, etc.
primaryAddress object Primary address for this contact.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
primaryPhone string Primary phone number.
email string (email) Email address.
mailingAddress object Mailing address if different from primary address. Overrides primaryAddress for notice delivery.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
alternatePhone string Secondary phone number for the member.
isExperiencingHomelessness boolean Whether the member lacks a fixed, regular, and adequate nighttime residence.
noticePreference enum Preferred method for receiving program notices.
enumpaper email both
alternateNoticeAddress object Address for notices when privacy concerns exist (e.g., domestic violence situations).
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
▶ residency Residency State residency information for a household member. States must verify residency for most benefit programs. SNAP does not require a minimum residency period (7 CFR § 273.3).
isStateResident boolean Whether the member currently resides in the state.
stateResidencyDate string (date) Date the member established residency in the state. Used for programs with residency waiting periods.
▶ citizenship Citizenship Citizenship and immigration status for a household member. Determines whether immigration verification checks are required and which federal benefit waiting periods apply. Non-citizens face a 5-year bar for SNAP in most cases (8 U.S.C. § 1612) and Medicaid (42 CFR § 435.406).
citizenshipStatus enum The member's citizenship status. Determines whether immigration status checks are required via FDSH VLP or USCIS SAVE.
enumus_citizen us_national non_citizen
certificateNumber string U.S. certificate of citizenship or naturalization number. Present when citizenshipStatus is us_citizen and naturalized.
immigrantStatus enum Specific immigration status per 8 U.S.C. § 1641. Required when citizenshipStatus is non_citizen.
enumlawful_permanent_resident refugee asylee deportation_withheld parolee conditional_entrant cuban_haitian_entrant amerasian battered_non_citizen trafficking_victim temporary_protected_status other
uscisNumberOrI94 string USCIS alien registration number or I-94 admission number. Used for FDSH VLP verification.
document object Immigration document details. Present when citizenshipStatus is non_citizen.
type enum Type of immigration document. Determines which fields FDSH VLP requires.
enumi_551 i_766 i_94 i_327 i_571 foreign_passport machine_readable_immigrant_visa other
number string Document number (card number, I-94 number, etc.).
expirationDate string (date) Document expiration date.
countryOfIssuance string ISO 3166-1 alpha-2 country code of the issuing country.
residedInUsSince1996 boolean Whether the member has resided in the U.S. continuously since August 22, 1996. Relevant to the 5-year bar under PRWORA.
hasQualifyingMilitaryConnection boolean Whether the member or a spouse/parent served honorably in the U.S. military. Exempts from certain waiting periods.
sponsored object Sponsor deeming information. Present when the member entered the U.S. as a sponsored immigrant.
hasBeenAbandonedBySponsor boolean Whether the sponsor has abandoned the member. Exempts from sponsor deeming.
hasBeenMistreatedBySponsor boolean Whether the member has been subjected to battery or extreme cruelty by the sponsor or sponsor's household. Exempts from sponsor deeming under VAWA provisions.
qualifiesForSponsorDeemingException boolean Whether any other sponsor deeming exception applies (e.g., member is indigent).
receivesInKindSupport boolean Whether the sponsor is currently providing in-kind support to the member.
▶ retroactiveMedicalCoverage RetroactiveMedicalCoverage Retroactive Medicaid coverage request for a household member. Medicaid may cover medical expenses incurred up to 3 months before the application date if the member would have been eligible (42 CFR § 435.914).
isRequested boolean Whether the member is requesting retroactive Medicaid coverage.
periods array[object] Months for which retroactive coverage is requested, with household income for each.
month string required The month for which coverage is requested, in YYYY-MM format.
householdIncome number (float) Total household income for this month. Used to assess eligibility for the retroactive period.
▶ disability Disability Disability status for a household member. Affects SNAP medical expense deductions for elderly or disabled members (7 CFR § 273.9(d)(3)), TANF exemptions from work requirements, and Medicaid disability pathways.
isDisabled boolean Whether the member has a disability as defined by the applying program.
hasLongTermCondition boolean Whether the disability or health condition is expected to last 12 months or more.
hasPhysicalDisability boolean Whether the member has a physical disability.
hasMentalDisability boolean Whether the member has a mental health condition or intellectual disability.
needsHelpWithSelfCare boolean Whether the member needs assistance with activities of daily living.
▶ studentStatus StudentStatus Student enrollment information for a household member. Affects SNAP eligibility — most students enrolled at least half-time at an institution of higher education are ineligible unless they meet an exemption (7 CFR § 273.5).
enrollmentStatus enum Current enrollment status at an educational institution.
enumfull_time part_time not_enrolled
institutionType enum Type of educational institution attended.
enumhigher_education vocational other
schoolName string Name of the school or institution.
isParticipatingInWorkStudy boolean Whether the member is participating in a federal work-study program. Exempts from the SNAP student rule.
▶ pregnancy Pregnancy Pregnancy information for a household member. Affects household size calculations for some programs and Medicaid presumptive eligibility.
isPregnant boolean Whether the member is currently pregnant.
dueDate string (date) Expected due date.
numberOfBabiesExpected integer Number of babies expected. Used when calculating household size for programs that count unborn children.
▶ fosterCare FosterCare Foster care history for a household member. Young adults who aged out of foster care may qualify for Medicaid coverage up to age 26 regardless of income under the Fostering Connections Act (42 U.S.C. § 675a).
startDate string (date) Date the member entered foster care.
endDate string (date) Date the member exited foster care.
exitReason enum Reason the member exited foster care. aged_out is the primary qualifier for extended Medicaid.
enumadopted reunified aged_out emancipated
exitState string USPS postal abbreviation of the state from which the member exited foster care. Relevant for interstate Medicaid coordination.
receivedMedicaidAtAge18 boolean Whether the member was receiving Medicaid when they turned 18. Required for the Fostering Connections Medicaid pathway.
returnedAfterAdoption boolean Whether the member returned to foster care after an adoption that was subsequently dissolved.
returnDate string (date) Date the member returned to foster care after dissolved adoption.
▶ military Military Military service information for a household member. Veterans and their families may qualify for additional program pathways. Active duty affects household composition rules for some programs.
isVeteran boolean Whether the member has served in the U.S. armed forces and has been discharged.
isActiveDuty boolean Whether the member is currently on active duty.
dischargeStatus enum Character of discharge. Affects eligibility for VA benefits and some state programs.
enumhonorable general other_than_honorable bad_conduct dishonorable uncharacterized
▶ institutionalStatus InstitutionalStatus Institutional living status for a household member. Members residing in certain institutions are ineligible for SNAP (7 CFR § 273.1(b)) and may have modified Medicaid eligibility.
livesInInstitution boolean Whether the member currently resides in an institution.
facilityName string Name of the institution.
facilityType enum Type of institution. Determines which program exclusions and rules apply.
enumnursing_home hospital incarceration other
dateEntered string (date) Date the member entered the institution.
pendingDispositionOfCharges boolean Whether the member is a pre-trial detainee (charges pending). Affects SNAP and Medicaid eligibility differently than conviction.
mealsProvided boolean Whether the institution provides meals as part of the living arrangement.
▶ priorConvictions PriorConvictions Criminal history fields affecting program eligibility. Certain drug felony convictions and other offenses create disqualifications or require additional review under federal law.
isFleeingFelon boolean Whether the member is fleeing prosecution, custody, or confinement for a felony. Disqualifies from SNAP (7 CFR § 273.11(n)) and TANF (45 CFR § 261.55).
convictedOfDrugRelatedFelony boolean Whether the member has a state or federal drug-related felony conviction. States may apply a lifetime ban or modified rules under 21 U.S.C. § 862a.
convictedDuplicateSnapBenefits boolean Whether the member has been convicted of fraudulently obtaining SNAP benefits in multiple jurisdictions simultaneously (7 CFR § 273.11(c)).
convictedOfSnapTrafficking boolean Whether the member has been convicted of SNAP benefit trafficking. Permanent disqualification (7 CFR § 273.11(b)).
convictedTradingSnapForFirearmsOrExplosives boolean Whether the member has been convicted of trading SNAP benefits for firearms, ammunition, or explosives. Permanent disqualification (7 CFR § 273.11(b)).
convictedOfDisqualifyingViolentCrime boolean Whether the member has a conviction for a disqualifying violent crime under state law.
disqualifiedForIPV boolean Whether the member has been disqualified for an Intentional Program Violation (IPV) under 7 CFR § 273.16.
isViolatingProbationOrParole boolean Whether the member is in violation of a condition of probation or parole. Disqualifies from SNAP (7 CFR § 273.11(n)).
▶ tribalStatus TribalStatus Tribal membership and affiliation information. Members of federally recognized tribes may have access to tribal food programs that interact with SNAP eligibility. Some states provide additional benefits to tribal members.
isAmericanIndianOrAlaskaNative boolean Whether the member is a member of a federally recognized tribe or is an Alaska Native.
tribeName string Name of the federally recognized tribe.
tribeState string USPS postal abbreviation of the state where the tribe is headquartered.
Responses
200 Member updated successfully.
▶ ApplicationMember
roles array[enum] Roles this person plays in the application.
enumprimary_applicant household_member non_applying_member authorized_representative absent_parent
programsAppliedFor array[enum] Programs this member is applying for.
enumsnap medicaid chip tanf
purchasesAndPreparesFood boolean Whether this member purchases and prepares food separately from the rest of the household.
isMigrantFarmWorker boolean Whether this member is a migrant or seasonal farm worker.
hasThirdPartyLiabilityClaim boolean Whether this member has a third-party liability claim that could cover medical costs.
personId string (uuid) Resolved person record ID. Auto-set on a confirmed match; caseworker can set it manually when selecting from match candidates or correcting a bad link.
▶ personalInformation PersonalInformation Core demographic and identity fields for a household member. Collected for all applying members. Used in identity verification, program eligibility calculations, and federal reporting.
ssn string Social Security Number. Required for most program eligibility determinations and SSA/FDSH identity verification.
dateOfBirth string (date) Date of birth. Used in age-based eligibility criteria and as a core identity-matching field for verification calls.
sexAssignedAtBirth enum Sex assigned at birth. Used in some program eligibility and reporting contexts.
enummale female intersex unknown
genderIdentity enum Member's self-reported gender identity. Collected for reporting; not used in eligibility calculations.
enumman woman non_binary transgender_man transgender_woman prefer_not_to_answer other
maritalStatus enum Current marital or partnership status. Affects household composition and tax filing status for Medicaid eligibility.
enumsingle married divorced separated widowed civil_union domestic_partnership
races array[enum] Self-reported racial categories. Collected for federal civil rights reporting. Not used in eligibility calculations.
enumamerican_indian_alaskan_native asian black_african_american native_hawaiian_pacific_islander white
isHispanicOrLatino boolean Whether the member identifies as Hispanic or Latino. Collected for federal civil rights reporting.
preferredSpokenLanguage string BCP 47 language tag for the member's preferred spoken language. Used to route interpreter services.
preferredWrittenLanguage string BCP 47 language tag for the member's preferred written language. Used for notice generation.
▶ contact MemberContact Contact and address information for a household member. Extends the base Contact type with member-specific fields: mailing address, homelessness flag, notice preferences, and alternate notice address. primaryAddress is used to determine county jurisdiction.
name object required Legal name of a person.
firstName string required First name.
middleName string Middle name.
middleInitial string Middle initial.
lastName string required Last name.
maidenName string Maiden name if applicable.
suffix string Name suffix such as Jr., Sr., III, etc.
primaryAddress object Primary address for this contact.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
primaryPhone string Primary phone number.
email string (email) Email address.
mailingAddress object Mailing address if different from primary address. Overrides primaryAddress for notice delivery.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
alternatePhone string Secondary phone number for the member.
isExperiencingHomelessness boolean Whether the member lacks a fixed, regular, and adequate nighttime residence.
noticePreference enum Preferred method for receiving program notices.
enumpaper email both
alternateNoticeAddress object Address for notices when privacy concerns exist (e.g., domestic violence situations).
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
▶ residency Residency State residency information for a household member. States must verify residency for most benefit programs. SNAP does not require a minimum residency period (7 CFR § 273.3).
isStateResident boolean Whether the member currently resides in the state.
stateResidencyDate string (date) Date the member established residency in the state. Used for programs with residency waiting periods.
▶ citizenship Citizenship Citizenship and immigration status for a household member. Determines whether immigration verification checks are required and which federal benefit waiting periods apply. Non-citizens face a 5-year bar for SNAP in most cases (8 U.S.C. § 1612) and Medicaid (42 CFR § 435.406).
citizenshipStatus enum The member's citizenship status. Determines whether immigration status checks are required via FDSH VLP or USCIS SAVE.
enumus_citizen us_national non_citizen
certificateNumber string U.S. certificate of citizenship or naturalization number. Present when citizenshipStatus is us_citizen and naturalized.
immigrantStatus enum Specific immigration status per 8 U.S.C. § 1641. Required when citizenshipStatus is non_citizen.
enumlawful_permanent_resident refugee asylee deportation_withheld parolee conditional_entrant cuban_haitian_entrant amerasian battered_non_citizen trafficking_victim temporary_protected_status other
uscisNumberOrI94 string USCIS alien registration number or I-94 admission number. Used for FDSH VLP verification.
document object Immigration document details. Present when citizenshipStatus is non_citizen.
type enum Type of immigration document. Determines which fields FDSH VLP requires.
enumi_551 i_766 i_94 i_327 i_571 foreign_passport machine_readable_immigrant_visa other
number string Document number (card number, I-94 number, etc.).
expirationDate string (date) Document expiration date.
countryOfIssuance string ISO 3166-1 alpha-2 country code of the issuing country.
residedInUsSince1996 boolean Whether the member has resided in the U.S. continuously since August 22, 1996. Relevant to the 5-year bar under PRWORA.
hasQualifyingMilitaryConnection boolean Whether the member or a spouse/parent served honorably in the U.S. military. Exempts from certain waiting periods.
sponsored object Sponsor deeming information. Present when the member entered the U.S. as a sponsored immigrant.
hasBeenAbandonedBySponsor boolean Whether the sponsor has abandoned the member. Exempts from sponsor deeming.
hasBeenMistreatedBySponsor boolean Whether the member has been subjected to battery or extreme cruelty by the sponsor or sponsor's household. Exempts from sponsor deeming under VAWA provisions.
qualifiesForSponsorDeemingException boolean Whether any other sponsor deeming exception applies (e.g., member is indigent).
receivesInKindSupport boolean Whether the sponsor is currently providing in-kind support to the member.
▶ retroactiveMedicalCoverage RetroactiveMedicalCoverage Retroactive Medicaid coverage request for a household member. Medicaid may cover medical expenses incurred up to 3 months before the application date if the member would have been eligible (42 CFR § 435.914).
isRequested boolean Whether the member is requesting retroactive Medicaid coverage.
periods array[object] Months for which retroactive coverage is requested, with household income for each.
month string required The month for which coverage is requested, in YYYY-MM format.
householdIncome number (float) Total household income for this month. Used to assess eligibility for the retroactive period.
▶ disability Disability Disability status for a household member. Affects SNAP medical expense deductions for elderly or disabled members (7 CFR § 273.9(d)(3)), TANF exemptions from work requirements, and Medicaid disability pathways.
isDisabled boolean Whether the member has a disability as defined by the applying program.
hasLongTermCondition boolean Whether the disability or health condition is expected to last 12 months or more.
hasPhysicalDisability boolean Whether the member has a physical disability.
hasMentalDisability boolean Whether the member has a mental health condition or intellectual disability.
needsHelpWithSelfCare boolean Whether the member needs assistance with activities of daily living.
▶ studentStatus StudentStatus Student enrollment information for a household member. Affects SNAP eligibility — most students enrolled at least half-time at an institution of higher education are ineligible unless they meet an exemption (7 CFR § 273.5).
enrollmentStatus enum Current enrollment status at an educational institution.
enumfull_time part_time not_enrolled
institutionType enum Type of educational institution attended.
enumhigher_education vocational other
schoolName string Name of the school or institution.
isParticipatingInWorkStudy boolean Whether the member is participating in a federal work-study program. Exempts from the SNAP student rule.
▶ pregnancy Pregnancy Pregnancy information for a household member. Affects household size calculations for some programs and Medicaid presumptive eligibility.
isPregnant boolean Whether the member is currently pregnant.
dueDate string (date) Expected due date.
numberOfBabiesExpected integer Number of babies expected. Used when calculating household size for programs that count unborn children.
▶ fosterCare FosterCare Foster care history for a household member. Young adults who aged out of foster care may qualify for Medicaid coverage up to age 26 regardless of income under the Fostering Connections Act (42 U.S.C. § 675a).
startDate string (date) Date the member entered foster care.
endDate string (date) Date the member exited foster care.
exitReason enum Reason the member exited foster care. aged_out is the primary qualifier for extended Medicaid.
enumadopted reunified aged_out emancipated
exitState string USPS postal abbreviation of the state from which the member exited foster care. Relevant for interstate Medicaid coordination.
receivedMedicaidAtAge18 boolean Whether the member was receiving Medicaid when they turned 18. Required for the Fostering Connections Medicaid pathway.
returnedAfterAdoption boolean Whether the member returned to foster care after an adoption that was subsequently dissolved.
returnDate string (date) Date the member returned to foster care after dissolved adoption.
▶ military Military Military service information for a household member. Veterans and their families may qualify for additional program pathways. Active duty affects household composition rules for some programs.
isVeteran boolean Whether the member has served in the U.S. armed forces and has been discharged.
isActiveDuty boolean Whether the member is currently on active duty.
dischargeStatus enum Character of discharge. Affects eligibility for VA benefits and some state programs.
enumhonorable general other_than_honorable bad_conduct dishonorable uncharacterized
▶ institutionalStatus InstitutionalStatus Institutional living status for a household member. Members residing in certain institutions are ineligible for SNAP (7 CFR § 273.1(b)) and may have modified Medicaid eligibility.
livesInInstitution boolean Whether the member currently resides in an institution.
facilityName string Name of the institution.
facilityType enum Type of institution. Determines which program exclusions and rules apply.
enumnursing_home hospital incarceration other
dateEntered string (date) Date the member entered the institution.
pendingDispositionOfCharges boolean Whether the member is a pre-trial detainee (charges pending). Affects SNAP and Medicaid eligibility differently than conviction.
mealsProvided boolean Whether the institution provides meals as part of the living arrangement.
▶ priorConvictions PriorConvictions Criminal history fields affecting program eligibility. Certain drug felony convictions and other offenses create disqualifications or require additional review under federal law.
isFleeingFelon boolean Whether the member is fleeing prosecution, custody, or confinement for a felony. Disqualifies from SNAP (7 CFR § 273.11(n)) and TANF (45 CFR § 261.55).
convictedOfDrugRelatedFelony boolean Whether the member has a state or federal drug-related felony conviction. States may apply a lifetime ban or modified rules under 21 U.S.C. § 862a.
convictedDuplicateSnapBenefits boolean Whether the member has been convicted of fraudulently obtaining SNAP benefits in multiple jurisdictions simultaneously (7 CFR § 273.11(c)).
convictedOfSnapTrafficking boolean Whether the member has been convicted of SNAP benefit trafficking. Permanent disqualification (7 CFR § 273.11(b)).
convictedTradingSnapForFirearmsOrExplosives boolean Whether the member has been convicted of trading SNAP benefits for firearms, ammunition, or explosives. Permanent disqualification (7 CFR § 273.11(b)).
convictedOfDisqualifyingViolentCrime boolean Whether the member has a conviction for a disqualifying violent crime under state law.
disqualifiedForIPV boolean Whether the member has been disqualified for an Intentional Program Violation (IPV) under 7 CFR § 273.16.
isViolatingProbationOrParole boolean Whether the member is in violation of a condition of probation or parole. Disqualifies from SNAP (7 CFR § 273.11(n)).
▶ tribalStatus TribalStatus Tribal membership and affiliation information. Members of federally recognized tribes may have access to tribal food programs that interact with SNAP eligibility. Some states provide additional benefits to tribal members.
isAmericanIndianOrAlaskaNative boolean Whether the member is a member of a federally recognized tribe or is an Alaska Native.
tribeName string Name of the federally recognized tribe.
tribeState string USPS postal abbreviation of the state where the tribe is headquartered.
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
personMatch anyOf read-only
▶ (one of)
▶ PersonMatch
matchStatus enum
enumconfirmed review_required no_match
candidates array[object] Match candidates. Populated for review_required; empty otherwise.
personId string (uuid) required The candidate person record ID.
confidenceScore number (float) required Match confidence score from 0 (no confidence) to 1 (certain).
▶ Variant
No additional fields
▶ programDeterminations array[ApplicationMemberProgramDetermination] read-only Per-program eligibility determination results, populated as decisions arrive from the eligibility domain.
program string required Program identifier (e.g., snap, medicaid, tanf).
outcome enum Determination outcome for this member/program combination.
enumapproved denied
determinedAt string (date-time) When the determination was recorded.
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ DELETE /applications/{applicationId}/members/{memberId} Remove a member

Remove a household member from this application.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

memberId string path ✓

Unique identifier of the application member.

Responses
204 Member removed successfully.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.

Household Info

Household-level data for an application (shelter costs, utilities, composition).

▶ GET /applications/{applicationId}/household-info Get household

Retrieve household-level data for this application.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Responses
200 Household data retrieved successfully.
▶ ApplicationHousehold
▶ roomers array[Roomer] Non-household members who share the living space and pay rent separately.
type enum required Whether the roomer is a household member counted in another capacity or a non-member contact.
enummember contact
id string (uuid) required Identifier of the member or contact record.
amountPaidForRent number (float) Amount the roomer pays for rent.
mealsIncludedWithRent boolean Whether meals are included with the roomer's rent payment.
utilitiesIncludedInRent boolean Whether utility costs are included in the rent payment.
isSubsidizedHousing boolean Whether the household lives in subsidized or public housing. Affects the SNAP utility standard deduction.
receivedTanfInAnotherState boolean Whether the household has received TANF benefits in another state. Required for multi-state TANF coordination.
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId}/household-info Update household

Apply partial updates to household data.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Request body required
▶ ApplicationHouseholdUpdate
▶ roomers array[Roomer] Non-household members who share the living space and pay rent separately.
type enum required Whether the roomer is a household member counted in another capacity or a non-member contact.
enummember contact
id string (uuid) required Identifier of the member or contact record.
amountPaidForRent number (float) Amount the roomer pays for rent.
mealsIncludedWithRent boolean Whether meals are included with the roomer's rent payment.
utilitiesIncludedInRent boolean Whether utility costs are included in the rent payment.
isSubsidizedHousing boolean Whether the household lives in subsidized or public housing. Affects the SNAP utility standard deduction.
receivedTanfInAnotherState boolean Whether the household has received TANF benefits in another state. Required for multi-state TANF coordination.
Responses
200 Household data updated successfully.
▶ ApplicationHousehold
▶ roomers array[Roomer] Non-household members who share the living space and pay rent separately.
type enum required Whether the roomer is a household member counted in another capacity or a non-member contact.
enummember contact
id string (uuid) required Identifier of the member or contact record.
amountPaidForRent number (float) Amount the roomer pays for rent.
mealsIncludedWithRent boolean Whether meals are included with the roomer's rent payment.
utilitiesIncludedInRent boolean Whether utility costs are included in the rent payment.
isSubsidizedHousing boolean Whether the household lives in subsidized or public housing. Affects the SNAP utility standard deduction.
receivedTanfInAnotherState boolean Whether the household has received TANF benefits in another state. Required for multi-state TANF coordination.
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.

Tax Filers

Tax filing status records for an application.

▶ GET /applications/{applicationId}/tax-filers List tax filers

Retrieve tax filer records for an application. Filter by memberId to scope to a single member.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
memberId string query

Filter records by the household member they belong to.

Responses
200 A paginated list of tax filer records.
▶ TaxFilerList
total integer required Total number of items available.
limit integer required Maximum number of items requested.
offset integer required Number of items skipped before the current page.
hasNext boolean Whether more items are available beyond the current page.
▶ items array[TaxFiler] required
filingJointlyWithSpouse boolean Whether the member files taxes jointly with a spouse.
▶ spouse PersonRef The spouse the member files with. Present when filingJointlyWithSpouse is true.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
claimingDependents boolean Whether the member claims any dependents on their tax return.
▶ dependents array[PersonRef] People the member claims as dependents on their tax return.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
expectedToBeClaimedByNonHouseholdMember boolean Whether the member expects to be claimed as a dependent by someone outside the household.
▶ personClaiming PersonRef A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
isNonCustodialParent boolean Whether the member is a non-custodial parent claiming a dependent child under a qualified court order.
hasDomesticViolenceTaxFilingException boolean Whether the member qualifies for the domestic violence exception to the tax-filer household composition rule.
id string (uuid) required read-only
memberId string (uuid) required The household member this tax filing record belongs to.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/tax-filers Add tax filer
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Request body required
▶ TaxFilerCreate
filingJointlyWithSpouse boolean Whether the member files taxes jointly with a spouse.
▶ spouse PersonRef The spouse the member files with. Present when filingJointlyWithSpouse is true.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
claimingDependents boolean Whether the member claims any dependents on their tax return.
▶ dependents array[PersonRef] People the member claims as dependents on their tax return.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
expectedToBeClaimedByNonHouseholdMember boolean Whether the member expects to be claimed as a dependent by someone outside the household.
▶ personClaiming PersonRef A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
isNonCustodialParent boolean Whether the member is a non-custodial parent claiming a dependent child under a qualified court order.
hasDomesticViolenceTaxFilingException boolean Whether the member qualifies for the domestic violence exception to the tax-filer household composition rule.
id string (uuid) The new record's id, a UUID (RFC 9562).
memberId string (uuid) required The household member this tax filing record belongs to.
Responses
201 Tax filer record created.
▶ TaxFiler
filingJointlyWithSpouse boolean Whether the member files taxes jointly with a spouse.
▶ spouse PersonRef The spouse the member files with. Present when filingJointlyWithSpouse is true.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
claimingDependents boolean Whether the member claims any dependents on their tax return.
▶ dependents array[PersonRef] People the member claims as dependents on their tax return.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
expectedToBeClaimedByNonHouseholdMember boolean Whether the member expects to be claimed as a dependent by someone outside the household.
▶ personClaiming PersonRef A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
isNonCustodialParent boolean Whether the member is a non-custodial parent claiming a dependent child under a qualified court order.
hasDomesticViolenceTaxFilingException boolean Whether the member qualifies for the domestic violence exception to the tax-filer household composition rule.
id string (uuid) required read-only
memberId string (uuid) required The household member this tax filing record belongs to.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/tax-filers/{taxFilerId} Get tax filer
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

taxFilerId string path ✓

Unique identifier of the tax filer record.

Responses
200 Tax filer record retrieved.
▶ TaxFiler
filingJointlyWithSpouse boolean Whether the member files taxes jointly with a spouse.
▶ spouse PersonRef The spouse the member files with. Present when filingJointlyWithSpouse is true.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
claimingDependents boolean Whether the member claims any dependents on their tax return.
▶ dependents array[PersonRef] People the member claims as dependents on their tax return.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
expectedToBeClaimedByNonHouseholdMember boolean Whether the member expects to be claimed as a dependent by someone outside the household.
▶ personClaiming PersonRef A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
isNonCustodialParent boolean Whether the member is a non-custodial parent claiming a dependent child under a qualified court order.
hasDomesticViolenceTaxFilingException boolean Whether the member qualifies for the domestic violence exception to the tax-filer household composition rule.
id string (uuid) required read-only
memberId string (uuid) required The household member this tax filing record belongs to.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId}/tax-filers/{taxFilerId} Update tax filer
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

taxFilerId string path ✓

Unique identifier of the tax filer record.

Request body required
▶ TaxFilerUpdate
filingJointlyWithSpouse boolean Whether the member files taxes jointly with a spouse.
▶ spouse PersonRef The spouse the member files with. Present when filingJointlyWithSpouse is true.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
claimingDependents boolean Whether the member claims any dependents on their tax return.
▶ dependents array[PersonRef] People the member claims as dependents on their tax return.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
expectedToBeClaimedByNonHouseholdMember boolean Whether the member expects to be claimed as a dependent by someone outside the household.
▶ personClaiming PersonRef A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
isNonCustodialParent boolean Whether the member is a non-custodial parent claiming a dependent child under a qualified court order.
hasDomesticViolenceTaxFilingException boolean Whether the member qualifies for the domestic violence exception to the tax-filer household composition rule.
Responses
200 Tax filer record updated.
▶ TaxFiler
filingJointlyWithSpouse boolean Whether the member files taxes jointly with a spouse.
▶ spouse PersonRef The spouse the member files with. Present when filingJointlyWithSpouse is true.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
claimingDependents boolean Whether the member claims any dependents on their tax return.
▶ dependents array[PersonRef] People the member claims as dependents on their tax return.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
expectedToBeClaimedByNonHouseholdMember boolean Whether the member expects to be claimed as a dependent by someone outside the household.
▶ personClaiming PersonRef A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
isNonCustodialParent boolean Whether the member is a non-custodial parent claiming a dependent child under a qualified court order.
hasDomesticViolenceTaxFilingException boolean Whether the member qualifies for the domestic violence exception to the tax-filer household composition rule.
id string (uuid) required read-only
memberId string (uuid) required The household member this tax filing record belongs to.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ DELETE /applications/{applicationId}/tax-filers/{taxFilerId} Delete tax filer
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

taxFilerId string path ✓

Unique identifier of the tax filer record.

Responses
204 Tax filer record deleted.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.

Health Plans

Health coverage plan records for an application.

▶ GET /applications/{applicationId}/health-plans List health plans

Retrieve health plan records for an application.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
Responses
200 A paginated list of health plan records.
▶ HealthPlanList
total integer required Total number of items available.
limit integer required Maximum number of items requested.
offset integer required Number of items skipped before the current page.
hasNext boolean Whether more items are available beyond the current page.
▶ items array[HealthPlan] required
▶ (one of) HealthPlan
▶ EmployerOrCobraHealthPlan
type enum Type of health coverage. employer_sponsored and marketplace affect Medicaid eligibility under the ACA affordability test (45 CFR § 155.305(f)). medicare and chip indicate current public program enrollment. tricare and va indicate military and veterans coverage.
enumemployer_sponsored cobra medicare tricare va marketplace peace_corps chip medicaid tribal_health_services other_federal other
typeOther string Free-text description when type is other.
premiumAmount number (float) Total premium amount for this plan.
premiumFrequency enum How often the premium is paid.
enumweekly every_two_weeks twice_monthly monthly yearly
type enum
enumemployer_sponsored cobra
organizationId string (uuid) The employer organization offering this plan.
coverageContact object Legal name of a person.
firstName string required First name.
middleName string Middle name.
middleInitial string Middle initial.
lastName string required Last name.
maidenName string Maiden name if applicable.
suffix string Name suffix such as Jr., Sr., III, etc.
hasMinimumValuePlan boolean Whether the employer plan meets ACA minimum value standards (60% actuarial value). Affects the Medicaid affordability test (45 CFR § 155.305(f)).
lowestCostPlanName string Name of the lowest-cost self-only plan available to the member through this employer.
lowestCostPlanPremium number (float) Employee-share premium for the lowest-cost self-only plan available to the member.
▶ MedicareHealthPlan
type enum Type of health coverage. employer_sponsored and marketplace affect Medicaid eligibility under the ACA affordability test (45 CFR § 155.305(f)). medicare and chip indicate current public program enrollment. tricare and va indicate military and veterans coverage.
enumemployer_sponsored cobra medicare tricare va marketplace peace_corps chip medicaid tribal_health_services other_federal other
typeOther string Free-text description when type is other.
premiumAmount number (float) Total premium amount for this plan.
premiumFrequency enum How often the premium is paid.
enumweekly every_two_weeks twice_monthly monthly yearly
type enum
enummedicare
medicareId string Medicare Beneficiary Identifier (MBI).
partA object Medicare Part A (hospital insurance) details.
status enum Whether the member is entitled to or actively enrolled in this part.
enumentitled enrolled
startDate string (date) Date coverage under this part began.
isPremiumFree boolean Whether Part A is premium-free based on the member's or spouse's work history. Applies to Part A only.
premiumAmount number (float) Monthly premium for this part. Primarily applicable to Part B.
premiumPaidBy enum Who pays the premium for this part.
enumself state employer other
partB object Medicare Part B (medical insurance) details.
status enum Whether the member is entitled to or actively enrolled in this part.
enumentitled enrolled
startDate string (date) Date coverage under this part began.
isPremiumFree boolean Whether Part A is premium-free based on the member's or spouse's work history. Applies to Part A only.
premiumAmount number (float) Monthly premium for this part. Primarily applicable to Part B.
premiumPaidBy enum Who pays the premium for this part.
enumself state employer other
partC object Medicare Part C (Medicare Advantage) details.
status enum Current enrollment status for this Part C plan.
enumentitled enrolled
startDate string (date) Date coverage under this plan began.
contractId string CMS contract ID for the Medicare Advantage organization.
planId string Plan ID within the contract.
planName string Name of the Medicare Advantage plan.
premiumAmount number (float) Monthly premium for this plan.
premiumPaidBy enum Who pays the premium for this plan.
enumself state employer other
partD object Medicare Part D (prescription drug) details.
status enum Current enrollment status for Part D.
enumentitled enrolled
startDate string (date) Date Part D coverage began.
planName string Name of the Part D plan.
premiumAmount number (float) Monthly premium for this plan.
premiumPaidBy enum Who pays the Part D premium.
enumself state employer other
▶ TricareHealthPlan
type enum Type of health coverage. employer_sponsored and marketplace affect Medicaid eligibility under the ACA affordability test (45 CFR § 155.305(f)). medicare and chip indicate current public program enrollment. tricare and va indicate military and veterans coverage.
enumemployer_sponsored cobra medicare tricare va marketplace peace_corps chip medicaid tribal_health_services other_federal other
typeOther string Free-text description when type is other.
premiumAmount number (float) Total premium amount for this plan.
premiumFrequency enum How often the premium is paid.
enumweekly every_two_weeks twice_monthly monthly yearly
type enum
enumtricare
programType string TRICARE program variant (e.g., TRICARE Prime, TRICARE Select).
insuranceCompanyName string Insurance carrier name.
policyNumber string Policy or member ID number.
▶ OtherHealthPlan
type enum Type of health coverage. employer_sponsored and marketplace affect Medicaid eligibility under the ACA affordability test (45 CFR § 155.305(f)). medicare and chip indicate current public program enrollment. tricare and va indicate military and veterans coverage.
enumemployer_sponsored cobra medicare tricare va marketplace peace_corps chip medicaid tribal_health_services other_federal other
typeOther string Free-text description when type is other.
premiumAmount number (float) Total premium amount for this plan.
premiumFrequency enum How often the premium is paid.
enumweekly every_two_weeks twice_monthly monthly yearly
type enum
enumva marketplace peace_corps chip medicaid tribal_health_services other_federal other
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/health-plans Add health plan
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Request body required
▶ HealthPlanCreate
▶ (one of) HealthPlan
▶ EmployerOrCobraHealthPlan
type enum Type of health coverage. employer_sponsored and marketplace affect Medicaid eligibility under the ACA affordability test (45 CFR § 155.305(f)). medicare and chip indicate current public program enrollment. tricare and va indicate military and veterans coverage.
enumemployer_sponsored cobra medicare tricare va marketplace peace_corps chip medicaid tribal_health_services other_federal other
typeOther string Free-text description when type is other.
premiumAmount number (float) Total premium amount for this plan.
premiumFrequency enum How often the premium is paid.
enumweekly every_two_weeks twice_monthly monthly yearly
type enum
enumemployer_sponsored cobra
organizationId string (uuid) The employer organization offering this plan.
coverageContact object Legal name of a person.
firstName string required First name.
middleName string Middle name.
middleInitial string Middle initial.
lastName string required Last name.
maidenName string Maiden name if applicable.
suffix string Name suffix such as Jr., Sr., III, etc.
hasMinimumValuePlan boolean Whether the employer plan meets ACA minimum value standards (60% actuarial value). Affects the Medicaid affordability test (45 CFR § 155.305(f)).
lowestCostPlanName string Name of the lowest-cost self-only plan available to the member through this employer.
lowestCostPlanPremium number (float) Employee-share premium for the lowest-cost self-only plan available to the member.
▶ MedicareHealthPlan
type enum Type of health coverage. employer_sponsored and marketplace affect Medicaid eligibility under the ACA affordability test (45 CFR § 155.305(f)). medicare and chip indicate current public program enrollment. tricare and va indicate military and veterans coverage.
enumemployer_sponsored cobra medicare tricare va marketplace peace_corps chip medicaid tribal_health_services other_federal other
typeOther string Free-text description when type is other.
premiumAmount number (float) Total premium amount for this plan.
premiumFrequency enum How often the premium is paid.
enumweekly every_two_weeks twice_monthly monthly yearly
type enum
enummedicare
medicareId string Medicare Beneficiary Identifier (MBI).
partA object Medicare Part A (hospital insurance) details.
status enum Whether the member is entitled to or actively enrolled in this part.
enumentitled enrolled
startDate string (date) Date coverage under this part began.
isPremiumFree boolean Whether Part A is premium-free based on the member's or spouse's work history. Applies to Part A only.
premiumAmount number (float) Monthly premium for this part. Primarily applicable to Part B.
premiumPaidBy enum Who pays the premium for this part.
enumself state employer other
partB object Medicare Part B (medical insurance) details.
status enum Whether the member is entitled to or actively enrolled in this part.
enumentitled enrolled
startDate string (date) Date coverage under this part began.
isPremiumFree boolean Whether Part A is premium-free based on the member's or spouse's work history. Applies to Part A only.
premiumAmount number (float) Monthly premium for this part. Primarily applicable to Part B.
premiumPaidBy enum Who pays the premium for this part.
enumself state employer other
partC object Medicare Part C (Medicare Advantage) details.
status enum Current enrollment status for this Part C plan.
enumentitled enrolled
startDate string (date) Date coverage under this plan began.
contractId string CMS contract ID for the Medicare Advantage organization.
planId string Plan ID within the contract.
planName string Name of the Medicare Advantage plan.
premiumAmount number (float) Monthly premium for this plan.
premiumPaidBy enum Who pays the premium for this plan.
enumself state employer other
partD object Medicare Part D (prescription drug) details.
status enum Current enrollment status for Part D.
enumentitled enrolled
startDate string (date) Date Part D coverage began.
planName string Name of the Part D plan.
premiumAmount number (float) Monthly premium for this plan.
premiumPaidBy enum Who pays the Part D premium.
enumself state employer other
▶ TricareHealthPlan
type enum Type of health coverage. employer_sponsored and marketplace affect Medicaid eligibility under the ACA affordability test (45 CFR § 155.305(f)). medicare and chip indicate current public program enrollment. tricare and va indicate military and veterans coverage.
enumemployer_sponsored cobra medicare tricare va marketplace peace_corps chip medicaid tribal_health_services other_federal other
typeOther string Free-text description when type is other.
premiumAmount number (float) Total premium amount for this plan.
premiumFrequency enum How often the premium is paid.
enumweekly every_two_weeks twice_monthly monthly yearly
type enum
enumtricare
programType string TRICARE program variant (e.g., TRICARE Prime, TRICARE Select).
insuranceCompanyName string Insurance carrier name.
policyNumber string Policy or member ID number.
▶ OtherHealthPlan
type enum Type of health coverage. employer_sponsored and marketplace affect Medicaid eligibility under the ACA affordability test (45 CFR § 155.305(f)). medicare and chip indicate current public program enrollment. tricare and va indicate military and veterans coverage.
enumemployer_sponsored cobra medicare tricare va marketplace peace_corps chip medicaid tribal_health_services other_federal other
typeOther string Free-text description when type is other.
premiumAmount number (float) Total premium amount for this plan.
premiumFrequency enum How often the premium is paid.
enumweekly every_two_weeks twice_monthly monthly yearly
type enum
enumva marketplace peace_corps chip medicaid tribal_health_services other_federal other
id string (uuid) The new record's id, a UUID (RFC 9562).
Responses
201 Health plan record created.
▶ HealthPlan
▶ (one of) HealthPlan
▶ EmployerOrCobraHealthPlan
type enum Type of health coverage. employer_sponsored and marketplace affect Medicaid eligibility under the ACA affordability test (45 CFR § 155.305(f)). medicare and chip indicate current public program enrollment. tricare and va indicate military and veterans coverage.
enumemployer_sponsored cobra medicare tricare va marketplace peace_corps chip medicaid tribal_health_services other_federal other
typeOther string Free-text description when type is other.
premiumAmount number (float) Total premium amount for this plan.
premiumFrequency enum How often the premium is paid.
enumweekly every_two_weeks twice_monthly monthly yearly
type enum
enumemployer_sponsored cobra
organizationId string (uuid) The employer organization offering this plan.
coverageContact object Legal name of a person.
firstName string required First name.
middleName string Middle name.
middleInitial string Middle initial.
lastName string required Last name.
maidenName string Maiden name if applicable.
suffix string Name suffix such as Jr., Sr., III, etc.
hasMinimumValuePlan boolean Whether the employer plan meets ACA minimum value standards (60% actuarial value). Affects the Medicaid affordability test (45 CFR § 155.305(f)).
lowestCostPlanName string Name of the lowest-cost self-only plan available to the member through this employer.
lowestCostPlanPremium number (float) Employee-share premium for the lowest-cost self-only plan available to the member.
▶ MedicareHealthPlan
type enum Type of health coverage. employer_sponsored and marketplace affect Medicaid eligibility under the ACA affordability test (45 CFR § 155.305(f)). medicare and chip indicate current public program enrollment. tricare and va indicate military and veterans coverage.
enumemployer_sponsored cobra medicare tricare va marketplace peace_corps chip medicaid tribal_health_services other_federal other
typeOther string Free-text description when type is other.
premiumAmount number (float) Total premium amount for this plan.
premiumFrequency enum How often the premium is paid.
enumweekly every_two_weeks twice_monthly monthly yearly
type enum
enummedicare
medicareId string Medicare Beneficiary Identifier (MBI).
partA object Medicare Part A (hospital insurance) details.
status enum Whether the member is entitled to or actively enrolled in this part.
enumentitled enrolled
startDate string (date) Date coverage under this part began.
isPremiumFree boolean Whether Part A is premium-free based on the member's or spouse's work history. Applies to Part A only.
premiumAmount number (float) Monthly premium for this part. Primarily applicable to Part B.
premiumPaidBy enum Who pays the premium for this part.
enumself state employer other
partB object Medicare Part B (medical insurance) details.
status enum Whether the member is entitled to or actively enrolled in this part.
enumentitled enrolled
startDate string (date) Date coverage under this part began.
isPremiumFree boolean Whether Part A is premium-free based on the member's or spouse's work history. Applies to Part A only.
premiumAmount number (float) Monthly premium for this part. Primarily applicable to Part B.
premiumPaidBy enum Who pays the premium for this part.
enumself state employer other
partC object Medicare Part C (Medicare Advantage) details.
status enum Current enrollment status for this Part C plan.
enumentitled enrolled
startDate string (date) Date coverage under this plan began.
contractId string CMS contract ID for the Medicare Advantage organization.
planId string Plan ID within the contract.
planName string Name of the Medicare Advantage plan.
premiumAmount number (float) Monthly premium for this plan.
premiumPaidBy enum Who pays the premium for this plan.
enumself state employer other
partD object Medicare Part D (prescription drug) details.
status enum Current enrollment status for Part D.
enumentitled enrolled
startDate string (date) Date Part D coverage began.
planName string Name of the Part D plan.
premiumAmount number (float) Monthly premium for this plan.
premiumPaidBy enum Who pays the Part D premium.
enumself state employer other
▶ TricareHealthPlan
type enum Type of health coverage. employer_sponsored and marketplace affect Medicaid eligibility under the ACA affordability test (45 CFR § 155.305(f)). medicare and chip indicate current public program enrollment. tricare and va indicate military and veterans coverage.
enumemployer_sponsored cobra medicare tricare va marketplace peace_corps chip medicaid tribal_health_services other_federal other
typeOther string Free-text description when type is other.
premiumAmount number (float) Total premium amount for this plan.
premiumFrequency enum How often the premium is paid.
enumweekly every_two_weeks twice_monthly monthly yearly
type enum
enumtricare
programType string TRICARE program variant (e.g., TRICARE Prime, TRICARE Select).
insuranceCompanyName string Insurance carrier name.
policyNumber string Policy or member ID number.
▶ OtherHealthPlan
type enum Type of health coverage. employer_sponsored and marketplace affect Medicaid eligibility under the ACA affordability test (45 CFR § 155.305(f)). medicare and chip indicate current public program enrollment. tricare and va indicate military and veterans coverage.
enumemployer_sponsored cobra medicare tricare va marketplace peace_corps chip medicaid tribal_health_services other_federal other
typeOther string Free-text description when type is other.
premiumAmount number (float) Total premium amount for this plan.
premiumFrequency enum How often the premium is paid.
enumweekly every_two_weeks twice_monthly monthly yearly
type enum
enumva marketplace peace_corps chip medicaid tribal_health_services other_federal other
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/health-plans/{healthPlanId} Get health plan
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

healthPlanId string path ✓

Unique identifier of the health plan record.

Responses
200 Health plan record retrieved.
▶ HealthPlan
▶ (one of) HealthPlan
▶ EmployerOrCobraHealthPlan
type enum Type of health coverage. employer_sponsored and marketplace affect Medicaid eligibility under the ACA affordability test (45 CFR § 155.305(f)). medicare and chip indicate current public program enrollment. tricare and va indicate military and veterans coverage.
enumemployer_sponsored cobra medicare tricare va marketplace peace_corps chip medicaid tribal_health_services other_federal other
typeOther string Free-text description when type is other.
premiumAmount number (float) Total premium amount for this plan.
premiumFrequency enum How often the premium is paid.
enumweekly every_two_weeks twice_monthly monthly yearly
type enum
enumemployer_sponsored cobra
organizationId string (uuid) The employer organization offering this plan.
coverageContact object Legal name of a person.
firstName string required First name.
middleName string Middle name.
middleInitial string Middle initial.
lastName string required Last name.
maidenName string Maiden name if applicable.
suffix string Name suffix such as Jr., Sr., III, etc.
hasMinimumValuePlan boolean Whether the employer plan meets ACA minimum value standards (60% actuarial value). Affects the Medicaid affordability test (45 CFR § 155.305(f)).
lowestCostPlanName string Name of the lowest-cost self-only plan available to the member through this employer.
lowestCostPlanPremium number (float) Employee-share premium for the lowest-cost self-only plan available to the member.
▶ MedicareHealthPlan
type enum Type of health coverage. employer_sponsored and marketplace affect Medicaid eligibility under the ACA affordability test (45 CFR § 155.305(f)). medicare and chip indicate current public program enrollment. tricare and va indicate military and veterans coverage.
enumemployer_sponsored cobra medicare tricare va marketplace peace_corps chip medicaid tribal_health_services other_federal other
typeOther string Free-text description when type is other.
premiumAmount number (float) Total premium amount for this plan.
premiumFrequency enum How often the premium is paid.
enumweekly every_two_weeks twice_monthly monthly yearly
type enum
enummedicare
medicareId string Medicare Beneficiary Identifier (MBI).
partA object Medicare Part A (hospital insurance) details.
status enum Whether the member is entitled to or actively enrolled in this part.
enumentitled enrolled
startDate string (date) Date coverage under this part began.
isPremiumFree boolean Whether Part A is premium-free based on the member's or spouse's work history. Applies to Part A only.
premiumAmount number (float) Monthly premium for this part. Primarily applicable to Part B.
premiumPaidBy enum Who pays the premium for this part.
enumself state employer other
partB object Medicare Part B (medical insurance) details.
status enum Whether the member is entitled to or actively enrolled in this part.
enumentitled enrolled
startDate string (date) Date coverage under this part began.
isPremiumFree boolean Whether Part A is premium-free based on the member's or spouse's work history. Applies to Part A only.
premiumAmount number (float) Monthly premium for this part. Primarily applicable to Part B.
premiumPaidBy enum Who pays the premium for this part.
enumself state employer other
partC object Medicare Part C (Medicare Advantage) details.
status enum Current enrollment status for this Part C plan.
enumentitled enrolled
startDate string (date) Date coverage under this plan began.
contractId string CMS contract ID for the Medicare Advantage organization.
planId string Plan ID within the contract.
planName string Name of the Medicare Advantage plan.
premiumAmount number (float) Monthly premium for this plan.
premiumPaidBy enum Who pays the premium for this plan.
enumself state employer other
partD object Medicare Part D (prescription drug) details.
status enum Current enrollment status for Part D.
enumentitled enrolled
startDate string (date) Date Part D coverage began.
planName string Name of the Part D plan.
premiumAmount number (float) Monthly premium for this plan.
premiumPaidBy enum Who pays the Part D premium.
enumself state employer other
▶ TricareHealthPlan
type enum Type of health coverage. employer_sponsored and marketplace affect Medicaid eligibility under the ACA affordability test (45 CFR § 155.305(f)). medicare and chip indicate current public program enrollment. tricare and va indicate military and veterans coverage.
enumemployer_sponsored cobra medicare tricare va marketplace peace_corps chip medicaid tribal_health_services other_federal other
typeOther string Free-text description when type is other.
premiumAmount number (float) Total premium amount for this plan.
premiumFrequency enum How often the premium is paid.
enumweekly every_two_weeks twice_monthly monthly yearly
type enum
enumtricare
programType string TRICARE program variant (e.g., TRICARE Prime, TRICARE Select).
insuranceCompanyName string Insurance carrier name.
policyNumber string Policy or member ID number.
▶ OtherHealthPlan
type enum Type of health coverage. employer_sponsored and marketplace affect Medicaid eligibility under the ACA affordability test (45 CFR § 155.305(f)). medicare and chip indicate current public program enrollment. tricare and va indicate military and veterans coverage.
enumemployer_sponsored cobra medicare tricare va marketplace peace_corps chip medicaid tribal_health_services other_federal other
typeOther string Free-text description when type is other.
premiumAmount number (float) Total premium amount for this plan.
premiumFrequency enum How often the premium is paid.
enumweekly every_two_weeks twice_monthly monthly yearly
type enum
enumva marketplace peace_corps chip medicaid tribal_health_services other_federal other
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId}/health-plans/{healthPlanId} Update health plan
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

healthPlanId string path ✓

Unique identifier of the health plan record.

Request body required
▶ HealthPlanUpdate
▶ type HealthPlanType Type of health coverage. employer_sponsored and marketplace affect Medicaid eligibility under the ACA affordability test (45 CFR § 155.305(f)). medicare and chip indicate current public program enrollment. tricare and va indicate military and veterans coverage.
No additional fields
typeOther string Free-text description when type is other.
premiumAmount number (float) Total premium amount for this plan.
▶ premiumFrequency PremiumFrequency How often the premium is paid.
No additional fields
Responses
200 Health plan record updated.
▶ HealthPlan
▶ (one of) HealthPlan
▶ EmployerOrCobraHealthPlan
type enum Type of health coverage. employer_sponsored and marketplace affect Medicaid eligibility under the ACA affordability test (45 CFR § 155.305(f)). medicare and chip indicate current public program enrollment. tricare and va indicate military and veterans coverage.
enumemployer_sponsored cobra medicare tricare va marketplace peace_corps chip medicaid tribal_health_services other_federal other
typeOther string Free-text description when type is other.
premiumAmount number (float) Total premium amount for this plan.
premiumFrequency enum How often the premium is paid.
enumweekly every_two_weeks twice_monthly monthly yearly
type enum
enumemployer_sponsored cobra
organizationId string (uuid) The employer organization offering this plan.
coverageContact object Legal name of a person.
firstName string required First name.
middleName string Middle name.
middleInitial string Middle initial.
lastName string required Last name.
maidenName string Maiden name if applicable.
suffix string Name suffix such as Jr., Sr., III, etc.
hasMinimumValuePlan boolean Whether the employer plan meets ACA minimum value standards (60% actuarial value). Affects the Medicaid affordability test (45 CFR § 155.305(f)).
lowestCostPlanName string Name of the lowest-cost self-only plan available to the member through this employer.
lowestCostPlanPremium number (float) Employee-share premium for the lowest-cost self-only plan available to the member.
▶ MedicareHealthPlan
type enum Type of health coverage. employer_sponsored and marketplace affect Medicaid eligibility under the ACA affordability test (45 CFR § 155.305(f)). medicare and chip indicate current public program enrollment. tricare and va indicate military and veterans coverage.
enumemployer_sponsored cobra medicare tricare va marketplace peace_corps chip medicaid tribal_health_services other_federal other
typeOther string Free-text description when type is other.
premiumAmount number (float) Total premium amount for this plan.
premiumFrequency enum How often the premium is paid.
enumweekly every_two_weeks twice_monthly monthly yearly
type enum
enummedicare
medicareId string Medicare Beneficiary Identifier (MBI).
partA object Medicare Part A (hospital insurance) details.
status enum Whether the member is entitled to or actively enrolled in this part.
enumentitled enrolled
startDate string (date) Date coverage under this part began.
isPremiumFree boolean Whether Part A is premium-free based on the member's or spouse's work history. Applies to Part A only.
premiumAmount number (float) Monthly premium for this part. Primarily applicable to Part B.
premiumPaidBy enum Who pays the premium for this part.
enumself state employer other
partB object Medicare Part B (medical insurance) details.
status enum Whether the member is entitled to or actively enrolled in this part.
enumentitled enrolled
startDate string (date) Date coverage under this part began.
isPremiumFree boolean Whether Part A is premium-free based on the member's or spouse's work history. Applies to Part A only.
premiumAmount number (float) Monthly premium for this part. Primarily applicable to Part B.
premiumPaidBy enum Who pays the premium for this part.
enumself state employer other
partC object Medicare Part C (Medicare Advantage) details.
status enum Current enrollment status for this Part C plan.
enumentitled enrolled
startDate string (date) Date coverage under this plan began.
contractId string CMS contract ID for the Medicare Advantage organization.
planId string Plan ID within the contract.
planName string Name of the Medicare Advantage plan.
premiumAmount number (float) Monthly premium for this plan.
premiumPaidBy enum Who pays the premium for this plan.
enumself state employer other
partD object Medicare Part D (prescription drug) details.
status enum Current enrollment status for Part D.
enumentitled enrolled
startDate string (date) Date Part D coverage began.
planName string Name of the Part D plan.
premiumAmount number (float) Monthly premium for this plan.
premiumPaidBy enum Who pays the Part D premium.
enumself state employer other
▶ TricareHealthPlan
type enum Type of health coverage. employer_sponsored and marketplace affect Medicaid eligibility under the ACA affordability test (45 CFR § 155.305(f)). medicare and chip indicate current public program enrollment. tricare and va indicate military and veterans coverage.
enumemployer_sponsored cobra medicare tricare va marketplace peace_corps chip medicaid tribal_health_services other_federal other
typeOther string Free-text description when type is other.
premiumAmount number (float) Total premium amount for this plan.
premiumFrequency enum How often the premium is paid.
enumweekly every_two_weeks twice_monthly monthly yearly
type enum
enumtricare
programType string TRICARE program variant (e.g., TRICARE Prime, TRICARE Select).
insuranceCompanyName string Insurance carrier name.
policyNumber string Policy or member ID number.
▶ OtherHealthPlan
type enum Type of health coverage. employer_sponsored and marketplace affect Medicaid eligibility under the ACA affordability test (45 CFR § 155.305(f)). medicare and chip indicate current public program enrollment. tricare and va indicate military and veterans coverage.
enumemployer_sponsored cobra medicare tricare va marketplace peace_corps chip medicaid tribal_health_services other_federal other
typeOther string Free-text description when type is other.
premiumAmount number (float) Total premium amount for this plan.
premiumFrequency enum How often the premium is paid.
enumweekly every_two_weeks twice_monthly monthly yearly
type enum
enumva marketplace peace_corps chip medicaid tribal_health_services other_federal other
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ DELETE /applications/{applicationId}/health-plans/{healthPlanId} Delete health plan
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

healthPlanId string path ✓

Unique identifier of the health plan record.

Responses
204 Health plan record deleted.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.

Health Enrollments

Member enrollment records linking household members to health plans.

▶ GET /applications/{applicationId}/health-enrollments List health enrollments

Retrieve health enrollment records for an application. Filter by memberId to scope to a single member.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
memberId string query

Filter records by the household member they belong to.

Responses
200 A paginated list of health enrollment records.
▶ HealthEnrollmentList
total integer required Total number of items available.
limit integer required Maximum number of items requested.
offset integer required Number of items skipped before the current page.
hasNext boolean Whether more items are available beyond the current page.
▶ items array[HealthEnrollment] required
healthPlanId string (uuid) The health plan this enrollment is for.
jobId string (uuid) The job through which this employer-sponsored coverage is offered. Present when the plan is employer_sponsored or cobra.
role enum required Whether the member is the primary subscriber (policyholder) or a dependent on another member's plan.
enumsubscriber dependent
startDate string (date) Date this member's coverage under the plan began.
endDate string (date) Date this member's coverage under the plan ended or is expected to end.
eligibleDate string (date) Date the member first became eligible for this plan.
enrollmentStatus enum Current enrollment status for this member in this plan.
enumeligible enrolled pending ended
prefersSeparateMailing boolean Whether the member prefers to receive plan notices at a different address than their primary mailing address.
▶ sponsor PersonRef A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
id string (uuid) required read-only
memberId string (uuid) required The household member enrolled in this plan.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/health-enrollments Add health enrollment
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Request body required
▶ HealthEnrollmentCreate
healthPlanId string (uuid) The health plan this enrollment is for.
jobId string (uuid) The job through which this employer-sponsored coverage is offered. Present when the plan is employer_sponsored or cobra.
role enum required Whether the member is the primary subscriber (policyholder) or a dependent on another member's plan.
enumsubscriber dependent
startDate string (date) Date this member's coverage under the plan began.
endDate string (date) Date this member's coverage under the plan ended or is expected to end.
eligibleDate string (date) Date the member first became eligible for this plan.
enrollmentStatus enum Current enrollment status for this member in this plan.
enumeligible enrolled pending ended
prefersSeparateMailing boolean Whether the member prefers to receive plan notices at a different address than their primary mailing address.
▶ sponsor PersonRef A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
id string (uuid) The new record's id, a UUID (RFC 9562).
memberId string (uuid) required The household member to enroll in this plan.
Responses
201 Health enrollment record created.
▶ HealthEnrollment
healthPlanId string (uuid) The health plan this enrollment is for.
jobId string (uuid) The job through which this employer-sponsored coverage is offered. Present when the plan is employer_sponsored or cobra.
role enum required Whether the member is the primary subscriber (policyholder) or a dependent on another member's plan.
enumsubscriber dependent
startDate string (date) Date this member's coverage under the plan began.
endDate string (date) Date this member's coverage under the plan ended or is expected to end.
eligibleDate string (date) Date the member first became eligible for this plan.
enrollmentStatus enum Current enrollment status for this member in this plan.
enumeligible enrolled pending ended
prefersSeparateMailing boolean Whether the member prefers to receive plan notices at a different address than their primary mailing address.
▶ sponsor PersonRef A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
id string (uuid) required read-only
memberId string (uuid) required The household member enrolled in this plan.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/health-enrollments/{healthEnrollmentId} Get health enrollment
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

healthEnrollmentId string path ✓

Unique identifier of the health enrollment record.

Responses
200 Health enrollment record retrieved.
▶ HealthEnrollment
healthPlanId string (uuid) The health plan this enrollment is for.
jobId string (uuid) The job through which this employer-sponsored coverage is offered. Present when the plan is employer_sponsored or cobra.
role enum required Whether the member is the primary subscriber (policyholder) or a dependent on another member's plan.
enumsubscriber dependent
startDate string (date) Date this member's coverage under the plan began.
endDate string (date) Date this member's coverage under the plan ended or is expected to end.
eligibleDate string (date) Date the member first became eligible for this plan.
enrollmentStatus enum Current enrollment status for this member in this plan.
enumeligible enrolled pending ended
prefersSeparateMailing boolean Whether the member prefers to receive plan notices at a different address than their primary mailing address.
▶ sponsor PersonRef A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
id string (uuid) required read-only
memberId string (uuid) required The household member enrolled in this plan.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId}/health-enrollments/{healthEnrollmentId} Update health enrollment
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

healthEnrollmentId string path ✓

Unique identifier of the health enrollment record.

Request body required
▶ HealthEnrollmentUpdate
healthPlanId string (uuid) The health plan this enrollment is for.
jobId string (uuid) The job through which this employer-sponsored coverage is offered. Present when the plan is employer_sponsored or cobra.
role enum required Whether the member is the primary subscriber (policyholder) or a dependent on another member's plan.
enumsubscriber dependent
startDate string (date) Date this member's coverage under the plan began.
endDate string (date) Date this member's coverage under the plan ended or is expected to end.
eligibleDate string (date) Date the member first became eligible for this plan.
enrollmentStatus enum Current enrollment status for this member in this plan.
enumeligible enrolled pending ended
prefersSeparateMailing boolean Whether the member prefers to receive plan notices at a different address than their primary mailing address.
▶ sponsor PersonRef A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
Responses
200 Health enrollment record updated.
▶ HealthEnrollment
healthPlanId string (uuid) The health plan this enrollment is for.
jobId string (uuid) The job through which this employer-sponsored coverage is offered. Present when the plan is employer_sponsored or cobra.
role enum required Whether the member is the primary subscriber (policyholder) or a dependent on another member's plan.
enumsubscriber dependent
startDate string (date) Date this member's coverage under the plan began.
endDate string (date) Date this member's coverage under the plan ended or is expected to end.
eligibleDate string (date) Date the member first became eligible for this plan.
enrollmentStatus enum Current enrollment status for this member in this plan.
enumeligible enrolled pending ended
prefersSeparateMailing boolean Whether the member prefers to receive plan notices at a different address than their primary mailing address.
▶ sponsor PersonRef A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
id string (uuid) required read-only
memberId string (uuid) required The household member enrolled in this plan.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ DELETE /applications/{applicationId}/health-enrollments/{healthEnrollmentId} Delete health enrollment
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

healthEnrollmentId string path ✓

Unique identifier of the health enrollment record.

Responses
204 Health enrollment record deleted.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.

Child Support

▶ GET /applications/{applicationId}/child-support Get child support

Retrieve child support cooperation data for this application.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Responses
200 Child support data retrieved successfully.
▶ ApplicationChildSupport
goodCauseChildSupportWaiver boolean Whether the household is claiming a good cause exemption from child support cooperation requirements.
▶ parentsOutsideHome array[ParentOutsideHome] Non-custodial parents outside the household for whom child support cooperation is being tracked.
type enum required Whether the non-custodial parent is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the member or contact record.
children array[object] References to the household members whose non-custodial parent this person is.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
attemptedMedicalSupportCooperation boolean Whether the household has attempted to cooperate with medical child support enforcement for this parent.
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId}/child-support Update child support

Apply partial updates to child support cooperation data.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Request body required
▶ ApplicationChildSupportUpdate
goodCauseChildSupportWaiver boolean Whether the household is claiming a good cause exemption from child support cooperation requirements.
▶ parentsOutsideHome array[ParentOutsideHome] Non-custodial parents outside the household for whom child support cooperation is being tracked.
type enum required Whether the non-custodial parent is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the member or contact record.
children array[object] References to the household members whose non-custodial parent this person is.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
attemptedMedicalSupportCooperation boolean Whether the household has attempted to cooperate with medical child support enforcement for this parent.
Responses
200 Child support data updated successfully.
▶ ApplicationChildSupport
goodCauseChildSupportWaiver boolean Whether the household is claiming a good cause exemption from child support cooperation requirements.
▶ parentsOutsideHome array[ParentOutsideHome] Non-custodial parents outside the household for whom child support cooperation is being tracked.
type enum required Whether the non-custodial parent is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the member or contact record.
children array[object] References to the household members whose non-custodial parent this person is.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
attemptedMedicalSupportCooperation boolean Whether the household has attempted to cooperate with medical child support enforcement for this parent.
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.

Contacts

Non-member contact records for an application (authorized representatives, sponsors, tax dependents, etc.).

▶ GET /applications/{applicationId}/contacts List contacts

Retrieve non-member contact records for an application.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
Responses
200 A paginated list of contact records.
▶ ContactList
total integer required Total number of items available.
limit integer required Maximum number of items requested.
offset integer required Number of items skipped before the current page.
hasNext boolean Whether more items are available beyond the current page.
▶ items array[Contact] required
name object required Legal name of a person.
firstName string required First name.
middleName string Middle name.
middleInitial string Middle initial.
lastName string required Last name.
maidenName string Maiden name if applicable.
suffix string Name suffix such as Jr., Sr., III, etc.
primaryAddress object Primary address for this contact.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
primaryPhone string Primary phone number.
email string (email) Email address.
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/contacts Add contact
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Request body required
▶ ContactCreate
name object required Legal name of a person.
firstName string required First name.
middleName string Middle name.
middleInitial string Middle initial.
lastName string required Last name.
maidenName string Maiden name if applicable.
suffix string Name suffix such as Jr., Sr., III, etc.
primaryAddress object Primary address for this contact.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
primaryPhone string Primary phone number.
email string (email) Email address.
id string (uuid) The new record's id, a UUID (RFC 9562).
Responses
201 Contact record created.
▶ Contact
name object required Legal name of a person.
firstName string required First name.
middleName string Middle name.
middleInitial string Middle initial.
lastName string required Last name.
maidenName string Maiden name if applicable.
suffix string Name suffix such as Jr., Sr., III, etc.
primaryAddress object Primary address for this contact.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
primaryPhone string Primary phone number.
email string (email) Email address.
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/contacts/{contactId} Get contact
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

contactId string path ✓

Unique identifier of the contact record.

Responses
200 Contact record retrieved.
▶ Contact
name object required Legal name of a person.
firstName string required First name.
middleName string Middle name.
middleInitial string Middle initial.
lastName string required Last name.
maidenName string Maiden name if applicable.
suffix string Name suffix such as Jr., Sr., III, etc.
primaryAddress object Primary address for this contact.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
primaryPhone string Primary phone number.
email string (email) Email address.
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId}/contacts/{contactId} Update contact
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

contactId string path ✓

Unique identifier of the contact record.

Request body required
▶ ContactUpdate
name object required Legal name of a person.
firstName string required First name.
middleName string Middle name.
middleInitial string Middle initial.
lastName string required Last name.
maidenName string Maiden name if applicable.
suffix string Name suffix such as Jr., Sr., III, etc.
primaryAddress object Primary address for this contact.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
primaryPhone string Primary phone number.
email string (email) Email address.
Responses
200 Contact record updated.
▶ Contact
name object required Legal name of a person.
firstName string required First name.
middleName string Middle name.
middleInitial string Middle initial.
lastName string required Last name.
maidenName string Maiden name if applicable.
suffix string Name suffix such as Jr., Sr., III, etc.
primaryAddress object Primary address for this contact.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
primaryPhone string Primary phone number.
email string (email) Email address.
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ DELETE /applications/{applicationId}/contacts/{contactId} Delete contact
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

contactId string path ✓

Unique identifier of the contact record.

Responses
204 Contact record deleted.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.

Organizations

Organization records for an application (employers, organizational authorized representatives).

▶ GET /applications/{applicationId}/organizations List organizations

Retrieve organization records for an application.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
Responses
200 A paginated list of organization records.
▶ OrganizationList
total integer required Total number of items available.
limit integer required Maximum number of items requested.
offset integer required Number of items skipped before the current page.
hasNext boolean Whether more items are available beyond the current page.
▶ items array[Organization] required
name string required Legal name of the organization.
ein string Employer Identification Number (EIN / Federal Tax ID).
▶ address Address Organization's primary business address.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
▶ phone PhoneNumber Organization's primary phone number.
No additional fields
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/organizations Add organization
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Request body required
▶ OrganizationCreate
name string required Legal name of the organization.
ein string Employer Identification Number (EIN / Federal Tax ID).
▶ address Address Organization's primary business address.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
▶ phone PhoneNumber Organization's primary phone number.
No additional fields
id string (uuid) The new record's id, a UUID (RFC 9562).
Responses
201 Organization record created.
▶ Organization
name string required Legal name of the organization.
ein string Employer Identification Number (EIN / Federal Tax ID).
▶ address Address Organization's primary business address.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
▶ phone PhoneNumber Organization's primary phone number.
No additional fields
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/organizations/{organizationId} Get organization
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

organizationId string path ✓

Unique identifier of the organization record.

Responses
200 Organization record retrieved.
▶ Organization
name string required Legal name of the organization.
ein string Employer Identification Number (EIN / Federal Tax ID).
▶ address Address Organization's primary business address.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
▶ phone PhoneNumber Organization's primary phone number.
No additional fields
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId}/organizations/{organizationId} Update organization
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

organizationId string path ✓

Unique identifier of the organization record.

Request body required
▶ OrganizationUpdate
name string required Legal name of the organization.
ein string Employer Identification Number (EIN / Federal Tax ID).
▶ address Address Organization's primary business address.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
▶ phone PhoneNumber Organization's primary phone number.
No additional fields
Responses
200 Organization record updated.
▶ Organization
name string required Legal name of the organization.
ein string Employer Identification Number (EIN / Federal Tax ID).
▶ address Address Organization's primary business address.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
▶ phone PhoneNumber Organization's primary phone number.
No additional fields
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ DELETE /applications/{applicationId}/organizations/{organizationId} Delete organization
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

organizationId string path ✓

Unique identifier of the organization record.

Responses
204 Organization record deleted.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.

Person Relationships

Directional relationship records between any two persons in an application.

▶ GET /applications/{applicationId}/person-relationships List person relationships

Retrieve person relationship records for an application.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
Responses
200 A paginated list of person relationship records.
▶ PersonRelationshipList
total integer required Total number of items available.
limit integer required Maximum number of items requested.
offset integer required Number of items skipped before the current page.
hasNext boolean Whether more items are available beyond the current page.
▶ items array[PersonRelationship] required
▶ from PersonRef required A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
▶ to PersonRef required A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
relationshipTypes array[enum] required The relationship type(s) from `from`'s perspective relative to `to`.
enumparent child spouse domestic_partner sibling grandparent grandchild legal_guardian caregiver primary_caregiver other_relative unrelated
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/person-relationships Add person relationship
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Request body required
▶ PersonRelationshipCreate
▶ from PersonRef required A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
▶ to PersonRef required A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
relationshipTypes array[enum] required The relationship type(s) from `from`'s perspective relative to `to`.
enumparent child spouse domestic_partner sibling grandparent grandchild legal_guardian caregiver primary_caregiver other_relative unrelated
id string (uuid) The new record's id, a UUID (RFC 9562).
Responses
201 Person relationship record created.
▶ PersonRelationship
▶ from PersonRef required A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
▶ to PersonRef required A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
relationshipTypes array[enum] required The relationship type(s) from `from`'s perspective relative to `to`.
enumparent child spouse domestic_partner sibling grandparent grandchild legal_guardian caregiver primary_caregiver other_relative unrelated
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/person-relationships/{personRelationshipId} Get person relationship
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

personRelationshipId string path ✓

Unique identifier of the person relationship record.

Responses
200 Person relationship record retrieved.
▶ PersonRelationship
▶ from PersonRef required A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
▶ to PersonRef required A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
relationshipTypes array[enum] required The relationship type(s) from `from`'s perspective relative to `to`.
enumparent child spouse domestic_partner sibling grandparent grandchild legal_guardian caregiver primary_caregiver other_relative unrelated
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId}/person-relationships/{personRelationshipId} Update person relationship
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

personRelationshipId string path ✓

Unique identifier of the person relationship record.

Request body required
▶ PersonRelationshipUpdate
▶ from PersonRef required A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
▶ to PersonRef required A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
relationshipTypes array[enum] required The relationship type(s) from `from`'s perspective relative to `to`.
enumparent child spouse domestic_partner sibling grandparent grandchild legal_guardian caregiver primary_caregiver other_relative unrelated
Responses
200 Person relationship record updated.
▶ PersonRelationship
▶ from PersonRef required A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
▶ to PersonRef required A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
relationshipTypes array[enum] required The relationship type(s) from `from`'s perspective relative to `to`.
enumparent child spouse domestic_partner sibling grandparent grandchild legal_guardian caregiver primary_caregiver other_relative unrelated
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ DELETE /applications/{applicationId}/person-relationships/{personRelationshipId} Delete person relationship
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

personRelationshipId string path ✓

Unique identifier of the person relationship record.

Responses
204 Person relationship record deleted.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.

Authorized Representatives

Authorized representative records for an application.

▶ GET /applications/{applicationId}/authorized-representatives List authorized representatives
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
Responses
200 A paginated list of authorized representative records.
▶ AuthorizedRepresentativeList
total integer required Total number of items available.
limit integer required Maximum number of items requested.
offset integer required Number of items skipped before the current page.
hasNext boolean Whether more items are available beyond the current page.
▶ items array[AuthorizedRepresentative] required
type enum required Whether the authorized representative is a household member, contact, or organization.
enummember contact organization
id string (uuid) required Identifier of the member, contact, or organization record.
▶ inCareOf PersonRef A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
receivesNotices boolean Whether this authorized representative should receive copies of program notices.
appointedByMemberId string (uuid) The household member who appointed this authorized representative.
▶ programs array[Program] Programs for which this person or organization is authorized to act. Empty array means authorized for all applied-for programs.
No additional fields
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/authorized-representatives Add authorized representative
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Request body required
▶ AuthorizedRepresentativeCreate
type enum required Whether the authorized representative is a household member, contact, or organization.
enummember contact organization
id string (uuid) required Identifier of the member, contact, or organization record.
▶ inCareOf PersonRef A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
receivesNotices boolean Whether this authorized representative should receive copies of program notices.
appointedByMemberId string (uuid) The household member who appointed this authorized representative.
▶ programs array[Program] Programs for which this person or organization is authorized to act. Empty array means authorized for all applied-for programs.
No additional fields
id string (uuid) The new record's id, a UUID (RFC 9562).
Responses
201 Authorized representative record created.
▶ AuthorizedRepresentative
type enum required Whether the authorized representative is a household member, contact, or organization.
enummember contact organization
id string (uuid) required Identifier of the member, contact, or organization record.
▶ inCareOf PersonRef A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
receivesNotices boolean Whether this authorized representative should receive copies of program notices.
appointedByMemberId string (uuid) The household member who appointed this authorized representative.
▶ programs array[Program] Programs for which this person or organization is authorized to act. Empty array means authorized for all applied-for programs.
No additional fields
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/authorized-representatives/{authorizedRepresentativeId} Get authorized representative
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

authorizedRepresentativeId string path ✓

Unique identifier of the authorized representative record.

Responses
200 Authorized representative record retrieved.
▶ AuthorizedRepresentative
type enum required Whether the authorized representative is a household member, contact, or organization.
enummember contact organization
id string (uuid) required Identifier of the member, contact, or organization record.
▶ inCareOf PersonRef A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
receivesNotices boolean Whether this authorized representative should receive copies of program notices.
appointedByMemberId string (uuid) The household member who appointed this authorized representative.
▶ programs array[Program] Programs for which this person or organization is authorized to act. Empty array means authorized for all applied-for programs.
No additional fields
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId}/authorized-representatives/{authorizedRepresentativeId} Update authorized representative
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

authorizedRepresentativeId string path ✓

Unique identifier of the authorized representative record.

Request body required
▶ AuthorizedRepresentativeUpdate
type enum required Whether the authorized representative is a household member, contact, or organization.
enummember contact organization
id string (uuid) required Identifier of the member, contact, or organization record.
▶ inCareOf PersonRef A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
receivesNotices boolean Whether this authorized representative should receive copies of program notices.
appointedByMemberId string (uuid) The household member who appointed this authorized representative.
▶ programs array[Program] Programs for which this person or organization is authorized to act. Empty array means authorized for all applied-for programs.
No additional fields
Responses
200 Authorized representative record updated.
▶ AuthorizedRepresentative
type enum required Whether the authorized representative is a household member, contact, or organization.
enummember contact organization
id string (uuid) required Identifier of the member, contact, or organization record.
▶ inCareOf PersonRef A polymorphic reference to a person in the application. Can be a household member (type: member, id: ApplicationMember.id) or a non-member contact from the application's people registry (type: contact, id: Person.id). Used throughout the application wherever a reference can point to either a member or a non-member.
type enum required Whether the referenced person is a household member or a people-registry contact.
enummember contact
id string (uuid) required Identifier of the referenced member or contact.
receivesNotices boolean Whether this authorized representative should receive copies of program notices.
appointedByMemberId string (uuid) The household member who appointed this authorized representative.
▶ programs array[Program] Programs for which this person or organization is authorized to act. Empty array means authorized for all applied-for programs.
No additional fields
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ DELETE /applications/{applicationId}/authorized-representatives/{authorizedRepresentativeId} Delete authorized representative
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

authorizedRepresentativeId string path ✓

Unique identifier of the authorized representative record.

Responses
204 Authorized representative record deleted.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.

Signatures

Signature records for an application.

▶ GET /applications/{applicationId}/signatures List signatures

Retrieve signature records for an application.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
Responses
200 A paginated list of signature records.
▶ SignatureList
total integer required Total number of items available.
limit integer required Maximum number of items requested.
offset integer required Number of items skipped before the current page.
hasNext boolean Whether more items are available beyond the current page.
▶ items array[Signature] required
▶ signer Signer required The person or organization providing the signature.
type enum required Whether the signer is a household member, contact, or organization.
enummember contact organization
id string (uuid) required Identifier of the member, contact, or organization record.
role enum required The role in which the signer is acting for this signature.
enumapplicant authorized_representative helper
purpose enum required What the signature covers.
enumapplication authorized_representative_appointment authorized_representative_acceptance rights_and_responsibilities hipaa_consent other
signedAt string (date-time) required Date and time the signature was collected.
signatureMethod enum required How the signature was collected.
enumelectronic wet_signature verbal
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/signatures Add signature
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Request body required
▶ SignatureCreate
▶ signer Signer required The person or organization providing the signature.
type enum required Whether the signer is a household member, contact, or organization.
enummember contact organization
id string (uuid) required Identifier of the member, contact, or organization record.
role enum required The role in which the signer is acting for this signature.
enumapplicant authorized_representative helper
purpose enum required What the signature covers.
enumapplication authorized_representative_appointment authorized_representative_acceptance rights_and_responsibilities hipaa_consent other
signedAt string (date-time) required Date and time the signature was collected.
signatureMethod enum required How the signature was collected.
enumelectronic wet_signature verbal
id string (uuid) The new record's id, a UUID (RFC 9562).
Responses
201 Signature record created.
▶ Signature
▶ signer Signer required The person or organization providing the signature.
type enum required Whether the signer is a household member, contact, or organization.
enummember contact organization
id string (uuid) required Identifier of the member, contact, or organization record.
role enum required The role in which the signer is acting for this signature.
enumapplicant authorized_representative helper
purpose enum required What the signature covers.
enumapplication authorized_representative_appointment authorized_representative_acceptance rights_and_responsibilities hipaa_consent other
signedAt string (date-time) required Date and time the signature was collected.
signatureMethod enum required How the signature was collected.
enumelectronic wet_signature verbal
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/signatures/{signatureId} Get signature
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

signatureId string path ✓

Unique identifier of the signature record.

Responses
200 Signature record retrieved.
▶ Signature
▶ signer Signer required The person or organization providing the signature.
type enum required Whether the signer is a household member, contact, or organization.
enummember contact organization
id string (uuid) required Identifier of the member, contact, or organization record.
role enum required The role in which the signer is acting for this signature.
enumapplicant authorized_representative helper
purpose enum required What the signature covers.
enumapplication authorized_representative_appointment authorized_representative_acceptance rights_and_responsibilities hipaa_consent other
signedAt string (date-time) required Date and time the signature was collected.
signatureMethod enum required How the signature was collected.
enumelectronic wet_signature verbal
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId}/signatures/{signatureId} Update signature
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

signatureId string path ✓

Unique identifier of the signature record.

Request body required
▶ SignatureUpdate
▶ signer Signer required The person or organization providing the signature.
type enum required Whether the signer is a household member, contact, or organization.
enummember contact organization
id string (uuid) required Identifier of the member, contact, or organization record.
role enum required The role in which the signer is acting for this signature.
enumapplicant authorized_representative helper
purpose enum required What the signature covers.
enumapplication authorized_representative_appointment authorized_representative_acceptance rights_and_responsibilities hipaa_consent other
signedAt string (date-time) required Date and time the signature was collected.
signatureMethod enum required How the signature was collected.
enumelectronic wet_signature verbal
Responses
200 Signature record updated.
▶ Signature
▶ signer Signer required The person or organization providing the signature.
type enum required Whether the signer is a household member, contact, or organization.
enummember contact organization
id string (uuid) required Identifier of the member, contact, or organization record.
role enum required The role in which the signer is acting for this signature.
enumapplicant authorized_representative helper
purpose enum required What the signature covers.
enumapplication authorized_representative_appointment authorized_representative_acceptance rights_and_responsibilities hipaa_consent other
signedAt string (date-time) required Date and time the signature was collected.
signatureMethod enum required How the signature was collected.
enumelectronic wet_signature verbal
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ DELETE /applications/{applicationId}/signatures/{signatureId} Delete signature
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

signatureId string path ✓

Unique identifier of the signature record.

Responses
204 Signature record deleted.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.

Sponsors

Sponsor records for non-citizen household members.

▶ GET /applications/{applicationId}/sponsors List sponsors

Retrieve sponsor records for an application. Filter by memberId to find sponsors for a specific member.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
memberId string query

Filter records by the household member they belong to.

Responses
200 A paginated list of sponsor records.
▶ SponsorList
total integer required Total number of items available.
limit integer required Maximum number of items requested.
offset integer required Number of items skipped before the current page.
hasNext boolean Whether more items are available beyond the current page.
▶ items array[Sponsor] required
sponsoredMemberId string (uuid) The household member sponsored by this person.
type enum Whether the sponsor is a household member or a people-registry contact.
enummember contact
▶ ssn SocialSecurityNumber Sponsor's Social Security Number. Used for income verification and deeming calculations.
No additional fields
▶ spouse Spouse Sponsor's spouse information, if the sponsor is married.
type enum Whether the sponsor's spouse is a household member or a people-registry contact.
enummember contact
id string (uuid) Identifier of the member or contact record for the spouse.
ssn string Spouse's Social Security Number.
signedAffidavit boolean Whether the sponsor's spouse has signed an I-864A Household Member Contract.
householdSize integer Size of the sponsor's household. Used in sponsor deeming calculations.
income number (float) Sponsor's annual income. Used in sponsor deeming calculations.
livesWithSponsored boolean Whether the sponsor lives in the same household as the sponsored member.
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/sponsors Add sponsor
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Request body required
▶ SponsorCreate
sponsoredMemberId string (uuid) The household member sponsored by this person.
type enum Whether the sponsor is a household member or a people-registry contact.
enummember contact
▶ ssn SocialSecurityNumber Sponsor's Social Security Number. Used for income verification and deeming calculations.
No additional fields
▶ spouse Spouse Sponsor's spouse information, if the sponsor is married.
type enum Whether the sponsor's spouse is a household member or a people-registry contact.
enummember contact
id string (uuid) Identifier of the member or contact record for the spouse.
ssn string Spouse's Social Security Number.
signedAffidavit boolean Whether the sponsor's spouse has signed an I-864A Household Member Contract.
householdSize integer Size of the sponsor's household. Used in sponsor deeming calculations.
income number (float) Sponsor's annual income. Used in sponsor deeming calculations.
livesWithSponsored boolean Whether the sponsor lives in the same household as the sponsored member.
id string (uuid) The new record's id, a UUID (RFC 9562).
Responses
201 Sponsor record created.
▶ Sponsor
sponsoredMemberId string (uuid) The household member sponsored by this person.
type enum Whether the sponsor is a household member or a people-registry contact.
enummember contact
▶ ssn SocialSecurityNumber Sponsor's Social Security Number. Used for income verification and deeming calculations.
No additional fields
▶ spouse Spouse Sponsor's spouse information, if the sponsor is married.
type enum Whether the sponsor's spouse is a household member or a people-registry contact.
enummember contact
id string (uuid) Identifier of the member or contact record for the spouse.
ssn string Spouse's Social Security Number.
signedAffidavit boolean Whether the sponsor's spouse has signed an I-864A Household Member Contract.
householdSize integer Size of the sponsor's household. Used in sponsor deeming calculations.
income number (float) Sponsor's annual income. Used in sponsor deeming calculations.
livesWithSponsored boolean Whether the sponsor lives in the same household as the sponsored member.
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/sponsors/{sponsorId} Get sponsor
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

sponsorId string path ✓

Unique identifier of the sponsor record.

Responses
200 Sponsor record retrieved.
▶ Sponsor
sponsoredMemberId string (uuid) The household member sponsored by this person.
type enum Whether the sponsor is a household member or a people-registry contact.
enummember contact
▶ ssn SocialSecurityNumber Sponsor's Social Security Number. Used for income verification and deeming calculations.
No additional fields
▶ spouse Spouse Sponsor's spouse information, if the sponsor is married.
type enum Whether the sponsor's spouse is a household member or a people-registry contact.
enummember contact
id string (uuid) Identifier of the member or contact record for the spouse.
ssn string Spouse's Social Security Number.
signedAffidavit boolean Whether the sponsor's spouse has signed an I-864A Household Member Contract.
householdSize integer Size of the sponsor's household. Used in sponsor deeming calculations.
income number (float) Sponsor's annual income. Used in sponsor deeming calculations.
livesWithSponsored boolean Whether the sponsor lives in the same household as the sponsored member.
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId}/sponsors/{sponsorId} Update sponsor
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

sponsorId string path ✓

Unique identifier of the sponsor record.

Request body required
▶ SponsorUpdate
sponsoredMemberId string (uuid) The household member sponsored by this person.
type enum Whether the sponsor is a household member or a people-registry contact.
enummember contact
▶ ssn SocialSecurityNumber Sponsor's Social Security Number. Used for income verification and deeming calculations.
No additional fields
▶ spouse Spouse Sponsor's spouse information, if the sponsor is married.
type enum Whether the sponsor's spouse is a household member or a people-registry contact.
enummember contact
id string (uuid) Identifier of the member or contact record for the spouse.
ssn string Spouse's Social Security Number.
signedAffidavit boolean Whether the sponsor's spouse has signed an I-864A Household Member Contract.
householdSize integer Size of the sponsor's household. Used in sponsor deeming calculations.
income number (float) Sponsor's annual income. Used in sponsor deeming calculations.
livesWithSponsored boolean Whether the sponsor lives in the same household as the sponsored member.
Responses
200 Sponsor record updated.
▶ Sponsor
sponsoredMemberId string (uuid) The household member sponsored by this person.
type enum Whether the sponsor is a household member or a people-registry contact.
enummember contact
▶ ssn SocialSecurityNumber Sponsor's Social Security Number. Used for income verification and deeming calculations.
No additional fields
▶ spouse Spouse Sponsor's spouse information, if the sponsor is married.
type enum Whether the sponsor's spouse is a household member or a people-registry contact.
enummember contact
id string (uuid) Identifier of the member or contact record for the spouse.
ssn string Spouse's Social Security Number.
signedAffidavit boolean Whether the sponsor's spouse has signed an I-864A Household Member Contract.
householdSize integer Size of the sponsor's household. Used in sponsor deeming calculations.
income number (float) Sponsor's annual income. Used in sponsor deeming calculations.
livesWithSponsored boolean Whether the sponsor lives in the same household as the sponsored member.
id string (uuid) required read-only
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ DELETE /applications/{applicationId}/sponsors/{sponsorId} Delete sponsor
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

sponsorId string path ✓

Unique identifier of the sponsor record.

Responses
204 Sponsor record deleted.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.

Jobs

Employment records for an application.

▶ GET /applications/{applicationId}/jobs List jobs

Retrieve job records for an application. Filter by memberId to scope to a single member.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
memberId string query

Filter records by the household member they belong to.

Responses
200 A paginated list of job records.
▶ JobList
total integer required Total number of items available.
limit integer required Maximum number of items requested.
offset integer required Number of items skipped before the current page.
hasNext boolean Whether more items are available beyond the current page.
▶ items array[Job] required
▶ (one of) Job
▶ EmployedJob
type enum Whether this is W-2 employment (employed) or self-employment / gig work (self_employed). Determines which expense deductions and verification pathways apply.
enumemployed self_employed
status enum required Current status of the job. active — currently working. on_strike — participating in a labor strike (SNAP eligibility may be affected under 7 CFR § 273.1(f)). ended — employment has concluded.
enumactive on_strike ended
hoursPerWeek number (float) Average hours worked per week. Used in TANF work participation rate calculations (45 CFR § 261.22) and CCDF activity eligibility determinations.
isTemporary boolean Whether the position is temporary or seasonal.
startDate string (date) Date employment began.
endDate string (date) Date employment ended or is expected to end.
endReason enum Reason employment ended. Present when status is ended.
enumvoluntary_separation involuntary_separation
strikeStartDate string (date) Date the strike began. Present when status is on_strike.
lastPaycheckDate string (date) Date of the most recent paycheck received from this employer.
lastPaycheckGrossAmount number (float) Gross amount of the most recent paycheck from this employer.
type enum
enumemployed
employerId string (uuid) The employer organization for this job.
▶ SelfEmployedJob
type enum Whether this is W-2 employment (employed) or self-employment / gig work (self_employed). Determines which expense deductions and verification pathways apply.
enumemployed self_employed
status enum required Current status of the job. active — currently working. on_strike — participating in a labor strike (SNAP eligibility may be affected under 7 CFR § 273.1(f)). ended — employment has concluded.
enumactive on_strike ended
hoursPerWeek number (float) Average hours worked per week. Used in TANF work participation rate calculations (45 CFR § 261.22) and CCDF activity eligibility determinations.
isTemporary boolean Whether the position is temporary or seasonal.
startDate string (date) Date employment began.
endDate string (date) Date employment ended or is expected to end.
endReason enum Reason employment ended. Present when status is ended.
enumvoluntary_separation involuntary_separation
strikeStartDate string (date) Date the strike began. Present when status is on_strike.
lastPaycheckDate string (date) Date of the most recent paycheck received from this employer.
lastPaycheckGrossAmount number (float) Gross amount of the most recent paycheck from this employer.
type enum
enumself_employed
businessName string Business or trade name.
businessType string Type of business or industry.
reportingMonth string (date) Month for which self-employment income is being reported (first day of the month).
expenses object Allowable business expense deductions.
utilities number (float) Utility costs attributable to the business.
taxes number (float) Business taxes paid.
interest number (float) Business loan interest paid.
laborCosts number (float) Wages or contracted labor costs paid to others.
costOfMerchandise number (float) Cost of goods purchased for resale.
other number (float) Other allowable business expenses not captured above.
id string (uuid) required read-only
memberId string (uuid) required The household member this job record belongs to.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/jobs Add job
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Request body required
▶ JobCreate
▶ (one of) Job
▶ EmployedJob
type enum Whether this is W-2 employment (employed) or self-employment / gig work (self_employed). Determines which expense deductions and verification pathways apply.
enumemployed self_employed
status enum required Current status of the job. active — currently working. on_strike — participating in a labor strike (SNAP eligibility may be affected under 7 CFR § 273.1(f)). ended — employment has concluded.
enumactive on_strike ended
hoursPerWeek number (float) Average hours worked per week. Used in TANF work participation rate calculations (45 CFR § 261.22) and CCDF activity eligibility determinations.
isTemporary boolean Whether the position is temporary or seasonal.
startDate string (date) Date employment began.
endDate string (date) Date employment ended or is expected to end.
endReason enum Reason employment ended. Present when status is ended.
enumvoluntary_separation involuntary_separation
strikeStartDate string (date) Date the strike began. Present when status is on_strike.
lastPaycheckDate string (date) Date of the most recent paycheck received from this employer.
lastPaycheckGrossAmount number (float) Gross amount of the most recent paycheck from this employer.
type enum
enumemployed
employerId string (uuid) The employer organization for this job.
▶ SelfEmployedJob
type enum Whether this is W-2 employment (employed) or self-employment / gig work (self_employed). Determines which expense deductions and verification pathways apply.
enumemployed self_employed
status enum required Current status of the job. active — currently working. on_strike — participating in a labor strike (SNAP eligibility may be affected under 7 CFR § 273.1(f)). ended — employment has concluded.
enumactive on_strike ended
hoursPerWeek number (float) Average hours worked per week. Used in TANF work participation rate calculations (45 CFR § 261.22) and CCDF activity eligibility determinations.
isTemporary boolean Whether the position is temporary or seasonal.
startDate string (date) Date employment began.
endDate string (date) Date employment ended or is expected to end.
endReason enum Reason employment ended. Present when status is ended.
enumvoluntary_separation involuntary_separation
strikeStartDate string (date) Date the strike began. Present when status is on_strike.
lastPaycheckDate string (date) Date of the most recent paycheck received from this employer.
lastPaycheckGrossAmount number (float) Gross amount of the most recent paycheck from this employer.
type enum
enumself_employed
businessName string Business or trade name.
businessType string Type of business or industry.
reportingMonth string (date) Month for which self-employment income is being reported (first day of the month).
expenses object Allowable business expense deductions.
utilities number (float) Utility costs attributable to the business.
taxes number (float) Business taxes paid.
interest number (float) Business loan interest paid.
laborCosts number (float) Wages or contracted labor costs paid to others.
costOfMerchandise number (float) Cost of goods purchased for resale.
other number (float) Other allowable business expenses not captured above.
id string (uuid) The new record's id, a UUID (RFC 9562).
memberId string (uuid) required The household member this job record belongs to.
Responses
201 Job record created.
▶ Job
▶ (one of) Job
▶ EmployedJob
type enum Whether this is W-2 employment (employed) or self-employment / gig work (self_employed). Determines which expense deductions and verification pathways apply.
enumemployed self_employed
status enum required Current status of the job. active — currently working. on_strike — participating in a labor strike (SNAP eligibility may be affected under 7 CFR § 273.1(f)). ended — employment has concluded.
enumactive on_strike ended
hoursPerWeek number (float) Average hours worked per week. Used in TANF work participation rate calculations (45 CFR § 261.22) and CCDF activity eligibility determinations.
isTemporary boolean Whether the position is temporary or seasonal.
startDate string (date) Date employment began.
endDate string (date) Date employment ended or is expected to end.
endReason enum Reason employment ended. Present when status is ended.
enumvoluntary_separation involuntary_separation
strikeStartDate string (date) Date the strike began. Present when status is on_strike.
lastPaycheckDate string (date) Date of the most recent paycheck received from this employer.
lastPaycheckGrossAmount number (float) Gross amount of the most recent paycheck from this employer.
type enum
enumemployed
employerId string (uuid) The employer organization for this job.
▶ SelfEmployedJob
type enum Whether this is W-2 employment (employed) or self-employment / gig work (self_employed). Determines which expense deductions and verification pathways apply.
enumemployed self_employed
status enum required Current status of the job. active — currently working. on_strike — participating in a labor strike (SNAP eligibility may be affected under 7 CFR § 273.1(f)). ended — employment has concluded.
enumactive on_strike ended
hoursPerWeek number (float) Average hours worked per week. Used in TANF work participation rate calculations (45 CFR § 261.22) and CCDF activity eligibility determinations.
isTemporary boolean Whether the position is temporary or seasonal.
startDate string (date) Date employment began.
endDate string (date) Date employment ended or is expected to end.
endReason enum Reason employment ended. Present when status is ended.
enumvoluntary_separation involuntary_separation
strikeStartDate string (date) Date the strike began. Present when status is on_strike.
lastPaycheckDate string (date) Date of the most recent paycheck received from this employer.
lastPaycheckGrossAmount number (float) Gross amount of the most recent paycheck from this employer.
type enum
enumself_employed
businessName string Business or trade name.
businessType string Type of business or industry.
reportingMonth string (date) Month for which self-employment income is being reported (first day of the month).
expenses object Allowable business expense deductions.
utilities number (float) Utility costs attributable to the business.
taxes number (float) Business taxes paid.
interest number (float) Business loan interest paid.
laborCosts number (float) Wages or contracted labor costs paid to others.
costOfMerchandise number (float) Cost of goods purchased for resale.
other number (float) Other allowable business expenses not captured above.
id string (uuid) required read-only
memberId string (uuid) required The household member this job record belongs to.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/jobs/{jobId} Get job
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

jobId string path ✓

Unique identifier of the job record.

Responses
200 Job record retrieved.
▶ Job
▶ (one of) Job
▶ EmployedJob
type enum Whether this is W-2 employment (employed) or self-employment / gig work (self_employed). Determines which expense deductions and verification pathways apply.
enumemployed self_employed
status enum required Current status of the job. active — currently working. on_strike — participating in a labor strike (SNAP eligibility may be affected under 7 CFR § 273.1(f)). ended — employment has concluded.
enumactive on_strike ended
hoursPerWeek number (float) Average hours worked per week. Used in TANF work participation rate calculations (45 CFR § 261.22) and CCDF activity eligibility determinations.
isTemporary boolean Whether the position is temporary or seasonal.
startDate string (date) Date employment began.
endDate string (date) Date employment ended or is expected to end.
endReason enum Reason employment ended. Present when status is ended.
enumvoluntary_separation involuntary_separation
strikeStartDate string (date) Date the strike began. Present when status is on_strike.
lastPaycheckDate string (date) Date of the most recent paycheck received from this employer.
lastPaycheckGrossAmount number (float) Gross amount of the most recent paycheck from this employer.
type enum
enumemployed
employerId string (uuid) The employer organization for this job.
▶ SelfEmployedJob
type enum Whether this is W-2 employment (employed) or self-employment / gig work (self_employed). Determines which expense deductions and verification pathways apply.
enumemployed self_employed
status enum required Current status of the job. active — currently working. on_strike — participating in a labor strike (SNAP eligibility may be affected under 7 CFR § 273.1(f)). ended — employment has concluded.
enumactive on_strike ended
hoursPerWeek number (float) Average hours worked per week. Used in TANF work participation rate calculations (45 CFR § 261.22) and CCDF activity eligibility determinations.
isTemporary boolean Whether the position is temporary or seasonal.
startDate string (date) Date employment began.
endDate string (date) Date employment ended or is expected to end.
endReason enum Reason employment ended. Present when status is ended.
enumvoluntary_separation involuntary_separation
strikeStartDate string (date) Date the strike began. Present when status is on_strike.
lastPaycheckDate string (date) Date of the most recent paycheck received from this employer.
lastPaycheckGrossAmount number (float) Gross amount of the most recent paycheck from this employer.
type enum
enumself_employed
businessName string Business or trade name.
businessType string Type of business or industry.
reportingMonth string (date) Month for which self-employment income is being reported (first day of the month).
expenses object Allowable business expense deductions.
utilities number (float) Utility costs attributable to the business.
taxes number (float) Business taxes paid.
interest number (float) Business loan interest paid.
laborCosts number (float) Wages or contracted labor costs paid to others.
costOfMerchandise number (float) Cost of goods purchased for resale.
other number (float) Other allowable business expenses not captured above.
id string (uuid) required read-only
memberId string (uuid) required The household member this job record belongs to.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId}/jobs/{jobId} Update job
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

jobId string path ✓

Unique identifier of the job record.

Request body required
▶ JobUpdate
▶ type JobType Whether this is W-2 employment (employed) or self-employment / gig work (self_employed). Determines which expense deductions and verification pathways apply.
No additional fields
▶ status JobStatus required Current status of the job. active — currently working. on_strike — participating in a labor strike (SNAP eligibility may be affected under 7 CFR § 273.1(f)). ended — employment has concluded.
No additional fields
hoursPerWeek number (float) Average hours worked per week. Used in TANF work participation rate calculations (45 CFR § 261.22) and CCDF activity eligibility determinations.
isTemporary boolean Whether the position is temporary or seasonal.
startDate string (date) Date employment began.
endDate string (date) Date employment ended or is expected to end.
▶ endReason JobEndReason Reason employment ended. Present when status is ended.
No additional fields
strikeStartDate string (date) Date the strike began. Present when status is on_strike.
lastPaycheckDate string (date) Date of the most recent paycheck received from this employer.
lastPaycheckGrossAmount number (float) Gross amount of the most recent paycheck from this employer.
Responses
200 Job record updated.
▶ Job
▶ (one of) Job
▶ EmployedJob
type enum Whether this is W-2 employment (employed) or self-employment / gig work (self_employed). Determines which expense deductions and verification pathways apply.
enumemployed self_employed
status enum required Current status of the job. active — currently working. on_strike — participating in a labor strike (SNAP eligibility may be affected under 7 CFR § 273.1(f)). ended — employment has concluded.
enumactive on_strike ended
hoursPerWeek number (float) Average hours worked per week. Used in TANF work participation rate calculations (45 CFR § 261.22) and CCDF activity eligibility determinations.
isTemporary boolean Whether the position is temporary or seasonal.
startDate string (date) Date employment began.
endDate string (date) Date employment ended or is expected to end.
endReason enum Reason employment ended. Present when status is ended.
enumvoluntary_separation involuntary_separation
strikeStartDate string (date) Date the strike began. Present when status is on_strike.
lastPaycheckDate string (date) Date of the most recent paycheck received from this employer.
lastPaycheckGrossAmount number (float) Gross amount of the most recent paycheck from this employer.
type enum
enumemployed
employerId string (uuid) The employer organization for this job.
▶ SelfEmployedJob
type enum Whether this is W-2 employment (employed) or self-employment / gig work (self_employed). Determines which expense deductions and verification pathways apply.
enumemployed self_employed
status enum required Current status of the job. active — currently working. on_strike — participating in a labor strike (SNAP eligibility may be affected under 7 CFR § 273.1(f)). ended — employment has concluded.
enumactive on_strike ended
hoursPerWeek number (float) Average hours worked per week. Used in TANF work participation rate calculations (45 CFR § 261.22) and CCDF activity eligibility determinations.
isTemporary boolean Whether the position is temporary or seasonal.
startDate string (date) Date employment began.
endDate string (date) Date employment ended or is expected to end.
endReason enum Reason employment ended. Present when status is ended.
enumvoluntary_separation involuntary_separation
strikeStartDate string (date) Date the strike began. Present when status is on_strike.
lastPaycheckDate string (date) Date of the most recent paycheck received from this employer.
lastPaycheckGrossAmount number (float) Gross amount of the most recent paycheck from this employer.
type enum
enumself_employed
businessName string Business or trade name.
businessType string Type of business or industry.
reportingMonth string (date) Month for which self-employment income is being reported (first day of the month).
expenses object Allowable business expense deductions.
utilities number (float) Utility costs attributable to the business.
taxes number (float) Business taxes paid.
interest number (float) Business loan interest paid.
laborCosts number (float) Wages or contracted labor costs paid to others.
costOfMerchandise number (float) Cost of goods purchased for resale.
other number (float) Other allowable business expenses not captured above.
id string (uuid) required read-only
memberId string (uuid) required The household member this job record belongs to.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ DELETE /applications/{applicationId}/jobs/{jobId} Delete job
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

jobId string path ✓

Unique identifier of the job record.

Responses
204 Job record deleted.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.

Income

Income records for an application.

▶ GET /applications/{applicationId}/incomes List income

Retrieve income records for an application. Filter by memberId to scope to a single member.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
memberId string query

Filter records by the household member they belong to.

Responses
200 A paginated list of income records.
▶ IncomeList
total integer required Total number of items available.
limit integer required Maximum number of items requested.
offset integer required Number of items skipped before the current page.
hasNext boolean Whether more items are available beyond the current page.
▶ items array[Income] required
▶ (one of) Income
▶ EarnedIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumemployed self_employed
jobId string (uuid) The job record this income is associated with.
▶ UnearnedIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumunearned
unearnedType enum The specific type of unearned income.
enumunemployment kinship_payment veterans_programs adoption_and_refugee_services ssi_or_ssdi private_disability workers_compensation disability_from_veterans_programs legal_settlement scholarship educational_grant work_study spousal_support child_support retirement_or_pension investment_interest_and_dividends social_security_retirement rental_income gambling_or_lottery_winnings gifts_or_donations loan_or_mortgage_income research_participation other
▶ InKindSupportIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumin_kind_support
inKindSupportType enum The category of in-kind support received.
enumshelter food utilities other
payerName string Name of the person or organization providing in-kind support.
▶ LumpSumIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumlump_sum
lumpSumType enum The type of lump sum payment.
enumlawsuit_settlement insurance_settlement social_security_ssi_ssdi_payment veterans inheritance surrender_of_annuity life_insurance_payout lottery_gambling_winnings other
▶ OtherIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumtribal education_grant other prior_period
id string (uuid) required read-only
memberId string (uuid) required The household member this income record belongs to.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/incomes Add income
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Request body required
▶ IncomeCreate
▶ (one of) Income
▶ EarnedIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumemployed self_employed
jobId string (uuid) The job record this income is associated with.
▶ UnearnedIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumunearned
unearnedType enum The specific type of unearned income.
enumunemployment kinship_payment veterans_programs adoption_and_refugee_services ssi_or_ssdi private_disability workers_compensation disability_from_veterans_programs legal_settlement scholarship educational_grant work_study spousal_support child_support retirement_or_pension investment_interest_and_dividends social_security_retirement rental_income gambling_or_lottery_winnings gifts_or_donations loan_or_mortgage_income research_participation other
▶ InKindSupportIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumin_kind_support
inKindSupportType enum The category of in-kind support received.
enumshelter food utilities other
payerName string Name of the person or organization providing in-kind support.
▶ LumpSumIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumlump_sum
lumpSumType enum The type of lump sum payment.
enumlawsuit_settlement insurance_settlement social_security_ssi_ssdi_payment veterans inheritance surrender_of_annuity life_insurance_payout lottery_gambling_winnings other
▶ OtherIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumtribal education_grant other prior_period
id string (uuid) The new record's id, a UUID (RFC 9562).
memberId string (uuid) required The household member this income record belongs to.
Responses
201 Income record created.
▶ Income
▶ (one of) Income
▶ EarnedIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumemployed self_employed
jobId string (uuid) The job record this income is associated with.
▶ UnearnedIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumunearned
unearnedType enum The specific type of unearned income.
enumunemployment kinship_payment veterans_programs adoption_and_refugee_services ssi_or_ssdi private_disability workers_compensation disability_from_veterans_programs legal_settlement scholarship educational_grant work_study spousal_support child_support retirement_or_pension investment_interest_and_dividends social_security_retirement rental_income gambling_or_lottery_winnings gifts_or_donations loan_or_mortgage_income research_participation other
▶ InKindSupportIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumin_kind_support
inKindSupportType enum The category of in-kind support received.
enumshelter food utilities other
payerName string Name of the person or organization providing in-kind support.
▶ LumpSumIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumlump_sum
lumpSumType enum The type of lump sum payment.
enumlawsuit_settlement insurance_settlement social_security_ssi_ssdi_payment veterans inheritance surrender_of_annuity life_insurance_payout lottery_gambling_winnings other
▶ OtherIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumtribal education_grant other prior_period
id string (uuid) required read-only
memberId string (uuid) required The household member this income record belongs to.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/incomes/{incomeId} Get income
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

incomeId string path ✓

Unique identifier of the income record.

Responses
200 Income record retrieved.
▶ Income
▶ (one of) Income
▶ EarnedIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumemployed self_employed
jobId string (uuid) The job record this income is associated with.
▶ UnearnedIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumunearned
unearnedType enum The specific type of unearned income.
enumunemployment kinship_payment veterans_programs adoption_and_refugee_services ssi_or_ssdi private_disability workers_compensation disability_from_veterans_programs legal_settlement scholarship educational_grant work_study spousal_support child_support retirement_or_pension investment_interest_and_dividends social_security_retirement rental_income gambling_or_lottery_winnings gifts_or_donations loan_or_mortgage_income research_participation other
▶ InKindSupportIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumin_kind_support
inKindSupportType enum The category of in-kind support received.
enumshelter food utilities other
payerName string Name of the person or organization providing in-kind support.
▶ LumpSumIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumlump_sum
lumpSumType enum The type of lump sum payment.
enumlawsuit_settlement insurance_settlement social_security_ssi_ssdi_payment veterans inheritance surrender_of_annuity life_insurance_payout lottery_gambling_winnings other
▶ OtherIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumtribal education_grant other prior_period
id string (uuid) required read-only
memberId string (uuid) required The household member this income record belongs to.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId}/incomes/{incomeId} Update income
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

incomeId string path ✓

Unique identifier of the income record.

Request body required
▶ IncomeUpdate
▶ type IncomeType The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
No additional fields
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
▶ frequency IncomeFrequency required How often the income is received or accrues.
No additional fields
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
▶ changeReason IncomeChangeReason Reason for a change in income. Present when reporting an income change.
No additional fields
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
Responses
200 Income record updated.
▶ Income
▶ (one of) Income
▶ EarnedIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumemployed self_employed
jobId string (uuid) The job record this income is associated with.
▶ UnearnedIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumunearned
unearnedType enum The specific type of unearned income.
enumunemployment kinship_payment veterans_programs adoption_and_refugee_services ssi_or_ssdi private_disability workers_compensation disability_from_veterans_programs legal_settlement scholarship educational_grant work_study spousal_support child_support retirement_or_pension investment_interest_and_dividends social_security_retirement rental_income gambling_or_lottery_winnings gifts_or_donations loan_or_mortgage_income research_participation other
▶ InKindSupportIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumin_kind_support
inKindSupportType enum The category of in-kind support received.
enumshelter food utilities other
payerName string Name of the person or organization providing in-kind support.
▶ LumpSumIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumlump_sum
lumpSumType enum The type of lump sum payment.
enumlawsuit_settlement insurance_settlement social_security_ssi_ssdi_payment veterans inheritance surrender_of_annuity life_insurance_payout lottery_gambling_winnings other
▶ OtherIncome
type enum The category of income. employed and self_employed are earned income; unearned covers passive and benefit income; lump_sum covers one-time payments; in_kind_support covers non-cash contributions; tribal covers per-capita and other tribal payments; education_grant covers grants and scholarships not reported elsewhere; prior_period covers income from a previous benefit period being reported now.
enumemployed self_employed unearned lump_sum in_kind_support tribal education_grant other prior_period
typeOther string Free-text description when type is other.
amount number (float) required The income amount for the given frequency period.
frequency enum required How often the income is received or accrues.
enumdaily weekly every_two_weeks twice_monthly monthly yearly variable
dateReceived string (date) Date the income was received. Used for lump sums and one-time payments.
changeReason enum Reason for a change in income. Present when reporting an income change.
enumstopped_working hours_reduced new_job change_in_employment marital_status_change other
changeExplanation string Free-text explanation of the income change. Present when changeReason is other.
type enum
enumtribal education_grant other prior_period
id string (uuid) required read-only
memberId string (uuid) required The household member this income record belongs to.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ DELETE /applications/{applicationId}/incomes/{incomeId} Delete income
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

incomeId string path ✓

Unique identifier of the income record.

Responses
204 Income record deleted.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.

Assets

Asset records for an application.

▶ GET /applications/{applicationId}/assets List assets

Retrieve asset records for an application. Filter by memberId to scope to a single member.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
memberId string query

Filter records by the household member they belong to.

Responses
200 A paginated list of asset records.
▶ AssetList
total integer required Total number of items available.
limit integer required Maximum number of items requested.
offset integer required Number of items skipped before the current page.
hasNext boolean Whether more items are available beyond the current page.
▶ items array[Asset] required
▶ (one of) Asset
▶ LiquidOrRetirementAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enumliquid retirement_account
financialInstitutionName string Name of the financial institution holding the account.
accountNumber string Account number.
▶ VehicleAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enumvehicle
year string Model year.
make string Vehicle make (manufacturer).
model string Vehicle model.
▶ InsuranceAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enuminsurance
policyType enum Insurance policy type.
enumterm permanent burial other
companyName string Insurance company name.
policyNumber string Policy or certificate number.
faceValue number (float) Face value of the insurance policy. Life insurance policies with a cash surrender value above the resource limit count toward SNAP and TANF resource tests.
isRevocable boolean Whether the insurance policy is revocable.
▶ RealPropertyAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enumreal_property
address object Property address.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
primaryUse enum Primary use of the real property.
enumprimary_residence rental self_employment for_sale other
primaryUseOther string Free-text description when primaryUse is other.
▶ OtherAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enumother
id string (uuid) required read-only
memberId string (uuid) required The household member this asset belongs to.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/assets Add asset
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Request body required
▶ AssetCreate
▶ (one of) Asset
▶ LiquidOrRetirementAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enumliquid retirement_account
financialInstitutionName string Name of the financial institution holding the account.
accountNumber string Account number.
▶ VehicleAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enumvehicle
year string Model year.
make string Vehicle make (manufacturer).
model string Vehicle model.
▶ InsuranceAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enuminsurance
policyType enum Insurance policy type.
enumterm permanent burial other
companyName string Insurance company name.
policyNumber string Policy or certificate number.
faceValue number (float) Face value of the insurance policy. Life insurance policies with a cash surrender value above the resource limit count toward SNAP and TANF resource tests.
isRevocable boolean Whether the insurance policy is revocable.
▶ RealPropertyAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enumreal_property
address object Property address.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
primaryUse enum Primary use of the real property.
enumprimary_residence rental self_employment for_sale other
primaryUseOther string Free-text description when primaryUse is other.
▶ OtherAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enumother
id string (uuid) The new record's id, a UUID (RFC 9562).
memberId string (uuid) required The household member this asset belongs to.
Responses
201 Asset record created.
▶ Asset
▶ (one of) Asset
▶ LiquidOrRetirementAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enumliquid retirement_account
financialInstitutionName string Name of the financial institution holding the account.
accountNumber string Account number.
▶ VehicleAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enumvehicle
year string Model year.
make string Vehicle make (manufacturer).
model string Vehicle model.
▶ InsuranceAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enuminsurance
policyType enum Insurance policy type.
enumterm permanent burial other
companyName string Insurance company name.
policyNumber string Policy or certificate number.
faceValue number (float) Face value of the insurance policy. Life insurance policies with a cash surrender value above the resource limit count toward SNAP and TANF resource tests.
isRevocable boolean Whether the insurance policy is revocable.
▶ RealPropertyAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enumreal_property
address object Property address.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
primaryUse enum Primary use of the real property.
enumprimary_residence rental self_employment for_sale other
primaryUseOther string Free-text description when primaryUse is other.
▶ OtherAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enumother
id string (uuid) required read-only
memberId string (uuid) required The household member this asset belongs to.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/assets/{assetId} Get asset
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

assetId string path ✓

Unique identifier of the asset record.

Responses
200 Asset record retrieved.
▶ Asset
▶ (one of) Asset
▶ LiquidOrRetirementAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enumliquid retirement_account
financialInstitutionName string Name of the financial institution holding the account.
accountNumber string Account number.
▶ VehicleAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enumvehicle
year string Model year.
make string Vehicle make (manufacturer).
model string Vehicle model.
▶ InsuranceAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enuminsurance
policyType enum Insurance policy type.
enumterm permanent burial other
companyName string Insurance company name.
policyNumber string Policy or certificate number.
faceValue number (float) Face value of the insurance policy. Life insurance policies with a cash surrender value above the resource limit count toward SNAP and TANF resource tests.
isRevocable boolean Whether the insurance policy is revocable.
▶ RealPropertyAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enumreal_property
address object Property address.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
primaryUse enum Primary use of the real property.
enumprimary_residence rental self_employment for_sale other
primaryUseOther string Free-text description when primaryUse is other.
▶ OtherAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enumother
id string (uuid) required read-only
memberId string (uuid) required The household member this asset belongs to.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId}/assets/{assetId} Update asset
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

assetId string path ✓

Unique identifier of the asset record.

Request body required
▶ AssetUpdate
▶ type AssetType The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
No additional fields
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
Responses
200 Asset record updated.
▶ Asset
▶ (one of) Asset
▶ LiquidOrRetirementAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enumliquid retirement_account
financialInstitutionName string Name of the financial institution holding the account.
accountNumber string Account number.
▶ VehicleAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enumvehicle
year string Model year.
make string Vehicle make (manufacturer).
model string Vehicle model.
▶ InsuranceAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enuminsurance
policyType enum Insurance policy type.
enumterm permanent burial other
companyName string Insurance company name.
policyNumber string Policy or certificate number.
faceValue number (float) Face value of the insurance policy. Life insurance policies with a cash surrender value above the resource limit count toward SNAP and TANF resource tests.
isRevocable boolean Whether the insurance policy is revocable.
▶ RealPropertyAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enumreal_property
address object Property address.
addressLine1 string required Primary street address line.
addressLine2 string Secondary address line such as apartment or unit.
city string required City or locality of residence.
state string required State, province, or region of residence.
zip string required Postal or ZIP code.
county string County or equivalent administrative region.
primaryUse enum Primary use of the real property.
enumprimary_residence rental self_employment for_sale other
primaryUseOther string Free-text description when primaryUse is other.
▶ OtherAsset
type enum The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
enumliquid vehicle real_property retirement_account insurance other
typeOther string Free-text description when type is other.
value number (float) required The current fair market value of the asset.
type enum
enumother
id string (uuid) required read-only
memberId string (uuid) required The household member this asset belongs to.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ DELETE /applications/{applicationId}/assets/{assetId} Delete asset
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

assetId string path ✓

Unique identifier of the asset record.

Responses
204 Asset record deleted.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.

Asset Disposals

Asset disposal records for an application.

▶ GET /applications/{applicationId}/asset-disposals List asset disposals

Retrieve asset disposal records for an application. Filter by memberId to scope to a single member.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
memberId string query

Filter records by the household member they belong to.

Responses
200 A paginated list of asset disposal records.
▶ AssetDisposalList
total integer required Total number of items available.
limit integer required Maximum number of items requested.
offset integer required Number of items skipped before the current page.
hasNext boolean Whether more items are available beyond the current page.
▶ items array[AssetDisposal] required
▶ type AssetType The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
No additional fields
typeOther string Free-text description when type is other.
dateOfDisposal string (date) required Date the asset was transferred, sold, or otherwise disposed of.
amountReceived number (float) required Amount actually received from the transfer or sale.
fairMarketValue number (float) required Fair market value of the asset at the time of disposal.
id string (uuid) required read-only
memberId string (uuid) required The household member who disposed of the asset.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/asset-disposals Add asset disposal
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Request body required
▶ AssetDisposalCreate
▶ type AssetType The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
No additional fields
typeOther string Free-text description when type is other.
dateOfDisposal string (date) required Date the asset was transferred, sold, or otherwise disposed of.
amountReceived number (float) required Amount actually received from the transfer or sale.
fairMarketValue number (float) required Fair market value of the asset at the time of disposal.
id string (uuid) The new record's id, a UUID (RFC 9562).
memberId string (uuid) required The household member who disposed of the asset.
Responses
201 Asset disposal record created.
▶ AssetDisposal
▶ type AssetType The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
No additional fields
typeOther string Free-text description when type is other.
dateOfDisposal string (date) required Date the asset was transferred, sold, or otherwise disposed of.
amountReceived number (float) required Amount actually received from the transfer or sale.
fairMarketValue number (float) required Fair market value of the asset at the time of disposal.
id string (uuid) required read-only
memberId string (uuid) required The household member who disposed of the asset.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/asset-disposals/{assetDisposalId} Get asset disposal
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

assetDisposalId string path ✓

Unique identifier of the asset disposal record.

Responses
200 Asset disposal record retrieved.
▶ AssetDisposal
▶ type AssetType The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
No additional fields
typeOther string Free-text description when type is other.
dateOfDisposal string (date) required Date the asset was transferred, sold, or otherwise disposed of.
amountReceived number (float) required Amount actually received from the transfer or sale.
fairMarketValue number (float) required Fair market value of the asset at the time of disposal.
id string (uuid) required read-only
memberId string (uuid) required The household member who disposed of the asset.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId}/asset-disposals/{assetDisposalId} Update asset disposal
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

assetDisposalId string path ✓

Unique identifier of the asset disposal record.

Request body required
▶ AssetDisposalUpdate
▶ type AssetType The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
No additional fields
typeOther string Free-text description when type is other.
dateOfDisposal string (date) required Date the asset was transferred, sold, or otherwise disposed of.
amountReceived number (float) required Amount actually received from the transfer or sale.
fairMarketValue number (float) required Fair market value of the asset at the time of disposal.
Responses
200 Asset disposal record updated.
▶ AssetDisposal
▶ type AssetType The category of asset. liquid (cash, checking, savings) is counted in the SNAP resource test (7 CFR § 273.8) and expedited screening resource threshold. vehicle and real_property treatment varies by program and state policy. retirement_account treatment depends on whether the account is accessible. insurance includes life insurance policies with cash value.
No additional fields
typeOther string Free-text description when type is other.
dateOfDisposal string (date) required Date the asset was transferred, sold, or otherwise disposed of.
amountReceived number (float) required Amount actually received from the transfer or sale.
fairMarketValue number (float) required Fair market value of the asset at the time of disposal.
id string (uuid) required read-only
memberId string (uuid) required The household member who disposed of the asset.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ DELETE /applications/{applicationId}/asset-disposals/{assetDisposalId} Delete asset disposal
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

assetDisposalId string path ✓

Unique identifier of the asset disposal record.

Responses
204 Asset disposal record deleted.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.

Expenses

Expense records for an application.

▶ GET /applications/{applicationId}/expenses List expenses

Retrieve expense records for an application. Filter by memberId to scope to a single member.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
memberId string query

Filter records by the household member they belong to.

Responses
200 A paginated list of expense records.
▶ ExpenseList
total integer required Total number of items available.
limit integer required Maximum number of items requested.
offset integer required Number of items skipped before the current page.
hasNext boolean Whether more items are available beyond the current page.
▶ items array[Expense] required
▶ type ExpenseType The category of expense. rent and mortgage are used in the SNAP excess shelter deduction (7 CFR § 273.9(d)(6)). dependent_care covers childcare and adult dependent care deductible under 7 CFR § 273.9(d)(4). medical covers out-of-pocket medical expenses for elderly or disabled members (7 CFR § 273.9(d)(3)). child_support covers legally obligated child support payments (7 CFR § 273.9(d)(5)).
No additional fields
typeOther string Free-text description when type is other.
amount number (float) required The expense amount.
legallyObligatedAmount number (float) The legally obligated portion of the expense. Used for child support deductions — only the legally obligated amount is deductible for SNAP (7 CFR § 273.9(d)(5)).
id string (uuid) required read-only
memberId string (uuid) required The household member this expense record belongs to.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/expenses Add expense
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Request body required
▶ ExpenseCreate
▶ type ExpenseType The category of expense. rent and mortgage are used in the SNAP excess shelter deduction (7 CFR § 273.9(d)(6)). dependent_care covers childcare and adult dependent care deductible under 7 CFR § 273.9(d)(4). medical covers out-of-pocket medical expenses for elderly or disabled members (7 CFR § 273.9(d)(3)). child_support covers legally obligated child support payments (7 CFR § 273.9(d)(5)).
No additional fields
typeOther string Free-text description when type is other.
amount number (float) required The expense amount.
legallyObligatedAmount number (float) The legally obligated portion of the expense. Used for child support deductions — only the legally obligated amount is deductible for SNAP (7 CFR § 273.9(d)(5)).
id string (uuid) The new record's id, a UUID (RFC 9562).
memberId string (uuid) required The household member this expense record belongs to.
Responses
201 Expense record created.
▶ Expense
▶ type ExpenseType The category of expense. rent and mortgage are used in the SNAP excess shelter deduction (7 CFR § 273.9(d)(6)). dependent_care covers childcare and adult dependent care deductible under 7 CFR § 273.9(d)(4). medical covers out-of-pocket medical expenses for elderly or disabled members (7 CFR § 273.9(d)(3)). child_support covers legally obligated child support payments (7 CFR § 273.9(d)(5)).
No additional fields
typeOther string Free-text description when type is other.
amount number (float) required The expense amount.
legallyObligatedAmount number (float) The legally obligated portion of the expense. Used for child support deductions — only the legally obligated amount is deductible for SNAP (7 CFR § 273.9(d)(5)).
id string (uuid) required read-only
memberId string (uuid) required The household member this expense record belongs to.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/expenses/{expenseId} Get expense
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

expenseId string path ✓

Unique identifier of the expense record.

Responses
200 Expense record retrieved.
▶ Expense
▶ type ExpenseType The category of expense. rent and mortgage are used in the SNAP excess shelter deduction (7 CFR § 273.9(d)(6)). dependent_care covers childcare and adult dependent care deductible under 7 CFR § 273.9(d)(4). medical covers out-of-pocket medical expenses for elderly or disabled members (7 CFR § 273.9(d)(3)). child_support covers legally obligated child support payments (7 CFR § 273.9(d)(5)).
No additional fields
typeOther string Free-text description when type is other.
amount number (float) required The expense amount.
legallyObligatedAmount number (float) The legally obligated portion of the expense. Used for child support deductions — only the legally obligated amount is deductible for SNAP (7 CFR § 273.9(d)(5)).
id string (uuid) required read-only
memberId string (uuid) required The household member this expense record belongs to.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId}/expenses/{expenseId} Update expense
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

expenseId string path ✓

Unique identifier of the expense record.

Request body required
▶ ExpenseUpdate
▶ type ExpenseType The category of expense. rent and mortgage are used in the SNAP excess shelter deduction (7 CFR § 273.9(d)(6)). dependent_care covers childcare and adult dependent care deductible under 7 CFR § 273.9(d)(4). medical covers out-of-pocket medical expenses for elderly or disabled members (7 CFR § 273.9(d)(3)). child_support covers legally obligated child support payments (7 CFR § 273.9(d)(5)).
No additional fields
typeOther string Free-text description when type is other.
amount number (float) required The expense amount.
legallyObligatedAmount number (float) The legally obligated portion of the expense. Used for child support deductions — only the legally obligated amount is deductible for SNAP (7 CFR § 273.9(d)(5)).
Responses
200 Expense record updated.
▶ Expense
▶ type ExpenseType The category of expense. rent and mortgage are used in the SNAP excess shelter deduction (7 CFR § 273.9(d)(6)). dependent_care covers childcare and adult dependent care deductible under 7 CFR § 273.9(d)(4). medical covers out-of-pocket medical expenses for elderly or disabled members (7 CFR § 273.9(d)(3)). child_support covers legally obligated child support payments (7 CFR § 273.9(d)(5)).
No additional fields
typeOther string Free-text description when type is other.
amount number (float) required The expense amount.
legallyObligatedAmount number (float) The legally obligated portion of the expense. Used for child support deductions — only the legally obligated amount is deductible for SNAP (7 CFR § 273.9(d)(5)).
id string (uuid) required read-only
memberId string (uuid) required The household member this expense record belongs to.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ DELETE /applications/{applicationId}/expenses/{expenseId} Delete expense
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

expenseId string path ✓

Unique identifier of the expense record.

Responses
204 Expense record deleted.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.

Disability Benefits

SSI/SSDI disability benefit records for an application.

▶ GET /applications/{applicationId}/disability-benefits List disability benefits

Retrieve disability benefit records for an application. Filter by memberId to scope to a single member.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
memberId string query

Filter records by the household member they belong to.

Responses
200 A paginated list of disability benefit records.
▶ DisabilityBenefitList
total integer required Total number of items available.
limit integer required Maximum number of items requested.
offset integer required Number of items skipped before the current page.
hasNext boolean Whether more items are available beyond the current page.
▶ items array[DisabilityBenefit] required
programType enum Whether this is a Supplemental Security Income (SSI) or Social Security Disability Insurance (SSDI) benefit.
enumssi ssdi
status enum Current status of the SSA benefit application or award.
enumpending approved active ended denied appealed
applicationDate string (date) Date the SSA benefit application was filed.
startDate string (date) Date benefit payments began or are expected to begin.
endDate string (date) Date benefit payments ended, if applicable.
id string (uuid) required read-only
memberId string (uuid) required The household member with this disability benefit.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/disability-benefits Add disability benefit
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Request body required
▶ DisabilityBenefitCreate
programType enum Whether this is a Supplemental Security Income (SSI) or Social Security Disability Insurance (SSDI) benefit.
enumssi ssdi
status enum Current status of the SSA benefit application or award.
enumpending approved active ended denied appealed
applicationDate string (date) Date the SSA benefit application was filed.
startDate string (date) Date benefit payments began or are expected to begin.
endDate string (date) Date benefit payments ended, if applicable.
id string (uuid) The new record's id, a UUID (RFC 9562).
memberId string (uuid) required The household member with this disability benefit.
Responses
201 Disability benefit record created.
▶ DisabilityBenefit
programType enum Whether this is a Supplemental Security Income (SSI) or Social Security Disability Insurance (SSDI) benefit.
enumssi ssdi
status enum Current status of the SSA benefit application or award.
enumpending approved active ended denied appealed
applicationDate string (date) Date the SSA benefit application was filed.
startDate string (date) Date benefit payments began or are expected to begin.
endDate string (date) Date benefit payments ended, if applicable.
id string (uuid) required read-only
memberId string (uuid) required The household member with this disability benefit.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/disability-benefits/{disabilityBenefitId} Get disability benefit
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

disabilityBenefitId string path ✓

Unique identifier of the disability benefit record.

Responses
200 Disability benefit record retrieved.
▶ DisabilityBenefit
programType enum Whether this is a Supplemental Security Income (SSI) or Social Security Disability Insurance (SSDI) benefit.
enumssi ssdi
status enum Current status of the SSA benefit application or award.
enumpending approved active ended denied appealed
applicationDate string (date) Date the SSA benefit application was filed.
startDate string (date) Date benefit payments began or are expected to begin.
endDate string (date) Date benefit payments ended, if applicable.
id string (uuid) required read-only
memberId string (uuid) required The household member with this disability benefit.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId}/disability-benefits/{disabilityBenefitId} Update disability benefit
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

disabilityBenefitId string path ✓

Unique identifier of the disability benefit record.

Request body required
▶ DisabilityBenefitUpdate
programType enum Whether this is a Supplemental Security Income (SSI) or Social Security Disability Insurance (SSDI) benefit.
enumssi ssdi
status enum Current status of the SSA benefit application or award.
enumpending approved active ended denied appealed
applicationDate string (date) Date the SSA benefit application was filed.
startDate string (date) Date benefit payments began or are expected to begin.
endDate string (date) Date benefit payments ended, if applicable.
Responses
200 Disability benefit record updated.
▶ DisabilityBenefit
programType enum Whether this is a Supplemental Security Income (SSI) or Social Security Disability Insurance (SSDI) benefit.
enumssi ssdi
status enum Current status of the SSA benefit application or award.
enumpending approved active ended denied appealed
applicationDate string (date) Date the SSA benefit application was filed.
startDate string (date) Date benefit payments began or are expected to begin.
endDate string (date) Date benefit payments ended, if applicable.
id string (uuid) required read-only
memberId string (uuid) required The household member with this disability benefit.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ DELETE /applications/{applicationId}/disability-benefits/{disabilityBenefitId} Delete disability benefit
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

disabilityBenefitId string path ✓

Unique identifier of the disability benefit record.

Responses
204 Disability benefit record deleted.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.

Deductions

Above-the-line tax deduction records for an application.

▶ GET /applications/{applicationId}/deductions List deductions

Retrieve deduction records for an application. Filter by memberId to scope to a single member.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
memberId string query

Filter records by the household member they belong to.

Responses
200 A paginated list of deduction records.
▶ DeductionList
total integer required Total number of items available.
limit integer required Maximum number of items requested.
offset integer required Number of items skipped before the current page.
hasNext boolean Whether more items are available beyond the current page.
▶ items array[Deduction] required
▶ type DeductionType The type of above-the-line income deduction. Used in MAGI calculations for Medicaid and CHIP (42 CFR § 435.603).
No additional fields
typeOther string Free-text description when type is other.
▶ frequency DeductionFrequency How often the deduction occurs.
No additional fields
amount number (float) required The deduction amount for the given frequency period.
annualAmount number (float) The total annual deduction amount. Used when frequency is variable or one_time_only.
id string (uuid) required read-only
memberId string (uuid) required The household member claiming this deduction.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/deductions Add deduction
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Request body required
▶ DeductionCreate
▶ type DeductionType The type of above-the-line income deduction. Used in MAGI calculations for Medicaid and CHIP (42 CFR § 435.603).
No additional fields
typeOther string Free-text description when type is other.
▶ frequency DeductionFrequency How often the deduction occurs.
No additional fields
amount number (float) required The deduction amount for the given frequency period.
annualAmount number (float) The total annual deduction amount. Used when frequency is variable or one_time_only.
id string (uuid) The new record's id, a UUID (RFC 9562).
memberId string (uuid) required The household member claiming this deduction.
Responses
201 Deduction record created.
▶ Deduction
▶ type DeductionType The type of above-the-line income deduction. Used in MAGI calculations for Medicaid and CHIP (42 CFR § 435.603).
No additional fields
typeOther string Free-text description when type is other.
▶ frequency DeductionFrequency How often the deduction occurs.
No additional fields
amount number (float) required The deduction amount for the given frequency period.
annualAmount number (float) The total annual deduction amount. Used when frequency is variable or one_time_only.
id string (uuid) required read-only
memberId string (uuid) required The household member claiming this deduction.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/deductions/{deductionId} Get deduction
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

deductionId string path ✓

Unique identifier of the deduction record.

Responses
200 Deduction record retrieved.
▶ Deduction
▶ type DeductionType The type of above-the-line income deduction. Used in MAGI calculations for Medicaid and CHIP (42 CFR § 435.603).
No additional fields
typeOther string Free-text description when type is other.
▶ frequency DeductionFrequency How often the deduction occurs.
No additional fields
amount number (float) required The deduction amount for the given frequency period.
annualAmount number (float) The total annual deduction amount. Used when frequency is variable or one_time_only.
id string (uuid) required read-only
memberId string (uuid) required The household member claiming this deduction.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId}/deductions/{deductionId} Update deduction
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

deductionId string path ✓

Unique identifier of the deduction record.

Request body required
▶ DeductionUpdate
▶ type DeductionType The type of above-the-line income deduction. Used in MAGI calculations for Medicaid and CHIP (42 CFR § 435.603).
No additional fields
typeOther string Free-text description when type is other.
▶ frequency DeductionFrequency How often the deduction occurs.
No additional fields
amount number (float) required The deduction amount for the given frequency period.
annualAmount number (float) The total annual deduction amount. Used when frequency is variable or one_time_only.
Responses
200 Deduction record updated.
▶ Deduction
▶ type DeductionType The type of above-the-line income deduction. Used in MAGI calculations for Medicaid and CHIP (42 CFR § 435.603).
No additional fields
typeOther string Free-text description when type is other.
▶ frequency DeductionFrequency How often the deduction occurs.
No additional fields
amount number (float) required The deduction amount for the given frequency period.
annualAmount number (float) The total annual deduction amount. Used when frequency is variable or one_time_only.
id string (uuid) required read-only
memberId string (uuid) required The household member claiming this deduction.
applicationId string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ DELETE /applications/{applicationId}/deductions/{deductionId} Delete deduction
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

deductionId string path ✓

Unique identifier of the deduction record.

Responses
204 Deduction record deleted.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.

Verifications

Application verification obligations — electronic check results and document evidence.

▶ GET /applications/{applicationId}/verifications List application verifications

Retrieve all verification obligations for a specific application.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
Responses
200 A paginated list of application verifications.
▶ VerificationList
total integer required Total number of items available.
limit integer required Maximum number of items requested.
offset integer required Number of items skipped before the current page.
hasNext boolean Whether more items are available beyond the current page.
▶ items array[Verification] required
applicationId string (uuid) read-only
status enum read-only Current status of the verification obligation.
enumpending inconclusive satisfied waived cannot_verify
▶ evidence array[VerificationEvidenceItem] read-only Electronic and document evidence items accumulated against this obligation.
▶ (one of) VerificationEvidenceItem
▶ VerificationElectronicEvidence
type enum required
enumelectronic
source enum required The external service that produced this result.
enumfdsh_fti fdsh_ssa fdsh_vlp irs_ievs save ssa_ievs swica uib
result enum required Whether the service check confirmed the obligation.
enumconclusive error inconclusive partial
serviceCallId string (uuid) ID of the data-exchange service call that produced this result.
receivedAt string (date-time) required When the result was received.
reviewedAt string (date-time) When a caseworker reviewed and accepted the electronic result.
reviewedBy string (uuid) ID of the caseworker who accepted the electronic result.
▶ VerificationDocumentEvidence
type enum required
enumdocument
documentId string (uuid) required ID of the verified document in the document-management domain.
receivedAt string (date-time) required When the document was received.
reviewedAt string (date-time) When a caseworker reviewed the document.
reviewedBy string (uuid) ID of the caseworker who reviewed the document.
▶ documentRequests array[VerificationDocumentRequest] read-only Outbound document request notices sent to the applicant for this obligation.
noticeId string (uuid) required ID of the notice in the communication domain.
type enum required Template identifier for the notice. Matches the type field on the communication.notice.sent event.
enumdocument_request_citizenship_verification document_request_identity_verification document_request_immigration_verification document_request_income_verification document_request_residency_verification
sentAt string (date-time) required When the notice was sent.
dueAt string (date-time) Deadline by which the applicant must respond.
channel string Channel through which the notice was sent.
enumemail in_person mail portal null
sourceId string (uuid) ID of the subject being verified. Points to an ApplicationMember when sourceType is `member`, or to an income record when sourceType is `income`. Null for household-level obligations (e.g., proof of residency).
sourceType string Identifies what sourceId refers to. Required when sourceId is set; null for household-level obligations.
enummember income
category enum Verification obligation category.
enumcitizenship identity immigration income residency
verificationType enum How this verification obligation is to be fulfilled.
enumdocument electronic
reviewedAt string (date-time) read-only When a caseworker accepted this verification obligation.
reviewedBy string (uuid) read-only ID of the caseworker who accepted this verification obligation.
id string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ POST /applications/{applicationId}/verifications Create a verification obligation

Create a verification obligation scoped to this application. Under normal circumstances verifications are created by the rules engine at submission; this endpoint supports caseworker-initiated obligations.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Request body required
▶ VerificationCreate
applicationId string (uuid) read-only
status enum read-only Current status of the verification obligation.
enumpending inconclusive satisfied waived cannot_verify
▶ evidence array[VerificationEvidenceItem] read-only Electronic and document evidence items accumulated against this obligation.
▶ (one of) VerificationEvidenceItem
▶ VerificationElectronicEvidence
type enum required
enumelectronic
source enum required The external service that produced this result.
enumfdsh_fti fdsh_ssa fdsh_vlp irs_ievs save ssa_ievs swica uib
result enum required Whether the service check confirmed the obligation.
enumconclusive error inconclusive partial
serviceCallId string (uuid) ID of the data-exchange service call that produced this result.
receivedAt string (date-time) required When the result was received.
reviewedAt string (date-time) When a caseworker reviewed and accepted the electronic result.
reviewedBy string (uuid) ID of the caseworker who accepted the electronic result.
▶ VerificationDocumentEvidence
type enum required
enumdocument
documentId string (uuid) required ID of the verified document in the document-management domain.
receivedAt string (date-time) required When the document was received.
reviewedAt string (date-time) When a caseworker reviewed the document.
reviewedBy string (uuid) ID of the caseworker who reviewed the document.
▶ documentRequests array[VerificationDocumentRequest] read-only Outbound document request notices sent to the applicant for this obligation.
noticeId string (uuid) required ID of the notice in the communication domain.
type enum required Template identifier for the notice. Matches the type field on the communication.notice.sent event.
enumdocument_request_citizenship_verification document_request_identity_verification document_request_immigration_verification document_request_income_verification document_request_residency_verification
sentAt string (date-time) required When the notice was sent.
dueAt string (date-time) Deadline by which the applicant must respond.
channel string Channel through which the notice was sent.
enumemail in_person mail portal null
sourceId string (uuid) ID of the subject being verified. Points to an ApplicationMember when sourceType is `member`, or to an income record when sourceType is `income`. Null for household-level obligations (e.g., proof of residency).
sourceType string Identifies what sourceId refers to. Required when sourceId is set; null for household-level obligations.
enummember income
category enum Verification obligation category.
enumcitizenship identity immigration income residency
verificationType enum How this verification obligation is to be fulfilled.
enumdocument electronic
reviewedAt string (date-time) read-only When a caseworker accepted this verification obligation.
reviewedBy string (uuid) read-only ID of the caseworker who accepted this verification obligation.
id string (uuid) The new record's id, a UUID (RFC 9562).
Responses
201 Verification created successfully.
▶ Verification
applicationId string (uuid) read-only
status enum read-only Current status of the verification obligation.
enumpending inconclusive satisfied waived cannot_verify
▶ evidence array[VerificationEvidenceItem] read-only Electronic and document evidence items accumulated against this obligation.
▶ (one of) VerificationEvidenceItem
▶ VerificationElectronicEvidence
type enum required
enumelectronic
source enum required The external service that produced this result.
enumfdsh_fti fdsh_ssa fdsh_vlp irs_ievs save ssa_ievs swica uib
result enum required Whether the service check confirmed the obligation.
enumconclusive error inconclusive partial
serviceCallId string (uuid) ID of the data-exchange service call that produced this result.
receivedAt string (date-time) required When the result was received.
reviewedAt string (date-time) When a caseworker reviewed and accepted the electronic result.
reviewedBy string (uuid) ID of the caseworker who accepted the electronic result.
▶ VerificationDocumentEvidence
type enum required
enumdocument
documentId string (uuid) required ID of the verified document in the document-management domain.
receivedAt string (date-time) required When the document was received.
reviewedAt string (date-time) When a caseworker reviewed the document.
reviewedBy string (uuid) ID of the caseworker who reviewed the document.
▶ documentRequests array[VerificationDocumentRequest] read-only Outbound document request notices sent to the applicant for this obligation.
noticeId string (uuid) required ID of the notice in the communication domain.
type enum required Template identifier for the notice. Matches the type field on the communication.notice.sent event.
enumdocument_request_citizenship_verification document_request_identity_verification document_request_immigration_verification document_request_income_verification document_request_residency_verification
sentAt string (date-time) required When the notice was sent.
dueAt string (date-time) Deadline by which the applicant must respond.
channel string Channel through which the notice was sent.
enumemail in_person mail portal null
sourceId string (uuid) ID of the subject being verified. Points to an ApplicationMember when sourceType is `member`, or to an income record when sourceType is `income`. Null for household-level obligations (e.g., proof of residency).
sourceType string Identifies what sourceId refers to. Required when sourceId is set; null for household-level obligations.
enummember income
category enum Verification obligation category.
enumcitizenship identity immigration income residency
verificationType enum How this verification obligation is to be fulfilled.
enumdocument electronic
reviewedAt string (date-time) read-only When a caseworker accepted this verification obligation.
reviewedBy string (uuid) read-only ID of the caseworker who accepted this verification obligation.
id string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/verifications/{verificationId} Get a verification obligation

Retrieve a single verification obligation by identifier.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

verificationId string path ✓

Unique identifier of the verification obligation.

Responses
200 Verification retrieved successfully.
▶ Verification
applicationId string (uuid) read-only
status enum read-only Current status of the verification obligation.
enumpending inconclusive satisfied waived cannot_verify
▶ evidence array[VerificationEvidenceItem] read-only Electronic and document evidence items accumulated against this obligation.
▶ (one of) VerificationEvidenceItem
▶ VerificationElectronicEvidence
type enum required
enumelectronic
source enum required The external service that produced this result.
enumfdsh_fti fdsh_ssa fdsh_vlp irs_ievs save ssa_ievs swica uib
result enum required Whether the service check confirmed the obligation.
enumconclusive error inconclusive partial
serviceCallId string (uuid) ID of the data-exchange service call that produced this result.
receivedAt string (date-time) required When the result was received.
reviewedAt string (date-time) When a caseworker reviewed and accepted the electronic result.
reviewedBy string (uuid) ID of the caseworker who accepted the electronic result.
▶ VerificationDocumentEvidence
type enum required
enumdocument
documentId string (uuid) required ID of the verified document in the document-management domain.
receivedAt string (date-time) required When the document was received.
reviewedAt string (date-time) When a caseworker reviewed the document.
reviewedBy string (uuid) ID of the caseworker who reviewed the document.
▶ documentRequests array[VerificationDocumentRequest] read-only Outbound document request notices sent to the applicant for this obligation.
noticeId string (uuid) required ID of the notice in the communication domain.
type enum required Template identifier for the notice. Matches the type field on the communication.notice.sent event.
enumdocument_request_citizenship_verification document_request_identity_verification document_request_immigration_verification document_request_income_verification document_request_residency_verification
sentAt string (date-time) required When the notice was sent.
dueAt string (date-time) Deadline by which the applicant must respond.
channel string Channel through which the notice was sent.
enumemail in_person mail portal null
sourceId string (uuid) ID of the subject being verified. Points to an ApplicationMember when sourceType is `member`, or to an income record when sourceType is `income`. Null for household-level obligations (e.g., proof of residency).
sourceType string Identifies what sourceId refers to. Required when sourceId is set; null for household-level obligations.
enummember income
category enum Verification obligation category.
enumcitizenship identity immigration income residency
verificationType enum How this verification obligation is to be fulfilled.
enumdocument electronic
reviewedAt string (date-time) read-only When a caseworker accepted this verification obligation.
reviewedBy string (uuid) read-only ID of the caseworker who accepted this verification obligation.
id string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId}/verifications/{verificationId} Update a verification obligation

Apply partial updates to a verification obligation.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

verificationId string path ✓

Unique identifier of the verification obligation.

Request body required
▶ VerificationUpdate
applicationId string (uuid) read-only
status enum read-only Current status of the verification obligation.
enumpending inconclusive satisfied waived cannot_verify
▶ evidence array[VerificationEvidenceItem] read-only Electronic and document evidence items accumulated against this obligation.
▶ (one of) VerificationEvidenceItem
▶ VerificationElectronicEvidence
type enum required
enumelectronic
source enum required The external service that produced this result.
enumfdsh_fti fdsh_ssa fdsh_vlp irs_ievs save ssa_ievs swica uib
result enum required Whether the service check confirmed the obligation.
enumconclusive error inconclusive partial
serviceCallId string (uuid) ID of the data-exchange service call that produced this result.
receivedAt string (date-time) required When the result was received.
reviewedAt string (date-time) When a caseworker reviewed and accepted the electronic result.
reviewedBy string (uuid) ID of the caseworker who accepted the electronic result.
▶ VerificationDocumentEvidence
type enum required
enumdocument
documentId string (uuid) required ID of the verified document in the document-management domain.
receivedAt string (date-time) required When the document was received.
reviewedAt string (date-time) When a caseworker reviewed the document.
reviewedBy string (uuid) ID of the caseworker who reviewed the document.
▶ documentRequests array[VerificationDocumentRequest] read-only Outbound document request notices sent to the applicant for this obligation.
noticeId string (uuid) required ID of the notice in the communication domain.
type enum required Template identifier for the notice. Matches the type field on the communication.notice.sent event.
enumdocument_request_citizenship_verification document_request_identity_verification document_request_immigration_verification document_request_income_verification document_request_residency_verification
sentAt string (date-time) required When the notice was sent.
dueAt string (date-time) Deadline by which the applicant must respond.
channel string Channel through which the notice was sent.
enumemail in_person mail portal null
sourceId string (uuid) ID of the subject being verified. Points to an ApplicationMember when sourceType is `member`, or to an income record when sourceType is `income`. Null for household-level obligations (e.g., proof of residency).
sourceType string Identifies what sourceId refers to. Required when sourceId is set; null for household-level obligations.
enummember income
category enum Verification obligation category.
enumcitizenship identity immigration income residency
verificationType enum How this verification obligation is to be fulfilled.
enumdocument electronic
reviewedAt string (date-time) read-only When a caseworker accepted this verification obligation.
reviewedBy string (uuid) read-only ID of the caseworker who accepted this verification obligation.
Responses
200 Verification updated successfully.
▶ Verification
applicationId string (uuid) read-only
status enum read-only Current status of the verification obligation.
enumpending inconclusive satisfied waived cannot_verify
▶ evidence array[VerificationEvidenceItem] read-only Electronic and document evidence items accumulated against this obligation.
▶ (one of) VerificationEvidenceItem
▶ VerificationElectronicEvidence
type enum required
enumelectronic
source enum required The external service that produced this result.
enumfdsh_fti fdsh_ssa fdsh_vlp irs_ievs save ssa_ievs swica uib
result enum required Whether the service check confirmed the obligation.
enumconclusive error inconclusive partial
serviceCallId string (uuid) ID of the data-exchange service call that produced this result.
receivedAt string (date-time) required When the result was received.
reviewedAt string (date-time) When a caseworker reviewed and accepted the electronic result.
reviewedBy string (uuid) ID of the caseworker who accepted the electronic result.
▶ VerificationDocumentEvidence
type enum required
enumdocument
documentId string (uuid) required ID of the verified document in the document-management domain.
receivedAt string (date-time) required When the document was received.
reviewedAt string (date-time) When a caseworker reviewed the document.
reviewedBy string (uuid) ID of the caseworker who reviewed the document.
▶ documentRequests array[VerificationDocumentRequest] read-only Outbound document request notices sent to the applicant for this obligation.
noticeId string (uuid) required ID of the notice in the communication domain.
type enum required Template identifier for the notice. Matches the type field on the communication.notice.sent event.
enumdocument_request_citizenship_verification document_request_identity_verification document_request_immigration_verification document_request_income_verification document_request_residency_verification
sentAt string (date-time) required When the notice was sent.
dueAt string (date-time) Deadline by which the applicant must respond.
channel string Channel through which the notice was sent.
enumemail in_person mail portal null
sourceId string (uuid) ID of the subject being verified. Points to an ApplicationMember when sourceType is `member`, or to an income record when sourceType is `income`. Null for household-level obligations (e.g., proof of residency).
sourceType string Identifies what sourceId refers to. Required when sourceId is set; null for household-level obligations.
enummember income
category enum Verification obligation category.
enumcitizenship identity immigration income residency
verificationType enum How this verification obligation is to be fulfilled.
enumdocument electronic
reviewedAt string (date-time) read-only When a caseworker accepted this verification obligation.
reviewedBy string (uuid) read-only ID of the caseworker who accepted this verification obligation.
id string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ DELETE /applications/{applicationId}/verifications/{verificationId} Delete a verification obligation

Remove a verification obligation from this application.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

verificationId string path ✓

Unique identifier of the verification obligation.

Responses
204 Verification deleted successfully.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
409 A conflict occurred with the current state of the resource.
▶ Conflict
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.

Interviews

SNAP interview obligation tracking.

▶ GET /applications/{applicationId}/interview Get the interview

Retrieve the SNAP interview obligation record for this application.

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Responses
200 Interview retrieved successfully.
▶ Interview
applicationId string (uuid) read-only
appointments array[string] read-only Appointment IDs from the scheduling domain accumulated for this interview obligation. Populated by the rules engine when scheduling.appointment.created fires.
waiverStatus enum Status of the interview waiver for this applicant.
enumpending granted denied
waiverReason string Reason the interview was waived. Required when waiverStatus is granted; used for audit and supervisory review.
completedAt string (date-time) When the caseworker attested the interview obligation was satisfied. Absent until completed.
id string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId}/interview Update the interview

Apply partial updates to the interview record (e.g., set waiverGranted, record completedAt).

Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

Request body required
▶ InterviewUpdate
applicationId string (uuid) read-only
appointments array[string] read-only Appointment IDs from the scheduling domain accumulated for this interview obligation. Populated by the rules engine when scheduling.appointment.created fires.
waiverStatus enum Status of the interview waiver for this applicant.
enumpending granted denied
waiverReason string Reason the interview was waived. Required when waiverStatus is granted; used for audit and supervisory review.
completedAt string (date-time) When the caseworker attested the interview obligation was satisfied. Absent until completed.
Responses
200 Interview updated successfully.
▶ Interview
applicationId string (uuid) read-only
appointments array[string] read-only Appointment IDs from the scheduling domain accumulated for this interview obligation. Populated by the rules engine when scheduling.appointment.created fires.
waiverStatus enum Status of the interview waiver for this applicant.
enumpending granted denied
waiverReason string Reason the interview was waived. Required when waiverStatus is granted; used for audit and supervisory review.
completedAt string (date-time) When the caseworker attested the interview obligation was satisfied. Absent until completed.
id string (uuid) required read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.

Review

▶ GET /applications/{applicationId}/review/demographics Get applicationReview demographics section panel
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
Responses
200 applicationReview demographics section panel retrieved successfully.
▶ ApplicationReviewSectionResponse
object
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/review/identity Get applicationReview identity section panel
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
Responses
200 applicationReview identity section panel retrieved successfully.
▶ ApplicationReviewSectionResponse
object
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/review/income Get applicationReview income section panel
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
Responses
200 applicationReview income section panel retrieved successfully.
▶ ApplicationReviewSectionResponse
object
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/review/employment Get applicationReview employment section panel
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
Responses
200 applicationReview employment section panel retrieved successfully.
▶ ApplicationReviewSectionResponse
object
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/review/health-coverage Get applicationReview health-coverage section panel
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
Responses
200 applicationReview health-coverage section panel retrieved successfully.
▶ ApplicationReviewSectionResponse
object
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/review/assets Get applicationReview assets section panel
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
Responses
200 applicationReview assets section panel retrieved successfully.
▶ ApplicationReviewSectionResponse
object
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/review/contact Get applicationReview contact section panel
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
Responses
200 applicationReview contact section panel retrieved successfully.
▶ ApplicationReviewSectionResponse
object
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/review/expenses Get applicationReview expenses section panel
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
Responses
200 applicationReview expenses section panel retrieved successfully.
▶ ApplicationReviewSectionResponse
object
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/review/household Get applicationReview household section panel
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
Responses
200 applicationReview household section panel retrieved successfully.
▶ ApplicationReviewSectionResponse
object
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.

Review Progress

▶ GET /applications/{applicationId}/review-progress/{section} List ReviewProgress state records for a section
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

section string path ✓

Section name within the sectionView composition.

▶q string query Search query using field:value syntax. Multiple conditions separated by
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
Responses
200
▶ ReviewProgressListResponse
▶ items array[ReviewProgress] required
status enum Caseworker review status for this section. Initialized to not_started when the application transitions to under_review.
enumnot_started in_progress complete flagged
notes object Caseworker notes for this review section. Updated via PATCH on the section state endpoint. additionalProperties: true allows states to extend with visibility controls, note types, or other fields via overlay.
text string Note content.
textFormat enum Rendering format for the note text. plain: literal text. markdown: rendered as Markdown. html: rendered as HTML.
enumplain markdown html
id string (uuid) required read-only
section enum required read-only
enumdemographics identity income employment health-coverage assets contact expenses household
itemId string (uuid) read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
total integer required
limit integer required
offset integer required
hasNext boolean required
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PUT /applications/{applicationId}/review-progress/{section} Replace ReviewProgress state for a section
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

section string path ✓

Section name within the sectionView composition.

Request body required
▶ ReviewProgressWritable
status enum Caseworker review status for this section. Initialized to not_started when the application transitions to under_review.
enumnot_started in_progress complete flagged
notes object Caseworker notes for this review section. Updated via PATCH on the section state endpoint. additionalProperties: true allows states to extend with visibility controls, note types, or other fields via overlay.
text string Note content.
textFormat enum Rendering format for the note text. plain: literal text. markdown: rendered as Markdown. html: rendered as HTML.
enumplain markdown html
Responses
200
▶ ReviewProgress
status enum Caseworker review status for this section. Initialized to not_started when the application transitions to under_review.
enumnot_started in_progress complete flagged
notes object Caseworker notes for this review section. Updated via PATCH on the section state endpoint. additionalProperties: true allows states to extend with visibility controls, note types, or other fields via overlay.
text string Note content.
textFormat enum Rendering format for the note text. plain: literal text. markdown: rendered as Markdown. html: rendered as HTML.
enumplain markdown html
id string (uuid) required read-only
section enum required read-only
enumdemographics identity income employment health-coverage assets contact expenses household
itemId string (uuid) read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId}/review-progress/{section} Update ReviewProgress state for a section
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

section string path ✓

Section name within the sectionView composition.

Request body required
▶ ReviewProgressWritable
status enum Caseworker review status for this section. Initialized to not_started when the application transitions to under_review.
enumnot_started in_progress complete flagged
notes object Caseworker notes for this review section. Updated via PATCH on the section state endpoint. additionalProperties: true allows states to extend with visibility controls, note types, or other fields via overlay.
text string Note content.
textFormat enum Rendering format for the note text. plain: literal text. markdown: rendered as Markdown. html: rendered as HTML.
enumplain markdown html
Responses
200
▶ ReviewProgress
status enum Caseworker review status for this section. Initialized to not_started when the application transitions to under_review.
enumnot_started in_progress complete flagged
notes object Caseworker notes for this review section. Updated via PATCH on the section state endpoint. additionalProperties: true allows states to extend with visibility controls, note types, or other fields via overlay.
text string Note content.
textFormat enum Rendering format for the note text. plain: literal text. markdown: rendered as Markdown. html: rendered as HTML.
enumplain markdown html
id string (uuid) required read-only
section enum required read-only
enumdemographics identity income employment health-coverage assets contact expenses household
itemId string (uuid) read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /applications/{applicationId}/review-progress/{section}/{itemId} Get ReviewProgress state for a collection item
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

section string path ✓

Section name within the sectionView composition.

itemId string path ✓

Item identifier for collection-backed sections.

Responses
200
▶ ReviewProgress
status enum Caseworker review status for this section. Initialized to not_started when the application transitions to under_review.
enumnot_started in_progress complete flagged
notes object Caseworker notes for this review section. Updated via PATCH on the section state endpoint. additionalProperties: true allows states to extend with visibility controls, note types, or other fields via overlay.
text string Note content.
textFormat enum Rendering format for the note text. plain: literal text. markdown: rendered as Markdown. html: rendered as HTML.
enumplain markdown html
id string (uuid) required read-only
section enum required read-only
enumdemographics identity income employment health-coverage assets contact expenses household
itemId string (uuid) read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PUT /applications/{applicationId}/review-progress/{section}/{itemId} Replace ReviewProgress state for a collection item
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

section string path ✓

Section name within the sectionView composition.

itemId string path ✓

Item identifier for collection-backed sections.

Request body required
▶ ReviewProgressWritable
status enum Caseworker review status for this section. Initialized to not_started when the application transitions to under_review.
enumnot_started in_progress complete flagged
notes object Caseworker notes for this review section. Updated via PATCH on the section state endpoint. additionalProperties: true allows states to extend with visibility controls, note types, or other fields via overlay.
text string Note content.
textFormat enum Rendering format for the note text. plain: literal text. markdown: rendered as Markdown. html: rendered as HTML.
enumplain markdown html
Responses
200
▶ ReviewProgress
status enum Caseworker review status for this section. Initialized to not_started when the application transitions to under_review.
enumnot_started in_progress complete flagged
notes object Caseworker notes for this review section. Updated via PATCH on the section state endpoint. additionalProperties: true allows states to extend with visibility controls, note types, or other fields via overlay.
text string Note content.
textFormat enum Rendering format for the note text. plain: literal text. markdown: rendered as Markdown. html: rendered as HTML.
enumplain markdown html
id string (uuid) required read-only
section enum required read-only
enumdemographics identity income employment health-coverage assets contact expenses household
itemId string (uuid) read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ PATCH /applications/{applicationId}/review-progress/{section}/{itemId} Update ReviewProgress state for a collection item
Parameters
Name Type In Req Description
applicationId string path ✓

Unique identifier of the application.

section string path ✓

Section name within the sectionView composition.

itemId string path ✓

Item identifier for collection-backed sections.

Request body required
▶ ReviewProgressWritable
status enum Caseworker review status for this section. Initialized to not_started when the application transitions to under_review.
enumnot_started in_progress complete flagged
notes object Caseworker notes for this review section. Updated via PATCH on the section state endpoint. additionalProperties: true allows states to extend with visibility controls, note types, or other fields via overlay.
text string Note content.
textFormat enum Rendering format for the note text. plain: literal text. markdown: rendered as Markdown. html: rendered as HTML.
enumplain markdown html
Responses
200
▶ ReviewProgress
status enum Caseworker review status for this section. Initialized to not_started when the application transitions to under_review.
enumnot_started in_progress complete flagged
notes object Caseworker notes for this review section. Updated via PATCH on the section state endpoint. additionalProperties: true allows states to extend with visibility controls, note types, or other fields via overlay.
text string Note content.
textFormat enum Rendering format for the note text. plain: literal text. markdown: rendered as Markdown. html: rendered as HTML.
enumplain markdown html
id string (uuid) required read-only
section enum required read-only
enumdemographics identity income employment health-coverage assets contact expenses household
itemId string (uuid) read-only
createdAt string (date-time) required read-only
updatedAt string (date-time) required read-only
400 The request is malformed or contains invalid parameters.
▶ BadRequest
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
422 The request was well-formed but contained semantic errors.
▶ UnprocessableEntity
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.