> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stardex.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create person

> Create a new person record with contact details and optional job association. Returns the created person with IDs for further operations.



## OpenAPI

````yaml /api-reference/openapi-v1.json post /v1/persons
openapi: 3.1.0
info:
  title: Stardex API (v1)
  version: 1.0.0
  description: >-
    Stardex ATS API — manage candidates, jobs, companies, and recruiting
    workflows.
servers:
  - url: https://api.stardex.ai
    description: Production API server
security:
  - bearerAuth: []
tags:
  - name: Persons
    description: Manage person records — contacts, work history, and custom fields.
  - name: Jobs
    description: Manage job postings — pipeline stages, team members, and custom fields.
  - name: Candidates
    description: Manage candidate records and pipeline stage transitions.
  - name: Companies
    description: Browse and retrieve company records.
  - name: Lists
    description: Create, search, and retrieve saved person and company lists.
  - name: Person Activities
    description: Create and manage activity records (notes, emails, meetings) for persons.
  - name: Team Members
    description: List team members for use in search filters and assignments.
  - name: Custom Fields
    description: Retrieve custom field definitions and tag options for search filters.
paths:
  /v1/persons:
    post:
      tags:
        - Persons
      summary: Create person
      description: >-
        Create a new person record with contact details and optional job
        association. Returns the created person with IDs for further operations.
      operationId: createPerson
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonCreateRequest'
      responses:
        '201':
          description: Person created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersonCreateResponse'
              example:
                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
                  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
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
components:
  schemas:
    PersonCreateRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          description: Full name (required). Used as display name across the system.
        first_name:
          type: string
          description: First name. Auto-split from name if omitted.
        last_name:
          type: string
          description: Last name. Auto-split from name if omitted.
        linkedin_url:
          type: string
          format: uri
          description: >-
            LinkedIn profile URL (e.g. "https://linkedin.com/in/johndoe"). Used
            for deduplication and enrichment.
        current_job_title:
          type: string
          description: Current job title.
        location:
          type: string
          description: Location (e.g. city, region, or country).
        company_name:
          type: string
          description: Current employer company name.
        emails:
          type: array
          items:
            type: string
            format: email
          description: Additional email addresses.
        work_email:
          type: string
          format: email
          description: Primary work email.
        work_phone:
          type: string
          description: Work phone number.
        personal_email:
          type: string
          format: email
          description: Personal email address.
        mobile_phone:
          type: string
          description: Mobile phone number.
        phone_numbers:
          type: array
          items:
            type: string
          description: Additional phone numbers.
        notes:
          type: string
          description: Initial note to attach to the person record.
        job_id:
          type: string
          description: >-
            Job UUID to add this person to that job pipeline as a candidate
            (creates the candidacy). Works whether the person is new or already
            exists (matched by linkedin_url, never duplicated). Get IDs from
            POST /v1/jobs/search.
        job_name:
          type: string
          description: >-
            Job title to match and add this person to that job pipeline as a
            candidate. Used when job_id is not provided.
        client_name:
          type: string
          description: Company name to associate this person as a client contact.
        client_id:
          type: string
          description: >-
            Company UUID for client contact association. Get IDs from GET
            /v1/companies.
        external_source_id:
          type: string
          description: Identifier from an external system (e.g. HRIS or legacy ATS).
        enrich_record:
          type: boolean
          description: >-
            When true, triggers background enrichment via data providers after
            creation.
        person_owner:
          type: string
          format: uuid
          description: >-
            UUID of the team member to assign as owner of this person. Get IDs
            from GET /v1/team-members. If the team member is not found, a
            warning is logged but person creation still proceeds.
      required:
        - name
        - linkedin_url
    PersonCreateResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          $ref: '#/components/schemas/PersonCreateResponseData'
      required:
        - success
        - data
    PersonCreateResponseData:
      type: object
      properties:
        id:
          type: string
          description: Created person UUID.
        name:
          type: string
          description: Person full name.
        linkedin_public_id:
          type:
            - string
            - 'null'
          description: LinkedIn vanity slug.
        current_job_title:
          type:
            - string
            - 'null'
          description: Current job title.
        company_name:
          type:
            - string
            - 'null'
          description: Current employer name.
        emails:
          type: array
          items:
            $ref: '#/components/schemas/PersonContactValue'
          description: Email addresses saved.
        location:
          type:
            - string
            - 'null'
          description: Location (e.g. city, region, or country).
        phones:
          type: array
          items:
            $ref: '#/components/schemas/PersonContactValue'
          description: Phone numbers saved.
        candidate_id:
          type:
            - string
            - 'null'
          description: >-
            Candidate UUID if the person was added to a job. Null if no job was
            specified.
        client_contact_id:
          type:
            - string
            - 'null'
          description: >-
            Client contact UUID if the person was linked to a client company.
            Null otherwise.
        external_source_id:
          type:
            - string
            - 'null'
          description: External system identifier, if provided.
      required:
        - id
        - name
        - linkedin_public_id
        - current_job_title
        - company_name
        - emails
        - location
        - phones
        - candidate_id
        - client_contact_id
        - external_source_id
    PersonContactValue:
      type: object
      properties:
        contact_data_type:
          type:
            - string
            - 'null'
          description: >-
            Contact category. Values: work, personal, mobile, home, other, or
            null if unknown.
        value:
          type: string
          description: Email address or phone number string.
      required:
        - contact_data_type
        - value
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Authenticate with a Bearer token: API key, OAuth token, or session
        token.

````