Skip to content

Phone Enrichment

Request

Enriches contact records with phone number data using multiple data sources.

Overview

The Phone Enrichment API enriches contact records with phone number data using multiple data sources. The service intelligently cascades through different lookup methods to maximize success rates.

Request Body

  • record_id: Your unique identifier for this record (required) - used for caching and duplicate detection
  • first_name: Contact's first name (optional) - required for name-based enrichment
  • last_name: Contact's last name (optional) - required for name-based enrichment
  • company: Company name or website URL (optional) - required for name-based enrichment
  • email: Contact's email address (optional) - can be used standalone for enrichment
  • linkedin_id: Contact's linkedin profile identifier/slug (optional) - can be used standalone for enrichment
  • domain: Company domain (optional) - enhances name/company enrichment method

Request Constraints

  • Single record per request
  • Must include record_id
  • record_id must be unique per contact record in your system
  • Must provide at least one of the following data combinations:
    • Name + Company/Domain: first_name, last_name, company (optionally enhanced with domain)
    • LinkedIn Profile Only: linkedin_id
    • Email Only: email
  • Enrichment prioritizes data in this order:
    1. Name + Company/Domain: Primary method when available
    2. LinkedIn Profile: Fallback when name/company data is incomplete
    3. Email Only: Final fallback when other data is insufficient

Response Fields

  • success: Boolean indicating request success
  • record_id: Echo of the input record ID
  • first_name: Echo of input first name (or null if not provided)
  • last_name: Echo of input last name (or null if not provided)
  • company: Echo of input company (or null if not provided)
  • email: Echo of input email or email found during enrichment (or null if not found)
  • linkedin_id: Echo of input LinkedIn ID or LinkedIn profile found during enrichment (or null if not found)
  • phone: International format phone number (E.164) or null if not found
  • processing_time_ms: Time taken to process the request in milliseconds
Security
BearerAuth
Bodyapplication/jsonrequired
record_idstring(Record Id)required

Your unique identifier for this record

first_namestring or null(First Name)
Any of:

Contact's first name (required for name-based enrichment)

string
last_namestring or null(Last Name)
Any of:

Contact's last name (required for name-based enrichment)

string
companystring or null(Company)
Any of:

Company name or website URL (required for name-based enrichment)

string
emailstring or null(Email)
Any of:

Contact's email address (optional)

string
linkedin_idstring or null(Linkedin Id)
Any of:

LinkedIn profile identifier/slug (e.g., 'john-doe-123456')

string
domainstring or null(Domain)
Any of:

Company domain (optional) - improves accuracy when provided

string
curl -i -X POST \
  https://api-gateway.agenthq.withlantern.com/v1/enrich/phone \
  -H 'Authorization: Bearer <YOUR_ApiToken_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "record_id": "string",
    "first_name": "string",
    "last_name": "string",
    "company": "string",
    "email": "string",
    "linkedin_id": "john-doe-123456",
    "domain": "string"
  }'

Responses

Success Response

Bodyapplication/json
successboolean(Success)required

Boolean indicating request success

record_idstring(Record Id)required

Echo of the input record ID

first_namestring or null(First Name)
Any of:

Echo of input first name

string
last_namestring or null(Last Name)
Any of:

Echo of input last name

string
companystring or null(Company)
Any of:

Echo of input company

string
emailstring or null(Email)
Any of:

Echo of input email or email found during enrichment

string
linkedin_idstring or null(Linkedin Id)
Any of:

Echo of input LinkedIn ID or LinkedIn profile found during enrichment

string
phonestring or null(Phone)
Any of:

International format phone number (E.164) or null if not found

string
processing_time_msinteger(Processing Time Ms)required

Time taken to process the request in milliseconds

Response
{
  "success": true,
  "record_id": "contact_001",
  "first_name": "John",
  "last_name": "Smith",
  "company": "Acme Corp",
  "email": "john.smith@acme.com",
  "linkedin_id": "john-smith-123456",
  "phone": "+1-555-123-4567",
  "processing_time_ms": 1250
}