Contents

# Plaid::InstitutionsGetByIdRequestOptions

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **include_optional_metadata** | **Boolean** | When `true`, return an institution's logo, brand color, and URL. When available, the bank's logo is returned as a base64 encoded 152x152 PNG, the brand color is in hexadecimal format. The default value is `false`.  Note that Plaid does not own any of the logos shared by the API and that by accessing or using these logos, you agree that you are doing so at your own risk and will, if necessary, obtain all required permissions from the appropriate rights holders and adhere to any applicable usage guidelines. Plaid disclaims all express or implied warranties with respect to the logos. | [optional][default to false] |
| **include_status** | **Boolean** | If `true`, the response will include status information about the institution. Default value is `false`. | [optional][default to false] |

## Example

```ruby
require 'plaid'

instance = Plaid::InstitutionsGetByIdRequestOptions.new(
  include_optional_metadata: null,
  include_status: null
)
```

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
plaid-14.0.0.beta.4	docs/InstitutionsGetByIdRequestOptions.md
plaid-14.0.0.beta.3	docs/InstitutionsGetByIdRequestOptions.md
plaid-14.0.0.beta.2	docs/InstitutionsGetByIdRequestOptions.md
plaid-14.0.0.beta.1	docs/InstitutionsGetByIdRequestOptions.md