All programs that submit Customer files are required to submit this file daily. Refer to Customer Files 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.
Submit an empty file if there are no changes.
| 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. See Data Requirements for Intended Roles for more details. | Required | string 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. 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. See Data Requirements for Intended 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. Possible values are active or deleted. | Required if customer_type = business, sole_prop | enumactivedeleted |
| relationship_type | Possible values are beneficial_owner, control_person, sole_proprietor | Required if customer_type = business, sole_prop | enum:beneficial_ownercontrol_personsole_proprietor |
| relationship_established_at | The date the relationship was established. Applicable for beneficial owners and control persons. | Optional | date YYYY-MM-DD |
| ownership_percentage | Percentage ownership. Applicable for beneficial owners only sum of all beneficial ownership percentage should be 100 or below. | Optional | number 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 ISO8601 |
| effective_at | The timestamp of when the related object(s) were polled to collect the information for this record. | Required | datetime ISO8601 |