FullEnrich

https://docs.fullenrich.com/
Admin
Data enrichment API that aggregates contact and company information from 20+ providers with...
Tokens:25,307
Snippets:170
Trust Score:9
Update:2 months ago
Show doc for...
Tokens:
Raw
### OfficeAddress Schema Examples

Source: https://docs.fullenrich.com/api/v2/people/search/post

Examples of fields within the OfficeAddress object.

```text
111 8th Ave
```

```text
New York, NY 10011, US
```

--------------------------------

### CompanyAddress Schema Examples

Source: https://docs.fullenrich.com/api/v2/people/search/post

Examples of fields within the CompanyAddress object.

```text
548 Market St
```

```text
San Francisco, CA 94105, US
```

```text
San Francisco
```

```text
California
```

```text
United States
```

```text
US
```

--------------------------------

### Company Professional Network Handle Example

Source: https://docs.fullenrich.com/api/v2/people/search/post

Example of a professional network handle URL.

```text
https://app.fullenrich.com/logo/company/handle/anthropic
```

--------------------------------

### Person Names Filter Example

Source: https://docs.fullenrich.com/api/v2/people/search/post

Example structure for filtering by person names.

```yaml
- value: John Smith
  exact_match: false
  exclude: false
```

--------------------------------

### Professional Network URL Filter Example

Source: https://docs.fullenrich.com/api/v2/people/search/post

Example structure for filtering by professional network URL.

```yaml
- value: https://www.linkedin.com/company/fullenrich
  exact_match: true
  exclude: false
```

--------------------------------

### CompanySocialProfile Schema Examples

Source: https://docs.fullenrich.com/api/v2/people/search/post

Examples of fields within the CompanySocialProfile object.

```text
1234
```

```text
https://www.linkedin.com/company/anthropic
```

```text
anthropic
```

```text
125000
```

--------------------------------

### Industry Filter Example

Source: https://docs.fullenrich.com/api/v2/people/search/post

Example structure for filtering by company industry.

```yaml
- value: Software Development
  exact_match: false
  exclude: false
- value: Computer Hardware Manufacturing
  exact_match: false
  exclude: false
```

--------------------------------

### Company Domain Filter Example

Source: https://docs.fullenrich.com/api/v2/people/search/post

Example structure for filtering by company domain.

```yaml
- value: google.com
  exact_match: true
  exclude: false
```

--------------------------------

### Person Professional Network URLs Filter Example

Source: https://docs.fullenrich.com/api/v2/people/search/post

Example structure for filtering by professional network URLs.

```yaml
- value: https://www.linkedin.com/in/john-doe
  exact_match: true
  exclude: false
```

--------------------------------

### Professional Network ID Filter Example

Source: https://docs.fullenrich.com/api/v2/people/search/post

Example structure for filtering by professional network ID.

```yaml
- value: 1234
  exact_match: true
  exclude: false
```

--------------------------------

### Past Company Name Filter Example

Source: https://docs.fullenrich.com/api/v2/people/search/post

Example structure for filtering by past company names.

```yaml
- value: Meta
  exact_match: true
  exclude: false
```

--------------------------------

### Past Company Domain Filter Example

Source: https://docs.fullenrich.com/api/v2/people/search/post

Example structure for filtering by past company domains.

```yaml
- value: facebook.com
  exact_match: true
  exclude: false
```

--------------------------------

### Company Specialties Filter Example

Source: https://docs.fullenrich.com/api/v2/people/search/post

Example structure for filtering by company specialties.

```yaml
- value: artificial intelligence
  exact_match: true
  exclude: false
```

--------------------------------

### Configure Webhook URL

Source: https://docs.fullenrich.com/api/v2/general/webhooks

Example JSON payload for setting up a webhook URL to receive batch completion notifications.

```json
{
  "name": "My Enrichment",
  "webhook_url": "https://your-server.com/webhook",
  "data": [...]
}
```

--------------------------------

### OpenAPI Specification for Bulk Reverse Email Results

Source: https://docs.fullenrich.com/api/v2/contact/reverse/email/bulk/get

Defines the GET endpoint for retrieving bulk reverse email lookup results by enrichment ID. Includes the request parameter schema and an example response structure.

```yaml
openapi: 3.1.0
info:
  title: FullEnrich API Documentation
  version: 2.0.0
  description: >
    FullEnrich API enables you to enrich B2B contacts with emails and phone
    numbers using data from 20+ providers.


    We are GDPR and CCPA compliant.
servers:
  - url: https://app.fullenrich.com/api/v2
paths:
  /contact/reverse/email/bulk/{enrichment_id}:
    get:
      summary: Get Bulk Reverse Email Results
      description: Use this endpoint to retrieve the result from a reverse email lookup.
      operationId: GetContactBulkReverseEmailByID
      parameters:
        - name: enrichment_id
          in: path
          required: true
          description: The unique identifier returned when the reverse lookup was started
          schema:
            type: string
          example: 2db5ea61-1752-42cf-8ea1-ab1da060cd0a
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseGetContactBulkReverseEmail'
              example:
                id: 2db5ea61-1752-42cf-8ea1-ab1da060cd0a
                name: Reverse Email Lookup
                status: FINISHED
                cost:
                  credits: 1
                data:
                  - input:
                      email: johnsnow@gmail.com
                    custom:
                      user_id: '12584'
                    profile:
                      id: 746e4816-19c8-54d8-b558-65a5a52cc85c
                      full_name: John Snow
                      first_name: John
                      last_name: Snow
                      headline: >-
                        Head of Sales Operations at Example Inc | Revenue
                        Operations, CRM & Sales Enablement
                      location:
                        country: United States
                        country_code: US
                        city: San Francisco
                        region: California
                      social_profiles:
                        professional_network:
                          url: https://www.linkedin.com/in/demoge/
                          handle: demoge
                          connection_count: 500
                      educations:
                        - school_name: Stanford University
                          degree: Bachelor of Science in Computer Science
                          start_at: '2015-09-01T00:00:00Z'
                          end_at: '2019-06-01T00:00:00Z'
                      languages:
                        - language: English
                          proficiency: PROFESSIONAL_WORKING
                        - language: French
                          proficiency: NATIVE_OR_BILINGUAL
                      skills:
                        - Sales Operations
                        - Business Development
                        - CRM Management
                      employment:
                        current:
                          title: Head of Sales Operations
                          is_current: true
                          start_at: '2022-03-15T00:00:00Z'
                          company:
                            id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                            name: Example Inc
                            domain: example.com
                            description: Leading example company
                            year_founded: 2010
                            headcount: 250
                            company_type: Privately Held
                            locations:
                              headquarters:
                                line1: 123 Market St
                                line2: San Francisco, CA 94105, US
                                city: San Francisco
                                region: California
                                country: United States
                                country_code: US
                              offices:
                                - line1: 456 Broadway
                                  line2: New York, NY 10013, US
                            industry:
                              main_industry: Software Development
                            social_profiles:
                              professional_network:
```

--------------------------------

### Verifying Webhook Authenticity

Source: https://docs.fullenrich.com/api/v2/general/webhooks

Instructions and code examples for verifying the authenticity of incoming webhooks using the X-Signature-SHA1 header.

```APIDOC
## Verifying Webhook Authenticity

### Description
Every webhook request includes an `X-Signature-SHA1` header. You must verify this signature by computing an HMAC-SHA1 hash of the raw request body using your API key as the secret.

### Verification Steps
1. Read the `X-Signature-SHA1` header value.
2. Capture the raw request body bytes exactly as received (do not re-serialize).
3. Compute the HMAC-SHA1 hash of the raw body using your API key.
4. Compare the computed hash with the header value using a constant-time comparison.
```

--------------------------------

### OpenAPI Specification for Get Credit Balance

Source: https://docs.fullenrich.com/api/v2/account/credits/get

This OpenAPI 3.1.0 specification defines the GET /account/credits endpoint, which retrieves the current credit balance. It includes details on request, responses, and security schemes.

```yaml
openapi: 3.1.0
info:
  title: FullEnrich API Documentation
  version: 2.0.0
  description: >
    FullEnrich API enables you to enrich B2B contacts with emails and phone
    numbers using data from 20+ providers.


    We are GDPR and CCPA compliant.
servers:
  - url: https://app.fullenrich.com/api/v2
security: []
paths:
  /account/credits:
    get:
      summary: Get Current Balance
      description: >-
        This endpoint provides the current balance of credits available in your
        workspace.
      operationId: getAccountCredits
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credits'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AuthorizationHeaderNotSet:
                  value:
                    code: error.authorization.not_set
                    message: Authorization headers not set
                AuthorizationHeaderNotAnBearer:
                  value:
                    code: error.authorization.not_bearer
                    message: Authorization headers do not have prefix 'bearer'
                UnknownApiKey:
                  value:
                    code: error.api.key
                    message: Unknown api key
        '404':
          description: Workspace ID not found
      security:
        - BearerAuth: []
components:
  schemas:
    Credits:
      type: object
      properties:
        balance:
          type: number
          format: double
          description: Number of credits available on your workspace
          examples:
            - 5000
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: string

```

--------------------------------

### GET api/v2/contact/reverse/email/bulk

Source: https://docs.fullenrich.com/api/v2/contact/reverse/email/bulk/get

Retrieves contact and company information for a list of email addresses.

```APIDOC
## GET api/v2/contact/reverse/email/bulk

### Description
Retrieves contact and company information for a list of email addresses.

### Method
GET

### Endpoint
api/v2/contact/reverse/email/bulk

### Response
#### Success Response (200)
- **data** (array) - List of contact and company profiles associated with the provided emails.

#### Error Response (401)
- **code** (string) - Error code (e.g., error.authorization.not_set, error.authorization.not_bearer, error.api.key)
- **message** (string) - Error description

#### Error Response (402)
- **Payment Required** - Indicates that the request requires payment or credit deduction.

#### Error Response (404)
- **Not Found** - The requested reverse email lookup was not found.
```

--------------------------------

### Get Current Balance

Source: https://docs.fullenrich.com/api/v2/account/credits/get

Fetches the current credit balance for the authenticated workspace. This is useful for monitoring usage and planning.

```APIDOC
## GET /account/credits

### Description
This endpoint provides the current balance of credits available in your workspace.

### Method
GET

### Endpoint
/account/credits

### Parameters

### Request Body

### Response
#### Success Response (200)
- **balance** (number) - Number of credits available on your workspace

#### Response Example
{
  "balance": 5000
}
```

--------------------------------

### Bulk Contact Enrichment Request Schema

Source: https://docs.fullenrich.com/api/v2/contact/enrich/bulk/post

Example JSON payload for initiating a bulk contact enrichment job.

```yaml
name: Sales Operations in London
webhook_url: https://example.com/webhook
webhook_events:
  contact_finished: https://example.com/webhook/contact
data:
  - first_name: John
    last_name: Snow
    domain: example.com
    company_name: Example Inc
    linkedin_url: https://www.linkedin.com/in/demoge/
    enrich_fields:
      - contact.work_emails
      - contact.personal_emails
      - contact.phones
    custom:
      user_id: '12584'
```

--------------------------------

### Unauthorized Error Responses

Source: https://docs.fullenrich.com/api/v2/contact/reverse/email/bulk/get

Examples of JSON error responses returned when authentication fails or is missing.

```json
{
  "code": "error.authorization.not_set",
  "message": "Authorization headers not set"
}
```

```json
{
  "code": "error.authorization.not_bearer",
  "message": "Authorization headers do not have prefix 'bearer'"
}
```

```json
{
  "code": "error.api.key",
  "message": "Unknown api key"
}
```

--------------------------------

### Bulk Contact Enrichment Request Schema

Source: https://docs.fullenrich.com/api/v2/contact/enrich/bulk/post

Example JSON structure for a bulk contact enrichment request, including webhook configuration and contact data.

```json
RequestPostContactBulkEnrich:
  type: object
  example:
    name: Sales Operations in London
    webhook_url: https://example.com/webhook
    webhook_events:
      contact_finished: https://example.com/webhook/contact
    data:
      - first_name: John
        last_name: Snow
        domain: example.com
        company_name: Example Inc
        professional_network_url: https://www.linkedin.com/in/demoge/
        enrich_fields:
          - contact.work_emails
          - contact.personal_emails
          - contact.phones
        custom:
          user_id: '12584'
```

--------------------------------

### OpenAPI Specification for API Key Verification

Source: https://docs.fullenrich.com/api/v2/account/keys/verify/get

This OpenAPI 3.1.0 specification defines the GET /account/keys/verify endpoint. It details the request, successful responses (200 OK), and various error responses (401 Unauthorized, 404 Not Found).

```yaml
openapi: 3.1.0
info:
  title: FullEnrich API Documentation
  version: 2.0.0
  description: >
    FullEnrich API enables you to enrich B2B contacts with emails and phone
    numbers using data from 20+ providers.


    We are GDPR and CCPA compliant.
servers:
  - url: https://app.fullenrich.com/api/v2
security: []
paths:
  /account/keys/verify:
    get:
      summary: Check If API Key Is Valid
      description: This endpoint checks if your API key is valid.
      operationId: checkKey
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/verifyKey'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AuthorizationHeaderNotSet:
                  value:
                    code: error.authorization.not_set
                    message: Authorization headers not set
                AuthorizationHeaderNotAnBearer:
                  value:
                    code: error.authorization.not_bearer
                    message: Authorization headers do not have prefix 'bearer'
                UnknowApiKey:
                  value:
                    code: error.api.key
                    message: Unknown api key
        '404':
          description: Workspace ID not found
      security:
        - BearerAuth: []
components:
  schemas:
    verifyKey:
      type: object
      description: Response returned when API key is valid
      properties:
        workspace_id:
          type: string
          description: The workspace ID associated with this API key
          example: 2db5ea61-1752-42cf-8ea1-ab1da060cd0a
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: string

```

--------------------------------

### OpenAPI Specification for Company Search

Source: https://docs.fullenrich.com/api/v2/company/search/post

The OpenAPI definition for the POST /company/search endpoint, including request schemas and error response examples.

```yaml
openapi: 3.1.0
info:
  title: FullEnrich API Documentation
  version: 2.0.0
  description: >
    FullEnrich API enables you to enrich B2B contacts with emails and phone
    numbers using data from 20+ providers.


    We are GDPR and CCPA compliant.
servers:
  - url: https://app.fullenrich.com/api/v2
security: []
paths:
  /company/search:
    post:
      summary: Search company
      description: >-
        Search for companies based on various filters. Multiple filters within
        the same field are combined with AND logic.
      operationId: postCompanySearch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchCompanyRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SearchCompanyResponse'
                  - $ref: '#/components/schemas/Metadata'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AuthorizationHeaderNotSet:
                  value:
                    code: error.authorization.not_set
                    message: Authorization headers not set
                AuthorizationHeaderNotAnBearer:
                  value:
                    code: error.authorization.not_bearer
                    message: Authorization headers do not have prefix 'bearer'
                UnknownApiKey:
                  value:
                    code: error.api.key
                    message: Unknown api key
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                RateLimitExceeded:
                  value:
                    code: error.rate.limit
                    message: Too many requests. Try again in 1m
      security:
        - BearerAuth: []
components:
  schemas:
    SearchCompanyRequest:
      type: object
      properties:
        offset:
          type: integer
          description: >-
            Number of companies to skip (use this for pagination). Maximum value
            is 10,000. To paginate beyond 10,000 results, use search_after
            instead.
          example: 20
        limit:
          type: integer
          description: 'Number of companies to return (default: 10, max: 100)'
          example: 20
        search_after:
          type: string
          description: >-
            Cursor-based pagination. Pass the search_after value from the
            previous response to get the next page. Works at any point in the
            result set, but is required to access results beyond the 10,000
            offset limit. The search_after token does not have any expiration
            date. However, when the database is updated (every month), if the
            position of a company changes, the same search_after token might
            display different results.
          example: WzE1LjUzNDU2MywiYjQ5MDBiYmQtOTg5MS01Mzk1LWIyODUtOWEyOGNiZThjOTM3Il0=
        names:
          type: array
          description: >-
            Filter by company names. Use exact_match for precise company name
            matching.
          items:
            type: object
            properties:
              value:
                type: string
                description: The string value to filter by
                example: Microsoft
              exclude:
                type: boolean
                description: >-
                  If true, excludes results matching this value. If false or
                  omitted (default), includes only matching results.
                example: false
              exact_match:
                type: boolean
                description: >-
                  When true, the value must match exactly as stored
                  (case-insensitive), with no tolerance for variations. When
                  false (default), the API tolerates minor differences such as
                  missing words, extra words, or slight reordering. Matching is
                  never case-sensitive.
                example: true
          example:
            - value: Microsoft
              exact_match: true
              exclude: false
        domains:
          type: array
          description: >-
            Filter by company domains (e.g., 'google.com', 'microsoft.com').
            Exact match recommended.
          items:
            type: object
            properties:
```

--------------------------------

### Webhook Payload with Custom Tracking

Source: https://docs.fullenrich.com/api/v2/general/webhooks

Example of a JSON webhook payload containing a custom object for tracking user or CRM identifiers.

```json
{
  "data": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "domain": "example.com",
      "custom": {
        "user_id": "12584",
        "crm_contact_id": "abc-123"
      }
    }
  ]
}
```

--------------------------------

### OpenAPI Specification for Bulk Enrichment Retrieval

Source: https://docs.fullenrich.com/api/v2/contact/enrich/bulk/get

Defines the GET /contact/enrich/bulk/{enrichment_id} endpoint, including path parameters, query options, and the expected JSON response structure.

