---
title: "Enrich a person record"
method: POST
path: "/"
---

# Enrich a person record

`POST /`

Submit a person record with PII fields and receive Windfall's enriched household and career data in real time.

## Request body

- EnrichmentRequest — A person record to enrich. Provide as many fields as possible for the best match results.
  - `id` string, nullable — Unique identifier from your system of record. Echoed back in the response for correlation.
  - `first_name` string, nullable — First name of the individual.
  - `last_name` string, nullable — Last name of the individual. If you only have a full name, enter it here and leave `first_name` empty.
  - `addresses` Address[] — A list of addresses associated with the individual.
    - `address` string, nullable — Street address. Multiple address lines should be concatenated with a space, e.g. `123 Main St Unit 42`. Can also be a full address if components aren't available separately.
    - `city` string, nullable — City or locality. Should be a locality recognized by the USPS.
    - `state` string, nullable — State abbreviation or full name. When not provided, it may be inferred from the zip code.
    - `zipcode` string, nullable — US or Canadian zip code. Must include at least 5 digits and may optionally include the +4 digits. For best results, always provide a zip code.
  - `emails` string[] — A list of email addresses associated with the individual.
  - `phones` string[] — A list of phone numbers. When a country code is not provided, +1 (United States) is assumed. Formatting is flexible.
  - `company_name` string, nullable — A company name associated with the individual. Used to improve career matching accuracy when multiple people share the same name.

## Response `200`

Enrichment results returned successfully.

- EnrichmentResponse — Enrichment results for the submitted person record.
  - `id` string, nullable — The ID you submitted, echoed back.
  - `household` object, nullable — Enriched household data including Windfall ID, net worth, and confidence score. Only present when a household match is found. Fields vary by account configuration.
  - `career` object, nullable — Career data including LinkedIn URL and confidence score. Only present when a career match is found. Fields vary by account configuration.
  - `household_matched` boolean, required — Whether household attributes were returned.
  - `career_matched` boolean, required — Whether career attributes were returned.

## Other responses

- `400` — Malformed request body. Ensure your JSON is valid.
- `401` — Invalid or missing API token. Check your `X-WF-Auth-Token` header.
- `429` — Rate limit exceeded. Maximum 5 requests per second. Back off and retry after a brief delay.

---

[API](https://skmtc.net/windfall/apis/windfall-api.md) · [All operations](https://skmtc.net/windfall/apis/windfall-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/windfall/windfall-api/revisions/3e69798fe200/schema)