Enrich
Enrich people
Match people with our database and enrich it with additional information.
Webhook result: Documentation
Query Parameters
apiToken?string | null
Header Parameters
x-api-token?string | null
peopleDataMappingobject
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.
Properties
1 <= properties <= 10000Empty Object
webhookUrlstring
Url of the webhook the enriched people should be sent to, when completed.
Example
"https://some-url.com"Response Body
curl -X POST "https://api.ocean.io/v2/enrich/people?apiToken=string" \
-H "x-api-token: string" \
-H "Content-Type: application/json" \
-d '{
"peopleDataMapping": {
"property1": {
"person": {}
},
"property2": {
"person": {}
}
},
"webhookUrl": "https://some-url.com"
}'{
"status": "in progress"
}{
"detail": "Conflicting API tokens provided in query parameters and headers"
}{
"detail": "Insufficient credits"
}{
"detail": "API token should be provided in headers or query parameters"
}Empty
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}