Skip to main content
POST
Create participant

Authorizations

x-api-key
string
header
required

API key with the iv_live_ prefix. Create one under Developer โ†’ API Keys.

Body

application/json
name
string
required

Full name

email
string
required

Email โ€” unique per account

role_id
string<uuid>

Role to associate

external_id
string

Your ATS / system ID โ€” echoed back in all webhook payloads

phone
string

Phone number

tags
string[]

Arbitrary labels, e.g. ["senior", "remote"]

profile
object

{ title, organization, experienceLevel, location }

background
object

{ skills: string[], education, languages: string[] }

resume_url
string<uri>

Publicly accessible resume URL โ€” triggers vector extraction

pipeline_id
string<uuid>

Assign to a hiring pipeline on creation

metadata
object

Arbitrary key-value store

status
string

Initial status (default: active)

Response

Success

Last modified on July 20, 2026