Skip to main content
POST
/
v1
/
persons
Create person
curl --request POST \
  --url https://api.stardex.ai/v1/persons \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "linkedin_url": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "current_job_title": "<string>",
  "linkedin_location": "<string>",
  "company_name": "<string>",
  "emails": [
    "jsmith@example.com"
  ],
  "work_email": "jsmith@example.com",
  "work_phone": "<string>",
  "personal_email": "jsmith@example.com",
  "mobile_phone": "<string>",
  "phone_numbers": [
    "<string>"
  ],
  "notes": "<string>",
  "job_id": "<string>",
  "job_name": "<string>",
  "client_name": "<string>",
  "client_id": "<string>",
  "external_source_id": "<string>",
  "enrich_record": true
}
'
{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "linkedin_public_id": "johndoe",
    "current_job_title": "Software Engineer",
    "company_name": "Tech Corp",
    "linkedin_location": "San Francisco, CA",
    "emails": [
      {
        "contact_data_type": "work",
        "value": "john@techcorp.com"
      }
    ],
    "phones": [
      {
        "contact_data_type": "mobile",
        "value": "+1-555-0123"
      }
    ],
    "candidate_id": "789e0123-e45f-67a8-b901-234567890123",
    "client_contact_id": null,
    "external_source_id": null
  }
}

Authorizations

​
Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Body

application/json
​
name
string
required

Full name (required). Used as display name across the system.

Minimum string length: 1
​
linkedin_url
string<uri>
required

LinkedIn profile URL (e.g. "https://linkedin.com/in/johndoe"). Used for deduplication and enrichment.

​
first_name
string

First name. Auto-split from name if omitted.

​
last_name
string

Last name. Auto-split from name if omitted.

​
current_job_title
string

Current job title.

​
linkedin_location
string

Location from LinkedIn profile.

​
company_name
string

Current employer company name.

​
emails
string<email>[]

Additional email addresses.

​
work_email
string<email>

Primary work email.

​
work_phone
string

Work phone number.

​
personal_email
string<email>

Personal email address.

​
mobile_phone
string

Mobile phone number.

​
phone_numbers
string[]

Additional phone numbers.

​
notes
string

Initial note to attach to the person record.

​
job_id
string

Job UUID to immediately add this person as a candidate. Get IDs from POST /v1/jobs/search.

​
job_name
string

Job title to match and add as candidate. Used when job_id is not provided.

​
client_name
string

Company name to associate this person as a client contact.

​
client_id
string

Company UUID for client contact association. Get IDs from GET /v1/companies.

​
external_source_id
string

Identifier from an external system (e.g. HRIS or legacy ATS).

​
enrich_record
boolean

When true, triggers background enrichment via data providers after creation.

Response

Person created

​
success
enum<boolean>
required
Available options:
true
​
data
object
required