This file provides daily updates to collateral that are connected to secured applications and/or accounts.
For all optional fields where you do not plan to pass through data, please include the header and an empty value.
IDs
| Field | Description | Required | Data Type |
|---|---|---|---|
| client_collateral_id | The unique ID of the collateral associated with this application or account. | Required | string |
| account_id | The ID of the account associated with this collateral | Required if account is opened | string |
| application_id | The ID of the application associated with this collateral | Required | string |
| balance_id | The unique balance ID of this collateral. | Required if collateral is in an account titled to Lead Bank and collateral type is deposit_balance and client_account_id is present | string |
Details
| Field | Description | Required | Data Type |
|---|---|---|---|
| type | The type of the collateral e.g. deposit_balance, shares, crypto | Required | enumdeposit_balancesharescryptocurrency |
| value_in_usd | The value of the collateral in USD | Required if not deposit_balance | number decimal (M,2) |
| amount | The number of units for the collateral | Required | number unit decimals |
| unit | The unit for which to measure the collateral e.g. USD, shares | Required | enumusdsharesbtceth |
| location | The location of the collateral e.g. Lead Bank, a brokerage, etc. | Required | string |
| status | active: a new user that has been added to the accountinactive: a previously sent user that has deactivated from the account | Required | enumactiveinactive |
Other
| Field | Description | Required | Data Type |
|---|---|---|---|
| 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 |