Postman Collection for testing the NYC Benefits Screening API maintained by @nycopportunity. Screen clients for benefits at scale or create new benefits screening tools. Send household composition data to eligibility rules for 35+ City, State, and Federal programs including SNAP, Cash Assistance, WIC, HEAP, and more. To learn more about the API view the public documentation at screeningapidocs.cityofnewyork.us.

$1 You will need to have an account for using the API. See getting started for more details.

• You will receive an email for access to the API from [email protected] with a username and verification code that can be used to set your password.

$2 Download Postman if you do not currently have it.

$3 Import the collection and the environment JSON files. The import button can be found in the top left of the application window.

• You may either download or clone a copy of this repository and import the folder.

• Or, import the raw GitHub user content from the following URLs;

  • Collection
  • Environment

• More details on importing collections can be found in the Postman documentation.

$4 Set up the environment. Select the NYC Benefits Screening API environment in the top right corner of the application window and click the 👁️ (eye) button to view, then click edit in the dropdown. Fill in your {{ username }} and {{ password }}. If you haven't set your password yet, you may use the Confirm Password endpoint in the collection to do so. You may also use the Change Password Form in the documentation.

• The {{ domain }} is preset to use the sandbox domain; sandbox.screeningapi.cityofnewyork.us. This should be used for testing requests.

• The production domain is screeningapi.cityofnewyork.us.

The Authentication endpoints are contained at the root of the collection. They will use the environment variables for values in the request body.

The Eligibility directory in the collection has a pre-request script that will reset the token environment variable for each endpoint in the folder. More details about authentication can be found on the Token-based Authentication page.

The Bulk Submission / Import directory contains a basic request and a filtered programs request. The sample_bulk_submission_import.csv included in this repository can be used as a template. In the Body tab of the request, you can click "Select File" to use it.

The Eligibility Programs has a preset Household Composition Data object. It can be modified according to the documentation in the Making a Request page or rebuild using the Request Builder tool.

The Mayor's Office for Economic Opportunity is committed to sharing open-source software that we use in our products. Feel free to ask questions and share feedback. Interested in contributing? See our open positions on buildwithnyc.github.io. Follow our team on GitHub @nycopportunity and @cityofnewyork:nycopportunity or browse our work on Github.