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

# Data Access Controls

> Learn how to disable fields from API responses.

## Overview

Data Access Controls allow developers to selectively disable specific fields from API responses. This ensures that only the necessary data is retrieved, improving transparency and reducing over-permissioning concerns for employers during the Finch Connect flow.

When a field is disabled:

* It will **not** appear in the API response, returning `null` instead.

* It will **not** be displayed on the permissions screen in Finch Connect.

This feature is only available to customers on a Pro or Premier plan, and will not affect data returned by flat file.

## How It Works

Each endpoint's fields are grouped into logical categories. If a developer includes **any** fields within a group, the recommended Finch Connect verbiage for that group will be displayed. If **all** fields in a group are excluded, the verbiage will be omitted from Finch Connect to provide a streamlined experience.

### Company Data

If a developer is requesting **all** fields, the Connect verbiage will display:

> "Read basic company data, company contact info, address details, and bank account data."

| Group               | Fields                                                  | Connect Verbiage          |
| ------------------- | ------------------------------------------------------- | ------------------------- |
| Basic Company Data  | Legal name, Entity type, Subtype, Departments, EIN      | Read basic company data   |
| Contact Info        | Primary Email, Primary Phone Number                     | Read company contact info |
| Address Details     | Location Line 1, Location Line 2, City, State, Zip Code | Read address details      |
| Banking Information | Bank Account Routing, Bank Account Number               | Read bank account data    |

### Directory Data

If a developer is requesting **all** fields, the Connect verbiage will display:

> ""Read company directory and organization structure."

| Group                  | Fields                   | Connect Verbiage            |
| ---------------------- | ------------------------ | --------------------------- |
| Company Directory      | Employee Name, Is Active | Read company directory      |
| Organization Structure | Manager, Department      | Read organization structure |

### Individual Data

If a developer is requesting **all** fields, the Connect verbiage will display:

> "Read individual data, contact info, and address details."

| Group                        | Fields                                                | Connect Verbiage     |
| ---------------------------- | ----------------------------------------------------- | -------------------- |
| Employee Identification      | Employee Name, Preferred Name, DOB, Gender, Ethnicity | Read individual data |
| Employee Contact Information | Email, Phone Number                                   | Read contact info    |
| Employee Address Details     | Address Line 1, Address Line 2, City, State, Zip Code | Read address details |

### Employment Data

If a developer is requesting **all** fields, the Connect verbiage will display:

> "Read individual employment and income data."

| Group                  | Fields                                                                                                                                                                   | Connect Verbiage                                  |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------- |
| Employment Details     | Title, Manager, Department, Employment Type, Subtype, Start Date, End Date, Latest Rehire Date, Is Active, Employment Status, Work Location Line 1, Work Location Line 2 | Read individual employment data, excluding income |
| Compensation           | Income                                                                                                                                                                   | Read income data                                  |
| Additional Information | Class Code, Custom Fields                                                                                                                                                | -                                                 |

## Getting Started

To configure Data Access Controls for your application:

1. Review the available field groupings above and determine which fields you need.

2. Contact

   [developers@tryfinch.com](mailto:developers@tryfinch.com)

   with your selected field restrictions.

3. Once enabled, your API responses will return

   `null`

   for any disabled fields, and Finch Connect will dynamically adjust permission verbiage accordingly.

4. For any questions or additional support, reach out to your Developer Success Engineer.