Skip to content

Product Checklist

This checklist is intended to help you think through key decisions and assumptions before integrating the Recidiviz Resource API with your application.

1. Ensure your application identifies needs

What needs does your application intend to address for clients? Those needs should map to one or more of the Resource Categories. If your application maps these needs dynamically, it can make use of the /api/v0/categories endpoint to retrieve the full list. See the openapi documentation or use the following:

curl -X 'GET' 'https://resource.recidiviz.org/api/v0/categories' \
  -H 'accept: application/json'

If the resource categorizations do not align with your client needs, please reach out to the Resource API team.

2. Explore relevant resources in your geographic area

The API has the capacity to surface new resources from the web, as well as verified resources from the Recidiviz resource team and our partners. Naturally, verified resources are more likely to be of high quality and address client needs. If your product timeline allows, consider:

  • researching high quality resources in your product's geographic area
  • loading verified resources from our partners into the database
  • reviewing or validating newly discovered resources from the API

Depending on your products needs and team capacity, we may be able to identify sufficient coverage of quality resources in your area before the product launch.

3. Plan client resource management

The API provides endpoints to search for resources, but does not retain any information about which resources have been shared with which clients. Your application will need to manage the relationships between clients, their relevant locations, and the resources associated with those locations.