```yaml
openapi: 3.1.0
info:
  title: FullEnrich API Documentation
  version: 2.0.0
  description: >
    FullEnrich API enables you to enrich B2B contacts with emails and phone
    numbers using data from 20+ providers.


    We are GDPR and CCPA compliant.
servers:
  - url: https://app.fullenrich.com/api/v2
security: []
paths:
  /contact/enrich/bulk/{enrichment_id}:
    get:
      summary: Get Bulk Enrich Results
      description: Use this endpoint to retrieve the result from an enrich.
      operationId: GetContactBulkEnrichByID
      parameters:
        - name: enrichment_id
          in: path
          required: true
          description: The unique identifier returned when the enrichment was started
          schema:
            type: string
          example: 2db5ea61-1752-42cf-8ea1-ab1da060cd0a
        - name: forceResults
          in: query
          schema:
            type: boolean
          description: >-
            Default = False. This parameter forces the API to return what has
            been found so far, even if the enrichment is not finished. This may
            result in missing information and is not recommended for regular
            use.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseGetContactBulkEnrich'
              example:
                id: 2db5ea61-1752-42cf-8ea1-ab1da060cd0a
                name: Sales Operations in London
                status: FINISHED
                cost:
                  credits: 14
                data:
                  - input:
                      first_name: John
                      last_name: Snow
                      company_domain: example.com
                      company_name: Example Inc
                      professional_network_url: https://www.linkedin.com/in/demoge/
                    custom:
                      user_id: '12584'
                    contact_info:
                      most_probable_work_email:
                        email: john.snow@example.com
                        status: DELIVERABLE
                      most_probable_personal_email:
                        email: johnsnow@gmail.com
                        status: DELIVERABLE
                      most_probable_phone:
                        number: +1 555-123-4567
                        region: US
                      work_emails:
                        - email: john.snow@example.com
                          status: DELIVERABLE
                      personal_emails:
                        - email: johnsnow@gmail.com
                          status: DELIVERABLE
                      phones:
                        - number: +1 555-123-4567
                          region: US
                        - number: +33 6 12 34 56 78
                          region: FR
                    profile:
                      id: 746e4816-19c8-54d8-b558-65a5a52cc85c
                      full_name: John Snow
                      first_name: John
                      last_name: Snow
                      headline: >-
                        Head of Sales Operations at Example Inc | Revenue
                        Operations, CRM & Sales Enablement
                      location:
                        country: United States
                        country_code: US
                        city: San Francisco
                        region: California
                      social_profiles:
                        professional_network:
                          id: 1234
                          url: https://www.linkedin.com/in/john-doe
                          handle: john-doe
                          connection_count: 500
                      educations:
                        - school_name: Stanford University
                          degree: Bachelor of Science in Computer Science
                          start_at: '2015-09-01T00:00:00Z'
                          end_at: '2019-06-01T00:00:00Z'
                      languages:
                        - language: English
                          proficiency: PROFESSIONAL_WORKING
                        - language: French
                          proficiency: NATIVE_OR_BILINGUAL
                      skills:
                        - Sales Operations
                        - Business Development
                        - CRM Management
```

--------------------------------

### Webhook Configuration

Source: https://docs.fullenrich.com/api/v2/general/webhooks

Configure a webhook URL to receive notifications when a batch process is finished, lacks credits, or is canceled.

```APIDOC
## Webhook Configuration

### Description
Provide a `webhook_url` in your request to receive a POST notification when the entire batch process is finished, lacks credits, or is canceled.

### Request Body
- **name** (string) - Optional - Name of the enrichment task
- **webhook_url** (string) - Required - The URL where the POST request will be sent
- **data** (array) - Required - The data payload for the enrichment

### Request Example
{
  "name": "My Enrichment",
  "webhook_url": "https://your-server.com/webhook",
  "data": []
}
```

--------------------------------

### GET /api/v2/contact/enrich/bulk/{id}

Source: https://docs.fullenrich.com/api/v2/contact/enrich/bulk/get

Retrieves the results of a bulk enrichment job by its unique identifier.

```APIDOC
## GET /api/v2/contact/enrich/bulk/{id}

### Description
Retrieves the status and enriched data for a specific bulk contact enrichment job.

### Method
GET

### Endpoint
/api/v2/contact/enrich/bulk/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique UUID of the enrichment job.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the enrichment job.
- **name** (string) - The name assigned to the enrichment job.
- **status** (string) - The current status of the job (CREATED, IN_PROGRESS, CANCELED, CREDITS_INSUFFICIENT, FINISHED, RATE_LIMIT, UNKNOWN).
- **data** (array) - List of enriched contact records.
- **cost** (object) - The cost in credits for this enrichment.
```

--------------------------------

### OpenAPI Specification for People Look Up

Source: https://docs.fullenrich.com/api/v2/people/lookup/post

Defines the POST /people/lookup endpoint, including request parameters, response schemas, and error handling.

