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

# Enrich contact



## OpenAPI

````yaml /openapi.yaml post /enrich
openapi: 3.0.0
info:
  title: AudienceLab API
  version: 1.0.0
  description: API endpoints for AudienceLab
servers:
  - url: https://api.audiencelab.io
    description: Production API
security:
  - ApiKeyAuth: []
tags:
  - name: Audience
  - name: Pixel
  - name: Enrichment
paths:
  /enrich:
    post:
      tags:
        - Enrichment
      summary: Enrich contact
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnrichSearchRequest'
            examples:
              company_search:
                summary: Search by company name
                value:
                  request_id: req_123456
                  filter:
                    company_name: Nike
                  is_or_match: false
              email_search:
                summary: Search by email
                value:
                  request_id: req_789012
                  filter:
                    email: john.doe@example.com
                  is_or_match: false
              phone_search:
                summary: Search by phone number
                value:
                  request_id: req_345678
                  filter:
                    phone: 555-123-4567
                  is_or_match: false
              combined_search:
                summary: Combined search with multiple filters (AND logic)
                value:
                  request_id: req_multi_001
                  filter:
                    company_name: Tesla
                    personal_state: CA
                    first_name: John
                  is_or_match: false
              or_search:
                summary: Search with OR logic
                value:
                  request_id: req_or_001
                  filter:
                    company_name: Google
                    personal_city: San Francisco
                  is_or_match: true
              search_with_fields:
                summary: Search with specific fields in response
                value:
                  request_id: req_fields_001
                  filter:
                    company_name: Apple
                  is_or_match: false
                  fields:
                    - first_name
                    - last_name
                    - b2b_email
                    - company
                    - job_title
      responses:
        '200':
          description: Successfully retrieved enriched contact data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnrichSearchResponse'
        '400':
          description: Bad request - Invalid query parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized - Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    EnrichSearchRequest:
      type: object
      properties:
        request_id:
          type: string
          description: Optional request ID for tracking
          example: req_123456
        filter:
          type: object
          description: >
            Search filter parameters with field names as keys and single string
            values.


            Available fields:


            **Personal Information:**

            - `uuid` - Unique identifier

            - `first_name` - First name

            - `last_name` - Last name

            - `email` - Email address

            - `email_domain` - Email domain

            - `sha256_email` - SHA256 hash of email

            - `phone` - Phone number


            **Location Information:**

            - `personal_zip` - Personal ZIP/postal code

            - `personal_address` - Personal street address

            - `personal_state` - Personal state/province

            - `personal_city` - Personal city


            **Company Information:**

            - `company_name` - Company name

            - `company_domain` - Company domain name


            **Social/Professional:**

            - `linkedin_url` - LinkedIn profile URL
          additionalProperties:
            type: string
          example:
            first_name: John
            last_name: Doe
            email: user@example.com
            phone: 555-123-4567
            company_name: Nike
            personal_city: San Francisco
            company_domain: nike.com
        fields:
          type: array
          description: >
            Optional array of field names to include in the response. If not
            specified, all available fields are returned.


            **Available output fields:**

            - `company` - Company name

            - `job_title` - Job title/position

            - `first_name` - First name

            - `last_name` - Last name

            - `b2b_email` - Business email address

            - `personal_email` - Personal email address

            - `b2b_phone` - Business phone number

            - `personal_phone` - Personal phone number

            - `sha256` - SHA256 hash identifier

            - `linkedin_url` - LinkedIn profile URL

            - `address` - Street address

            - `city` - City

            - `state` - State/province

            - `zip` - ZIP/postal code

            - `industry` - Industry classification

            - `company_domain` - Company domain
          items:
            type: string
            enum:
              - company
              - job_title
              - first_name
              - last_name
              - b2b_email
              - personal_email
              - b2b_phone
              - personal_phone
              - sha256
              - linkedin_url
              - address
              - city
              - state
              - zip
              - industry
              - company_domain
          example:
            - first_name
            - last_name
            - b2b_email
            - company
            - job_title
        is_or_match:
          type: boolean
          description: |
            Determines how multiple criteria are combined:
            - `true`: OR logic - returns contacts matching ANY of the criteria
            - `false`: AND logic - returns contacts matching ALL of the criteria
          example: false
      required:
        - filter
        - is_or_match
    EnrichSearchResponse:
      type: object
      properties:
        request_id:
          type: string
          description: Request ID if provided in the request
          example: req_123456
        timestamp:
          type: integer
          format: int64
          description: Unix timestamp in milliseconds
          example: 1704067200000
        found:
          type: integer
          description: Number of matching records found
          example: 2
        result:
          type: array
          items:
            type: object
            description: >-
              Enriched contact data containing all available fields for the
              matched records
          description: Array of enriched contact records with complete profile information
          example:
            - email: john.doe@example.com
              first_name: John
              last_name: Doe
              business_email: jdoe@acmecorp.com
              sha256_email: a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3
              company_name: Acme Corp
              company_domain: acmecorp.com
              job_title: Senior Software Engineer
              industry: Technology
              city: San Francisco
              state: CA
              zip: '94105'
              address: 123 Market St
              linkedin_url: https://linkedin.com/in/johndoe
            - email: jane.smith@example.com
              first_name: Jane
              last_name: Smith
              business_email: jsmith@acmecorp.com
              sha256_email: b665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae4
              company_name: Acme Corp
              company_domain: acmecorp.com
              job_title: Product Manager
              industry: Technology
              city: New York
              state: NY
              zip: '10001'
              address: 456 Broadway
              linkedin_url: https://linkedin.com/in/janesmith
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
          example: error message
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key

````