---
updatedAt: 2025-11-18T19:01:27.000Z
agentTools:
  projectIndex: https://api-documentation.versium.com/llms.txt
---

# Configuration Parameters

## Required Parameters

| Name                | Description                                                                                   | Value Type       | Possible Values                                           | Notes                                                                                            |
| :------------------ | :-------------------------------------------------------------------------------------------- | :--------------- | :-------------------------------------------------------- | :----------------------------------------------------------------------------------------------- |
| required\_fields\[] | An array of contact fields that a record must have in order to be present in the output list. | array of strings | address, email, phone, phone\_multiple, phone\_mobile, oa | phone\_multiple and oa (online audience) must also be provided in the maximum\_coverage\[] field |

## Optional Parameters

<Table align={["left","left","left","left","left"]}>
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        Name
      </th>

      <th style={{ textAlign: "left" }}>
        Description
      </th>

      <th style={{ textAlign: "left" }}>
        Value Type
      </th>

      <th style={{ textAlign: "left" }}>
        Possible Values
      </th>

      <th style={{ textAlign: "left" }}>
        Notes
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td style={{ textAlign: "left" }}>
        optional_fields[]
      </td>

      <td style={{ textAlign: "left" }}>
        An array of contact fields that a record should include when the data is available.
      </td>

      <td style={{ textAlign: "left" }}>
        array of strings
      </td>

      <td style={{ textAlign: "left" }}>
        address, email, phone, phone_multiple, phone_mobile
      </td>

      <td style={{ textAlign: "left" }}>
        phone_multiple must also be provided in the maximum_coverage[] field
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        max_coverage[]
      </td>

      <td style={{ textAlign: "left" }}>
        An array of contact fields that a record should be added to a record. This will kick off a process to append the contact fields from our additional, internal data sources.
      </td>

      <td style={{ textAlign: "left" }}>
        array of strings
      </td>

      <td style={{ textAlign: "left" }}>
        email, phone, phone_multiple, phone_mobile, oa
      </td>

      <td style={{ textAlign: "left" }}>
        Because this option causes the system to run an append, it can greatly increase the overall processing time, i.e. from 1 minutes to multiple hours.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        max_records
      </td>

      <td style={{ textAlign: "left" }}>
        The maximum number of records to return.
      </td>

      <td style={{ textAlign: "left" }}>
        integer greater than 0
      </td>

      <td style={{ textAlign: "left" }}>

      </td>

      <td style={{ textAlign: "left" }}>

      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        contacts_per_addr
      </td>

      <td style={{ textAlign: "left" }}>
        Whether to return a maximum of 1 record per address.
      </td>

      <td style={{ textAlign: "left" }}>
        integer
      </td>

      <td style={{ textAlign: "left" }}>
        1
      </td>

      <td style={{ textAlign: "left" }}>
        Currently only supports the value 1.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        include_demo_categories[]
      </td>

      <td style={{ textAlign: "left" }}>
        An array of demographic categories that should be included in the output list.
      </td>

      <td style={{ textAlign: "left" }}>
        an array of strings
      </td>

      <td style={{ textAlign: "left" }}>
        b2cDemographic, b2cHouseFinAuto, b2cLifestyleInterest, b2cPoliticalDonor
      </td>

      <td style={{ textAlign: "left" }}>

      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        include_filter_attrs
      </td>

      <td style={{ textAlign: "left" }}>
        A boolean for whether to include any demographic filters used for creating the list, as columns in the output list.
      </td>

      <td style={{ textAlign: "left" }}>
        boolean
      </td>

      <td style={{ textAlign: "left" }}>
        1
      </td>

      <td style={{ textAlign: "left" }}>
        For example, if the list is filtered by gender, then Gender will appear as a column in the output list.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        rcfg_phone_format
      </td>

      <td style={{ textAlign: "left" }}>
        An integer to change the returned phone format.

        * *note**: if parameter is omitted  only 10 digit phone will be returned (4255553214)
      </td>

      <td style={{ textAlign: "left" }}>
        integer
      </td>

      <td style={{ textAlign: "left" }}>
        1
      </td>

      <td style={{ textAlign: "left" }}>
        <li> 1 - country code will be returned in front ot 10 digit phone (14255553214)</li>
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        rcfg_show_preview
      </td>

      <td style={{ textAlign: "left" }}>
        For the estimate API: include the preview of records in the response.
      </td>

      <td style={{ textAlign: "left" }}>
        boolean
      </td>

      <td style={{ textAlign: "left" }}>
        1
      </td>

      <td style={{ textAlign: "left" }}>
        This will slow the response time down. Only use this if you require the preview.
      </td>
    </tr>
  </tbody>
</Table>