```yaml
openapi: 3.1.0
info:
  title: FullEnrich API Documentation
  version: 2.0.0
  description: >
    FullEnrich API enables you to enrich B2B contacts with emails and phone
    numbers using data from 20+ providers.


    We are GDPR and CCPA compliant.
servers:
  - url: https://app.fullenrich.com/api/v2
paths:
  /people/lookup:
    post:
      summary: Look up people
      description: >-
        Look up a single person using their identifiers (professional network
        URL/ID, or full name combined with a company identifier). Returns the
        best matching person.
      operationId: postPeopleLookup
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LookUpPeopleRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/LookUpPeopleResponse'
                  - $ref: '#/components/schemas/LookUpMetadata'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AuthorizationHeaderNotSet:
                  value:
                    code: error.authorization.not_set
                    message: Authorization headers not set
                AuthorizationHeaderNotAnBearer:
                  value:
                    code: error.authorization.not_bearer
                    message: Authorization headers do not have prefix 'bearer'
                UnknownApiKey:
                  value:
                    code: error.api.key
                    message: Unknown api key
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                RateLimitExceeded:
                  value:
                    code: error.rate.limit
                    message: Too many requests. Try again in 1m
      security:
        - BearerAuth: []
components:
  schemas:
    LookUpPeopleRequest:
      type: object
      description: >-
        Provide at least one identifier to match a single person. The
        professional network URL or ID is the most reliable. A full name can be
        combined with a company identifier (domain, professional network URL, or
        professional network ID) to disambiguate the match.
      properties:
        person_name:
          type: string
          description: Full name of the person to look up.
          example: Enzo Romera
        person_professional_network_url:
          type: string
          description: Professional network profile URL of the person.
          example: https://www.linkedin.com/in/enzo-romera
        person_professional_network_id:
          type: integer
          description: Professional network profile ID of the person.
          example: 530992355
        company_professional_network_url:
          type: string
          description: >-
            Professional network URL of the company the person works for. Used
            to disambiguate when looking up by name.
          example: https://www.linkedin.com/company/anthropic
        company_professional_network_id:
          type: integer
          description: >-
            Professional network ID of the company the person works for. Used to
            disambiguate when looking up by name.
          example: 1883877
        company_domain:
          type: string
          description: >-
            Domain of the company the person works for. Used to disambiguate
```

--------------------------------

### GET /api/v2/contact/reverse/email/bulk/{id}

Source: https://docs.fullenrich.com/api/v2/contact/reverse/email/bulk/get

Retrieves the details and results of a bulk reverse email lookup operation.

```APIDOC
## GET /api/v2/contact/reverse/email/bulk/{id}

### Description
Retrieves the status and data associated with a specific bulk reverse email lookup operation.

### Method
GET

### Endpoint
/api/v2/contact/reverse/email/bulk/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique UUID of the bulk reverse email lookup operation.

### Response
#### Success Response (200)
- **id** (string) - The operation UUID.
- **name** (string) - The name of the operation.
- **status** (string) - The current status of the operation (CREATED, IN_PROGRESS, CANCELED, CREDITS_INSUFFICIENT, FINISHED, RATE_LIMIT, UNKNOWN).
- **data** (array) - List of records containing input email, custom data, and profile information.
- **cost** (object) - Information regarding credits consumed.

#### Error Response (404)
- **code** (string) - error.reverse.email.not_found
- **message** (string) - Reverse email ID not found
```

--------------------------------

### POST /contact/reverse/email/bulk

Source: https://docs.fullenrich.com/api/v2/contact/reverse/email/bulk/post

Initiates a bulk reverse lookup process for a list of email addresses.

```APIDOC
## POST /contact/reverse/email/bulk

### Description
Initiates a bulk reverse lookup process for a list of email addresses. This operation is asynchronous and returns an enrichment ID.

### Method
POST

### Endpoint
/contact/reverse/email/bulk

### Request Body
- **name** (string) - Required - A readable name for this reverse lookup (visible in your dashboard)
- **webhook_url** (string) - Optional - URL that will receive a POST request when the entire reverse lookup is finished
- **webhook_events** (object) - Optional - Optional webhook URLs for specific events
  - **contact_finished** (string) - Optional - URL that receives a POST request each time a single email is processed
- **data** (array) - Required - List of email objects to process
  - **email** (string) - Required - Email address to perform reverse lookup on
  - **custom** (object) - Optional - Custom fields returned in the result

### Request Example
{
  "name": "Reverse Lookup Batch 1",
  "webhook_url": "https://example.com/webhook",
  "webhook_events": {
    "contact_finished": "https://example.com/webhook/contact"
  },
  "data": [
    {
      "email": "john.snow@example.com",
      "custom": {
        "user_id": "12584"
      }
    }
  ]
}

### Response
#### Success Response (200)
- **enrichment_id** (string) - UUID of the initiated enrichment process

#### Response Example
{
  "enrichment_id": "2db5ea61-1752-42cf-8ea1-ab1da060cd0a"
}
```

--------------------------------

### Enrichment Not Found Error

Source: https://docs.fullenrich.com/api/v2/contact/enrich/bulk/get

Returned when the requested enrichment ID does not exist.

```json
value:
  code: error.enrichment.not_found
  message: Enrichment ID not found
```

--------------------------------

### Configure contact_finished webhook

Source: https://docs.fullenrich.com/api/v2/general/webhooks

Include the contact_finished key in your webhook_events configuration to receive individual contact updates.

```json
{
  "name": "My Enrichment",
  "webhook_url": "https://your-server.com/webhook/batch-complete",
  "webhook_events": {
    "contact_finished": "https://your-server.com/webhook/single-contact"
  },
  "data": [...]
}
```

--------------------------------

### GET /contact/enrich/bulk/{enrichment_id}

Source: https://docs.fullenrich.com/api/v2/contact/enrich/bulk/get

Use this endpoint to retrieve the result from an enrich. You don’t need to use this endpoint if you are using a webhook.

```APIDOC
## GET /contact/enrich/bulk/{enrichment_id}

### Description
Use this endpoint to retrieve the result from an enrich.

### Method
GET

### Endpoint
/contact/enrich/bulk/{enrichment_id}

### Parameters
#### Path Parameters
- **enrichment_id** (string) - Required - The unique identifier returned when the enrichment was started

#### Query Parameters
- **forceResults** (boolean) - Optional - Default = False. This parameter forces the API to return what has been found so far, even if the enrichment is not finished.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the enrichment
- **name** (string) - The name of the enrichment task
- **status** (string) - The current status of the enrichment (e.g., FINISHED)
- **cost** (object) - The cost associated with the enrichment
- **data** (array) - The list of enriched contact data

#### Response Example
{
  "id": "2db5ea61-1752-42cf-8ea1-ab1da060cd0a",
  "name": "Sales Operations in London",
  "status": "FINISHED",
  "cost": {
    "credits": 14
  },
  "data": [
    {
      "input": {
        "first_name": "John",
        "last_name": "Snow",
        "company_domain": "example.com",
        "company_name": "Example Inc",
        "professional_network_url": "https://www.linkedin.com/in/demoge/"
      },
      "custom": {
        "user_id": "12584"
      },
      "contact_info": {
        "most_probable_work_email": {
          "email": "john.snow@example.com",
          "status": "DELIVERABLE"
        },
        "most_probable_personal_email": {
          "email": "johnsnow@gmail.com",
          "status": "DELIVERABLE"
        },
        "most_probable_phone": {
          "number": "+1 555-123-4567",
          "region": "US"
        },
        "work_emails": [
          {
            "email": "john.snow@example.com",
            "status": "DELIVERABLE"
          }
        ],
        "personal_emails": [
          {
            "email": "johnsnow@gmail.com",
            "status": "DELIVERABLE"
          }
        ],
        "phones": [
          {
            "number": "+1 555-123-4567",
            "region": "US"
          },
          {
            "number": "+33 6 12 34 56 78",
            "region": "FR"
          }
        ]
      },
      "profile": {
        "id": "746e4816-19c8-54d8-b558-65a5a52cc85c",
        "full_name": "John Snow",
        "first_name": "John",
        "last_name": "Snow",
        "headline": "Head of Sales Operations at Example Inc | Revenue Operations, CRM & Sales Enablement",
        "location": {
          "country": "United States",
          "country_code": "US",
          "city": "San Francisco",
          "region": "California"
        },
        "social_profiles": {
          "professional_network": {
            "id": 1234,
            "url": "https://www.linkedin.com/in/john-doe",
            "handle": "john-doe",
            "connection_count": 500
          }
        },
        "educations": [
          {
            "school_name": "Stanford University",
            "degree": "Bachelor of Science in Computer Science",
            "start_at": "2015-09-01T00:00:00Z",
            "end_at": "2019-06-01T00:00:00Z"
          }
        ],
        "languages": [
          {
            "language": "English",
            "proficiency": "PROFESSIONAL_WORKING"
          },
          {
            "language": "French",
            "proficiency": "NATIVE_OR_BILINGUAL"
          }
        ],
        "skills": [
          "Sales Operations",
          "Business Development",
          "CRM Management"
        ]
      }
    }
  ]
}
```

--------------------------------

### GET /contact/reverse/email/bulk/{enrichment_id}

Source: https://docs.fullenrich.com/api/v2/contact/reverse/email/bulk/get

