v1

latestSwagger 2.02026-07-172161122.5 KB

Enrichment API

Retrieve enrichment results

Retrieves the results of an asynchronous person enrichment operation

get/enrich/v1/person/results/{id}

Path parameters

idstring uuid required

Result ID

Response

Successfully retrieved enriched data

isCompleteboolean

Indicates if all enrichment operations are complete required: true

messagestring

Optional message providing additional information required: false

pendingFieldsstring[]

List of fields still being processed required: false

resultUrlstring

URL to check the final result when processing is incomplete required: false format: uri

statusstring

Operation status required: true enum: success,error,warning

Example response

{
  "data": {
    "emails": [
      {
        "address": "john.doe@example.com",
        "deliverable": "true",
        "type": "work"
      }
    ],
    "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": "United States",
      "region": "California",
      "timezone": "PST"
    },
    "name": {
      "firstName": "John",
      "fullName": "John Doe",
      "lastName": "Doe"
    },
    "phoneNumbers": [
      {
        "number": "+14155552671",
        "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"
}