Enrich person

POST /v2/enrich/person

Match a person with our database and enrich it with additional information.

Cost: 3 credits

Query parameters

apiToken string Required

application/json

Body Required

person object Required

Additional properties are NOT allowed.
Hide person attributes Show person attributes object
- id string | null
- name string | null
- firstName string | null
- lastName string | null
- jobTitle string | null
- email string | null
- phone string | null
- facebook string | null
- twitter string | null
- linkedin string | null
- country string | null
company object | null

The company to match with

Additional properties are NOT allowed.
Hide company attributes Show company attributes object | null
- name string | null
- registrationNumber string | null
- email string | null
- phone string | null
- countryCode string | null
- state string | null
- city string | null
- streetAddress string | null
- postalCode string | null
- address string | null
- facebook string | null
- twitter string | null
- linkedin string | null
- instagram string | null
- xing string | null
- domain string | null
- youtube string | null
revealEmails object | null

Additional properties are NOT allowed.
Hide revealEmails attributes Show revealEmails attributes object | null
- includeEmails boolean
  
  Include the emails for all the results. One email credit will be charged for each verified email.
  
  Default value is false.
- webhookUrl string | null
revealPhones object | null

Additional properties are NOT allowed.
Hide revealPhones attributes Show revealPhones attributes object | null
- includePhones boolean
  
  Include the phones for all the results. One phone credit will be charged for each verified phone.
  
  Default value is false.
- webhookUrl string | null

Responses

200 application/json

Successful Response
Hide response attributes Show response attributes object
- id string Required
  
  Internal ocean id of the person
- domain string Required
  
  Domain of the company the person is working for
- name string | null
- firstName string | null
- lastName string | null
- country string | null
- location string | null
- linkedinUrl string | null
- seniorities array[string] | null
  
  Values are Owner, Founder, Board Member, C-Level, Partner, VP, Head, Director, Manager, or Other.
- departments array[string] | null
  
  Values are Accounting and Finance, Board, Business Support, Customer Relations, Design, Editorial Personnel, Engineering, Founder/Owner, Healthcare, HR, Legal, Management, Manufacturing, Marketing and Advertising, Operations, PR and Communications, Procurement, Product, Quality Control, R&D, Sales, Security, Supply Chain, or Other.
- photo string | null
- jobTitle string | null
- jobTitleEnglish string | null
- summary string | null
404

Not found
422 application/json

Validation Error
Hide response attribute Show response attribute object
- detail array[object]
  
  Hide detail attributes Show detail attributes object
  
  loc array[string | integer] Required
  
  msg string Required
  
  type string Required

POST /v2/enrich/person

curl \
 -X POST https://api.ocean.io/v2/enrich/person?apiToken=string \
 -H "Content-Type: application/json" \
 -d '{"person":{"id":"b8952796be57982d","name":"John Doe","firstName":"John","lastName":"Doe","jobTitle":"CEO","email":"john.doe@example.com","phone":"+45 12345678","facebook":"https://www.facebook.com/johndoe","twitter":"https://twitter.com/johndoe","linkedin":"https://www.linkedin.com/in/johndoe","country":"dk"},"company":{"name":"Ocean ApS","registrationNumber":"123456789","email":"hello@ocean.io","phone":"+45 12345678","countryCode":"dk","state":"Arkansas","city":"Copenhagen","streetAddress":"Strandgade 6","postalCode":"1401","address":"Strandgade 6, 1401 Copenhagen","facebook":"https://www.facebook.com/oceanio","twitter":"https://twitter.com/oceanio","linkedin":"https://www.linkedin.com/company/oceanio","instagram":"https://www.instagram.com/oceanio","xing":"https://www.xing.com/oceanio","domain":"ocean.io","youtube":"https://www.youtube.com/oceanio"},"revealEmails":{"webhookUrl":"https://url.com/webhook","includeEmails":true},"revealPhones":{"webhookUrl":"https://url.com/webhook","includePhones":true}}'

Request examples

{
  "person": {
    "id": "b8952796be57982d",
    "name": "John Doe",
    "firstName": "John",
    "lastName": "Doe",
    "jobTitle": "CEO",
    "email": "john.doe@example.com",
    "phone": "+45 12345678",
    "facebook": "https://www.facebook.com/johndoe",
    "twitter": "https://twitter.com/johndoe",
    "linkedin": "https://www.linkedin.com/in/johndoe",
    "country": "dk"
  },
  "company": {
    "name": "Ocean ApS",
    "registrationNumber": "123456789",
    "email": "hello@ocean.io",
    "phone": "+45 12345678",
    "countryCode": "dk",
    "state": "Arkansas",
    "city": "Copenhagen",
    "streetAddress": "Strandgade 6",
    "postalCode": "1401",
    "address": "Strandgade 6, 1401 Copenhagen",
    "facebook": "https://www.facebook.com/oceanio",
    "twitter": "https://twitter.com/oceanio",
    "linkedin": "https://www.linkedin.com/company/oceanio",
    "instagram": "https://www.instagram.com/oceanio",
    "xing": "https://www.xing.com/oceanio",
    "domain": "ocean.io",
    "youtube": "https://www.youtube.com/oceanio"
  },
  "revealEmails": {
    "webhookUrl": "https://url.com/webhook",
    "includeEmails": true
  },
  "revealPhones": {
    "webhookUrl": "https://url.com/webhook",
    "includePhones": true
  }
}

Response examples (200)

{
  "id": "e9447c74eafa8a19",
  "domain": "google.com",
  "name": "John Doe",
  "firstName": "John",
  "lastName": "Doe",
  "country": "us",
  "location": "Copenhagen, Capital Region, Denmark",
  "linkedinUrl": "https://www.linkedin.com/in/someone",
  "seniorities": [
    "C-Level",
    "Manager"
  ],
  "departments": [
    "Management",
    "Marketing and Advertising"
  ],
  "photo": "http://media.licdn.com/dms/image/somelink",
  "jobTitle": "Professeur",
  "jobTitleEnglish": "Teacher",
  "summary": "Some text that the person wrote to describe themselves"
}

Response examples (422)

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}