curl --request POST \
--url https://id-api.asksquid.ai/api/visitors/enrichment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "john.doe@example.com"
}
'{
"profile": {
"id": "64fa2b9f1c2a3e4b5d6f7890",
"alias": "<string>",
"email": "jsmith@example.com"
},
"traits": {
"id": "00000000000000_0000",
"email": "john.doe@example.com",
"full_name": "john doe",
"first_name": "john",
"middle_initial": null,
"middle_name": null,
"last_name": "doe",
"work_email": "john.doe@company.com",
"recommended_personal_email": "john.doe@example.com",
"emails": [
{
"address": "john.doe@example.com",
"type": "personal"
},
{
"address": "john.doe@company.com",
"type": "current_professional"
}
],
"gender": "male",
"birth_year": 1990,
"birth_date": "1990-05-15",
"mobile_phone": "+1-555-123-4567",
"phone_numbers": [
"+1-555-123-4567",
"+1-555-987-6543"
],
"industry": "internet",
"home_owner": null,
"married": null,
"children": null,
"email_status": null,
"photo_url": "https://example.com/photos/profile.jpg",
"extrapolated_email_confidence": null
},
"social": {
"linkedin": {
"id": "123456",
"url": "linkedin.com/in/username",
"username": "username"
},
"facebook": {
"url": "facebook.com/username",
"username": "username"
},
"twitter": {
"url": "twitter.com/username",
"username": "username"
},
"github": {
"url": "github.com/username",
"username": "username"
}
},
"company": {
"name": "acme corp",
"size": "51-200",
"founded": 2010,
"industry": "technology",
"description": "a technology company providing innovative solutions",
"revenue": "$10M - $50M",
"phone_numbers": [
"+1-555-000-0000"
],
"website": "example.com",
"linkedin": {
"url": "linkedin.com/company/example",
"id": "12345"
},
"location": {
"name": "main street, city, country",
"city": "city",
"state": "state",
"locality": "city",
"metro": null,
"region": "state",
"country": "country",
"continent": "continent",
"street_address": null,
"address_line_2": null,
"postal_code": null,
"geo": "40.00,-80.00"
}
},
"organization": {
"id": "org123456",
"name": "example company",
"website_url": "www.example.com/",
"blog_url": "blog.example.com",
"angellist_url": "angel.co/example-company",
"linkedin_url": "www.linkedin.com/company/example",
"twitter_url": "www.twitter.com/example",
"facebook_url": "www.facebook.com/example",
"primary_phone": {
"number": "+1 555-000-0000",
"source": "source",
"sanitized_number": "+15550000000"
},
"languages": [
"english"
],
"alexa_ranking": null,
"phone": "+1 555-000-0000",
"linkedin_uid": "123456",
"founded_year": 2010,
"publicly_traded_symbol": null,
"publicly_traded_exchange": null,
"logo_url": "example.com/logos/company.png",
"crunchbase_url": null,
"primary_domain": "example.com",
"sic_codes": [
"1234"
],
"naics_codes": [
"12345"
],
"sanitized_phone": "+15550000000",
"industry": "technology",
"estimated_num_employees": 50,
"keywords": [
"technology",
"software",
"services"
],
"organization_revenue_printed": "10m",
"organization_revenue": 10000000,
"industries": [
"technology"
],
"secondary_industries": [],
"snippets_loaded": true,
"industry_tag_id": "5567cd467369644d39040000",
"industry_tag_hash": {
"technology": "tag123456"
},
"retail_location_count": 0,
"raw_address": "123 main st., suite 100, city, state 12345, country",
"street_address": "123 main st",
"city": "city",
"state": "state",
"postal_code": "12345",
"country": "country",
"owned_by_organization_id": "parent123",
"owned_by_organization": {
"id": "parent123",
"name": "parent company",
"website_url": "www.parentcompany.com/"
},
"short_description": "example company is a technology company providing innovative solutions...",
"suborganizations": [],
"num_suborganizations": 0,
"annual_revenue_printed": "10m",
"annual_revenue": 10000000,
"total_funding": 5000000,
"total_funding_printed": "5m",
"latest_funding_round_date": "2020-01-01t00:00:00.000+00:00",
"latest_funding_stage": "series a",
"funding_events": [
{
"id": "event123",
"date": "2020-01-01T00:00:00.000+00:00",
"news_url": "example.com/news/funding",
"type": "series a",
"investors": "investor one, investor two",
"amount": "3m",
"currency": "$"
}
],
"technology_names": [
"email",
"analytics",
"crm"
],
"current_technologies": [
{
"uid": "tech123",
"name": "technology",
"category": "category"
}
],
"org_chart_root_people_ids": [
"person123"
],
"org_chart_sector": "sector",
"org_chart_removed": false,
"org_chart_show_department_filter": true,
"organization_headcount_six_month_growth": null,
"organization_headcount_twelve_month_growth": null,
"organization_headcount_twenty_four_month_growth": null
},
"job": {
"title": "developer",
"role": "engineering",
"sub_role": null,
"title_levels": [],
"income_range": "$75k - $100k",
"net_worth": "$100k - $250k",
"headline": "senior manager at example company",
"seniority": "vp",
"functions": [
"operations"
],
"departments": [
"master_operations"
],
"subdepartments": [
"operations"
]
},
"location": {
"name": "street, city, country",
"city": "city",
"state": "state",
"locality": "city",
"metro": null,
"region": "region",
"country": "country",
"continent": "continent",
"street_address": null,
"address_line_2": null,
"postal_code": null,
"geo": "40.00,-75.00",
"last_updated": null
},
"location_names": [],
"street_addresses": [],
"regions": [],
"experience": [
{
"company": {
"name": "previous company",
"size": null,
"id": null,
"founded": null,
"industry": null,
"location": null,
"linkedin_url": null,
"linkedin_id": null,
"facebook_url": null,
"twitter_url": null,
"website": null
},
"location_names": [],
"end_date": "2015-06",
"start_date": "2013-01",
"title": {
"name": "software engineer",
"role": "engineering",
"sub_role": null,
"levels": []
},
"is_primary": false
},
{
"company": {
"name": "current company",
"size": "51-200",
"id": "company123",
"founded": 2010,
"industry": "technology",
"location": {
"name": "street, city, country",
"locality": "city",
"region": "region",
"metro": null,
"country": "country",
"continent": "continent",
"street_address": null,
"address_line_2": null,
"postal_code": null,
"geo": "40.00,-75.00"
},
"linkedin_url": "linkedin.com/company/example",
"linkedin_id": "12345",
"facebook_url": "facebook.com/example",
"twitter_url": null,
"website": "example.com"
},
"location_names": [],
"end_date": null,
"start_date": "2015-07",
"title": {
"name": "senior engineer",
"role": "engineering",
"sub_role": null,
"levels": []
},
"is_primary": true
}
],
"interests": [],
"skills": [],
"device": {
"type": "desktop"
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Enrich Visitor
Enrich a person by email or phone: full record with direct contact, social, company, organization, job, location, and work history. Charged as one ID match plus one Squid ID+ record.
curl --request POST \
--url https://id-api.asksquid.ai/api/visitors/enrichment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "john.doe@example.com"
}
'{
"profile": {
"id": "64fa2b9f1c2a3e4b5d6f7890",
"alias": "<string>",
"email": "jsmith@example.com"
},
"traits": {
"id": "00000000000000_0000",
"email": "john.doe@example.com",
"full_name": "john doe",
"first_name": "john",
"middle_initial": null,
"middle_name": null,
"last_name": "doe",
"work_email": "john.doe@company.com",
"recommended_personal_email": "john.doe@example.com",
"emails": [
{
"address": "john.doe@example.com",
"type": "personal"
},
{
"address": "john.doe@company.com",
"type": "current_professional"
}
],
"gender": "male",
"birth_year": 1990,
"birth_date": "1990-05-15",
"mobile_phone": "+1-555-123-4567",
"phone_numbers": [
"+1-555-123-4567",
"+1-555-987-6543"
],
"industry": "internet",
"home_owner": null,
"married": null,
"children": null,
"email_status": null,
"photo_url": "https://example.com/photos/profile.jpg",
"extrapolated_email_confidence": null
},
"social": {
"linkedin": {
"id": "123456",
"url": "linkedin.com/in/username",
"username": "username"
},
"facebook": {
"url": "facebook.com/username",
"username": "username"
},
"twitter": {
"url": "twitter.com/username",
"username": "username"
},
"github": {
"url": "github.com/username",
"username": "username"
}
},
"company": {
"name": "acme corp",
"size": "51-200",
"founded": 2010,
"industry": "technology",
"description": "a technology company providing innovative solutions",
"revenue": "$10M - $50M",
"phone_numbers": [
"+1-555-000-0000"
],
"website": "example.com",
"linkedin": {
"url": "linkedin.com/company/example",
"id": "12345"
},
"location": {
"name": "main street, city, country",
"city": "city",
"state": "state",
"locality": "city",
"metro": null,
"region": "state",
"country": "country",
"continent": "continent",
"street_address": null,
"address_line_2": null,
"postal_code": null,
"geo": "40.00,-80.00"
}
},
"organization": {
"id": "org123456",
"name": "example company",
"website_url": "www.example.com/",
"blog_url": "blog.example.com",
"angellist_url": "angel.co/example-company",
"linkedin_url": "www.linkedin.com/company/example",
"twitter_url": "www.twitter.com/example",
"facebook_url": "www.facebook.com/example",
"primary_phone": {
"number": "+1 555-000-0000",
"source": "source",
"sanitized_number": "+15550000000"
},
"languages": [
"english"
],
"alexa_ranking": null,
"phone": "+1 555-000-0000",
"linkedin_uid": "123456",
"founded_year": 2010,
"publicly_traded_symbol": null,
"publicly_traded_exchange": null,
"logo_url": "example.com/logos/company.png",
"crunchbase_url": null,
"primary_domain": "example.com",
"sic_codes": [
"1234"
],
"naics_codes": [
"12345"
],
"sanitized_phone": "+15550000000",
"industry": "technology",
"estimated_num_employees": 50,
"keywords": [
"technology",
"software",
"services"
],
"organization_revenue_printed": "10m",
"organization_revenue": 10000000,
"industries": [
"technology"
],
"secondary_industries": [],
"snippets_loaded": true,
"industry_tag_id": "5567cd467369644d39040000",
"industry_tag_hash": {
"technology": "tag123456"
},
"retail_location_count": 0,
"raw_address": "123 main st., suite 100, city, state 12345, country",
"street_address": "123 main st",
"city": "city",
"state": "state",
"postal_code": "12345",
"country": "country",
"owned_by_organization_id": "parent123",
"owned_by_organization": {
"id": "parent123",
"name": "parent company",
"website_url": "www.parentcompany.com/"
},
"short_description": "example company is a technology company providing innovative solutions...",
"suborganizations": [],
"num_suborganizations": 0,
"annual_revenue_printed": "10m",
"annual_revenue": 10000000,
"total_funding": 5000000,
"total_funding_printed": "5m",
"latest_funding_round_date": "2020-01-01t00:00:00.000+00:00",
"latest_funding_stage": "series a",
"funding_events": [
{
"id": "event123",
"date": "2020-01-01T00:00:00.000+00:00",
"news_url": "example.com/news/funding",
"type": "series a",
"investors": "investor one, investor two",
"amount": "3m",
"currency": "$"
}
],
"technology_names": [
"email",
"analytics",
"crm"
],
"current_technologies": [
{
"uid": "tech123",
"name": "technology",
"category": "category"
}
],
"org_chart_root_people_ids": [
"person123"
],
"org_chart_sector": "sector",
"org_chart_removed": false,
"org_chart_show_department_filter": true,
"organization_headcount_six_month_growth": null,
"organization_headcount_twelve_month_growth": null,
"organization_headcount_twenty_four_month_growth": null
},
"job": {
"title": "developer",
"role": "engineering",
"sub_role": null,
"title_levels": [],
"income_range": "$75k - $100k",
"net_worth": "$100k - $250k",
"headline": "senior manager at example company",
"seniority": "vp",
"functions": [
"operations"
],
"departments": [
"master_operations"
],
"subdepartments": [
"operations"
]
},
"location": {
"name": "street, city, country",
"city": "city",
"state": "state",
"locality": "city",
"metro": null,
"region": "region",
"country": "country",
"continent": "continent",
"street_address": null,
"address_line_2": null,
"postal_code": null,
"geo": "40.00,-75.00",
"last_updated": null
},
"location_names": [],
"street_addresses": [],
"regions": [],
"experience": [
{
"company": {
"name": "previous company",
"size": null,
"id": null,
"founded": null,
"industry": null,
"location": null,
"linkedin_url": null,
"linkedin_id": null,
"facebook_url": null,
"twitter_url": null,
"website": null
},
"location_names": [],
"end_date": "2015-06",
"start_date": "2013-01",
"title": {
"name": "software engineer",
"role": "engineering",
"sub_role": null,
"levels": []
},
"is_primary": false
},
{
"company": {
"name": "current company",
"size": "51-200",
"id": "company123",
"founded": 2010,
"industry": "technology",
"location": {
"name": "street, city, country",
"locality": "city",
"region": "region",
"metro": null,
"country": "country",
"continent": "continent",
"street_address": null,
"address_line_2": null,
"postal_code": null,
"geo": "40.00,-75.00"
},
"linkedin_url": "linkedin.com/company/example",
"linkedin_id": "12345",
"facebook_url": "facebook.com/example",
"twitter_url": null,
"website": "example.com"
},
"location_names": [],
"end_date": null,
"start_date": "2015-07",
"title": {
"name": "senior engineer",
"role": "engineering",
"sub_role": null,
"levels": []
},
"is_primary": true
}
],
"interests": [],
"skills": [],
"device": {
"type": "desktop"
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Your Squid ID API key, format: Bearer <key> (keys start with sqid_).
Body
Response
Enriched record
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
detailed organization/company information
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
list of location names
[]
list of street addresses
Show child attributes
Show child attributes
[]
list of regions associated with visitor
[]
work experience history
Show child attributes
Show child attributes
[
{
"company": {
"name": "previous company",
"size": null,
"id": null,
"founded": null,
"industry": null,
"location": null,
"linkedin_url": null,
"linkedin_id": null,
"facebook_url": null,
"twitter_url": null,
"website": null
},
"location_names": [],
"end_date": "2015-06",
"start_date": "2013-01",
"title": {
"name": "software engineer",
"role": "engineering",
"sub_role": null,
"levels": []
},
"is_primary": false
},
{
"company": {
"name": "current company",
"size": "51-200",
"id": "company123",
"founded": 2010,
"industry": "technology",
"location": {
"name": "street, city, country",
"locality": "city",
"region": "region",
"metro": null,
"country": "country",
"continent": "continent",
"street_address": null,
"address_line_2": null,
"postal_code": null,
"geo": "40.00,-75.00"
},
"linkedin_url": "linkedin.com/company/example",
"linkedin_id": "12345",
"facebook_url": "facebook.com/example",
"twitter_url": null,
"website": "example.com"
},
"location_names": [],
"end_date": null,
"start_date": "2015-07",
"title": {
"name": "senior engineer",
"role": "engineering",
"sub_role": null,
"levels": []
},
"is_primary": true
}
]
visitor's interests
[]
visitor's skills
[]
Show child attributes
Show child attributes
Was this page helpful?
