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

# Customer Relationship Schema

This schema connects the relationship between individuals and businesses or sole proprietors.

<Warning>
  All programs that submit Customer files are required to submit this file daily. Refer to [Customer Files overview](/file-integrations/customer/overview) for more details. If you do not onboard commercial customers (or are not onboarding them within a particular batch), simply submit a "headers-only" file conforming to this schema.
</Warning>

<Check>
  Submit an empty file if there are no changes.
</Check>

| **Field**                     | **Description**                                                                                                                                                                                                                                                                                                                                                                                    | **Required**                                                     | **Data Type**                                                                                                                                                                                                                                                                                            |
| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| client\_individual\_id        | The individual you want to link to the business or sole prop customer.  This should be `client_customer_id` of `customer_type` =`individual` from Customer file.  All individuals being linked to the business or sole prop customers must meet data requirements of `authorized_signer`. <br /><br />See [Data Requirements for Intended Roles](/api-integrations/entity/roles) for more details. | Required                                                         | string<br /><br />If `customer_type` = `business`, we require all `control_person` and all applicable `beneficial_owners` under `client_individual_id`. At least one control person is required.  <br />If `customer_type` = `sole_prop`, we require one `sole_proprietor` under `client_individual_id`. |
| client\_business\_id          | The `business` customer you are linking individuals to.  This should be `client_customer_id` of `customer_type` = `business` from Customer file.  All sole prop customers must meet data requirements of `account_holder`. <br /><br />See [Data Requirements for Intended Roles](/api-integrations/entity/roles) for more details.                                                                | One of `client_business_id` or `client_sole_prop_id` is required | string                                                                                                                                                                                                                                                                                                   |
| client\_sole\_prop\_id        | The `sole_prop` customer you are linking individuals to.  This should be `client_customer_id` of `customer_type` = `sole_prop` from Customer file.  All sole prop customers must meet data requirements of `account_holder`                                                                                                                                                                        | One of `client_business_id` or `client_sole_prop_id` is required | string                                                                                                                                                                                                                                                                                                   |
| status                        | Status of associated beneficial owner/control person for business or sole proprietor of sole prop.  This is used in the case there are individual relationships added or removed to businesses or sole proprietorships.<br /><br />Possible values are `active` or `deleted.`                                                                                                                      | Required if `customer_type` = `business`, `sole_prop`            | enum<br />`active`<br />`deleted`                                                                                                                                                                                                                                                                        |
| relationship\_type            | Possible values are `beneficial_owner`, `control_person`, `sole_proprietor`                                                                                                                                                                                                                                                                                                                        | Required if `customer_type` = `business`, `sole_prop`            | enum:<br />`beneficial_owner`<br />`control_person`<br />`sole_proprietor`                                                                                                                                                                                                                               |
| relationship\_established\_at | The date the relationship was established. Applicable for beneficial owners and control persons.                                                                                                                                                                                                                                                                                                   | Optional                                                         | date<br />YYYY-MM-DD                                                                                                                                                                                                                                                                                     |
| ownership\_percentage         | Percentage ownership. Applicable for beneficial owners only<br />sum of all beneficial ownership percentage should be 100 or below.                                                                                                                                                                                                                                                                | Optional                                                         | number<br />decimal(M, 2)                                                                                                                                                                                                                                                                                |
| title                         | Title of the Control Person. (e.g., CEO, Owner)                                                                                                                                                                                                                                                                                                                                                    | Required if relationship\_type = `control_person`                | string                                                                                                                                                                                                                                                                                                   |
| generated\_at                 | The day this file is generated. This should always be the date the file is sent to Lead Bank.                                                                                                                                                                                                                                                                                                      | Required                                                         | datetime<br />ISO8601                                                                                                                                                                                                                                                                                    |
| effective\_at                 | The timestamp of when the related object(s) were polled to collect the information for this record.                                                                                                                                                                                                                                                                                                | Required                                                         | datetime<br />ISO8601                                                                                                                                                                                                                                                                                    |