> ## 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.

# Enrich person contact details

> Look up email (and phone, when enabled) contact details for a person via Stardex enrichment providers.

**Organization gate**: requires `enrichment_api_enabled` on the organization (staff-enabled).

**Quota**: organization-wide limit of 500 enrichment requests per active team member with an `auth_user_id`, per UTC calendar month. Quota usage is returned in the response body and in `X-Enrichment-Quota-*` headers.

**API-key scope**: `persons:write`.



## OpenAPI

````yaml /api-reference/openapi-v1.json post /v1/persons/{id}/enrich
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/{id}/enrich:
    post:
      tags:
        - Persons
      summary: Enrich person contact details
      description: >-
        Look up email (and phone, when enabled) contact details for a person via
        Stardex enrichment providers.


        **Organization gate**: requires `enrichment_api_enabled` on the
        organization (staff-enabled).


        **Quota**: organization-wide limit of 500 enrichment requests per active
        team member with an `auth_user_id`, per UTC calendar month. Quota usage
        is returned in the response body and in `X-Enrichment-Quota-*` headers.


        **API-key scope**: `persons:write`.
      operationId: enrichPersonContact
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
            description: Person UUID
      responses:
        '200':
          description: Contact details enriched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersonContactEnrichmentResponse'
              example:
                success: true
                data:
                  person_id: 123e4567-e89b-12d3-a456-426614174000
                  linkedin_public_id: johndoe
                  linkedin_url: https://www.linkedin.com/in/johndoe
                  emails:
                    - value: john@example.com
                      contact_data_type: personal
                      source: rocketreach
                      priority: 1
                    - value: john@techcorp.com
                      contact_data_type: work
                      source: apollo
                      priority: 2
                  phones:
                    - value: +1-555-0123
                      contact_data_type: mobile
                      source: signalhire
                      priority: 1
                    - value: +1-555-0199
                      contact_data_type: work
                      source: fullenrich
                      priority: 2
                    - value: +1-555-0142
                      contact_data_type: home
                      source: pdl
                      priority: 3
                  quota:
                    allowed: true
                    used: 12
                    limit: 1500
                    remaining: 1488
                    billable_member_count: 3
                    per_member_limit: 500
                    period_start: '2026-09-01'
                    resets_at: '2026-10-01T00:00:00.000Z'
        '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:
    PersonContactEnrichmentResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          $ref: '#/components/schemas/PersonContactEnrichmentData'
      required:
        - success
        - data
    PersonContactEnrichmentData:
      type: object
      properties:
        person_id:
          type: string
          format: uuid
        linkedin_public_id:
          type: string
        linkedin_url:
          type: string
          format: uri
        emails:
          type: array
          items:
            type: object
            properties:
              value:
                type: string
                description: Enriched email address or phone number.
              contact_data_type:
                type: string
                enum:
                  - personal
                  - work
                  - mobile
                  - home
                description: Contact classification.
              source:
                type: string
                description: Provider or cache source that returned this value.
              priority:
                type: integer
                description: Lower numbers are higher priority.
            required:
              - value
              - contact_data_type
              - source
              - priority
        phones:
          type: array
          items:
            type: object
            properties:
              value:
                type: string
                description: Enriched email address or phone number.
              contact_data_type:
                type: string
                enum:
                  - personal
                  - work
                  - mobile
                  - home
                description: Contact classification.
              source:
                type: string
                description: Provider or cache source that returned this value.
              priority:
                type: integer
                description: Lower numbers are higher priority.
            required:
              - value
              - contact_data_type
              - source
              - priority
          description: >-
            Phone numbers when reveal_phone_numbers is enabled for the
            organization; otherwise empty.
        quota:
          type: object
          properties:
            allowed:
              type: boolean
            used:
              type: integer
              description: >-
                Enrichment requests used by this organization in the current UTC
                month.
            limit:
              type: integer
              description: >-
                Monthly organization enrichment limit: 500 × active team members
                with an auth_user_id.
            remaining:
              type: integer
            billable_member_count:
              type: integer
              description: >-
                Count of distinct active team members with an auth_user_id used
                to compute the limit.
            per_member_limit:
              type: integer
              description: Per-member monthly allowance (currently 500).
            period_start:
              type: string
              description: UTC calendar month start (YYYY-MM-DD).
            resets_at:
              type: string
              description: >-
                ISO timestamp when the monthly quota resets (1st of next month,
                UTC).
          required:
            - allowed
            - used
            - limit
            - remaining
            - billable_member_count
            - per_member_limit
            - period_start
            - resets_at
      required:
        - person_id
        - linkedin_public_id
        - linkedin_url
        - emails
        - phones
        - quota
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Authenticate with a Bearer token: API key, OAuth token, or session
        token.

````