---
title: "Enrich people"
method: POST
path: "/v2/enrich/people"
tags: ["Enrich"]
---

# Enrich people

`POST /v2/enrich/people`

Match people with our database and enrich it with additional information.


**Webhook result:**
[Documentation](/docs/webhooks/enrich_people)

## Query parameters

- `apiToken` string, nullable

## Headers

- `x-api-token` string, nullable

## Request body

- MatchPeopleBody
  - `peopleDataMapping` object, required — A dictionary where each key is a unique user-defined ID for a person, and each value is the data for that person to be enriched. This ID will be included in the webhook response together with the enriched person data, allowing the user to match the response to the original request.
  - `webhookUrl` string, required — Url of the webhook the enriched people should be sent to, when completed.

## Response `200`

Successful Response

- EnrichPeopleResult
  - `status` 'in progress', required — Status of the enrichment request. Always `"in progress"` initially, as enrichment is processed asynchronously in the background. Once completed, results for all people will be sent to the provided webhook.

## Other responses

- `400` — Bad Request
- `402` — Payment Required
- `403` — Forbidden
- `404` — Not found
- `422` — Validation Error

---

[API](https://skmtc.dev/ocean/apis/ocean-io-api-documentation.md) · [All operations](https://skmtc.dev/ocean/apis/ocean-io-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ocean/ocean-io-api-documentation/revisions/a5d5c0530873/schema)