FOfolk
Person enrichments

Enrich people

Changed on

Request an asynchronous enrichment of emails and/or phones for up to 500 people.

post/v1/person-enrichments

Request

  • Base URL
    https://api.folk.app
  • URL
    https://api.folk.app/v1/person-enrichments
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring

A unique key, such as a UUID, that makes retrying this request safe: a retry with the same key and body returns the original response without running the operation again. Keys are kept for 24 hours after the request completes.

Example:8e03978e-40d5-43e8-bc93-6894a57f9324

Request body

fieldsstring[] required

The fields to enrich on each person. Each field can only be requested once.

idsstring[] required

The IDs of the people to enrich, up to 500. Duplicate IDs are enriched once. IDs that don't match a person you can enrich don't reject the request: they are reported as items with the skipped status.

Example request

{
  "fields": [
    "emails",
    "phones"
  ],
  "ids": [
    "per_05834d3b-2c1a-4e5f-8a9b-0c1d2e3f4a5b",
    "per_9a1c7e2f-3b4d-4c5e-9f6a-7b8c9d0e1f2a",
    "per_77be1a2b-4c5d-4e6f-8a7b-9c0d1e2f3a4b"
  ]
}

Response

The enrichment that has been requested.

deprecationsstring[]

Example response

{
  "data": {
    "id": "enr_3f2a6c1e-8b1d-4f0a-9c2e-5d7b8a9e0f11",
    "status": "pending",
    "fields": [
      "emails",
      "phones"
    ],
    "createdAt": "2026-09-23T13:02:36.209Z",
    "finishedAt": null,
    "errorReason": null,
    "summary": null,
    "items": null
  },
  "deprecations": [
    "This field is deprecated"
  ]
}

Changes