Skip to main content

NYC Benefits Platform | Screening API

Build a Request

Household Data

Enter values into the fields below for the Household Composition Data.


How much cash household has right now in; cash on hand, checking or saving accounts, stocks, bonds, or mutual funds.

Where the household is living right now; whether they own their home, is renting their home, lives in a shelter, etc.

Person Data

Enter values for a person of the household to build the person object. You can add another person below.


The Head of Household is the person who can represent everyone in the family and pays most of the family’s expenses.

Do any of these apply to the person?

Select all of the following that apply.

Does this person recieve either of the following benefits?

Select all of the following that apply.


Does this person have any income?

This includes money from jobs, alimony, investments, or gifts. You will need to include itemized income. The more income included, the more accurate the screening results will be.

Does this person have any expenses?

This includes costs like rent, mortgage, medical bills, child care, child support, and heating bills. You will need to include itemized expenses. The more expenses included, the more accurate the screening results will be.

Data Retention


Household Composition Data

The data above may be shared with City agencies to improve access to benefits and programs. If the following option is checked this data will not be logged into our database. To learn more please view our terms of service.