Skip to main content
POST
Provide an email OR a phone and get back the complete record, including Squid ID+ premium fields (mobile phone, personal email, home address, demographics, and social profiles). Billed as one ID match plus one Squid ID+ record at your current rates, on each successful enrichment. Use Get Visitor Details (free to call) when you only need the base fields on an existing visitor.
Requires API access enabled for the website the key belongs to. Squid ID+ does not need to be enabled: the ID+ portion is charged at the discounted rate. Enrichments are not added to your visitors dashboard.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Authorization
string
required

Your Squid ID API key, format: Bearer <key> (keys start with sqid_).

Body

application/json

Provide either email OR phone (but not both)

email
string<email>
required

visitor's email address (use email OR phone, not both)

phone
string

visitor's phone number (use email OR phone, not both)

forceUpdate
boolean
default:false

force update even if identity exists

Response

Enriched record

profile
object
traits
object
social
object
company
object
organization
object

detailed organization/company information

job
object
location
object
location_names
string[]

list of location names

Example:
street_addresses
object[]

list of street addresses

Example:
regions
string[]

list of regions associated with visitor

Example:
experience
object[]

work experience history

Example:
interests
string[]

visitor's interests

Example:
skills
string[]

visitor's skills

Example:
device
object