Skip to main content
POST

Authorizations

Authorization
string
header
required

API key passed as a Bearer token in the Authorization header.

Headers

x-api-version
enum<string>
default:2025-11-01
required

API version to use. This endpoint currently requires 2025-11-01.

Available options:
2025-11-01
Example:

"2025-11-01"

Body

application/json

Profile URLs and optional field selection.

Request body for /person/enrich using professional-network profile URLs.

professional_network_profile_urls
string[]
required

Array of professional-network profile URLs (max 25).

fields
string[]

Fields to include in the response. Valid field groups for enrich: basic_profile, professional_network, skills, social_handles, experience, education, certifications, honors, dev_platform_profiles. Use dot-notation for nested fields (e.g., "basic_profile.name", "experience.employment_details"). If omitted, a default set (basic_profile, social_handles) is returned — request additional groups explicitly. Some groups (for example certifications and honors) require field-level permission on your API key.

Example:
preview
boolean
default:false

Preview mode returns only basic profile fields and charges 0 credits. Cannot be combined with enrich_realtime. Preview is enterprise only and must be enabled for your account — without it, the API returns 400 invalid_request with the message Preview feature is not available for your account. Please reach out to Crustdata team.

Response

Enriched person profiles

matched_on
string

The submitted professional-network profile URL.

match_type
enum<string>
Available options:
professional_network_profile_url
matches
object[]
Example: