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

# Enrich contacts

> Runs the contact waterfall over a completed search to attach emails and phone numbers. This spends money, so it is deliberately gated: completed searches only, on an explicit call, with an explicit target.



## OpenAPI

````yaml /openapi.json post /api/scans/{id}/enrich
openapi: 3.1.0
info:
  title: Revcenter API
  description: >-
    Search, enrich, and activate people and companies. Two authentication
    surfaces share one host: the bearer-token API under `/v1` for
    server-to-server and agent use, and the workspace-session API under `/api`
    that the Revcenter app itself runs on.
  version: '2026-08-12'
servers:
  - url: https://api.revcenter.ai
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Search
    description: Web search, search runs, results, exports, and shareable shortlists.
  - name: People
    description: Person search, profile enrichment, and the workspace contact pool.
  - name: Companies
    description: Company search, company enrichment, and org-chart people.
  - name: Campaigns
    description: Plan, publish, and launch outbound sequences on Smartlead and HeyReach.
  - name: Account
    description: Health, usage totals, and cost events.
paths:
  /api/scans/{id}/enrich:
    post:
      tags:
        - Search
      summary: Enrich contacts
      description: >-
        Runs the contact waterfall over a completed search to attach emails and
        phone numbers. This spends money, so it is deliberately gated: completed
        searches only, on an explicit call, with an explicit target.
      operationId: enrichScan
      parameters:
        - $ref: '#/components/parameters/ScanId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - targets
              properties:
                targets:
                  type: string
                  enum:
                    - email
                    - phone
                    - both
                  description: What to look up.
            examples:
              emailsOnly:
                summary: Emails only
                value:
                  targets: email
              both:
                summary: Emails and phones
                value:
                  targets: both
      responses:
        '200':
          description: Enrichment ran.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '400':
          $ref: '#/components/responses/AppBadRequest'
        '401':
          $ref: '#/components/responses/AppUnauthorized'
        '404':
          $ref: '#/components/responses/AppNotFound'
        '424':
          $ref: '#/components/responses/AppProviderUnavailable'
      security:
        - sessionCookie: []
components:
  parameters:
    ScanId:
      name: id
      in: path
      required: true
      description: The search ID.
      schema:
        type: string
        format: uuid
  responses:
    AppBadRequest:
      description: Missing or invalid input.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AppError'
          examples:
            missing:
              value:
                error: criteria (CriteriaV2) is required
    AppUnauthorized:
      description: >-
        Not signed in, no active workspace, or the account lacks the role this
        action needs. A frozen account gets `403` with code `frozen`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AppError'
          examples:
            signIn:
              value:
                error: Sign in required
    AppNotFound:
      description: >-
        The record does not exist, or belongs to another workspace. The two are
        deliberately indistinguishable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AppError'
          examples:
            notFound:
              value:
                error: Scan not found
    AppProviderUnavailable:
      description: >-
        A capability this action needs is not connected for the workspace. The
        `code` names which one.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AppError'
          examples:
            search:
              value:
                error: Search is unavailable for this workspace.
                code: search_unavailable
            scoring:
              value:
                error: AI scoring is unavailable for this workspace.
                code: ai_scoring_unavailable
            heyreach:
              value:
                error: No HeyReach API key configured — add one in Credentials.
                code: heyreach_not_configured
  schemas:
    AppError:
      type: object
      description: >-
        The error shape used by every `/api` endpoint. Flatter than the `/v1`
        shape, and `code` appears only where the UI branches on it.
      properties:
        error:
          type: string
        code:
          type: string
          examples:
            - search_unavailable
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A Revcenter API key: `Authorization: Bearer rvc_live_...`. Keys are
        scoped, rate limited per key, and metered per workspace.
    sessionCookie:
      type: apiKey
      in: cookie
      name: session
      description: >-
        A signed-in workspace session, sent as a browser cookie. Requests must
        include credentials, and act on the session's active workspace.

````