OCocean
Enrich

Enrich people

Changed on

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

Webhook result: Documentation

post/v2/enrich/people

Request

  • Base URL
    https://api.ocean.io
  • URL
    https://api.ocean.io/v2/enrich/people
  • Auth
    none declared

Query parameters

apiTokenstring nullable

Headers

x-api-tokenstring nullable

Request body

peopleDataMappingobject 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.

webhookUrlstring required

Url of the webhook the enriched people should be sent to, when completed.

Example request

{
  "webhookUrl": "https://some-url.com"
}

Response

Successful Response

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.

Example response

{
  "status": "in progress"
}

Changes