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

# Enrich a person

> Finds a person's work email, phone number or both, and saves the person, with what was found, as a contact in your workspace. Name the person one way: by `personId` (the `id` of their row from `GET /v1/lists/{listId}/rows`, or the id an earlier enrich or upload answered), by `linkedinUrl`, or by a name (`firstName`, `lastName` or both, or `fullName`) with `companyName` or `companyDomain`.

`find` says what to look for: `email` (the default), `phone` or `email_and_phone`. `providers` says where: `package` (the default) searches our own data package; `waterfall` searches the package, then a fixed series of further providers until one finds it. A waterfall search can take over a minute, so allow two minutes for the answer.

The answer lists the person's work email addresses whose check showed `valid` or `catch-all`, and every phone number they now have with what checking it showed (`hq` is the company's main line). Personal email addresses are left out and never charged. `found` holds what this call found that the person did not have, with who found it (`foundBy`): those values are what the call is charged for.

A `personId` your organization does not have answers `404` `person_not_found`. While another call is enriching the same person, a call answers `409` `enrichment_in_progress` and costs nothing: try again once it finishes. A person with too little to search with answers `422` `person_not_identifiable`.

**Price:** per value found, by who found it: an email \$0.02 from the package or \$0.05 from the waterfall, a phone number \$0.05 from the package or \$0.10 from the waterfall. With `providers` `package`, every value costs the package price. Values the person already had are free, and a call that finds nothing costs nothing. Before the search runs, the most it can cost for what `find` asks is held from your balance, and what it does not use is released. **Scope:** enrichment, with a key that can write.



## OpenAPI

````yaml /openapi.json post /v1/people/enrich
openapi: 3.1.0
info:
  title: outbound.dev API
  version: v1
  description: Find people and companies, and see what every call costs, with one API key.
servers:
  - url: https://api.outbound.dev
security: []
tags:
  - name: People
    description: >-
      Search people with filters, a saved search or a plain-language query,
      count matches and look up filter values.
  - name: Companies
    description: >-
      Search companies, count matches, name one company by its name, domain or
      LinkedIn page, and list its people.
  - name: Saved searches
    description: Keep a search under a title and run it again, for people or for companies.
  - name: Lists
    description: >-
      Keep people or companies in lists: create and change lists, page through
      their rows, and add or remove people.
  - name: Folders
    description: Group lists of one kind into folders.
  - name: Enrichment
    description: >-
      Find people's work emails and phone numbers: one person, a batch of
      people, or a list.
  - name: Jobs
    description: >-
      Long tasks a call started: their progress, what they produced and what
      they were charged, and stopping them.
  - name: Accounts
    description: >-
      Connect the mailboxes and LinkedIn seats that campaigns and the inbox send
      from, and look after them.
  - name: Campaigns
    description: >-
      Email and LinkedIn campaigns: their steps, the people they enroll, their
      queue of messages, templates, the knowledge hubs and writing styles AI
      steps are written from, the tracking domain their links go through, and
      the lists every campaign leaves out.
  - name: Inbox
    description: >-
      Read and answer the conversations of your mailboxes and LinkedIn seats,
      and send new messages and invitations.
  - name: Account
    description: >-
      The calling key and its organization, its rate limits, and revoking the
      key.
  - name: Billing
    description: The balance, the ledger of every change to it, and the price list.
  - name: Usage and requests
    description: >-
      Calls and spend by day, and the record of every request of the last 30
      days.