Retrieves the result from a reverse email lookup. Note that using a webhook is recommended for real-time updates.

```APIDOC
## GET /contact/reverse/email/bulk/{enrichment_id}

### Description
Use this endpoint to retrieve the result from a reverse email lookup.

### Method
GET

### Endpoint
/contact/reverse/email/bulk/{enrichment_id}

### Parameters
#### Path Parameters
- **enrichment_id** (string) - Required - The unique identifier returned when the reverse lookup was started

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the enrichment
- **name** (string) - The name of the lookup
- **status** (string) - The current status of the enrichment (e.g., FINISHED)
- **cost** (object) - Credit cost details
- **data** (array) - The enriched profile data

#### Response Example
{
  "id": "2db5ea61-1752-42cf-8ea1-ab1da060cd0a",
  "name": "Reverse Email Lookup",
  "status": "FINISHED",
  "cost": {
    "credits": 1
  },
  "data": [
    {
      "input": {
        "email": "johnsnow@gmail.com"
      },
      "profile": {
        "full_name": "John Snow",
        "first_name": "John",
        "last_name": "Snow"
      }
    }
  ]
}
```

--------------------------------

### Enrichment In Progress Error

Source: https://docs.fullenrich.com/api/v2/contact/enrich/bulk/get

Returned when an enrichment request is still processing.

```json
value:
  code: error.enrichment.in_progress
  message: Enrichment not ready, try again in 30 seconds
```

--------------------------------

### OpenAPI Specification for POST /people/search

Source: https://docs.fullenrich.com/api/v2/people/search/post

Defines the endpoint structure, request body schema, and potential error responses for searching people.

```yaml
openapi: 3.1.0
info:
  title: FullEnrich API Documentation
  version: 2.0.0
  description: >
    FullEnrich API enables you to enrich B2B contacts with emails and phone
    numbers using data from 20+ providers.


    We are GDPR and CCPA compliant.
servers:
  - url: https://app.fullenrich.com/api/v2
security: []
paths:
  /people/search:
    post:
      summary: Search people
      description: >-
        Search for people based on various filters. Multiple filters within the
        same field are combined with AND logic.
      operationId: postPeopleSearch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchPeopleRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SearchPeopleResponse'
                  - $ref: '#/components/schemas/Metadata'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AuthorizationHeaderNotSet:
                  value:
                    code: error.authorization.not_set
                    message: Authorization headers not set
                AuthorizationHeaderNotAnBearer:
                  value:
                    code: error.authorization.not_bearer
                    message: Authorization headers do not have prefix 'bearer'
                UnknownApiKey:
                  value:
                    code: error.api.key
                    message: Unknown api key
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                RateLimitExceeded:
                  value:
                    code: error.rate.limit
                    message: Too many requests. Try again in 1m
      security:
        - BearerAuth: []
components:
  schemas:
    SearchPeopleRequest:
      type: object
      properties:
        offset:
          type: integer
          description: >-
            Number of people to skip (use this for pagination). Maximum value is
            10,000. To paginate beyond 10,000 results, use search_after instead.
          example: 0
        limit:
          type: integer
          description: 'Number of people to return (default: 10, max: 100)'
          example: 20
        search_after:
          type: string
          description: >-
            Cursor-based pagination. Pass the search_after value from the
            previous response to get the next page. Works at any point in the
            result set, but is required to access results beyond the 10,000
            offset limit. The search_after token does not have any expiration
            date. However, when the database is updated (every month), if the
            position of a contact changes, the same search_after token might
            display different results.
          example: WzE1LjUzNDU2MywiYjQ5MDBiYmQtOTg5MS01Mzk1LWIyODUtOWEyOGNiZThjOTM3Il0=
        current_company_names:
          type: array
          description: >-
            Filter by current company names. Use exact_match for precise company
            name matching.
          items:
            type: object
            properties:
              value:
                type: string
                description: The string value to filter by
                example: Anthropic
              exclude:
                type: boolean
                description: >-
                  If true, excludes results matching this value. If false or
                  omitted (default), includes only matching results.
                example: false
              exact_match:
                type: boolean
                description: >-
                  When true, the value must match exactly as stored
                  (case-insensitive), with no tolerance for variations. When
                  false (default), the API tolerates minor differences such as
                  missing words, extra words, or slight reordering. Matching is
                  never case-sensitive.
                example: true
          example:
            - value: Anthropic
              exact_match: true
              exclude: false
            - value: OpenAI
              exact_match: true
              exclude: false
        current_company_domains:
          type: array
          description: >-
            Filter by current company domains (e.g., 'google.com',
```
Tokens:
Raw