Sign in
Enrichment API

Enrich Person Information

Enriches a person's information using LinkedIn URL, email, and other optional details.

get/enrich/v1/person

Query parameters

linkedinUrlstring

LinkedIn profile URL of the person

emailstring

Email address of the person

firstNamestring

First name of the person

lastNamestring

Last name of the person

includeMobileNumberstring

Include mobile phone number in the enrichment result

Response

Enrichment results including personal, job, and social data

isCompleteboolean
messagestring
pendingFieldsstring[]
resultUrlstring
statusstring

Example response

{
  "data": {
    "emails": [
      {
        "address": "john.doe@example.com",
        "deliverable": "true",
        "type": "professional"
      }
    ],
    "jobs": [
      {
        "company": "Tech Corp",
        "companyLinkedin": "https://linkedin.com/company/techcorp",
        "companyWebsite": "https://techcorp.com",
        "duration": {
          "endMonth": 12,
          "endYear": 2023,
          "startMonth": 1,
          "startYear": 2020
        },
        "isCurrent": true,
        "seniority": "Senior",
        "title": "Software Engineer"
      }
    ],
    "location": {
      "city": "San Francisco",
      "country": "USA",
      "region": "California",
      "timezone": "PST"
    },
    "name": {
      "firstName": "John",
      "fullName": "John Doe",
      "lastName": "Doe"
    },
    "phoneNumbers": [
      {
        "number": "+1234567890",
        "type": "mobile"
      }
    ],
    "profilePic": "https://example.com/profile.jpg",
    "social": {
      "discord": {
        "username": "johndoe#1234"
      },
      "github": {
        "url": "https://github.com/johndoe",
        "username": "johndoe"
      },
      "linkedin": {
        "followerCount": 500,
        "id": "123456789",
        "publicId": "john-doe",
        "url": "https://linkedin.com/in/john-doe"
      },
      "x": {
        "handle": "@johndoe",
        "url": "https://x.com/johndoe"
      }
    }
  },
  "isComplete": true,
  "message": "Enrichment completed",
  "pendingFields": [
    "[\"email\"",
    " \"phone number\"]"
  ],
  "resultUrl": "https://api.customeros.ai/enrich/v1/person/results/550e8400-e29b-41d4-a716-446655440000",
  "status": "success"
}

Changes