paths:
  /v1/people/enrich:
    post:
      tags:
        - Enrichment
      summary: Enrich a person
      description: >-
        Finds a person's work email, phone number or both, and saves the person,
        with what was found, as a contact in your workspace. Name the person one
        way: by `personId` (the `id` of their row from `GET
        /v1/lists/{listId}/rows`, or the id an earlier enrich or upload
        answered), by `linkedinUrl`, or by a name (`firstName`, `lastName` or
        both, or `fullName`) with `companyName` or `companyDomain`.


        `find` says what to look for: `email` (the default), `phone` or
        `email_and_phone`. `providers` says where: `package` (the default)
        searches our own data package; `waterfall` searches the package, then a
        fixed series of further providers until one finds it. A waterfall search
        can take over a minute, so allow two minutes for the answer.


        The answer lists the person's work email addresses whose check showed
        `valid` or `catch-all`, and every phone number they now have with what
        checking it showed (`hq` is the company's main line). Personal email
        addresses are left out and never charged. `found` holds what this call
        found that the person did not have, with who found it (`foundBy`): those
        values are what the call is charged for.


        A `personId` your organization does not have answers `404`
        `person_not_found`. While another call is enriching the same person, a
        call answers `409` `enrichment_in_progress` and costs nothing: try again
        once it finishes. A person with too little to search with answers `422`
        `person_not_identifiable`.


        **Price:** per value found, by who found it: an email \$0.02 from the
        package or \$0.05 from the waterfall, a phone number \$0.05 from the
        package or \$0.10 from the waterfall. With `providers` `package`, every
        value costs the package price. Values the person already had are free,
        and a call that finds nothing costs nothing. Before the search runs, the
        most it can cost for what `find` asks is held from your balance, and
        what it does not use is released. **Scope:** enrichment, with a key that
        can write.
      operationId: postPeopleEnrich
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          description: >-
            Names this operation, so a retry with the same key and body gets the
            first success again, marked `Idempotent-Replayed`, instead of
            running or charging twice. A mailbox's `password` is not compared:
            the same mailbox sent again with another password is the same call,
            and gets the first answer. Kept 24 hours for your organization and
            this route. A refusal (`4xx`) frees the key at once, so a corrected
            retry runs. After a server error (`5xx`), which may still take
            effect, the key stays held for 5 minutes from the call's start, and
            a retry in that time answers `409` `idempotency_in_progress`; after
            that, a send or import that may already have gone out answers `409`
            `idempotency_outcome_unknown` instead of running again. 1 to 255
            visible ASCII characters, such as a UUID.
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: ^[\x21-\x7E]+$
          example: 5f1c9d2e-8a4b-4e7c-9f30-6b2a1d8e4c75
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                personId:
                  type: string
                  description: >-
                    The person's id: the `id` of their row from `GET
                    /v1/lists/{listId}/rows`, or the id an earlier enrich or
                    upload answered. Send it on its own.
                  minLength: 24
                  maxLength: 24
                  pattern: ^[0-9a-fA-F]+$
                linkedinUrl:
                  type: string
                  description: The person's LinkedIn profile URL. Send it on its own.
                  maxLength: 500
                  pattern: ^(https?:\/\/)?([\w-]+\.)?linkedin\.com\/in\/[^\s/?#]+
                  example: https://www.linkedin.com/in/ana-costa
                firstName:
                  type: string
                  description: >-
                    The person's first name, with `companyName` or
                    `companyDomain`.
                  minLength: 1
                  maxLength: 200
                lastName:
                  type: string
                  description: >-
                    The person's last name, with `companyName` or
                    `companyDomain`.
                  minLength: 1
                  maxLength: 200
                fullName:
                  type: string
                  description: >-
                    The person's full name, in place of `firstName` and
                    `lastName`, with `companyName` or `companyDomain`.
                  minLength: 1
                  maxLength: 400
                companyName:
                  type: string
                  description: The name of the company the person works at.
                  minLength: 1
                  maxLength: 300
                companyDomain:
                  type: string
                  description: >-
                    The website domain of the company the person works at, such
                    as `northwind.example`.
                  minLength: 1
                  maxLength: 300
                find:
                  type: string
                  description: >-
                    What to find: a work `email` (the default), a `phone`
                    number, or both (`email_and_phone`).
                  enum:
                    - email
                    - phone
                    - email_and_phone
                  default: email
                providers:
                  type: string
                  description: >-
                    Where to look: `package` (the default) searches our own data
                    package; `waterfall` searches the package, then a fixed
                    series of further providers. A value's price depends on who
                    found it.
                  enum:
                    - package
                    - waterfall
                  default: package
            example:
              linkedinUrl: https://www.linkedin.com/in/ana-costa
              find: email_and_phone
              providers: waterfall
      responses:
        '200':
          description: >-
            The person's email addresses and phone numbers after the call, and
            what it found.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            X-Charged-Usd:
              $ref: '#/components/headers/ChargedUsd'
            X-Balance-Usd:
              $ref: '#/components/headers/BalanceUsd'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            Idempotent-Replayed:
              $ref: '#/components/headers/IdempotentReplayed'
          content:
            application/json:
              schema:
                type: object
                required:
                  - emails
                  - phones
                  - found
                properties:
                  personId:
                    type: string
                    description: >-
                      The person's id in your workspace, as list rows and
                      `personIds` name it. Send it as `personId` to enrich them
                      again. Absent when the person could not be saved.
                  emails:
                    type: array
                    description: >-
                      Every work email address the person has whose check showed
                      it can receive mail: `valid`, or `catch-all` (the domain
                      accepts mail for any address, so this one could not be
                      confirmed). Personal addresses are left out.
                    items:
                      type: object
                      required:
                        - email
                        - status
                      properties:
                        email:
                          type: string
                        status:
                          type: string
                          enum:
                            - valid
                            - catch-all
                  phones:
                    type: array
                    description: >-
                      Every phone number the person has, with what checking it
                      showed.
                    items:
                      type: object
                      required:
                        - phoneNumber
                      properties:
                        phoneNumber:
                          type: string
                        status:
                          type: string
                          enum:
                            - valid
                            - hq
                            - unverified
                          description: '`hq` is the company''s main line.'
                  primaryEmail:
                    type: string
                    description: >-
                      The address to write to. Absent when the person has no
                      address in `emails`.
                  primaryPhone:
                    type: string
                    description: >-
                      The number to call. Absent when the person has no phone
                      number.
                  found:
                    type: object
                    description: >-
                      What this call found that the person did not have: the
                      values it was charged for. Empty when it found nothing
                      new.
                    properties:
                      email:
                        type: object
                        description: The work email address found. Absent when none was.
                        required:
                          - email
                          - foundBy
                        properties:
                          email:
                            type: string
                          foundBy:
                            type: string
                            enum:
                              - package
                              - waterfall
                            description: >-
                              Who found the value, which sets its price:
                              `package` or `waterfall`.
                      phone:
                        type: object
                        description: The phone number found. Absent when none was.
                        required:
                          - phoneNumber
                          - foundBy
                        properties:
                          phoneNumber:
                            type: string
                          foundBy:
                            type: string
                            enum:
                              - package
                              - waterfall
                            description: >-
                              Who found the value, which sets its price:
                              `package` or `waterfall`.
              example:
                personId: 6a1f0c2b9d4e8a7f3c5b2e22
                emails:
                  - email: ana@northwind.example
                    status: valid
                phones:
                  - phoneNumber: '+14155550123'
                    status: valid
                primaryEmail: ana@northwind.example
                primaryPhone: '+14155550123'
                found:
                  email:
                    email: ana@northwind.example
                    foundBy: package
                  phone:
                    phoneNumber: '+14155550123'
                    foundBy: waterfall
        '429':
          $ref: '#/components/responses/RateLimited'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/ServerError'
      security:
        - apiKey: []
components:
  headers:
    RequestId:
      description: The request's id. Quote it when you write to support.
      schema:
        type: string
        example: req_6a1f0c2b9d4e8a7f3c5b2e10
    ChargedUsd:
      description: What this call cost, in US dollars as an exact six-decimal string.
      schema:
        type: string
        example: '0.005000'
    BalanceUsd:
      description: >-
        The organization's balance after this call, in US dollars as an exact
        six-decimal string.
      schema:
        type: string
        example: '9.995000'
    RateLimitLimit:
      description: >-
        The calls allowed in the window of the route's limit with the fewest
        calls left.
      schema:
        type: integer
        example: 20
    RateLimitRemaining:
      description: The calls left in that window.
      schema:
        type: integer
        example: 19
    RateLimitReset:
      description: Seconds until that window resets.
      schema:
        type: integer
        example: 42
    IdempotentReplayed:
      description: >-
        `true` on an answer given again for an `Idempotency-Key`: it is the
        first call's, and nothing ran or was charged this time. Absent
        otherwise.
      schema:
        type: string
        enum:
          - 'true'
    RetryAfter:
      description: Seconds to wait before calling again.
      schema:
        type: integer
        example: 42
  responses:
    RateLimited:
      description: >-
        Too many calls. Wait the seconds in Retry-After, then call again. When
        the limit reached does not say when it resets, such as a mail provider's
        own limit on a mailbox, Retry-After is 60. The RateLimit headers
        describe this API's own limits, so they come only with a 429 one of
        those gave. The body is empty.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
    Error:
      description: The request was refused. The body names the reason in `error.code`.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServerError:
      description: >-
        Something failed on our side and nothing was charged. Retry with
        backoff; quote X-Request-Id if it persists. The body is empty.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - doc_url
          properties:
            code:
              type: string
              description: >-
                Stable and machine-readable: branch on it. It never changes
                meaning.
            message:
              type: string
              description: >-
                A human-readable explanation for logs. It may be reworded at any
                time.
            param:
              type: string
              description: The request field the error is about, when there is one.
            doc_url:
              type: string
              description: The code's entry in the errors reference.
            request_id:
              type: string
              description: >-
                The request's id, as in the X-Request-Id header. Quote it to
                support.
      example:
        error:
          code: insufficient_balance
          message: Your balance cannot cover this call. Add funds and try again.
          doc_url: https://docs.outbound.dev/errors#insufficient_balance
          request_id: req_6a1f0c2b9d4e8a7f3c5b2e10
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        An API key from the console, starting `ob_live_`, sent as
        `Authorization: Bearer <key>`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.