├── .github └── workflows │ └── lockdown.yml ├── 2020-09-14.yml ├── CHANGELOG.md └── README.md /.github/workflows/lockdown.yml: -------------------------------------------------------------------------------- 1 | # Commented this out since it seemed to be an unnecessary extra step. We can add this back if we find 2 | # that external folks are creating a lot of PRs against the https://github.com/plaid/plaid-openapi repo. 3 | 4 | # name: 'Lock down repository' 5 | 6 | # on: 7 | # pull_request: 8 | # types: opened 9 | 10 | # jobs: 11 | # lockdown: 12 | # runs-on: ubuntu-latest 13 | # steps: 14 | # - uses: dessant/repo-lockdown@v2 15 | # with: 16 | # github-token: ${{ github.token }} 17 | # lock-pr: true 18 | # process-only: 'prs' 19 | # exclude-pr-labels: 'publish' 20 | # pr-comment: 'The Plaid OpenAPI file is generated internally. Please open an [issue](https://github.com/plaid/plaid-openapi/issues/new) detailing your fix and we will backport it into our generator. Thanks!' 21 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ### 2020-09-14_1.641.1 2 | - Fix descriptions for BaseReportAccountMetadata 3 | 4 | ### 2020-09-14_1.641.0 5 | - Deprecated `/link/token/create`'s `cra_options.base_report` object in favor of `cra_options.client_report_id` 6 | 7 | ### 2020-09-14_1.640.0 8 | - [Breaking] Add /cashflow_report/transactions/get route, identital to /cashflow_report/get minus days_requested request parameter 9 | - Remove historical_balances from BusinessAccounts object 10 | 11 | ### 2020-09-14_1.639.0 12 | - Add `webhook` field to `/session/token/create` request 13 | 14 | ### 2020-09-14_1.638.6 15 | - Deprecate Prism Products field from Partner Insights generation and retrieval 16 | 17 | ### 2020-09-14_1.638.5 18 | - Add client report id to partner insights 19 | 20 | ### 2020-09-14_1.638.4 21 | - Remove unused enums for MonitoringInsightsStatus and MonitoringItemStatusCode 22 | 23 | ### 2020-09-14_1.638.3 24 | - Add Prism Detect and Extend cashscores to CRA Partner Insights 25 | 26 | ### 2020-09-14_1.638.2 27 | - (beta) expect a boolean instead of a string in generated client interfaces for PLAID-NEW-USER-API-ENABLED 28 | 29 | ### 2020-09-14_1.638.1 30 | - Support for upcoming results in `link/token/get`. 31 | 32 | ### 2020-09-14_1.638.0 33 | - (pre-release) Preparation for upcoming products. 34 | 35 | ### 2020-09-14_1.637.6 36 | - Deprecate `report.items.accounts.account_insights` for `/cra/check_report/base_report/get` 37 | 38 | ### 2020-09-14_1.637.5 39 | - Fix incorrect placement of `nullable: true` on `AccountBaseNullable` object, making the object actually `nullable`. 40 | 41 | ### 2020-09-14_1.637.4 42 | - Add missing `unsent` value as a possible `verification_status` to reflect actual API behavior. 43 | 44 | ### 2020-09-14_1.637.3 45 | - (beta) Add `PLAID-NEW-USER-API-ENABLED` as a header parameter to `/user/create` 46 | - (beta) Add `PLAID-NEW-USER-API-ENABLED` as a header parameter to `/user/remove` 47 | 48 | ### 2020-09-14_1.637.2 49 | - (beta) Add `user_id` to `/session/token/create` response 50 | 51 | ### 2020-09-14_1.637.1 52 | - Add optional `institution_id` to `/item/import` 53 | 54 | ### 2020-09-14_1.637.0 55 | - Add `android_package_name` to `/session/token/create` 56 | 57 | ### 2020-09-14_1.636.0 58 | - Update `average_inflow_amount` to be positive. 59 | 60 | ### 2020-09-14_1.635.4 61 | - [BREAKING] (beta) Updated `user_token` field in `UserCreateResponse` to be optional. 62 | - [BREAKING for Go] (beta) Updated `user_token` field in `UserRemoveRequest` to be optional. 63 | - Other hidden changes. 64 | 65 | ### 2020-09-14_1.635.3 66 | - (beta) Add `user_id` to `/link/token/create` response 67 | 68 | ### 2020-09-14_1.635.2 69 | - Update description of `ruleset.outcome` in `/signal/evaluate` response 70 | 71 | ### 2020-09-14_1.635.1 72 | - Fix description undeprecating `report.items.accounts.attributes` after it was mistakenly deprecated for `/cra/check_report/base_report/get` 73 | 74 | ### 2020-09-14_1.635.0 75 | - Add `expected_funds_available_date` to `transfer` and `sweep` objects in responses for `/transfer/create`, `/transfer/get`, `/transfer/list`, `/transfer/sweep/get`, `/transfer/sweep/list` 76 | 77 | ### 2020-09-14_1.634.3 78 | - Undeprecated `report.items.accounts.attributes` after it was mistakenly deprecated for `/cra/check_report/base_report/get` 79 | 80 | ### 2020-09-14_1.634.2 81 | - Removed `deposit_switch` from the `products` field in the `/link/token/create` request 82 | 83 | ### 2020-09-14_1.634.1 84 | - [BREAKING] Move `result` from `triggered_rule_details` to `ruleset` in response of `/signal/evaluate` 85 | 86 | ### 2020-09-14_1.634.0 87 | - [BREAKING] `client_user_id` is now required for `/session/token/create` 88 | 89 | ### 2020-09-14_1.633.1 90 | - [BREAKING] Update `account` object to nullable in `/processor/transactions/sync` response 91 | 92 | ### 2020-09-14_1.633.0 93 | - Move `user_id` field of `/session/token/create` request to be within `user` 94 | 95 | ### 2020-09-14_1.632.6 96 | - Update descriptions for `CashFlowUpdatesLowBalanceWebhook` and `CashFlowUpdatesLargeDepositWebhook` 97 | 98 | ### 2020-09-14_1.632.5 99 | - Add new `CashFlowUpdatesInsightsWebhook` for Cash Flow Updates 100 | 101 | ### 2020-09-14_1.632.4 102 | - Add `triggered_rule_details` to `/signal/evaluate` response 103 | 104 | ### 2020-09-14_1.632.3 105 | - [BREAKING] Update `webhook` field in `IssuesSubscribeRequest` to be required 106 | 107 | ### 2020-09-14_1.632.2 108 | - Update the `warnings` field in `/cra/check_report/verification/get` response to be required 109 | 110 | ### 2020-09-14_1.632.1 111 | - Add `AT` and `FI` to the list of available countries 112 | 113 | ### 2020-09-14_1.632.0 114 | - Add `user_id` field to `/session/token/create` request 115 | 116 | ### 2020-09-14_1.631.0 117 | - [BREAKING] Correct the schema object returned by `AssetReport` `investments` field -- it is now correctly represented as an `AssetReportInvestments` object, not an `AssetReportInvestmentsTransaction` object, to accurately reflect the API behavior. 118 | 119 | ### 2020-09-14_1.630.0 120 | - Add optional `income_categories` param to `/cra/monitoring_insights/subscribe` request 121 | 122 | ### 2020-09-14_1.629.0 123 | - [Breaking] Date of birth is now required within consumer report user identity for `user/create` and `user/update` 124 | 125 | ### 2020-09-14_1.628.4 126 | - Renamed CRA Cash Flow Updates webhook types 127 | 128 | ### 2020-09-14_1.628.3 129 | - Adde `warnings` to responses for `cra/check_report/income_insights/get`, `cra/check_report/network_insights/get`, `cra/check_report/cashflow_insights/get`, and `cra/check_report/partner_insights/get` 130 | 131 | ### 2020-09-14_1.628.2 132 | - Update description for the `options.add_ons` field in `asset_reports/create` 133 | 134 | ### 2020-09-14_1.628.1 135 | - Add `client_report_id` field to `cra/check_report/create` request and deprecate `base_report.client_report_id` field in `cra/check_report/create`. 136 | - Add `client_report_id` field to `LinkTokenCreateRequestCraOptions` field 137 | - Deprecate `client_report_id` field in `LinkTokenCreateRequestBaseReport` 138 | - Add `client_report_id` field to `CraIncomeInsights` 139 | 140 | ### 2020-09-14_1.628.0 141 | - Add `redirect_uri` field to `/session/token/create` request 142 | 143 | ### 2020-09-14_1.627.1 144 | - Update description of `transfer_id` field on `TransferEvent` schema to be empty string for Plaid Ledger Sweep events 145 | 146 | ### 2020-09-14_1.627.0 147 | - [BREAKING] Update `posted_date` field on `/statements/list` response to be nullable 148 | 149 | ### 2020-09-14_1.626.0 150 | - Add reason_code field to /transfer/cancel request 151 | 152 | ### 2020-09-14_1.625.2 153 | - Add `USER_PERMISSION_REVOKED` and `USER_ACCOUNT_REVOKED` webhook codes to `WebhookCodeEnum` in `SandboxItemFireWebhookRequest` to reflect actual API behavior. 154 | 155 | ### 2020-09-14_1.625.1 156 | - Add new `verification_name` field to `Account` 157 | 158 | ### 2020-09-14_1.625.0 159 | - Add new `posted_date` field to `/statements/list` response 160 | 161 | ### 2020-09-14_1.624.0 162 | - (pre-release) Add `human_review` object to the `analysis` object within each `documentary_verification.documents` object. This change affects the response of all of the identity verification endpoints: 163 | - `identity_verification/create` 164 | - `identity_verification/get` 165 | - `identity_verification/list` 166 | - `identity_verification/retry` 167 | 168 | ### 2020-09-14_1.623.0 169 | 170 | ### 2020-09-14_1.622.0 171 | - [BREAKING] Updated the `investments` schema returned by `/asset_report/get` (`AssetReportInvestments`) to accurately reflect the actual API behavior, including renaming the schema object 172 | - Updated the Auth descriptions to reflect the fact that the preferred method to enable database and micro-deposit-based Auth verification flows is now the Dashboard, and that Database Insights has been deprecated and replaced by the similar product Database Auth. 173 | 174 | ### 2020-09-14_1.621.0 175 | - [BREAKING] Changed `score` in `PlaidCheckScore` from a float to an integer 176 | 177 | ### 2020-09-14_1.620.0 178 | - Add `intent_id` field to `/transfer/event/sync` response 179 | 180 | ### 2020-09-14_1.619.1 181 | - Add new `cashflow_updates` webhook triggers 182 | - Remove `reason` field from `MonitoringInsightsWebhook` 183 | 184 | ### 2020-09-14_1.619.0 185 | - Add `/session/token/create` endpoint 186 | 187 | ### 2020-09-14_1.618.2 188 | - Add `beacon_user_id` to `/beacon/report_syndication/get` and `/beacon/report_syndication/list` response 189 | 190 | ### 2020-09-14_1.618.1 191 | - `/cashflow_report/get` endpoint is added. This includes defining the `CashflowReportGetRequest` and `CashflowReportGetResponse` fields. Adding `access_token` as required field in `CashflowReportRefreshRequest`. 192 | 193 | ### 2020-09-14_1.618.0 194 | - Add `attributes` object to `BaseReport` definition. 195 | 196 | ### 2020-09-14_1.617.6 197 | - `/cashflow_report/refresh` endpoint is added. This includes defining the `CashflowReportRefreshRequest` and `CashflowReportRefreshResponse` fields. 198 | 199 | ### 2020-09-14_1.617.5 200 | - `submitted_at` is added as an optional field to `/signal/decision/report`. 201 | 202 | ### 2020-09-14_1.617.4 203 | - `persistentId` and `isTokenizedAccountNumber` fields now only populated for select institutions in sandbox related to TAN-based institutions (ins_13, ins_56) or the default testing OAuth institution (ins_127287) 204 | 205 | ### 2020-09-14_1.617.3 206 | - Modified how contribution transactions are summed up in `account_details_401k.contribution_details` object in `/investments/auth/get` endpoint. 207 | 208 | ### 2020-09-14_1.617.2 209 | - Updated PrismCashScore and PrismFirstDetect to allow Score in /cra/check_report/partner_insights/get to be nullable 210 | 211 | ### 2020-09-14_1.617.1 212 | - For Plaid Check: `date_of_birth` is now required within the `consumer_report_user_identity` object when creating or updating a user token. 213 | 214 | ### 2020-09-14_1.617.0 215 | - [Breaking] Removed the deprecated longest_gap_between_transactions, average_inflow_amount, and average_outflow_amount fields from the BaseReportAccountInsights object in the /cra/check_report/base_report/get response. 216 | 217 | ### 2020-09-14_1.616.0 218 | - Add `originating_fund_source` to `/wallet/transaction/execute` endpoint. 219 | 220 | ### 2020-09-14_1.615.0 221 | - Add `account_details_401k` objects to `/investments/auth/get` endpoint. 222 | 223 | ### 2020-09-14_1.614.1 224 | - Update `owners` field description for empty case 225 | 226 | ### 2020-09-14_1.614.0 227 | - Add model for the new `retirement_401k` numbers object to the `InvestmentsAuthGetNumbers` schema. 228 | 229 | ### 2020-09-14_1.613.0 230 | - Add `POST /signal/schedule` endpoint 231 | 232 | ### 2025-01-27_1.611.0 233 | - Add `end_to_end_id` to `/payment_initiation/payment/get` 234 | 235 | ### 2020-09-14_1.611.0 236 | - Add RfP to /transfer/capabilities/get 237 | 238 | ### 2020-09-14_1.610.2 239 | - Update `cashflow_updates` docs to reflect proper cadence 240 | 241 | ### 2020-09-14_1.610.1 242 | - Add `funds_available` sweep status and event type 243 | 244 | ### 2020-09-14_1.610.0 245 | - Add `PaymentInitiationConsentStatusUpdateWebhook` definition. 246 | 247 | ### 2020-09-14_1.609.0 248 | - Remove `/profile/get` and `/link/profile/eligibility/check` endpoints 249 | 250 | ### 2020-09-14_1.608.0 251 | - Remove erroneous UserToken object from LinkTokenGetMetadataResponse, as the specification was incorrect and the object was never returned as part of the response. 252 | 253 | ### 2020-09-14_1.607.0 254 | - Add failure_code and description fields to `/transfer/sweep/get` and `transfer/sweep/list` endpoints. Deprecated `ach_return_code` field of the TransferFailure and TransferRefundFailure objects. 255 | 256 | ### 2020-09-14_1.606.1 257 | - Updated description to `funding_account_id` field of `transfer/ledger/deposit` and `transfer/ledger/withdraw` 258 | 259 | ### 2020-09-14_1.606.0 260 | - Add `sandbox/payment/simulate` endpoint to enable testing of payment status transitions. 261 | 262 | ### 2020-09-14_1.605.0 263 | - Add `nsf_overdraft_transactions_count_30d/60d/90d` fields to `attributes` field of `cra/check_report/base_report/get` 264 | 265 | ### 2020-09-14_1.604.1 266 | - Add `account_id` to `/transactions/sync` request `options` object. 267 | 268 | ### 2020-09-14_1.603.2 269 | - Fix incorrect `USER_ACCOUNT_REVOKED` schema and example 270 | 271 | ### 2020-09-14_1.603.1 272 | - Internal changes only 273 | 274 | ### 2020-09-14_1.603.0 275 | - (pre-release) Add `fraud_analysis_details` and `image_quality_details` objects to the `analysis` object within each `documentary_verification.documents` object. These changes affect the response of all of the identity verification endpoints: 276 | - `identity_verification/create` 277 | - `identity_verification/get` 278 | - `identity_verification/list` 279 | - `identity_verification/retry` 280 | 281 | ### 2020-09-14_1.602.1 282 | - Documentation-only change to `/cra/monitoring_insights/subscribe` for cadence 283 | 284 | ### 2020-09-14_1.602.0 285 | - Added `payer_details` field to `payment_initiation/consent/get` response 286 | 287 | ### 2020-09-14_1.601.2 288 | - Documentation-only change to Investments `Security` object for new Fixed Income fields and sandbox availability 289 | 290 | ### 2020-09-14_1.601.1 291 | - Update descriptions for `/network/status/get` request fields 292 | 293 | ### 2020-09-14_1.601.0 294 | - Clean up legacy `/cra/base_report/*` endpoints from libraries in favor of `/cra/check_report/*` 295 | endpoints. 296 | 297 | ### 2020-09-14_1.600.2 298 | - Update descriptions for `/network/status/get` request and response fields 299 | - Add `nullable: true` to mortgage `account_number` field in the `MortgageLiability` schema to reflect actual behavior. 300 | - Add `transactions_refresh` to `Products` array to reflect actual behavior; this field is not accepted as input to `/link/token/create` but can be part of supported products array in the `Institution` object. 301 | 302 | ### 2020-09-14_1.600.1 303 | - `depository`+`cash management` Accounts are now eligible for Auth data for certain institutions 304 | 305 | ### 2020-09-14_1.600.0 306 | - Added `is_tokenized_account_number` to the `numbers.ach` object 307 | 308 | ### 2020-09-14_1.599.0 309 | - Added `auth_method` field to `Item` object 310 | 311 | ### 2020-09-14_1.598.0 312 | - Add `user_insights_id` to `/cra/monitoring_insights/get` response 313 | - 314 | ### 2020-09-14_1.597.0 315 | - (beta) Add /network/status/get endpoint 316 | 317 | ### 2020-09-14_1.596.0 318 | - Unhide `/sandbox/cra/cashflow_updates/update` 319 | 320 | ### 2020-09-14_1.595.0 321 | - Add `ruleset_key` to `/transfer/authorization/create` request 322 | 323 | ### 2020-09-14_1.594.0 324 | - Deprecated `consumer_dispute_id` field on consumer dispute object 325 | 326 | ### 2020-09-14_1.593.0 327 | - Add `fixed_income` object (which contains the `yield_rate`, `maturity_date`, `issue_date`, and `face_value` fields) to the Security object (Investments) 328 | 329 | ### 2020-09-14_1.592.1 330 | 331 | ### 2020-09-14_1.592.0 332 | - Add `/sandbox/cra/cashflow_updates/update` endpoint 333 | 334 | ### 2020-09-14_1.591.1 335 | - Hide `TransferMigratedFundingAccountIDRequest` from docs 336 | 337 | ### 2020-09-14_1.591.0 338 | - (pre-release) Add overall `risk_level`, and in some cases `factors` to each type of `risk_check` object. Also add `first_party_synthentic_fraud` and `third_party_synthentic_fraud` objects to`risk_check.identity_abuse_signals.synthetic_identity`. These changes affect the response of all of the identity verification endpoints: 339 | - `identity_verification/create` 340 | - `identity_verification/get` 341 | - `identity_verification/list` 342 | - `identity_verification/retry` 343 | 344 | ### 2020-09-14_1.590.0 345 | - Add `webhook` field to `TransferPlatformOriginatorCreateRequest` 346 | 347 | ### 2020-09-14_1.589.0 348 | - Add `PLATFORM_ONBOARDING_UPDATE` webhook for transfer 349 | 350 | ### 2020-09-14_1.588.0 351 | - Add `/processor/investments/transactions/get` endpoint 352 | 353 | ### 2020-09-14_1.587.1 354 | - Add `institution_name` field in the `Item` object 355 | 356 | ### 2020-09-14_1.587.0 357 | - Add `/processor/investments/holdings/get` endpoint 358 | 359 | ### 2020-09-14_1.586.4 360 | - Update `cause` and make it nullable 361 | 362 | ### 2020-09-14_1.586.3 363 | - Update `email` description in `/user_account/session/get` response 364 | 365 | ### 2020-09-14_1.586.2 366 | - Update `event_type` description of `/sandbox/transfer/simulate`. Added `funds_available` to status list 367 | 368 | ### 2020-09-14_1.586.1 369 | - [Breaking] Changed `ConsentEventCode` enum values. Replaced `PLAID_END_USER_PRIVACY_POLICY` with `USER_AGREEMENT` 370 | 371 | ### 2020-09-14_1.586.0 372 | - Add `webhook` field to requests for `/sandbox/transfer/simulate`, `/sandbox/transfer/refund/simulate`, `/sandbox/transfer/ledger/simulate_available` and `/sandbox/transfer/sweep/simulate`. 373 | 374 | ### 2020-09-14_1.585.5 375 | - Correct a typo in /link/token/create description 376 | 377 | ### 2020-09-14_1.585.4 378 | - Updated transition date to move away from deprecated fields in CRA Base Report API 379 | 380 | ### 2020-09-14_1.585.3 381 | - Fixed erroneous missing `last_statement_balance` field in `StudentLoan` object -- field was returned in API but not in specification. 382 | 383 | ### 2020-09-14_1.585.2 384 | - Remove minimum length for `end_customer` in `user/create` 385 | 386 | ### 2020-09-14_1.585.1 387 | - Deprecate `options` in `payment_initiation/consent/create` 388 | 389 | ### 2020-09-14_1.585.0 390 | - [Breaking] Created `ItemWithConsentFields`, a new object definition that extends the `Item` object to include 1033-related consent fields. 391 | - [Breaking] Removed the 1033-related consent fields from the `Item` object, ensuring that these fields now only appear in the `ItemWithConsentFields` object within the `/item/get` response. 392 | 393 | ### 2020-09-14_1.584.1 394 | - Deprecated `version` in `cra/check_report/partner_insights/get` in favor of `model_version` 395 | 396 | ### 2020-09-14_1.584.0 397 | - Made total inflow/outflow amount fields in the `cra/check_report/base_report/get` response nullable 398 | 399 | ### 2020-09-14_1.583.1 400 | - Updated `description` field in `payment_configuration` object in `/link/token/create` to be optional 401 | 402 | ### 2020-09-14_1.583.0 403 | - Added total inflow/outflow amount fields to `attributes` object in the `cra/check_report/base_report/get` response 404 | 405 | ### 2020-09-14_1.582.0 406 | - Added a new field in `/link/token/create` 407 | 408 | ### 2020-09-14_1.581.0 409 | - Update `verify_sms` object in the response of all of the identity verification endpoints to add `redacted_at` timestamp: 410 | - `identity_verification/create` 411 | - `identity_verification/get` 412 | - `identity_verification/list` 413 | - `identity_verification/retry` 414 | 415 | ### 2020-09-14_1.580.4 416 | - Fixed an incorrect example response in `/user_account/session/get` 417 | 418 | ### 2020-09-14_1.580.3 419 | - Fix wrong nullable annotation in `/signal/evaluate` response 420 | 421 | ### 2020-09-14_1.580.2 422 | - Make `scores` nullable in `/signal/evaluate` and `/processor/signal/evaluate` response 423 | 424 | ### 2020-09-14_1.580.1 425 | - Add new `payer_details` field to `payment_initiation/consent/create` in preparation to new account restrictions 426 | 427 | ### 2020-09-14_1.579.1 428 | - Add new `type` field to `payment_initiation/consent/create` and deprecate the `scopes` field 429 | 430 | ### 2020-09-14_1.578.1 431 | - Update `verify_sms` object in the response of all of the identity verification endpoints to support nullable `verification.phone_number` and expand allowed statuses for `verification.status`: 432 | - `identity_verification/create` 433 | - `identity_verification/get` 434 | - `identity_verification/list` 435 | - `identity_verification/retry` 436 | 437 | ### 2020-09-14_1.578.0 438 | - Add `verify_sms` object in the response of all of the identity verification endpoints: 439 | - `identity_verification/create` 440 | - `identity_verification/get` 441 | - `identity_verification/list` 442 | - `identity_verification/retry` 443 | 444 | ### 2020-09-14_1.577.1 445 | - Added support for `signal` to `required_if_supported_products`. 446 | - Added support for `cra_network_insights` to `Products` array. 447 | - Define `MonitoringInsightsWebhook` 448 | - Fix definition for JWTHeader object 449 | 450 | ### 2020-09-14_1.577.0 451 | - Updated description for the `is_primary_account` field of base reports 452 | 453 | ### 2020-09-14_1.576.0 454 | - Expose beacon_user_id in `/identity_verification/*` endpoints 455 | - Added new optional parameter `days_required` to `cra_options` in `/link/token/create` and to `/cra/check_report/create` 456 | - Added new metadata object with `start_date` and `end_date` in the responses for: 457 | - `/cra/check_report/base_report/get` 458 | - `/cra/check_report/income_insights/get` 459 | - `/cra/check_report/partner_insights/get` 460 | 461 | ### 2020-09-14_1.575.1 462 | - Update `date_of_birth` field description in `user/create` 463 | 464 | ### 2020-09-14_1.575.0 465 | - Add `primary_account_score` and `is_primary_account` fields to the `cra/check_report/base_report/get` response 466 | 467 | ### 2020-09-14_1.574.1 468 | - Add `FAILED` enum for Monitoring 469 | 470 | ### 2020-09-14_1.574.0 471 | - Make `MonitoringInsights` nullable 472 | 473 | ### 2020-09-14_1.573.2 474 | - Update session results array fields in `/link/token/get` response to be required 475 | 476 | ### 2020-09-14_1.573.1 477 | - mark `category_id` in BaseReport transaction as nullable 478 | - Update `date_of_birth` description in `user/create` 479 | 480 | ### 2020-09-14_1.573.0 481 | - Removed `is_missing_income` from `/cra/monitoring_insights/get` 482 | 483 | ### 2020-09-14_1.572.0 484 | - Add `uuid` validation for `subscription_id` in `/cra/monitoring_insights/get` 485 | - Add `ConsumerReportPermissiblePurpose` to `CraMonitoringInsightsGetRequest` 486 | - Add `HistoricalAnnualIncome` insight 487 | 488 | ### 2020-09-14_1.571.0 489 | - Add `attributes` and `nsf_overdraft_transactions_count` to `cra/check_report/base_report/get` 490 | 491 | ### 2020-09-14_1.570.3 492 | - Update product list for `/partner/customer/create` 493 | 494 | ### 2020-09-14_1.570.2 495 | - Add `predicted_next_date` field to `/transactions/recurring/get` 496 | 497 | ### 2020-09-14_1.570.1 498 | - Add `end_customer` hidden field to `user/create` for client RealPage 499 | 500 | ### 2020-09-14_1.569.5 501 | - Show `date_of_birth` on the open API doc 502 | 503 | ### 2020-09-14_1.569.4 504 | - Add `ssn_last_4` to ConsumerReportUserIdentity 505 | 506 | ### 2020-09-14_1.569.3 507 | - Add `USER_FRAUD_ALERT` to BaseReportWarningCode 508 | 509 | ### 2020-09-14_1.569.2 510 | - Removed erroneous `required` attribute from `request_id` field in LinkMetadataEvent object. 511 | 512 | ### 2020-09-14_1.569.1 513 | - Add `processing_mode` field to the `PaymentInitiationConsentPaymentExecuteRequest` object for the `/payment_initiation/consent/payment/execute` endpoint 514 | 515 | ### 2020-09-14_1.568.1 516 | - Updated description of CRA Base Report API fields with new deprecation date 517 | 518 | ### 2020-09-14_1.568.0 519 | - Add `name` object to the `extracted_data` within each `documentary_verification.documents` object in the response of all of the identity verification endpoints: 520 | - `identity_verification/create` 521 | - `identity_verification/get` 522 | - `identity_verification/list` 523 | - `identity_verification/retry` 524 | 525 | ### 2020-09-14_1.567.5 526 | - Add `error_reason` to `/cra/check_report/partner_insights/get` 527 | 528 | ### 2020-09-14_1.567.4 529 | - [internal only] Hiding plaid_check_score_version from docs 530 | 531 | ### 2020-09-14_1.567.3 532 | - Update description for `email` field in `/identity_verification/create` and `/identity_verification/retry` to include link to RFC specification on email format 533 | 534 | ### 2020-09-14_1.567.2 535 | - Publish processor Paynote 536 | 537 | ### 2020-09-14_1.567.1 538 | - Update description for `add_ons` field in `/asset_report/create` 539 | 540 | ### 2020-09-14_1.567.0 541 | - [BREAKING] removed `products` field from `cra/check_report/create` request 542 | 543 | ### 2020-09-14_1.566.0 544 | - Added `status` to the `MonitoringInsightsWebhook` object 545 | - Changed `webhook_code` to be deterministic 546 | 547 | ### 2020-09-14_1.565.1 548 | - Update `days_available` field description for Asset Reports and CRA Base Reports. 549 | 550 | ### 2020-09-14_1.565.0 551 | - Removed `deposit_switch` from the `products` field in the `/link/token/create` request 552 | - Deprecated DepositSwitch endpoints, requests and response 553 | 554 | ### 2020-09-14_1.564.0 555 | - add `/issues/get`, `/issues/search`, and `/issues/subscribe` for Support API endpoints. 556 | 557 | ### 2020-09-14_1.563.0 558 | - Update fields on `item` object in `/item/get` response 559 | - Add `consented_use_cases` field 560 | - Add `consented_data_scopes` field 561 | - Add `created_at` field 562 | - Update descriptions for `consented_products` and `consent_expiration_time` fields 563 | - Add `/consent/events/get` endpoint 564 | 565 | ### 2020-09-14_1.157.1 566 | - Internal changes 567 | 568 | ### 2020-09-14_1.157.0 569 | - (pre-release) Add `facial_analysis` to the `analysis` within each `selfie_check.selfies` object in the response of all of the identity verification endpoints: 570 | - `identity_verification/create` 571 | - `identity_verification/get` 572 | - `identity_verification/list` 573 | - `identity_verification/retry` 574 | 575 | ### 2020-09-14_1.156.2 576 | - [BREAKING] Remove `from_client_id` and `to_client_id` from `/transfer/ledger/distribute` request 577 | - Add `from_ledger_id` and `to_ledger_id` to `/transfer/ledger/distribute` request 578 | - Add `ledger_id` in transfer routes response examples 579 | 580 | ### 2020-09-14_1.156.1 581 | - Update `account type schema` link to reference the correct URL. 582 | 583 | ### 2020-09-14_1.562.0 584 | - Add `data_sources` object to the `/investments/auth/get` response 585 | - `data_sources` object contains the `numbers`, `owners`, and `holdings` fields 586 | 587 | ### 2020-09-14_1.561.0 588 | - [BREAKING] Add `authorization_id` to /transfer/get request and make `transfer_id` optional. 589 | 590 | ### 2020-09-14_1.560.0 591 | - Add `pay_by_bank` to product enum list 592 | 593 | ### 2020-09-14_1.559.0 594 | - Add `name`, `is_default` to /transfer/ledger/get response 595 | - [BREAKING] Move `ledger_id` from nested `balance` struct to top level in /transfer/ledger/get response 596 | 597 | ### 2020-09-14_1.558.0 598 | - Add `liveness_check` to the `analysis` within each `selfie_check.selfies` object in the response of all of the identity verification endpoints: 599 | - `identity_verification/create` 600 | - `identity_verification/get` 601 | - `identity_verification/list` 602 | - `identity_verification/retry` 603 | 604 | ### 2020-09-14_1.557.2 605 | - Internal changes only 606 | 607 | ### 2020-09-14_1.557.1 608 | - Internal changes only 609 | 610 | ### 2020-09-14_1.557.0 611 | - Add `ledger_id` to /transfer/ledger/get response 612 | 613 | ### 2020-09-14_1.556.0 614 | - Added plural named array fields to `BaseReportAccountInsights` in /cra/base_report/get 615 | 616 | ### 2020-09-14_1.555.0 617 | - Add `require_all_items` field to /asset_report/create 618 | 619 | ### 2020-09-14_1.554.0 620 | - Add `sector` and `industry` properties to the `Security` model. 621 | 622 | ### 2020-09-14_1.553.0 623 | - Add `ISSUE_RESOLVED` webhook 624 | 625 | ### 2020-09-14_1.552.0 626 | - Add `ytd_amount` to `PaystubOverrideEarningsTotal` in /credit/payroll_income/get 627 | 628 | ### 2020-09-14_1.551.0 629 | - Internal changes only 630 | 631 | ### 2020-09-14_1.550.0 632 | - Add `/fdx/recipient` and `/fdx/recipients` endpoints 633 | 634 | ### 2020-09-14_1.549.0 635 | - Made fields required instead of omitempty for CRA Income Insights Transactions 636 | 637 | ### 2020-09-14_1.548.4 638 | - Set CreditAmountWithCurrency fields as required 639 | 640 | ### 2020-09-14_1.548.3 641 | - Added missing `LOGIN_REPAIRED` enum value to possible webhook codes for `/sandbox/item/fire_webhook` request in order to match endpoint description. 642 | 643 | ### 2020-09-14_1.548.2 644 | - [BREAKING] Moved `forecasted_monthly_income` to be a level higher. 645 | 646 | ### 2020-09-14_1.548.1 647 | - Made the fields in account_insights array fields as required. 648 | 649 | ### 2020-09-14_1.548.0 650 | - [BREAKING] Changed fields of `CraMonitoringGetResponse` to be simple `objects` instead of `arrays` 651 | - [BREAKING] Moved `income_sources` to the `income` module in the response 652 | 653 | ### 2020-09-14_1.547.2 654 | - Add `cra_item_add_results` field to `results` object in `/link/token/get` response. 655 | 656 | ### 2020-09-14_1.547.1 657 | - Increase `/wallet/transactions/list` cursor size to 1024 characters. 658 | 659 | ### 2020-09-14_1.547.0 660 | - Add `ledger_id` to the request and response of a number of transfer endpoints. 661 | 662 | ### 2020-09-14_1.546.0 663 | - Added `WalletTransactionRelation` object. 664 | - Added `related_transactions` field to WalletTransaction object. 665 | 666 | ### 2020-09-14_1.545.3 667 | - Some description updates to CRA Base Report fields 668 | 669 | ### 2020-09-14_1.545.2 670 | - Updated phone number examples in Identity Verification endpoints. 671 | 672 | ### 2020-09-14_1.545.1 673 | - Add `update.item_ids` field to `/link/token/create` request. 674 | 675 | ### 2020-09-14_1.545.0 676 | - [BREAKING] Rename network attributes to network insights in the `cra/check_report/network_insights/get` schemas 677 | 678 | ### 2020-09-14_1.544.0 679 | - Added `is_shareable` field to the `/identity_verification/retry` endpoint 680 | 681 | ### 2020-09-14_1.543.2 682 | - [Breaking] Added `data_breach` report type to BeaconReport response object 683 | 684 | ### 2020-09-14_1.543.1 685 | - Added `consumer_statement` field to `Account` in `BaseReport` 686 | - make `warnings` for BaseReportGetResponse required 687 | 688 | ### 2020-09-14_1.543.0 689 | - Add `/network_insights/report/get` 690 | 691 | ### 2020-09-14_1.542.0 692 | - Added `error_code_reason` field to plaidError 693 | 694 | ### 2020-09-14_1.541.1 695 | - Add `update.user` field to `/link/token/create` request. 696 | 697 | ### 2020-09-14_1.541.0 698 | - (pre-release) Add `reauthorization_enabled` field to /link/token/create request 699 | 700 | ### 2020-09-14_1.540.2 701 | - [Breaking] Updated `document_status` field in `identity/document/upload` to include parsing_type 702 | 703 | ### 2020-09-14_1.540.1 704 | - Added `MonitoringInsightsWebhook` 705 | - Added `webhook` field in `cra/monitoring_insights/subscribe` 706 | 707 | ### 2020-09-14_1.540.0 708 | - Added `file_type` field to `/credit/payroll_income/risk_signals/get` 709 | 710 | ### 2020-09-14_1.539.0 711 | - Add `authorization_usage` field to the `transfer/metrics/get` response 712 | 713 | ### 2020-09-14_1.538.0 714 | - Added cra/monitoring_insights/subscribe 715 | - Added cra/monitoring_insights/unsubscribe 716 | - Added cra/monitoring_insights/get 717 | 718 | ### 2020-09-14_1.537.0 719 | - Added depository_accounts to Beacon 720 | - Added event_date to BeaconReports 721 | 722 | ### 2020-09-14_1.536.0 723 | - Internal changes only 724 | 725 | ### 2020-09-14_1.535.3 726 | 727 | - Added missing values to `PlaidErrorType` enum. 728 | 729 | ### 2020-09-14_1.535.2 730 | - Make some `CraBankIncomeSummary` fields visible. 731 | 732 | ### 2020-09-14_1.535.1 733 | 734 | ### 2020-09-14_1.535.0 735 | - [Breaking for Go] Updated `consumer_report_user_identity` field in `/user/update` to be required to reflect actual API behavior. 736 | 737 | ### 2020-09-14_1.534.7 738 | - Add `stated_account_number_enabled` to `investments_auth` in `LinkTokenCreateRequest` 739 | 740 | ### 2020-09-14_1.534.6 741 | - [Breaking] Updated base report endpoints and objects to include `cra` prefix 742 | 743 | ### 2020-09-14_1.534.5 744 | - Add `enable_multi_item_link` field to `/link/token/create` 745 | 746 | ### 2020-09-14_1.534.4 747 | - Undeprecate `/identity/match`'s `legal_name.is_business_name_detected` 748 | 749 | ### 2020-09-14_1.534.3 750 | - Add 'Beacon' to product enum list and make available in `/link/token/create` products 751 | 752 | ### 2020-09-14_1.534.2 753 | - Mark some `BaseReportAccountInsights` fields as optional. 754 | 755 | ### 2020-09-14_1.534.1 756 | 757 | - Internal changes only 758 | 759 | ### 2020-09-14_1.533.1 760 | - Add `user_action_required` to transfer authorization's `decision` enum. 761 | - Add `authorization_id` to transfer object in `/link/token/create` request. 762 | 763 | ### 2020-09-14_1.533.0 764 | - Made `user` request field optional in `beacon/user/update` 765 | 766 | ### 2020-09-14_1.532.4 767 | - fix `/cra/check_report/pdf/get` external doc url 768 | 769 | ### 2020-09-14_1.532.3 770 | - Docs updates 771 | 772 | ### 2020-09-14_1.532.2 773 | - [Breaking] Rename `/cra/check_report/network_attributes/get` to `/cra/check_report/network_insights/get` 774 | 775 | ### 2020-09-14_1.532.1 776 | 777 | - Internal changes only 778 | 779 | ### 2020-09-14_1.531.1 780 | - Update idempotency key expiration time to 48 hours in `virtual-accounts/#wallet-transaction-execute-request-idempotency-key` 781 | 782 | ### 2020-09-14_1.531.0 783 | - Add `balance_plus` to `products` in `LinkTokenCreateRequest` 784 | - Add `balance_plus` to `additional_consented_products` in `LinkTokenCreateRequest` 785 | 786 | ### 2020-09-14_1.530.0 787 | - Add `/user/remove` endpoint 788 | 789 | ### 2020-09-14_1.529.0 790 | - Added `/sandbox/user/reset_login` endpoint 791 | 792 | ### 2020-09-14_1.528.0 793 | - Added `beacon/user/account_insights/get` endpoint 794 | - Updated `description`field for `access_tokens` in `beacon/user/create` and `beacon/user/update` requests 795 | - [Breaking] Renamed `/user_account/session/get` operationId `sessionGet` to `userAccountSessionGet` for consistency with existing API naming scheme. 796 | 797 | ### 2020-09-14_1.527.0 798 | - [Breaking] Removed `development.plaid.com` as a valid server and updated docs to remove references to Development, due to the decomissioning of the Development environment 799 | 800 | ### 2020-09-14_1.526.1 801 | - Add `/user/items/get` endpoint 802 | 803 | ### 2020-09-14_1.526.0 804 | - Add `/cra/check_report/network_attributes/get` 805 | 806 | ### 2020-09-14_1.525.1 807 | 808 | [Breaking] Renamed `bank_income` to `report` in the `cra/check_report/income_insights/get` response 809 | 810 | ### 2020-09-14_1.524.1 811 | 812 | - [Breaking] Remove `minLength` validations from several attributes. Fixes multiple validation bugs in the ruby client libraries which do not handle `nil` gracefully before this change. 813 | 814 | ### 2020-09-14_1.524.0 815 | 816 | - Add transfer refund event types to TransferEventType enum. 817 | 818 | ### 2020-09-14_1.523.0 819 | 820 | - Added support for the `layer` product. 821 | 822 | ### 2020-09-14_1.522.0 823 | 824 | - Added support for the `/user_account/session/get` API. 825 | 826 | ### 2020-09-14_1.521.0 827 | 828 | - Internal changes only 829 | 830 | ### 2020-09-14_1.520.0 831 | 832 | - [Breaking] Contains fixes to Balance Plus (beta): 833 | - [Breaking] Convert `risk_level` string to an enum object `RiskLevel`. 834 | - [Breaking] Adds missing `required` labels to certain fields within `BalancePlusAttributes`, `AccountsBalanceGetResponsePaymentRiskAssessment`, `AccountsBalanceGetRequestPaymentDetails`, and `RiskReason`. 835 | - Adds missing `additionalProperties` field to `BalancePlusAttributes` 836 | - Fix incorrect response example for Balance Plus 837 | - Docs updates for Balance Plus 838 | 839 | ### 2020-09-14_1.519.0 840 | 841 | - Add `rtp` to network options in `/transfer/intent/create` 842 | - Added `access_tokens` field to `/beacon/user/create` and `/beacon/user/update` requests 843 | - Added `item_ids` to `/beacon/user/*` responses 844 | 845 | ### 2020-09-14_1.518.9 846 | 847 | - Update `description` field for `decision_rationale` in `transfer/authorization/create` response 848 | 849 | ### 2020-09-14_1.518.8 850 | 851 | - Fix incorrect documentation for ENTITY_SCREENING: STATUS_UPDATED webhook which wrongly documented `screening_id` instead of `entity_screening_id` in the payload. 852 | 853 | ### 2020-09-14_1.518.7 854 | 855 | - Internal changes only 856 | 857 | ### 2020-09-14_1.518.6 858 | 859 | - Add `add_ons` in cra/check_report/pdf/get 860 | 861 | ### 2020-09-14_1.518.5 862 | 863 | - Internal changes only 864 | 865 | ### 2020-09-14_1.518.4 866 | 867 | - Add `Recall` as a possible Virtual Account wallet transaction type 868 | 869 | ### 2020-09-14_1.518.3 870 | 871 | - Internal changes only 872 | 873 | ### 2020-09-14_1.518.2 874 | 875 | - Documentation edits to cra endpoints 876 | - Add `income-sensitive repayment` to StudentRepaymentPlan and update description for repayment plan type 877 | 878 | ### 2020-09-14_1.518.1 879 | 880 | - Documentation edits to cra endpoints 881 | - Add item, account, and transaction IDs to `/cra/base_report/get` response 882 | 883 | ### 2020-09-14_1.518.0 884 | 885 | - Add several cra related properties to `/user/create` and `/link/token/create` 886 | 887 | ### 2020-09-14_1.517.7 888 | 889 | - Add `cra/check_report/pdf/get` endpoint 890 | 891 | ### 2020-09-14_1.517.6 892 | 893 | - Add `cra/check_report/base_report/get` endpoint 894 | 895 | ### 2020-09-14_1.517.5 896 | 897 | - Add `error_message` to `document_metadata` object for `credit/payroll_income/get` and `credit/bank_statements/uploads/get` 898 | 899 | ### 2020-09-14_1.517.4 900 | 901 | - Add `production` to the `secrets` object in `/partner/customer/create` response and deprecate `development` 902 | 903 | ### 2020-09-14_1.517.3 904 | 905 | - Add new enums to `canonical_description` in `credit/payroll_income/get`: `RETIREMENT`, `GIG ECONOMY`, and `STOCK COMPENSATION` 906 | 907 | ### 2020-09-14_1.517.2 908 | 909 | - Added `ITEM: EVENTS` webhook and example to documentation 910 | 911 | ### 2020-09-14_1.517.1 912 | 913 | - Added `public_tokens` on `SESSION_FINISHED` webhook 914 | - Deprecated `public_token` on `SESSION_FINISHED` webhook 915 | - Added `ITEM_ADD_RESULT` webhook 916 | 917 | ### 2020-09-14_1.517.0 918 | 919 | - [Breaking] Update `/link/token/get` response structure 920 | 921 | ### 2020-09-14_1.516.0 922 | 923 | - Internal changes only 924 | 925 | ### 2020-09-14_1.515.0 926 | 927 | - Added `/cra/loans/applications/register` 928 | - Added `/cra/loans/register` 929 | - Added `/cra/loans/update` 930 | - Added `/cra/loans/unregister` 931 | 932 | ### 2020-09-14_1.514.2 933 | 934 | - Added `days_since_first_observed transaction` as a field in the Account Risk Insights response. 935 | 936 | ### 2020-09-14_1.514.1 937 | 938 | - Update `risk_profile_key`and `RiskProfile` description 939 | 940 | ### 2020-09-14_1.514.0 941 | 942 | - Added `transfer/authorization/cancel` endpoint 943 | 944 | ### 2020-09-14_1.513.0 945 | 946 | - Added `consumer_report/pdf/get` endpoint 947 | 948 | ### 2020-09-14_1.512.0 949 | 950 | - Added support for address and date of birth in `/payment_initiation/payment/reverse` request. 951 | 952 | ### 2020-09-14_1.511.0 953 | 954 | - Added `user_token` to `link/token/get` response metadata 955 | - Internal changes 956 | 957 | ### 2020-09-14_1.510.2 958 | 959 | - Added `include_insights` to `/credit/relay/get` request 960 | - 961 | 962 | ### 2020-09-14_1.510.1 963 | 964 | - Add `database_insights_pending` as a potential enum value to `LinkDeliveryVerificationStatus` and `LinkSessionSuccessMetadataAccount.VerificationStatus`. 965 | - Remove `database_insights_pass`, `database_insights_pass_with_caution` and `database_insights_fail` as potential values from `LinkDeliveryVerificationStatus` and `LinkSessionSuccessMetadataAccount.VerificationStatus` 966 | 967 | ### 2020-09-14_1.510.0 968 | 969 | - Internal changes only 970 | 971 | ### 2020-09-14_1.509.4 972 | 973 | - Internal changes only 974 | 975 | ### 2020-09-14_1.509.3 976 | 977 | - Update description of transfer authorization decision code `MANUALLY_VERIFIED_ITEM` 978 | 979 | ### 2020-09-14_1.509.2 980 | 981 | - Fixes to `RemovedTransaction` object definition: set `additionalProperties` explicitly to true and list `account_id` and `transaction_id` as `required`. 982 | 983 | ### 2020-09-14_1.509.1 984 | 985 | - add `SMS_MICRODEPOSITS_VERIFICATION` to the `webhook_code` field of `/sandbox/item/fire_webhook` 986 | 987 | ### 2020-09-14_1.509.0 988 | 989 | - Add `supports_payment_consents` to institution's `payment_initiation_metadata`. 990 | 991 | ### 2020-09-14_1.508.0 992 | 993 | - Add new fields to `/cra/bank_income/get` endpoint 994 | 995 | ### 2020-09-14_1.507.3 996 | 997 | - Add `paystub` and `w2` values to custom sandbox configuration schema 998 | 999 | ### 2020-09-14_1.507.2 1000 | 1001 | - Mark `/transfer/balance/get` endpoint deprecated 1002 | 1003 | ### 2020-09-14_1.507.1 1004 | 1005 | - Update `funds_available` description 1006 | 1007 | ### 2020-09-14_1.507.0 1008 | 1009 | - Add `funds_available` transfer status and transfer event type 1010 | 1011 | ### 2020-09-14_1.506.0 1012 | 1013 | - Add `statements` to the `options` field in the request object for `/sandbox/public_token/create` endpoint 1014 | 1015 | ### 2020-09-14_1.505.1 1016 | 1017 | - Internal changes only 1018 | 1019 | ### 2020-09-14_1.505.0 1020 | 1021 | - Add `profile` product 1022 | 1023 | ### 2020-09-14_1.504.2 1024 | 1025 | - [Breaking] Update `network` field type in `/transfer/recurring/create` request from `TransferACHNetwork` to `TransferRecurringNetwork` as recurring now supports rtp. 1026 | - [Breaking] Update `network` field type in `RecurringTransfer` and `RecurringTransferNullable` from `TransferACHNetwork` to `TransferRecurringNetwork` as recurring now supports rtp. 1027 | 1028 | ### 2020-09-14_1.504.1 1029 | 1030 | - Documentation updates for `/transactions/sync` and Database Match / Database Insights (beta). 1031 | 1032 | ### 2020-09-14_1.504.0 1033 | 1034 | - Add new fields to `/transactions/sync` and `/processor/transactions/sync` endpoints 1035 | 1036 | ### 2020-09-14_1.503.6 1037 | 1038 | - [Breaking change for Go client library] Make `start_date` and `end_date` required in the `statements` object for the `/link/token/create` endpoint 1039 | 1040 | ### 2020-09-14_1.503.5 1041 | 1042 | - Improve description for `RiskCheckIdentityAbuseSignals` 1043 | 1044 | ### 2020-09-14_1.503.4 1045 | 1046 | - Improve description for `TransferNetworkTraceID` 1047 | 1048 | ### 2020-09-14_1.503.3 1049 | 1050 | - Update description for `TransferNetworkTraceID` 1051 | 1052 | ### 2020-09-14_1.503.2 1053 | 1054 | - Change `forecasted_average_monthly_income_prediction_intervals` to plural. 1055 | 1056 | ### 2020-09-14_1.503.1 1057 | 1058 | - Add `has_more` field to /transfer/event/list and /transfer/event/sync to indicate there are more events to be pulled 1059 | 1060 | ### 2020-09-14_1.503.0 1061 | 1062 | - Add new `/cra/base_report/create` endpoint 1063 | 1064 | ### 2020-09-14_1.502.4 1065 | 1066 | - Add `sms_microdeposits_verification_enabled` to `auth` object inside `/link/token/create` calls. 1067 | 1068 | ### 2020-09-14_1.502.3 1069 | 1070 | - Added descriptions for `vested_quantity` and `vested_amount` fields for `investments/holdings/get` 1071 | - Removed description for `vested_quantity` and `vested_amount` fields for `HoldingsOverride` object (for sandbox) 1072 | 1073 | ### 2020-09-14_1.502.2 1074 | 1075 | - [Breaking] Update `network` field type in `/transfer/recurring/create` request from `TransferNetwork` to `TransferACHNetwork` since recurring currently only works for ACH. 1076 | - [Breaking] Update `network` field type in `RecurringTransfer` and `RecurringTransferNullable` from `TransferNetwork` to `TransferACHNetwork` since recurring currently only works for ACH. 1077 | 1078 | ### 2020-09-14_1.502.1 1079 | 1080 | - Update description for `/item/remove` and `/asset_report/remove` 1081 | 1082 | ### 2020-09-14_1.502.0 1083 | 1084 | - Add `client_report_id` fields to `/link/token/create` and `/cra/base_report/get` 1085 | 1086 | ### 2020-09-14_1.501.2 1087 | 1088 | - Updating `insights` field in `/cra/partner_insights/get` response to contain both numerical and string values 1089 | 1090 | ### 2020-09-14_1.501.1 1091 | 1092 | - Enable original description for all customers on `/transactions/get` endpoint 1093 | 1094 | ### 2020-09-14_1.501.0 1095 | 1096 | [Breaking change for Go client library] Mark `address` field in `/beacon/user/create` as optional 1097 | 1098 | ### 2020-09-14_1.500.0 1099 | 1100 | - Remove `prime_trust` processor partner 1101 | 1102 | ### 2020-09-14_1.499.2 1103 | 1104 | - Fix broken link from previous update 1105 | 1106 | ### 2020-09-14_1.499.1 1107 | 1108 | - Updated doc url for some Transfer and processor endpoints to support documentation reorganization 1109 | - Minor documentation updates and clarifications 1110 | 1111 | ### 2020-09-14_1.499.0 1112 | 1113 | - [Breaking change for Go client library] Make `account_id` optional in `/transactions/recurring/get` endpoint 1114 | 1115 | ### 2020-09-14_1.489.3 1116 | 1117 | - Update description of `network_trace_id` 1118 | 1119 | ### 2020-09-14_1.489.2 1120 | 1121 | - Correct documentation to indicate that `assets` is not supported in the `additional_consented_products` field 1122 | - Remove `additionalProperties: true` incorrectly applied to `transferIntentGet` object and missed in `2020-09-14_1.352.0`. This will result in more strict type checking for this object, but should not be a breaking change. 1123 | 1124 | ### 2020-09-14_1.498.1 1125 | 1126 | - Enable original description for all customers 1127 | 1128 | ### 2020-09-14_1.498.0 1129 | 1130 | - Add `POST /beacon/account_risk/v1/evaluate` endpoint 1131 | 1132 | ### 2020-09-14_1.497.0 1133 | 1134 | - Add `institution_id` to `processor/account/get` endpoint. 1135 | 1136 | ### 2020-09-14_1.496.5 1137 | 1138 | - Update the description and enum values for `linked_services` in the response of all of the identity verification endpoints: 1139 | - `identity_verification/create` 1140 | - `identity_verification/get` 1141 | - `identity_verification/list` 1142 | - `identity_verification/retry` 1143 | 1144 | ### 2020-09-14_1.496.4 1145 | 1146 | Add `POST /beacon/user/history/list` 1147 | 1148 | ### 2020-09-14_1.496.3 1149 | 1150 | - Add `timestamp` to the beacon user's `audit_trail` object 1151 | - Add `version` to the beacon user object. 1152 | 1153 | ### 2020-09-14_1.496.2 1154 | 1155 | - Adds prediction interval to `/cra/bank_income/get` 1156 | 1157 | ### 2020-09-14_1.496.1 1158 | 1159 | - Update the descriptions for `risk_level` and `score` in `/accounts/balance/get` 1160 | 1161 | ### 2020-09-14_1.496.0 1162 | 1163 | - Add `verification_insights` object to `Account` (closed beta feature - Database Insights) 1164 | - Add `database_insights_pass`, `database_insights_pass_with_caution`, and `database_insights_fail` as new values for `verification_status` field (closed beta feature - Database Insights) 1165 | 1166 | ### 2020-09-14_1.495.2 1167 | 1168 | - Add `pending idr` to student loan liability statuses 1169 | 1170 | ### 2020-09-14_1.495.1 1171 | 1172 | - Add `processor_identity` product 1173 | 1174 | ### 2020-09-14_1.494.1 1175 | 1176 | - Mark `wire_details` as nullable in the transfer object 1177 | 1178 | ### 2020-09-14_1.494.0 1179 | 1180 | - Add `vested_quantity` and `vested_value` fields to the `Holding` object. 1181 | 1182 | ### 2020-09-14_1.493.0 1183 | 1184 | - Add `POST /cra/partner_insights/get` 1185 | 1186 | ### 2020-09-14_1.492.1 1187 | 1188 | - Added documentation for the `HOSTED_VERIFICATION` webhook. 1189 | - Add `wire` to request and response of `/transfer/authorization/create` 1190 | 1191 | ### 2020-09-14_1.492.0 1192 | 1193 | - Remove `page_count`, `name`, and `status` fields from Identity Document Upload's document metadata. 1194 | 1195 | ### 2020-09-14_1.491.3 1196 | 1197 | - Increase max length of description field on `/transfer/intent/create` from 8 to 15 1198 | 1199 | ### 2020-09-14_1.491.2 1200 | 1201 | - Added documentation for the `securities.type` field in `investments/holdings/get` and `investments/transactions/get` endpoints. 1202 | 1203 | ### 2020-09-14_1.491.1 1204 | 1205 | - Add new `no_data` type to `name` and `date_of_birth` fields in `documentary_verification.documents[].analysis.extracted_data` in the response of all of the identity verification endpoints: 1206 | - `identity_verification/create` 1207 | - `identity_verification/get` 1208 | - `identity_verification/list` 1209 | - `identity_verification/retry` 1210 | 1211 | ### 2020-09-14_1.491.0 1212 | 1213 | - Add `identity` object to `link/token/create` request body 1214 | 1215 | ### 2020-09-14_1.490.0 1216 | 1217 | - Add `events` field to the `sessions` parameter in the `/link/token/get` response 1218 | 1219 | ### 2020-09-14_1.489.1 1220 | 1221 | - Mark optional `scope` and `reference` fields in `/payment_initiation/consent/payment/execute` as nullable 1222 | 1223 | ### 2020-09-14_1.489.0 1224 | 1225 | - Add optional `scope` and `reference` fields to `/payment_initiation/consent/payment/execute` 1226 | 1227 | ### 2020-09-14_1.488.0 1228 | 1229 | - Add optional `item_ids` field to the request of `credit/payroll_income/get` and `credit/bank_statements/uploads/get` 1230 | 1231 | ### 2020-09-14_1.487.2 1232 | 1233 | - Add `num_1099s_uploaded` to `document_income_results` object in `/credit/sessions/get` response 1234 | 1235 | ### 2020-09-14_1.487.1 1236 | 1237 | - Correct the Document Income Verification `parsing_config` enum used by `/link/token/create` to contain `risk_signals` instead of `fraud_risk` to match the actual API implementation. 1238 | - Dcumentation updates to reflect updates to Signal, including that new Items with Signal should now be created with `signal` in `/link/token/create` instead of using `/signal/prepare`. 1239 | 1240 | ### 2020-09-14_1.487.0 1241 | 1242 | - [Breaking] Introduce a new `AssetReportAccountBalance` object which duplicates the existing `AccountBalance` object with an additional `margin_loan_amount` field. Updated `AccountAssets.balances` to return the new `AssetReportAccountBalance` object instead of the existing `AccountBalance` object. 1243 | - Add `vested_quantity` and `vested_value` fields to the `AssetReportInvestments` object. 1244 | 1245 | ### 2020-09-14_1.486.1 1246 | 1247 | - Update `bank_income_sources` in CRA Bank Income Get to be required in response since the empty array is being omitted. 1248 | 1249 | ### 2020-09-14_1.486.0 1250 | 1251 | - Add `requires_real_time_balance_refresh`, `risk_reasons`, `attributes`, `balance_last_updated`, and `score` fields to `/accounts/balance/get` endpoint 1252 | 1253 | ### 2020-09-14_1.485.1 1254 | 1255 | - Update `legal_name` description in `user` object in `/link/token.create` request 1256 | 1257 | ### 2020-09-14_1.485.0 1258 | 1259 | - Add `/processor/liabilities/get` endpoint 1260 | 1261 | ### 2020-09-14_1.484.1 1262 | 1263 | - Add `/identity_verification/autofill/create` (closed beta) 1264 | 1265 | ### 2020-09-14_1.484.0 1266 | 1267 | - Add `/statements/refresh` endpoint 1268 | 1269 | ### 2020-09-14_1.483.2 1270 | 1271 | - Add `/beacon/duplicate/get` route 1272 | 1273 | ### 2020-09-14_1.483.1 1274 | 1275 | - Internal changes only 1276 | 1277 | ### 2020-09-14_1.483.0 1278 | 1279 | - Added net new fields to StatementsAccount object: `account_mask`, `account_subtype`, `account_official_name` 1280 | 1281 | ### 2020-09-14_1.482.3 1282 | 1283 | - Update `description` description for `/transfer/create` 1284 | 1285 | ### 2020-09-14_1.482.2 1286 | 1287 | - Update /credit/relay/get response example 1288 | 1289 | ### 2020-09-14_1.482.1 1290 | 1291 | - Update `funding_account_id` description for `/transfer/intent/create` 1292 | 1293 | ### 2020-09-14_1.482.0 1294 | 1295 | - Adds a new field `payment_details` to `/accounts/balance/get` request 1296 | - Adds a new field `payment_risk_assessment` to `/accounts/balance/get` response 1297 | 1298 | ### 2020-09-14_1.481.1 1299 | 1300 | - Update `USER_ACCOUNT_REVOKED` description and set to visible 1301 | 1302 | ### 2020-09-14_1.481.0 1303 | 1304 | - Add `available` to balance object in `wallet/get` and `wallet/list` response 1305 | 1306 | ### 2020-09-14_1.480.1 1307 | 1308 | - Documentation-only change to Investments `Security` object for new fields and sandbox availability 1309 | 1310 | ### 2020-09-14_1.480.0 1311 | 1312 | - Add `phone_number` to `/transactions/enrich` response 1313 | 1314 | ### 2020-09-14_1.479.0 1315 | 1316 | - [Breaking change for Go client library] Make `street` and `city` optional in the address attribute of `identity_verification/create` 1317 | 1318 | ### 2020-09-14_1.478.4 1319 | 1320 | - Add `registration_number` to `/partner/customer/create` request 1321 | 1322 | ### 2020-09-14_1.478.3 1323 | 1324 | - Update `/identity/get` response for identity document upload beta customers 1325 | 1326 | ### 2020-09-14_1.478.2 1327 | 1328 | - Deprecate `funding_account_id` from `/transfer/recurring/create` request 1329 | 1330 | ### 2020-09-14_1.478.1 1331 | 1332 | - Description-only changes to support Hosted Link (beta) 1333 | 1334 | ### 2020-09-14_1.478.0 1335 | 1336 | - Add `market_identifier_code` and `option_contract` fields in the Security (investment) object 1337 | - `option_contract` object contains `contract_type`, `expiration_date`, `strike_price`, and `underlying_security_ticker` 1338 | 1339 | ### 2020-09-14_1.477.1 1340 | 1341 | - Changes `last_user_modified_date` to `last_user_modified_datetime` on transaction stream object. 1342 | 1343 | ### 2020-09-14_1.477.0 1344 | 1345 | - Bug fix nullability definitions for `/beacon/user/create` and `/beacon/user/update` request payloads 1346 | 1347 | ### 2020-09-14_1.476.1 1348 | 1349 | - Update Recurring Transaction description 1350 | 1351 | ### 2020-09-14_1.476.0 1352 | 1353 | - Add `/beacon/user/update` 1354 | 1355 | ### 2020-09-14_1.475.0 1356 | 1357 | - Add `/beacon/report_syndication/get` route 1358 | 1359 | ### 2020-09-14_1.474.4 1360 | 1361 | - Add Statements Refresh webhook 1362 | 1363 | ### 2020-09-14_1.474.3 1364 | 1365 | - Internal changes only 1366 | 1367 | ### 2020-09-14_1.474.2 1368 | 1369 | - Deprecate `credit_funds_source` in `/transfer/authorization/create` request 1370 | 1371 | ### 2020-09-14_1.474.1 1372 | 1373 | - Added `identity_match` to Products schema object 1374 | 1375 | ### 2020-09-14_1.474.0 1376 | 1377 | - Added `statements/refresh` endpoint 1378 | 1379 | ### 2020-09-14_1.473.0 1380 | 1381 | - Add Beacon webhooks 1382 | 1383 | ### 2020-09-14_1.472.0 1384 | 1385 | - Change client library visibility of `options.transactions.days_requested` field for `/link/token/create` and `/sandbox/public_token/create` 1386 | - Add `options.days_requested` field to `/transactions/get` and `/transactions/sync` 1387 | 1388 | ### 2020-09-14_1.471.0 1389 | 1390 | [Breaking change for Go client libraries] Make `products` field in `/institutions/search` request optional to fix https://github.com/plaid/plaid-ruby/issues/476 1391 | 1392 | ### 2020-09-14_1.470.1 1393 | 1394 | - Bug fixes and improvements 1395 | 1396 | ### 2020-09-14_1.470.0 1397 | 1398 | - Add balance insights firleds to CRA Base Reports 1399 | 1400 | ### 2020-09-14_1.469.1 1401 | 1402 | - Change visibility of `/transactions/recurring/streams/...` endpoints 1403 | 1404 | ### 2020-09-14_1.469.0 1405 | 1406 | - Update date format in Base reports 1407 | 1408 | ### 2020-09-14_1.468.0 1409 | 1410 | - [Breaking change for Go client library] Mark `income_verification.access_tokens` and `access_token` nullable in `link/token/create` request, to match the actual behavior of the API. 1411 | - Add `other` to `account_filters` in `link/token/create` request 1412 | 1413 | ### 2020-09-14_1.467.0 1414 | 1415 | - Change `/transactions/recurring/streams/merge` and `/transactions/recurring/streams/update` return type 1416 | 1417 | ### 2020-09-14_1.466.0 1418 | 1419 | - Add `/transactions/recurring/streams/create`, `/transactions/recurring/streams/merge`, and `/transactions/recurring/streams/update` endpoints 1420 | 1421 | ### 2020-09-14_1.465.0 1422 | 1423 | - [Breaking change for Go client library] Mark `products`, `required_if_supported_products`, `optional_products`, `additional_consented_products`, and `user.ssn` as nullable in `/link/token/create` request. 1424 | - Set `minLength` for `client_name`, `language`, `access_token`, and `user.client_user_id` in `/link/token/create` request, to match actual validation behavior of the API. 1425 | 1426 | ### 2020-09-14_1.464.1 1427 | 1428 | - Add `webhook_code` to `/sandbox/income/fire_webhook` 1429 | - Change `verification_status` to be an optional field in `/sandbox/income/fire_webhook` 1430 | 1431 | ### 2020-09-14_1.464.0 1432 | 1433 | - Add `/processor/signal/prepare` endpoint. 1434 | 1435 | ### 2020-09-14_1.463.7 1436 | 1437 | - Internal changes only 1438 | 1439 | ### 2020-09-14_1.463.6 1440 | 1441 | - Add `database_matched` to `verification_status` for database matched items. 1442 | 1443 | ### 2020-09-14_1.463.5 1444 | 1445 | - Add `hosted_link.url_lifetime_seconds` to `/link/token/create` request 1446 | 1447 | ### 2020-09-14_1.463.4 1448 | 1449 | - Add `database_match_enabled` field to `auth` object in `link/token/create` 1450 | 1451 | ### 2020-09-14_1.463.3 1452 | 1453 | - Mark `RecurringInsightsStream` fields `is_active`, `merchant_name`, and `average_days_apart` as required. 1454 | 1455 | ### 2020-09-14_1.463.2 1456 | 1457 | - Add `user_id` into the webhook schema for `AssetsProductReadyWebhook` 1458 | 1459 | ### 2020-09-14_1.463.1 1460 | 1461 | - [Breaking change for Go client library] Mark `access_token` and `account_id` required in `/transfer/create`, to match the actual behavior of the API. 1462 | 1463 | ### 2020-09-14_1.463.0 1464 | 1465 | - Add is_user_modified and last_user_modified_date to TransactionStream 1466 | 1467 | ### 2020-09-14_1.462.0 1468 | 1469 | - Update `/beta/transactions/user_insights/v1/get` endpoint with recurring transactions and feature updates. 1470 | 1471 | ### 2020-09-14_1.461.2 1472 | 1473 | - Clean up description for transfer refund simulate route. 1474 | 1475 | ### 2020-09-14_1.461.1 1476 | 1477 | - Remove `client_id` and `secret` from required param list of `/transfer/ledger/distribute` 1478 | 1479 | ### 2020-09-14_1.461.0 1480 | 1481 | - Add `/beacon/user/review` route for updating the status of Beacon Users 1482 | 1483 | ### 2020-09-14_1.460.0 1484 | 1485 | - Permissions manager API: bug fix: update `date` field in ConnectedApplication schema to `date-time` to match API behavior 1486 | - Permissions manager API: add `/item/application/unlink` endpoint 1487 | 1488 | ### 2020-09-14_1.459.2 1489 | 1490 | - Do not support .docx or .doc file for `/transfer/diligence/document/upload` 1491 | 1492 | ### 2020-09-14_1.459.1 1493 | 1494 | - Make `products` request parameter for `/partner/customer/create` optional. 1495 | 1496 | ### 2020-09-14_1.459.0 1497 | 1498 | - Add route `/transfer/ledger/distribute` 1499 | 1500 | ### 2020-09-14_1.458.1 1501 | 1502 | - Refunds start processing after 4 days (not 3 days). 1503 | 1504 | ### 2020-09-14_1.458.0 1505 | 1506 | - Remove `account_ids` parameter `/processor/transactions/get` options object 1507 | - Change `accounts` response field for `/processor/transactions/get` to `account` 1508 | 1509 | ### 2020-09-14_1.457.4 1510 | 1511 | Add BASE_REPORT_WARNING warning type 1512 | 1513 | ### 2020-09-14_1.457.3 1514 | 1515 | Add `BE` to the list of available countries 1516 | 1517 | ### 2020-09-14_1.457.2 1518 | 1519 | - Add `access_tokens` field to `/link/token/create` request 1520 | 1521 | ### 2020-09-14_1.457.1 1522 | 1523 | - Clean up description for transfer ledger simulate routes. 1524 | 1525 | ### 2020-09-14_1.457.0 1526 | 1527 | - Remove `account_ids` parameter from `/processor/transactions/recurring/get` request 1528 | 1529 | ### 2020-09-14_1.456.0 1530 | 1531 | - Add `hosted_link.completion_redirect_uri` to `link/token/create` request 1532 | 1533 | ### 2020-09-14_1.455.2 1534 | 1535 | - Deprecate max_single_transfer_amount and max_monthly_amount in /transfer/configuration/get response. 1536 | - Deprecate monthly_transfer_volume in /transfer/metrics/get response. 1537 | 1538 | ### 2020-09-14_1.455.1 1539 | 1540 | - Update documentation for `/credit/payroll_income/parsing_config/update` 1541 | 1542 | ### 2020-09-14_1.455.0 1543 | 1544 | - Add new /sandbox/transfer/refund/simulate route to simulate refund events in sandbox. 1545 | 1546 | ### 2020-09-14_1.454.0 1547 | 1548 | - Add `is_investments_fallback_item` field to `/investments/holdings/get` and `/investments/transactions/get` responses 1549 | 1550 | ### 2020-09-14_1.453.0 1551 | 1552 | - Add `/credit/payroll_income/parsing_config/update` for updating the parsing configuration for document income verficiations 1553 | 1554 | ### 2020-09-14_1.452.0 1555 | 1556 | - Add `warnings` field to `/cra/base_report/get` response 1557 | 1558 | ### 2020-09-14_1.451.0 1559 | 1560 | - Add `/beacon/report_syndication/list` for listing `BeaconReportSyndication` objects linked to a specific `BeaconUser` 1561 | 1562 | ### 2020-09-14_1.450.0 1563 | 1564 | - [Breaking] Remove `user_token` field from `asset_report/create` request. 1565 | 1566 | ### 2020-09-14_1.449.2 1567 | 1568 | - Updates `isin` and `cusip` field descriptions for new call to action. 1569 | 1570 | ### 2020-09-14_1.449.1 1571 | 1572 | - Add new refund event types. 1573 | 1574 | ### 2020-09-14_1.449.0 1575 | 1576 | - Add `/beacon/report/list` for listing `BeaconReport` objects created for a specific `BeaconUser` 1577 | 1578 | ### 2020-09-14_1.448.0 1579 | 1580 | - Make `publisher` field from `FDXNotifications` as optional 1581 | 1582 | ### 2020-09-14_1.447.0 1583 | 1584 | - Mark `fraud_amount` as nullable for `BeaconReport` objects in `/beacon/report/create` 1585 | 1586 | ### 2020-09-14_1.446.0 1587 | 1588 | - Add `allow_manual_entry` field to `investments` object in `link/token/create` 1589 | - Update `/credit/freddie_mac/reports/get` return type data shape to contain one object with both VOA and VOE assets combined 1590 | 1591 | ### 2020-09-14_1.445.0 1592 | 1593 | - Add new insights and counterparty fields for Transactions endpoints 1594 | - Deprecate legacy category fields for Transactions endpoints 1595 | 1596 | ### 2020-09-14_1.444.0 1597 | 1598 | - Add new webhook type `AUTHORIZATION_GRANTED` to `sandbox/item/fire_webhook` 1599 | 1600 | ### 2020-09-14_1.443.0 1601 | 1602 | - Add `RETURN` as possible Virtual Account wallet transaction type 1603 | 1604 | ### 2020-09-14_1.442.0 1605 | 1606 | - Add `facilitator_fee` field for the Transfers endpoints 1607 | 1608 | ### 2020-09-14_1.441 1609 | 1610 | - [Breaking change for Go client library] Update `/transfer/capabilities/get` to no longer accept payment profile token and require an `account_id` and `access_token` 1611 | - Update examples for ledger endpoints to be more realistic 1612 | 1613 | ### 2020-09-14_1.440.0 1614 | 1615 | - Add `optional_products` parameter to `/link/token/create` request. 1616 | 1617 | ### 2020-09-14_1.439.0 1618 | 1619 | - [Breaking] Renamed `TransactionsEnrichGetRequest` and `TransactionsEnrichGetResponse` objects to 1620 | `TransactionsEnrichRequest` and `TransactionsEnrichResponse`. 1621 | 1622 | ### 2020-09-14_1.438.1 1623 | 1624 | - [Breaking change for Go client library] remove `device`, `user_present` from required request param list of `/transfer/recurring/create` 1625 | 1626 | ### 2020-09-14_1.438.0 1627 | 1628 | - Add new `/beta/transactions/user_insights/v1/get` endpoint 1629 | 1630 | ### 2020-09-14_1.437.0 1631 | 1632 | - Remove min/max restriction of `days_requested` in OpenAPI. 1633 | 1634 | ### 2020-09-14_1.436.0 1635 | 1636 | - Update `days_requested` to be a required field in base reports in `link/token/create` 1637 | 1638 | ### 2020-09-14_1.435.0 1639 | 1640 | - Update `/sandbox/transfer/sweep/simulate` to mark `swept` transfers as `swept_settled`. 1641 | 1642 | ### 2020-09-14_1.434.0 1643 | 1644 | - Added a new type of webhook for dashboard alerts, `InstitutionStatusAlertWebhook`. 1645 | 1646 | ### 2020-09-14_1.433.0 1647 | 1648 | - Update response of `/transfer/authorizarion/create` 1649 | 1650 | ### 2020-09-14_1.432.0 1651 | 1652 | - Update `days_requested` in `base_report` in `link/token/create` to enforce a min/max of 1/731 days 1653 | 1654 | ### 2020-09-14_1.431.7 1655 | 1656 | - Add processor Zero Hash 1657 | 1658 | ### 2020-09-14_1.431.6 1659 | 1660 | - Update response example of `sandbox/transfer/ledger/deposit/simulate` and `sandbox/transfer/ledger/withdraw/simulate` 1661 | 1662 | ### 2020-09-14_1.431.5 1663 | 1664 | - Update the description of `sweep.settled` event 1665 | 1666 | ### 2020-09-14_1.431.4 1667 | 1668 | - Update description of endpoint `/sandbox/transfer/ledger/simulate_available` 1669 | 1670 | ### 2020-09-14_1.431.3 1671 | 1672 | - Deprecate `originator_client_id` in `/transfer/get`, `/transfer/cancel`, and `/transfer/balance/get` 1673 | 1674 | ### 2020-09-14_1.431.2 1675 | 1676 | - Docs updates for Statements endpoints 1677 | 1678 | ### 2020-09-14_1.431.1 1679 | 1680 | - Remove `balance` field from response of `/sandbox/transfer/ledger/simulate_available` 1681 | 1682 | ### 2020-09-14_1.431.0 1683 | 1684 | - Add `/user/update` and update the description for consumer report user identity 1685 | 1686 | ### 2020-09-14_1.430.3 1687 | 1688 | - Add `sandbox/transfer/ledger/deposit/simulate` and `sandbox/transfer/ledger/withdraw/simulate` 1689 | 1690 | ### 2020-09-14_1.430.2 1691 | 1692 | - Update `transfer/sweep/list` to support filter by `trigger` 1693 | 1694 | ### 2020-09-14_1.430.1 1695 | 1696 | - Add `transfer/ledger/withdraw` route 1697 | 1698 | ### 2020-09-14_1.430.0 1699 | 1700 | - Add `transfer/originator/funding_account/update` route 1701 | 1702 | ### 2020-09-14_1.429.3 1703 | 1704 | - add ledger sweep event types to `TransferEventType` 1705 | 1706 | ### 2020-09-14_1.429.2 1707 | 1708 | - Documentation updates for `LOGIN_REPAIRED` webhook and transfer. 1709 | - Add `transfer/ledger/deposit` route 1710 | 1711 | ### 2020-09-14_1.429.1 1712 | 1713 | - Updated /identity/match's address score threshold recommendation from 80 or above to 70 or above 1714 | 1715 | ### 2020-09-14_1.429.0 1716 | 1717 | - [Breaking change for Go client library] For Transfer endpoints that take payment profiles as input, remove `payment_profile` field and make 1718 | `account_id` and `access_token` mandatory. The removed field is not in use. 1719 | - Mark all payment profile-specific endpoints as `deprecated`. 1720 | - Docs updates for Transfer, including clarifying that certain request fields for `/transfer/authorization/create` 1721 | are not currently used. 1722 | - Propagate Signal docs update from 2020-09-14_1.419.0 to all relevant endpoints. 1723 | - Add `institution_not_supported` as a property to `LinkSessionExitMetadata.Status` 1724 | 1725 | ### 2020-09-14_1.428.1 1726 | 1727 | - Change `/credit/reports/freddie_mac/get` schema to contain new `ReportingInformationParentIdentifier` field 1728 | 1729 | ### 2020-09-14_1.428.0 1730 | 1731 | - Add `verification_report_type` to `asset_report/create` request 1732 | 1733 | ### 2020-09-14_1.427.1 1734 | 1735 | - Remove references to the verification `report_type` field in `asset_report/get` and `asset_report/pdf/get` 1736 | 1737 | ### 2020-09-14_1.427.0 1738 | 1739 | - Add `/processor/account/get` route 1740 | 1741 | ### 2020-09-14_1.426.0 1742 | 1743 | - Add `instant_microdeposits_enabled` field to `auth` object in `link/token/create` 1744 | 1745 | ### 2020-09-14_1.425.0 1746 | 1747 | - Add `investments` field to `asset_report/get` response as part of the `items.accounts` object 1748 | 1749 | ### 2020-09-14_1.424.2 1750 | 1751 | - Update descriptions of some Transactions endpoint fields 1752 | 1753 | ### 2020-09-14_1.424.1 1754 | 1755 | - Add clarification to processor webhook doc that the processor can call it 1756 | - Fix `sandbox/transfer/ledger/simulate_available` doc url 1757 | 1758 | ### 2020-09-14_1.424.0 1759 | 1760 | - Add `/sandbox/transfer/ledger/simulate_available` route 1761 | 1762 | ### 2020-09-14_1.423.0 1763 | 1764 | - Update code of `BaseReportsErrorWebhook` to `ERROR` 1765 | - Add new enum to StudentRepaymentPlan and add to description of repayment_plan_type 1766 | 1767 | ### 2020-09-14_1.422.0 1768 | 1769 | - Move `BaseReportsProductReadyWebhook` and `BaseReportsErrorWebhook` 1770 | - Remove `asset_report_id` and add `user_id` to `BaseReportsErrorWebhook` 1771 | 1772 | ### 2020-09-14_1.421.0 1773 | 1774 | - Update permissible purpose code `LEGITIMATE_BUSINESS_NEED_TENANT_OTHER` to `LEGITIMATE_BUSINESS_NEED_OTHER` 1775 | 1776 | ### 2020-09-14_1.420.1 1777 | 1778 | - Add new enums to `canonical_description` in `credit/payroll_income/get` 1779 | 1780 | ### 2020-09-14_1.420.0 1781 | 1782 | - Add `database_match_enabled` field to `auth` object in `link/token/create` 1783 | 1784 | ### 2020-09-14_1.419.2 1785 | 1786 | - Add `/transfer/ledger/get` route 1787 | 1788 | ### 2020-09-14_1.419.1 1789 | 1790 | - Add `submitted` and `not_submitted` to transferDiligenceStatus 1791 | 1792 | ### 2020-09-14_1.419.0 1793 | 1794 | - Update `/signal/decision/report` description 1795 | - Overwriting `initiated` field is now supported and no longer returns an `INVALID_FIELD` error 1796 | 1797 | ### 2020-09-14_1.418.0 1798 | 1799 | - Add `frequency` to `/transactions/enrich` 1800 | 1801 | ### 2020-09-14_1.417.0 1802 | 1803 | - Remove `category`, `category_id`, `transaction_type`, `name`, `payment_meta` fields from Base Report insights 1804 | 1805 | ### 2020-09-14_1.416.0 1806 | 1807 | - Add `card_switch` to `/link/token/create` 1808 | 1809 | ### 2020-09-14_1.415.0 1810 | 1811 | - Add `consumer_report_permissible_purpose` to `link/token/create` 1812 | 1813 | ### 2020-09-14_1.414.0 1814 | 1815 | - Update `currency` on `payment/reverse` and `amount_refunded` on `payment/get` 1816 | 1817 | ### 2020-09-14_1.413.0 1818 | 1819 | - Add `statements` to `/link/token/create` request 1820 | 1821 | ### 2020-09-14_1.412.0 1822 | 1823 | - Add `hosted_link_url` to `/link/token/create` response 1824 | - Add `hosted_link.delivery_method` to `/link/token/create` 1825 | 1826 | ### 2020-09-14_1.411.0 1827 | 1828 | - Add `link_sessions` to `/link/token/get` 1829 | - Add `LINK:SESSION_FINISHED` webhook 1830 | 1831 | ### 2020-09-14_1.410.1 1832 | 1833 | - Add `statements` to the list of supported Plaid products in the `/link/token/create` endpoint 1834 | 1835 | ### 2020-09-14_1.410.0 1836 | 1837 | - add `/credit/relay/pdf/get` endpoint 1838 | 1839 | ### 2020-09-14_1.409.0 1840 | 1841 | - Add `original_client_id` to `/transfer/balance/get` 1842 | - Mark `type` optional in `/transfer/balance/get` request 1843 | 1844 | ### 2020-09-14_1.408.0 1845 | 1846 | - Add `status` to `document_reference` in `/credit/payroll_income/risk_signals/get` 1847 | 1848 | ### 2020-09-14_1.407.0 1849 | 1850 | - Add `consumer_report_user_identity` to `/user/create` 1851 | 1852 | ### 2020-09-14_1.406.1 1853 | 1854 | - Add comment explaining availability of `confidence_level` field for `/transactions/*` endpoints 1855 | 1856 | ### 2020-09-14_1.406.0 1857 | 1858 | - Added insights fields to `/cra/base_report/get` 1859 | 1860 | ### 2020-09-14_1.405.0 1861 | 1862 | - Update identity/match user.address such that none of the fields are required 1863 | - Add `AddressDataNullableNoRequiredFields` 1864 | 1865 | ### 2020-09-14_1.404.1 1866 | 1867 | - Allowing null failure_reason for refunds to be displayed 1868 | - 1869 | 1870 | ### 2020-09-14_1.404.0 1871 | 1872 | - Add `failure_reason` to `/wallet/transaction/get` and `/wallet/transaction/list` endpoint in virtual accounts. 1873 | 1874 | ### 2020-09-14_1.403.1 1875 | 1876 | - Add `parsing_config` to `/link/token/create` 1877 | 1878 | ### 2020-09-14_1.403.0 1879 | 1880 | - Add `failure_reason` field to refunds for failed and returned refunds 1881 | 1882 | ### 2020-09-14_1.402.0 1883 | 1884 | - Add `area_code` match status to the response of the `identity_verification/get` and `identity_verification/list` endpoint 1885 | 1886 | ### 2020-09-14_1.401.0 1887 | 1888 | - Add `POST /cra/bank_income/get` 1889 | 1890 | ### 2020-09-14_1.400.0 1891 | 1892 | - Add `cra/base_report/get` endpoint 1893 | 1894 | ### 2020-09-14_1.399.0 1895 | 1896 | - Add `base_report` field to `/link/token/create` and corresponding Base Report webhooks 1897 | 1898 | ### 2020-09-14_1.398.0 1899 | 1900 | - Make CreditBankIncomeWebhookUpdateResponse visible 1901 | 1902 | ### 2020-09-14_1.397.0 1903 | 1904 | - Remove extraneous `Item` field from `/processor/transactions/get` response 1905 | - Reference new `/processor/token/webhook/update` endpoint in processor Transactions routes. 1906 | 1907 | ### 2020-09-14_1.396.2 1908 | 1909 | - Document cash management account support 1910 | 1911 | ### 2020-09-14_1.396.1 1912 | 1913 | - Fix document capitalization of `confidence_level` field in `/transactions/enrich` 1914 | 1915 | ### 2020-09-14_1.396.0 1916 | 1917 | - Add `/beacon/report/create` 1918 | 1919 | ### 2020-09-14_1.395.0 1920 | 1921 | - Add `POST /beacon/user/create` 1922 | - Add `POST /beacon/user/get` 1923 | 1924 | ### 2020-09-14_1.394.0 1925 | 1926 | - Made `/statements/list` and `/statements/download` APIs for Plaid's Statements PDF beta product available in client SDKs 1927 | 1928 | ### 2020-09-14_1.393.0 1929 | 1930 | - Add `date_of_birth` and `address` fields to `documentary_verification.documents[].extracted_data` in the response of all of the identity verification endpoints: 1931 | - `identity_verification/create` 1932 | - `identity_verification/get` 1933 | - `identity_verification/list` 1934 | - `identity_verification/retry` 1935 | 1936 | ### 2020-09-14_1.392.4 1937 | 1938 | - Update the following about identity/match name, phone number, email, and address score descriptions: 1939 | - Ensure consistent language across all fields 1940 | - Include score recommended "match" threshold for all fields. 1941 | 1942 | ### 2020-09-14_1.392.3 1943 | 1944 | - Update the `async_update` field description. 1945 | 1946 | ### 2020-09-14_1.392.2 1947 | 1948 | - Mark a few response fields as always present in the identity verification API: 1949 | - `selfie_check.selfies[].capture.image_url` 1950 | - `selfie_check.selfies[].capture.video_url` 1951 | - `risk_check.identity_abuse_signals` 1952 | - `risk_check.identity_abuse_signals.synthetic_identity.score` 1953 | - `risk_check.identity_abuse_signals.stolen_identity.score` 1954 | 1955 | ### 2020-09-14_1.392.1 1956 | 1957 | - Documentation updates for the `/link/token/create` endpoint 1958 | 1959 | ### 2020-09-14_1.392.0 1960 | 1961 | - Add `confidence_level` field to Counterparty and PersonalFinanceCategory for `/transactions/enrich` 1962 | 1963 | ### 2020-09-14_1.391.3 1964 | 1965 | - Remove the `core_attributes` field in `signal_insights` of /transfer/authorization/create 1966 | 1967 | ### 2020-09-14_1.391.2 1968 | 1969 | - Update the `pending_manual_verification` field's description in `/auth/get` response 1970 | 1971 | ### 2020-09-14_1.391.1 1972 | 1973 | - Update the description of `/investments/transactions/get` 1974 | 1975 | ### 2020-09-14_1.391.0 1976 | 1977 | - Update the `async_update` option to be visible in `/investments/transactions/get` 1978 | 1979 | ### 2020-09-14_1.390.1 1980 | 1981 | - Update the `signal_insights` field's description in `/transfers/authorization/create` request 1982 | 1983 | ### 2020-09-14_1.390.0 1984 | 1985 | - Add `transfer_id` field to `/transfers/sweep/list` request 1986 | 1987 | ### 2020-09-14_1.389.0 1988 | 1989 | - Add `InvestmentsHistoricalUpdateWebhook`, a `HISTORICAL_UPDATE` webhook of type `INVESTMENTS_TRANSACTIONS`. 1990 | 1991 | ### 2020-09-14_1.388.1 1992 | 1993 | - Add `status` field to a sweep object. Add `status` field to `/transfers/sweep/list` request 1994 | 1995 | ### 2020-09-14_1.388.0 1996 | 1997 | - [Breaking] Remove `asset_report_token` as required field in `/asset_report/get` and mark as nullable 1998 | 1999 | ### 2020-09-14_1.387.1 2000 | 2001 | - Allow empty `mask` on the `meta` field of overridden accounts in the sandbox custom user configuration object schema. 2002 | 2003 | ### 2020-09-14_1.387.0 2004 | 2005 | - Mark `region` and `postal_code` fields as nullable in `/identity_verification/create`, `/identity_verification/retry`, and `/link/token/create` 2006 | 2007 | ### 2020-09-14_1.386.0 2008 | 2009 | - Add payloads for processor Transactions webhooks. 2010 | 2011 | ### 2020-09-14_1.385.2 2012 | 2013 | - Mark `next_origination_date` nullable 2014 | 2015 | ### 2020-09-14_1.385.1 2016 | 2017 | - Add expiration time description to `transfer/authorization/create` `idempotency_key` parameter 2018 | 2019 | ### 2020-09-14_1.385.0 2020 | 2021 | - Add `user` field to `/identity_verification/retry` 2022 | - Add `client_user_id` field to `/identity_verification/create` 2023 | - Deprecate `user.client_user_id` field in `/identity_verification/create` 2024 | - [Breaking] Renamed `IdentityVerificationRequestUser` object to `IdentityVerificationCreateRequestUser` 2025 | 2026 | ### 2020-09-14_1.384.0 2027 | 2028 | - Remove `maxLength` constraint from `client_user_id` field for `/processor/signal/evaluate` and `/signal/evaluate` requests 2029 | 2030 | ### 2020-09-14_1.383.3 2031 | 2032 | - Add `test_clock_id` to `transfer/authorization/create` request 2033 | 2034 | ### 2020-09-14_1.383.2 2035 | 2036 | - Update `InvestmentsAuthOwner` title 2037 | 2038 | ### 2020-09-14_1.383.1 2039 | 2040 | - Add `account_id` to `bank_accounts` and `transactions` in `/credit/bank_statements/uploads/get` response 2041 | 2042 | ### 2020-09-14_1.383.0 2043 | 2044 | - Add `transfer/diligence/document/upload` endpoint 2045 | 2046 | ### 2020-09-14_1.382.1 2047 | 2048 | - Add `amount` to `/transfer/sweep/list` request 2049 | 2050 | ### 2020-09-14_1.382.0 2051 | 2052 | - Add `signal_insights` to `/transfer/authorization/create` request 2053 | 2054 | ### 2020-09-14_1.381.0 2055 | 2056 | - Add definitions for `/sandbox/bank_income/fire_webhook` 2057 | 2058 | ### 2020-09-14_1.380.0 2059 | 2060 | - Update validation `sweep_id` for `/transfers/sweep/get` to allow UUID or 8 character hexadecimal string 2061 | 2062 | ### 2020-09-14_1.379.0 2063 | 2064 | - Add `scheme` to `/wallet/transaction/get` and `/wallet/transaction/list` 2065 | 2066 | ### 2020-09-14_1.378.1 2067 | 2068 | - Fix issue in which `request_id` was erroneously not listed as required in `ItemActivityListResponse` 2069 | 2070 | ### 2020-09-14_1.378.0 2071 | 2072 | - Add `reroute_to_credentials` to `/link/token/create` auth request 2073 | 2074 | ### 2020-09-14_1.377.0 2075 | 2076 | - Add definitions for `/investments/auth/get` 2077 | 2078 | ### 2020-09-14_1.376.0 2079 | 2080 | - Add `required_if_supported_products` to `/link/token/create` request 2081 | 2082 | ### 2020-09-14_1.375.0 2083 | 2084 | - Add hidden `account_type` to `/transactions/enrich` request and response 2085 | - Add hidden `account_subtype` to `/transactions/enrich` request and response 2086 | 2087 | ### 2020-09-14_1.374.3 2088 | 2089 | - Add `num_bank_statements_uploaded` to `document_income_results` object in `/credit/sessions/get` response 2090 | 2091 | ### 2020-09-14_1.374.2 2092 | 2093 | - Add `income_source` enum to `/transactions/enrich` `counterparty_type` field 2094 | 2095 | ### 2020-09-14_1.374.1 2096 | 2097 | - Update `oauth` descriptions for `/institutions/get` and `/institutions/search` 2098 | 2099 | ### 2020-09-14_1.374.0 2100 | 2101 | - Add `/credit/bank_statements/uploads/get` endpoint 2102 | 2103 | ### 2020-09-14_1.373.0 2104 | 2105 | - Add support for address and date of birth in `virtual-accounts/#wallettransactionexecute` endpoint 2106 | 2107 | ### 2020-09-14_1.372.3 2108 | 2109 | - Modify `/transactions/enrich` field `user_id` to `client_user_id` 2110 | - Modify `/transactions/enrich` field `account_id` to `client_account_id` 2111 | 2112 | ### 2020-09-14_1.372.2 2113 | 2114 | - Update docs for `/transactions/enrich` response to include non-null example values for `lat` and `lon` fields 2115 | 2116 | ### 2020-09-14_1.372.1 2117 | 2118 | - Update descriptions for `PAYMENT_STATUS_EXECUTED` and `PAYMENT_STATUS_INITIATED` 2119 | - Update description for `PaymentAmountCurrency` 2120 | 2121 | ### 2020-09-14_1.372.0 2122 | 2123 | - Add `user_id` and `account_id` fields to `/transactions/enrich` request and resposne 2124 | 2125 | ### 2020-09-14_1.371.4 2126 | 2127 | - Update descriptions for `/credit/payroll_income/risk_signals/get` and `INCOME_VERIFICATION_RISK_SIGNALS` webhook 2128 | 2129 | ### 2020-09-14_1.371.3 2130 | 2131 | - Add test_clock_id to `/transfer/simulate` 2132 | - [Breaking change for Go] Make `virtual_time` optional in `/sandbox/transfer/test_clock/create` 2133 | 2134 | ### 2020-09-14_1.371.2 2135 | 2136 | - Add test_clock_id to `/sandbox/transfer/simulate` and `/sandbox/transfer/sweep/simulate` endpoints 2137 | 2138 | ### 2020-09-14_1.371.1 2139 | 2140 | - Update `transfer/diligence/submit` copy 2141 | 2142 | ### 2020-09-14_1.370.0 2143 | 2144 | - Add `investments/refresh` endpoint 2145 | 2146 | ### 2020-09-14_1.369.3 2147 | 2148 | - Update `description` field in `/transfer/create` to have max length of 15 2149 | 2150 | ### 2020-09-14_1.369.2 2151 | 2152 | - Add new `CreditBankIncomeCategory` value 2153 | 2154 | ### 2020-09-14_1.369.1 2155 | 2156 | - Fix `/processor/transactions` routes doc links 2157 | 2158 | ### 2020-09-14_1.369.0 2159 | 2160 | - Add `/processor/token/permissions/get` endpoint 2161 | - Add `/processor/token/permissions/set` endpoint 2162 | 2163 | ### 2020-09-14_1.368.2 2164 | 2165 | - Add `transfer/diligence/submit` endpoint 2166 | 2167 | ### 2020-09-14_1.368.1 2168 | 2169 | - Update `client_user_id` description for Identity Verification endpoints 2170 | - Update `user` description for Identity Match via Identity Verification Data use case 2171 | 2172 | ### 2020-09-14_1.368.0 2173 | 2174 | - Add `/transfer/balance/get` endpoint 2175 | 2176 | ### 2020-09-14_1.367.0 2177 | 2178 | - Added `LinkEventsWebhook` schema 2179 | 2180 | ### 2020-09-14_1.366.0 2181 | 2182 | - Add `credit_funds_source` field for authorizations and transfers 2183 | - Make `funding_account_id` nullable in various /transfer API responses 2184 | 2185 | ### 2020-09-14_1.356.0 2186 | 2187 | - Update `notificationsPayload.customFields` datatype from an object to an array of objects 2188 | 2189 | ### 2020-09-14_1.355.1 2190 | 2191 | - Added `warnings` to `/processor/signal/evaluate` response. 2192 | 2193 | ### 2020-09-14_1.355.0 2194 | 2195 | - Added `/processor/identity/match` endpoint. 2196 | 2197 | ### 2020-09-14_1.354.0 2198 | 2199 | - Adds a `selfie_check` object to the response schema of all the identity verification endpoints: 2200 | - `identity_verification/create` 2201 | - `identity_verification/get` 2202 | - `identity_verification/list` 2203 | - `identity_verification/retry` 2204 | 2205 | ### 2020-09-14_1.353.1 2206 | 2207 | - Update `INCOME_VERIFICATION_RISK_SIGNALS` with webhook tag 2208 | 2209 | ### 2020-09-14_1.353.0 2210 | 2211 | - Add `ASSETS: PRODUCT_READY` and `ASSETS: ERROR` webhooks to `/sandbox/item/fire_webhook` endpoint 2212 | 2213 | ### 2020-09-14_1.352.0 2214 | 2215 | - Removed explicit `additionalProperties: true` marker for request objects and objects used only within request objects, primarily impacting the Payment Initiation API. This will result in more strict type checking for those objects, but should not be a breaking change. 2216 | 2217 | ### 2020-09-14_1.351.1 2218 | 2219 | - Update `transfer/authorization/create` copy 2220 | 2221 | ### 2020-09-14_1.351.0 2222 | 2223 | - Add new `INCOME_VERIFICATION_RISK_SIGNALS` webhook 2224 | 2225 | ### 2020-09-14_1.350.0 2226 | 2227 | - Remove `settled_amount` 2228 | - Rename `expected_settlement_schedule` as `expected_sweep_settlement_schedule` 2229 | 2230 | ### 2020-09-14_1.349.0 2231 | 2232 | - [Breaking] Converts several types that were incorrectly typed as `number` to `integer`. In some languages, this will change the type used for this field, which may be a breaking change for some Plaid integrations. The following fields are impacted: 2233 | 2234 | For all products: 2235 | 2236 | - `PlaidError.status` 2237 | 2238 | For Liabilities: 2239 | 2240 | - `PSLFStatus.payments_made` 2241 | - `PSLFStatus.payments_remaining` 2242 | 2243 | For Identity Verification and Monitor: 2244 | 2245 | - `DocumentaryVerificationDocument.DocumentAnalysis.attempt` 2246 | - `EntityScreeningHitAnalysis.search_terms_version` 2247 | - `EntityWatchlistScreeningSearchTerms.search_terms_version` 2248 | - `IdentityVerificationTemplateReference.version` 2249 | 2250 | The following client library languages are impacted: 2251 | 2252 | - Go: Type changes from Float64 to Int32 2253 | - Java: Type changes from Double to Integer 2254 | - Python: Type changes from float to int 2255 | - Ruby: Type changes from Float to Integer 2256 | 2257 | ### 2020-09-14_1.348.2 2258 | 2259 | - Update `/identity/match`'s score description to explicitly mention that null values are returned if input is missing from either the financial institution or the API 2260 | - Update `/identity/match` sample response to include `is_business_name_detected` 2261 | 2262 | ### 2020-09-14_1.348.1 2263 | 2264 | - Make the `warnings` field in `SignalEvaluateResponse` non-nullable 2265 | 2266 | ### 2020-09-14_1.348.0 2267 | 2268 | - Add `STARTED` and `INTERNAL_ERROR` to bank income and employment `/credit/sessions/get` status 2269 | 2270 | ### 2020-09-14_1.347.1 2271 | 2272 | - Change invalid format `datetime` to `date` on `initiated_date` field 2273 | - Update `SignalWarning` descriptions 2274 | 2275 | ### 2020-09-14_1.347.0 2276 | 2277 | Fix npm publish 2278 | 2279 | ### 2020-09-14_1.346.0 2280 | 2281 | - Releasing new `/credit/payroll_income/risk_signals/get` endpoint 2282 | 2283 | ### 2020-09-14_1.345.4 2284 | 2285 | - Revert `sweep_amount` description 2286 | 2287 | ### 2020-09-14_1.345.3 2288 | 2289 | - Update `sweep_amount` description 2290 | 2291 | ### 2020-09-14_1.345.2 2292 | 2293 | - Internal changes 2294 | 2295 | ### 2020-09-14_1.345.1 2296 | 2297 | - Update `/transactions/enrich` field `is_recurring` field to be optional.bool 2298 | 2299 | ### 2020-09-14_1.345.0 2300 | 2301 | - Fix bug in which `environment` field was incorrectly missing from Assets webhooks. 2302 | 2303 | ### 2020-09-14_1.344.0 2304 | 2305 | - Add recurrence and is_recurring fields to `/transactions/enrich` 2306 | 2307 | ### 2020-09-14_1.343.6 2308 | 2309 | - Update incorrect required fields for `/watchlist_screening/entity/update` 2310 | 2311 | ### 2020-09-14_1.343.5 2312 | 2313 | - Update `owners` description for `/credit/bank_income/get` and `/beta/credit/v1/bank_employment/get` 2314 | 2315 | ### 2020-09-14_1.343.4 2316 | 2317 | - Make comment about `webhook` field in `/link/token/create` request more explicit 2318 | 2319 | ### 2020-09-14_1.343.3 2320 | 2321 | - Make VOA in /credit/freddie_mac/reports/get optional 2322 | 2323 | ### 2020-09-14_1.343.2 2324 | 2325 | - Update `warnings` description for `/credit/bank_income/get` and `/beta/credit/v1/bank_employment/get` 2326 | 2327 | ### 2020-09-14_1.343.1 2328 | 2329 | - Updated Asset endpoint descriptions related to Verification of Employment 2330 | 2331 | ### 2020-09-14_1.343.0 2332 | 2333 | - Add new `warnings` field to the response of `/signal/evaluate` 2334 | 2335 | ### 2020-09-14_1.342.0 2336 | 2337 | - Add `report_type` to assets webhook docs 2338 | - Make `add_ons` public in assets docs for /asset_report/create 2339 | - Make `fast_report` public in assets docs for /asset_report/get 2340 | 2341 | ### 2020-09-14_1.341.0 2342 | 2343 | - Add `risk_check` attribute to all Identity Verification responses 2344 | 2345 | ### 2020-09-14_1.340.1 2346 | 2347 | - Update examples for `entity_id` in `/transactions/enrich` 2348 | 2349 | ### 2020-09-14_1.340.0 2350 | 2351 | - Create `options` in `/link_delivery/create` 2352 | - Create `recipient` within `options` field 2353 | - Move `communication_methods` from top level to `recipient` 2354 | - Add `first_name` in `recipient` 2355 | 2356 | ### 2020-09-14_1.339.0 2357 | 2358 | - Add `callback_type` to link delivery webhooks 2359 | 2360 | ### 2020-09-14_1.338.2 2361 | 2362 | - Make `communication_methods` optional in `/link_delivery/create` 2363 | 2364 | ### 2020-09-14_1.338.1 2365 | 2366 | - Remove beta description from `/transactions/enrich` endpoint docs 2367 | 2368 | ### 2020-09-14_1.338.0 2369 | 2370 | - Add `transaction_id` to `/payment-initiation/#payment_status_update` 2371 | - Add `payment_id` and `wallet_id` to `/virtual-accounts/#wallet_transaction_status_update` 2372 | 2373 | ### 2020-09-14_1.337.4 2374 | 2375 | - Add `credit_category` to the `/asset_report/get` endpoint 2376 | 2377 | ### 2020-09-14_1.337.3 2378 | 2379 | - Update description for the `address` field in `/payment_initiation/recipient/create`. 2380 | 2381 | ### 2020-09-14_1.337.2 2382 | 2383 | - Add annually recurring frequency to `/transactions/recurring/get` 2384 | 2385 | ### 2020-09-14_1.337.1 2386 | 2387 | - Make documentation for credit categories in the `/asset_report/get` endpoint public 2388 | 2389 | ### 2020-09-14_1.337.0 2390 | 2391 | - Add bank employment results to `/credit/sessions/get` 2392 | 2393 | ### 2020-09-14_1.336.1 2394 | 2395 | - Add `signal` to Products array. 2396 | 2397 | ### 2020-09-14_1.336.0 2398 | 2399 | - Add options to `/credit/payroll_income/refresh` to allow item-level refresh 2400 | 2401 | ### 2020-09-14_1.335.2 2402 | 2403 | - Updated `amount.value` description field with new minimum requirement for `/payment_initiation/payment/reverse` and `/wallet/transaction/execute` 2404 | 2405 | ### 2020-09-14_1.335.1 2406 | 2407 | - Add 'employment' as an available product in the request to `/partner/customer/create` 2408 | 2409 | ### 2020-09-14_1.335.0 2410 | 2411 | - [Breaking] Renamed Identity Verification UserName objects to IdentityVerificationRequestUserName and IdentityVerificationResponseUserName 2412 | 2413 | ### 2020-09-14_1.334.0 2414 | 2415 | - Add "entity_id" field to /transactions/enrich 2416 | 2417 | ### 2020-09-14_1.333.0 2418 | 2419 | - Add "add_ons" field to asset_report/create 2420 | 2421 | ### 2020-09-14_1.332.0 2422 | 2423 | - [Breaking] Remove `/wallet/transaction/list` endpoint 2424 | - [Note] Determined that `/wallet/transaction/list` is unused 2425 | 2426 | ### 2020-09-14_1.331.0 2427 | 2428 | Add `LinkDeliveryCallbackWebhook`, `LinkUserDeliveryStatusWebhook` for Link Delivery. 2429 | 2430 | ### 2020-09-14_1.330.0 2431 | 2432 | - [Breaking] Remove `options.wallet_id` field in `/payment_initiation/payment/create` and `/payment_initiation/consent/create` request. 2433 | - [Note] Determined that this field is unused. 2434 | 2435 | ### 2020-09-14_1.229.2 2436 | 2437 | - Undeprecated the `legal_name` field in the `/link/token/create` request. 2438 | 2439 | ### 2020-09-14_1.229.1 2440 | 2441 | - Add `income_verification` as a supported product in the request for `/partner/customer/create`. 2442 | 2443 | ### 2020-09-14_1.229.0 2444 | 2445 | - Add `network` field to `/transfer/intent/create` request. 2446 | - Updated `reference` minLength for `/wallet/transaction/execute` request and `/payment_initiation/payment/reverse` request. 2447 | 2448 | ### 2020-09-14_1.228.0 2449 | 2450 | - Add `access_tokens` and `item_ids` to `/link_delivery/get` response 2451 | 2452 | ### 2020-09-14_1.227.0 2453 | 2454 | - Add optional `persistent_account_id` field to account responses 2455 | 2456 | ### 2020-09-14_1.226.0 2457 | 2458 | - Add `employment` fields to `/link/token/create` 2459 | 2460 | ### 2020-09-14_1.225.0 2461 | 2462 | - Add `redacted_at` field in Identity Verification response and Documentary Verification Document component 2463 | - Update `original_front` field in Identity Verification Document Images to be nullable in redacted Identity Verification sessions 2464 | 2465 | ### 2020-09-14_1.224.0 2466 | 2467 | - Add `earliest_deposit_date` and change `last_deposit_date` to `latest_deposit_date` for `/beta/credit/v1/bank_employment/get` 2468 | 2469 | ### 2020-09-14_1.223.0 2470 | 2471 | - Add `redirect_uris` to `/partner/customer/create` request. 2472 | 2473 | ### 2020-09-14_1.222.0 2474 | 2475 | - Add `wallet_id` field to `/wallet/transaction/get` and `/wallet/transaction/list` responses 2476 | 2477 | ### 2020-09-14_1.221.0 2478 | 2479 | - Update `link_delivery/get` to remove `public_tokens` from the response 2480 | 2481 | ### 2020-09-14_1.220.0 2482 | 2483 | - Update `link_delivery/create` to accept `communication_methods` and deprecate `delivery_method` and `delivery_destination` 2484 | 2485 | ### 2020-09-14_1.219.1 2486 | 2487 | - Fix the `refund_id` example. 2488 | - Update address objects to reflect that in rare instances, `city` may be `null`. 2489 | 2490 | ### 2020-09-14_1.219.0 2491 | 2492 | - Add partner webhook event type 2493 | 2494 | ### 2020-09-14_1.218.1 2495 | 2496 | - Mark `phone_number_verified_time` and `email_address_verified_time` as deprecated, since it is no longer required to provide these fields to enable to enable the Returning User Experience. 2497 | 2498 | ### 2020-09-14_1.218.1 2499 | 2500 | - Introduce `expected_settlement_date` field in the Transfer object 2501 | 2502 | ### 2020-09-14_1.218.0 2503 | 2504 | - Add `/beta/credit/v1/bank_employment/get` endpoint 2505 | 2506 | ### 2020-09-14_1.217.0 2507 | 2508 | - Add `updated` field to `/credit/audit_copy_token/update` response 2509 | - Add `SchemaVersion` to VOE and VOA schemas for `/credit/freddie_mac/reports/get` 2510 | 2511 | ### 2020-09-14_1.216.0 2512 | 2513 | - Introduce `funding_account_id` field in the Transfer API 2514 | - Remove deprecated `origination_account_id` field from the Transfer documentation 2515 | 2516 | ### 2020-09-14_1.215.2 2517 | 2518 | - Use more strict validation for `payment_id` and `recipient_id` fields in API 2519 | 2520 | ### 2020-09-14_1.215.1 2521 | 2522 | - Use more strict validation for payment `consent_id` field in API 2523 | 2524 | ### 2020-09-14_1.215.0 2525 | 2526 | - Add `status` to Wallet schema 2527 | 2528 | ### 2020-09-14_1.214.0 2529 | 2530 | - Add `/credit/freddie_mac/reports/get` endpoint 2531 | 2532 | ### 2020-09-14_1.213.1 2533 | 2534 | - Reflect that `days_requested` field in Bank Income Verification object in `/link/token/create` request is required when using Bank Income. 2535 | - Reflect that `is_update_mode` field in Bank Income Verification object in `/link/token/create` request defaults to `false`. 2536 | - Update description to reflect that Document Income object in `/link/token/create` request is not required, even when using Document Income. 2537 | 2538 | ### 2020-09-14_1.213.0 2539 | 2540 | - Update `PartnerEndCustomerStatus` enum values. 2541 | 2542 | ### 2020-09-14_1.212.0 2543 | 2544 | - Add `/credit/audit_copy_token/update` endpoint 2545 | - Add `report_type` to AssetReportCreateRequest 2546 | 2547 | ### 2020-09-14_1.211.1 2548 | 2549 | - Fix `US_MBS` list code which was mistakenly documented as `US_MBC` for screening individuals with Monitor 2550 | - Document `TR_CMB` list code for screening individuals with Monitor 2551 | - Document `IZ_WBK` list code for screening individuals and entities with Monitor 2552 | 2553 | ### 2020-09-14_1.211.0 2554 | 2555 | - Add `/partner/customer/oauth_institutions/get` endpoint. 2556 | 2557 | ### 2020-09-14_1.210.8 2558 | 2559 | - Update example response for `/credit/bank_income/get` 2560 | 2561 | ### 2020-09-14_1.210.7 2562 | 2563 | - Documentation updates for Investments APIs and Bank Transfer APIs. 2564 | 2565 | ### 2020-09-14_1.210.6 2566 | 2567 | - Add validation on `originator_client_id` and `redirect_uri` for `/transfer/originator/create` and `transfer/originator/get` request 2568 | 2569 | ### 2020-09-14_1.210.5 2570 | 2571 | - Add `company_name` to TransferOriginatorGetResponse 2572 | 2573 | ### 2020-09-14_1.210.4 2574 | 2575 | - Add `recurring_transfer_id` to Transfer 2576 | 2577 | ### 2020-09-14_1.210.3 2578 | 2579 | - Make `id_numbers` field hidden in `/user/create` request 2580 | 2581 | ### 2020-09-14_1.210.2 2582 | 2583 | - Make `transfer_ids` required in RecurringTransfer 2584 | 2585 | ### 2020-09-14_1.210.1 2586 | 2587 | - Change the `/transactions/enrich` `options.include_legacy_categories` field to `options.include_legacy_category` 2588 | - Make documentation for the `/transactions/enrich` `options.include_legacy_category` request field visible 2589 | - Make documentation for the `/transactions/enrich` `legacy_category` and `legacy_category_id` response fields visible 2590 | - Add `direction` to required fields for `ClientProvidedTransaction` 2591 | 2592 | ### 2020-09-14_1.210.0 2593 | 2594 | - Add `/transfer/capabilities/get` endpoint to fetch RTP eligibility for a linked plaid item 2595 | 2596 | ### 2020-09-14_1.209.2 2597 | 2598 | - Renamed the `NullableRecurringTransfer` type to `RecurringTransferNullable` type 2599 | 2600 | ### 2020-09-14_1.209.1 2601 | 2602 | Add `nullable` property to `date_of_birth`, `phone_number_verified_time`, and `email_address_verified_time` fields within `LinkTokenCreateRequestUser` to resolve undesireable client library behavior in certain languages. 2603 | 2604 | ### 2020-09-14_1.209.0 2605 | 2606 | - add `NullableRecurringTransfer` field 2607 | - replace `RecurringTransfer` with `NullableRecurringTransfer` for `TransferRecurringCreateResponse` 2608 | - and `Decision` in required fields for `TransferRecurringCreateResponse` 2609 | - add required fields for `TransferRecurringSchedule` 2610 | 2611 | ### 2020-09-14_1.208.0 2612 | 2613 | - Add `total_amounts` field to `/credit/bank_income/get` response 2614 | - Deprecate `amount`, `iso_currency_code`, and `unofficial_currency_code` at top levels in `/credit/bank_income/get` response 2615 | 2616 | ### 2020-09-14_1.207.0 2617 | 2618 | - Add `id_numbers` field to `/user/create` request 2619 | 2620 | ### 2020-09-14_1.206.11 2621 | 2622 | - Add `RECURRING_NEW_TRANSFER` webhook event. 2623 | - Add `RECURRING_TRANSFER_SKIPPED` webhook event. 2624 | - Add `RECURRING_CANCELLED` webhook event. 2625 | 2626 | ### 2020-09-14_1.206.10 2627 | 2628 | - make `idempotency_key` field for `/transfer/recurring/create` non-nullable 2629 | 2630 | ### 2020-09-14_1.206.9 2631 | 2632 | - Add `description` field for `RecurringTransfer` object 2633 | - Make `TransferRecurringStatus` non-nullable 2634 | 2635 | ### 2020-09-14_1.206.8 2636 | 2637 | - Make all mentions of relay tokens lowercase 2638 | 2639 | ### 2020-09-14_1.206.7 2640 | 2641 | - Updated external URLs for Credit Relay endpoints, and marked them as beta in the summary 2642 | 2643 | ### 2020-09-14_1.206.6 2644 | 2645 | - Add more enums values to `pay_rate` field in `/credit/payroll_income/get` response 2646 | - Add `pay_basis` field to `/credit/payroll_income/get` 2647 | 2648 | ### 2020-09-14_1.206.5 2649 | 2650 | - Updated Credit Relay Token descriptions 2651 | 2652 | ### 2020-09-14_1.206.4 2653 | 2654 | - Add `FUNDS_SWEEP` as a `type` enum for the `WalletTransaction` object 2655 | 2656 | ### 2020-09-14_1.206.3 2657 | 2658 | - Make `test_clock_id` non-nullable in `test_clock`. 2659 | 2660 | ### 2020-09-14_1.206.2 2661 | 2662 | - Update `CounterpartyType` to rename `delivery_marketplace` to `marketplace` 2663 | - Update `CounterpartyType` to add `payment_terminal` 2664 | 2665 | ### 2020-09-14_1.206.1 2666 | 2667 | - Update the `transactions/enrich` transaction description example to match the request. 2668 | 2669 | ### 2020-09-14_1.206.0 2670 | 2671 | - Add `/sandbox/transfer/test_clock/list` for recurring transfer 2672 | - rm `decision` and `decision_rationale` from `RecurringTransfer` 2673 | - add `decision` and `decision_rationale` in `TransferRecurringCreateResponse` 2674 | - rename `frozen_timestamp` to `virtual_time` 2675 | - not requiring `client_id` and `secret` for recurring transfer APIs 2676 | 2677 | ### 2020-09-14_1.205.9 2678 | 2679 | - Use a nested `options` field for optional request params to `transactions/enrich` 2680 | - Make nullable fields required for `transactions/enrich` 2681 | 2682 | ### 2020-09-14_1.205.8 2683 | 2684 | - Update supported payment scheme options for `/payment_initiation/payment/create` 2685 | – Update description of `/payment_initiation/recipient/create` to mention non-Eurozone countries. 2686 | – Update `/payment_initiation/payment/create` mentioning new currencies and non-Eurozone markets. 2687 | – Removed `CHF` and `CZK` from the list of supported currencies. 2688 | 2689 | ### 2020-09-14_1.205.7 2690 | 2691 | - Add website and logo_url to the `Counterparty` object for the Enrich product. 2692 | - Update descriptions for logo_url field in `Counterparty`, `TransactionCounterparty`, `Enrichments` and `Enhancements`. 2693 | 2694 | ### 2020-09-14_1.205.6 2695 | 2696 | - Update field descriptions and response examples for `transactions/enrich` 2697 | 2698 | ### 2020-09-14_1.205.5 2699 | 2700 | - Add support for optional request parameters in /transactions/enrich 2701 | - Add `location` field to `ClientProvidedTransaction` object 2702 | - Add `mcc` field to `ClientProvidedTransaction` object 2703 | - Add `date_posted` field to `ClientProvidedTransaction` object 2704 | 2705 | ### 2020-09-14_1.205.4 2706 | 2707 | - Document partial refunds 2708 | - Update description for `/payment_initiation/payment/reverse` endpoint 2709 | - Update description for `/payment_initiation/payment/get` endpoint 2710 | 2711 | ### 2020-09-14_1.205.3 2712 | 2713 | - Update description for `/signal/evaluate` endpoint 2714 | 2715 | ### 2020-09-14_1.205.2 2716 | 2717 | - Update response examples, descriptions, and formatting for `/transactions/enrich` endpoint 2718 | 2719 | ### 2020-09-14_1.205.1 2720 | 2721 | - Update descriptions for `CUSIP` and `ISIN` fields in the investments `Security` type to reflect CGS license requirements 2722 | 2723 | ### 2020-09-14_1.205.0 2724 | 2725 | - Add `/transactions/enrich` endpoint, the EA version of `/beta/transactions/v1/enhance`. 2726 | 2727 | ### 2020-09-14_1.204.0 2728 | 2729 | - Remove `/income/verification/refresh` endpoint 2730 | 2731 | ### 2020-09-14_1.203.0 2732 | 2733 | - Add 7 brand new recurring transfer APIs 2734 | - Add `/transfer/recurring/create` 2735 | - Add `/transfer/recurring/list` 2736 | - Add `/transfer/recurring/get` 2737 | - Add `/transfer/recurring/cancel` 2738 | - Add `/sandbox/transfer/test_clock/create` 2739 | - Add `/sandbox/transfer/test_clock/advance` 2740 | - Add `/sandbox/transfer/test_clock/get` 2741 | 2742 | ### 2020-09-14_1.202.6 2743 | 2744 | - IdentityMatchResponse `PhoneNumberMatchScore` and `EmailAddressMatchScore` use `score` instead of `scores` 2745 | 2746 | ### 2020-09-14_1.202.5 2747 | 2748 | - Add `/partner/customer/remove` endpoint 2749 | 2750 | ### 2020-09-14_1.202.4 2751 | 2752 | - Internal changes 2753 | 2754 | ### 2020-09-14_1.202.3 2755 | 2756 | - New Transfer API routes for hosted onboarding of TPS end-customers 2757 | 2758 | ### 2020-09-14_1.202.0 2759 | 2760 | - Add `refunds` field to `Transfer` object 2761 | - Add `refund_id` field to `TransferEvent` object 2762 | - Fix typo for `transfer/get` and `transfer/refund/get` 2763 | 2764 | ### 2020-09-14_1.201.0 2765 | 2766 | - Add support for partial refunds 2767 | - Add `amount` field to `/payment_initiation/payment/reverse` request 2768 | - Add `amount_refunded` field to `/payment_initiation/payment/get` and `/payment_initiation/payment/list` responses 2769 | 2770 | ### 2020-09-14_1.200.0 2771 | 2772 | - Add `risk_summary` and `page_number` to `/beta/credit/payroll_income/risk_signals/get` 2773 | 2774 | ### 2020-09-14_1.199.0 2775 | 2776 | - Renamed `/wallet/transactions/list` into `/wallet/transaction/list` as endpoint 2777 | 2778 | ### 2020-09-14_1.198.8 2779 | 2780 | - `/transfer/authorization/create` and `/transfer/create` may not return `account_id` in response. 2781 | 2782 | ### 2020-09-14_1.198.7 2783 | 2784 | - Add `SYNC_UPDATES_AVAILABLE` support to `/sandbox/item/fire_webhook` 2785 | 2786 | ### 2020-09-14_1.198.6 2787 | 2788 | - Make `ProductStatus` object nullable to reflect Sandbox-specific behavior. 2789 | - Clarify documentation for `SYNC_UPDATES_AVAILABLE` webhook. 2790 | 2791 | ### 2020-09-14_1.198.5 2792 | 2793 | - Internal changes 2794 | 2795 | ### 2020-09-14_1.198.4 2796 | 2797 | - Add `deleted_at` to `/payment_profile/get` response. 2798 | 2799 | ### 2020-09-14_1.198.3 2800 | 2801 | - Change `start_date` to `start_time` for `/wallet/transaction/list` response. 2802 | 2803 | ### 2020-09-14_1.198.2 2804 | 2805 | - Update list of available products for `/partner/customer/create`. 2806 | 2807 | ### 2020-09-14_1.198.1 2808 | 2809 | - Add `institution_name` and `institution_id` fields to `/credit/payroll_income/get` response. 2810 | 2811 | ### 2020-09-14_1.198.0 2812 | 2813 | - Add `options.start_date` and `options.end_date` to `/wallet/transaction/list` endpoint. 2814 | - Add `last_status_update` and `payment_id` field to `WalletTransaction`. 2815 | - Add `transaction_id` field to `PaymentInitiationPayment` 2816 | 2817 | ### 2020-09-14_1.197.6 2818 | 2819 | - Add `originator_client_id` to Transfer API endpoints 2820 | 2821 | ### 2020-09-14_1.197.5 2822 | 2823 | - Deprecate `origination_account_id` from `/transfer/authorization/create` endpoint. 2824 | 2825 | ### 2020-09-14_1.197.4 2826 | 2827 | - Add `asset_under_management` field to `PartnerCustomerCreateRequest`. 2828 | 2829 | ### 2020-09-14_1.197.3 2830 | 2831 | - Update supported `CountryCode`'s in `link/token/create` docs. 2832 | 2833 | ### 2020-09-14_1.197.2 2834 | 2835 | - ach_class optional 2836 | - add rtp network option 2837 | 2838 | ### 2020-09-14_1.197.1 2839 | 2840 | - Add newly supported languages for Link 2841 | 2842 | ### 2020-09-14_1.197.0 2843 | 2844 | - Add `PAYMENT_PROFILE_LOGIN_REQUIRED` to transfer authorization `decision_rationale.code`. 2845 | 2846 | ### 2020-09-14_1.196.3 2847 | 2848 | - Add `institution_name` field to `payroll_income_result` of `/credit/sessions/get` 2849 | 2850 | ### 2020-09-14_1.196.2 2851 | 2852 | - Add requirements for `logo` in `PartnerCustomerCreateRequest`. 2853 | 2854 | ### 2020-09-14_1.196.2 2855 | 2856 | - Deprecate webhook status `VERIFICATION_STATUS_PENDING_APPROVAL` in `income_verification` apis. 2857 | 2858 | ### 2020-09-14_1.196.1 2859 | 2860 | - Add a note in the description of `/transfer/authorization/create` 2861 | 2862 | ### 2020-09-14_1.196.0 2863 | 2864 | - Added endpoint `/sandbox/payment_profile/reset_login` 2865 | 2866 | ### 2020-09-14_1.195.0 2867 | 2868 | - Consolidate usages of `Error` into `PlaidError` 2869 | - Add a `PlaidErrorType` enum 2870 | 2871 | ### 2020-09-14_1.194.2 2872 | 2873 | - Fix typo for `income_verification` in `/sandbox/public_token/create` options 2874 | 2875 | ### 2020-09-14_1.194.1 2876 | 2877 | - Update field descriptions in `/partner/customer/*` responses. 2878 | - Make `PartnerEndCustomerWithSecrets` extend `PartnerEndCustomer`. 2879 | - Fix documentation links in `/partner/customer/*` endpoints. 2880 | 2881 | ### 2020-09-14_1.194.0 2882 | 2883 | - Add `/partner/customer/enable` endpoint 2884 | 2885 | ### 2020-09-14_1.193.0 2886 | 2887 | - Rename `LOGIN_REQUIRED` from transfer authorizations `decision_rationale` to `ITEM_LOGIN_REQUIRED` 2888 | 2889 | ### 2020-09-14_1.192.3 2890 | 2891 | - Add `/fdx/notifications` endpoint. 2892 | 2893 | ### 2020-09-14_1.192.2 2894 | 2895 | - Add `USER_REPORTED_NO_INCOME` to CreditSessionBankIncomeStatus 2896 | 2897 | ### 2020-09-14_1.192.1 2898 | 2899 | - Update description for `payment_profile_token` field 2900 | 2901 | ### 2020-09-14_1.192.0 2902 | 2903 | - Add `income_verfication` field to `/sandbox/public_token/create` 2904 | 2905 | ### 2020-09-14_1.191.1 2906 | 2907 | - Add `document_income_result` field to `credit/sessions/get` 2908 | 2909 | ### 2020-09-14_1.191.0 2910 | 2911 | - Remove `payment_profile_id` from `/payment_profile/*`, `/transfer/authorization/create`, and `/transfer/create` endpoints and replace with `payment_profile_token` 2912 | 2913 | ### 2020-09-14_1.190.0 2914 | 2915 | - Removed auditor_id from /credit/audit_copy/token/create 2916 | 2917 | ### 2020-09-14_1.189.0 2918 | 2919 | - Add length boundary for the `client_user_id` field in `user/create` 2920 | 2921 | ### 2020-09-14_1.188.0 2922 | 2923 | - Add `SchemaVersion` field to Freddie Mac Verification of Assets Schema 2924 | 2925 | ### 2020-09-14_1.187.0 2926 | 2927 | - Add `non-custodial wallet` to account subtypes supported for investments 2928 | - Add `trade` investment transaction subtype as a subtype of `transfer` investment transaction type 2929 | 2930 | ### 2020-09-14_1.186.2 2931 | 2932 | - Add `errors` field to `credit/sessions/get` 2933 | 2934 | ### 2020-09-14_1.186.1 2935 | 2936 | - Add `payroll_income_result` field to `credit/sessions/get` 2937 | 2938 | ### 2020-09-14_1.186.0 2939 | 2940 | - Update `IdentityVerificationRequestUser.date_of_birth` to be required to match the existing behavior of the API. 2941 | 2942 | ### 2020-09-14_1.185.0 2943 | 2944 | - Add support for `USER_INPUT_TIMEOUT` as a value for `force_error` in the sandbox custom user schema. 2945 | 2946 | ### 2020-09-14_1.184.0 2947 | 2948 | - Make `payment_id` not required in `/link/token/create` under the `payment_initiation` field. 2949 | 2950 | ### 2020-09-14_1.183.0 2951 | 2952 | - Add `beacon_session_id` field in req of /transfer/authorization/create endpoint. 2953 | 2954 | ### 2020-09-14_1.182.0 2955 | 2956 | - Add `/link/oauth/correlation_id/exchange` endpoint. 2957 | 2958 | ### 2020-09-14_1.181.1 2959 | 2960 | - Update `report_tokens` in `/credit/relay/create` endpoint request to be a list of strings instead a list of objects 2961 | 2962 | ### 2020-09-14_1.181.0 2963 | 2964 | - Add `credit/sessions/get` endpoint 2965 | 2966 | ### 2020-09-14_1.180.0 2967 | 2968 | - Remove `Date` and `DateNullable` types in identity_verification and monitor endpoints. Replace with `ISO8601Date` and `ISO8601DateNullable` 2969 | instead. 2970 | 2971 | ### 2020-09-14_1.179.0 2972 | 2973 | - Remove `idempotency_key` field from resp of /transfer/authorization/create endpoint. 2974 | 2975 | ### 2020-09-14_1.178.2 2976 | 2977 | - Change `institution_price_as_of` field on the Holdings object to nullable 2978 | 2979 | ### 2020-09-14_1.178.1 2980 | 2981 | - Add `AUTHORISING` wallet transaction status 2982 | 2983 | ### 2020-09-14_1.178.0 2984 | 2985 | - Add `/partner/customer/get` endpoint. 2986 | - Add `status` to the response for `/partner/customer/create`. 2987 | 2988 | ### 2020-09-14_1.177.4 2989 | 2990 | - Add `settled` as a valid event type for `/sandbox/transfer/simulate` 2991 | 2992 | ### 2020-09-14_1.177.3 2993 | 2994 | - Replace `ASSET_TRANSACTION_DESCRIPTION` with `ASSET_TRANSACTION_DESCRIPTON` in Freddie Mac 2995 | Asset Report 2996 | 2997 | ### 2020-09-14_1.177.2 2998 | 2999 | - Add `ownership_type` to Asset Report account object, to reflect actual API behavior. 3000 | - Update and clarify docs, including update to reflect new Transfers cutoff times. 3001 | 3002 | ### 2020-09-14_1.177.1 3003 | 3004 | - Add `settled` as a possible Transfer status and `swept_settled` as a possible Transfer sweep status 3005 | - Add `settled` and `swept_settled` as new Transfer event types 3006 | - Add `settled` field to Transfer sweep object 3007 | - Add `standard_return_window` and `unauthorized_return_window` fields to Transfer object 3008 | 3009 | ### 2020-09-14_1.177.0 3010 | 3011 | - Add `options` and `days_to_included` to `AssetReportGetRequest` 3012 | 3013 | ### 2020-09-14_1.176.2 3014 | 3015 | - Add `recipient_id` field examples to the `/wallet/create`, `/wallet/get`, and `/wallet/list` responses 3016 | 3017 | ### 2020-09-14_1.176.1 3018 | 3019 | - Set `employment_report_token` field in the `/credit/employment/get` endpoint to be not required 3020 | 3021 | ### 2020-09-14_1.176.0 3022 | 3023 | - Add `mask` to the `meta` field of overridden accounts in the sandbox custom user configuration object schema. 3024 | 3025 | ### 2020-09-14_1.175.0 3026 | 3027 | - Remove `MiddleName` and add `VALIDATION_SOURCES` to Freddie Mac Asset Report 3028 | 3029 | ### 2020-09-14_1.174.1 3030 | 3031 | - Add `adyen` as processor partner 3032 | 3033 | ### 2020-09-14_1.174.0 3034 | 3035 | - Add `environment` as an attribute to all webhook payloads 3036 | 3037 | ### 2020-09-14_1.173.0 3038 | 3039 | - Add `idempotency_key` field in req/resp of /transfer/authorization/create endpoint. 3040 | 3041 | ### 2020-09-14_1.172.1 3042 | 3043 | - Removed `/asset_report/relay/` endpoints 3044 | 3045 | ### 2020-09-14_1.172.0 3046 | 3047 | - Add payroll institution to /credit/income/precheck endpoint. 3048 | 3049 | ### 2020-09-14_1.171.0 3050 | 3051 | - Add `recipient_id` to the `/wallet/create`, `/wallet/get`, and `/wallet/list` responses 3052 | 3053 | ### 2020-09-14_1.170.1 3054 | 3055 | - Fix that `client_id` and `secret` were erroneously marked as `required` for the request bodies of some endpoints. (These fields can be sent in the header and thus are not required in bodies). 3056 | 3057 | ### 2020-09-14_1.170.0 3058 | 3059 | - Add `with_guarantee` field in request of `/transfer/authorization/create` 3060 | 3061 | ### 2020-09-14_1.169.0 3062 | 3063 | - Add `issuing_region` as a field in the extracted data to documentary verification documents `/identity_verification/create`, `/identity_verification/get`, `/identity_verification/list` and `/identity_verification/retry` responses. 3064 | 3065 | ### 2020-09-14_1.168.2 3066 | 3067 | - Add `bacs`/`iban` recommendation for `/payment_initiation/recipient/create` 3068 | 3069 | ### 2020-09-14_1.168.1 3070 | 3071 | - Update descriptions for `/payment_profile/create`, `/payment_profile/get` and `/payment_profile/remove` 3072 | 3073 | ### 2020-09-14_1.168.0 3074 | 3075 | -- Add `counterparties` to `/beta/transactions/v1/enhance` response 3076 | 3077 | ### 2020-09-14_1.167.1 3078 | 3079 | - Added `MICRODEPOSIT_ERROR` which was returned by the API but missing from the error type enum. 3080 | - Various fixes to typos and descriptions 3081 | 3082 | ### 2020-09-14_1.167.0 3083 | 3084 | - Add authorization code `MIGRATED_ACCOUNT_ITEM` for Items created via `/transfer/migrate_account` endpoint 3085 | 3086 | ### 2020-09-14_1.166.0 3087 | 3088 | - Add `updated_at` field to Payroll Item entries in `/credit/payroll_income/get` 3089 | 3090 | ### 2020-09-14_1.165.3 3091 | 3092 | - removed LoanRoleType, ReportIdentifierType, and ReportDateTime fields from `/credit/asset_report/freddie_mac/get` 3093 | 3094 | ### 2020-09-14_1.165.2 3095 | 3096 | - Remove deprecated reverse_swept enum value from documentation 3097 | 3098 | ### 2020-09-14_1.165.1 3099 | 3100 | - Update example response for the `wallet/list` endpoint 3101 | 3102 | ### 2020-09-14_1.165.0 3103 | 3104 | - Add details for `IdentityMatchResponse` for `/identity/match` endpoint 3105 | 3106 | ### 2020-09-14_1.164.10 3107 | 3108 | - Update descriptions for `HOLDINGS: DEFAULT_UPDATE` and `INVESTMENT_TRANSACTIONS: DEFAULT_UPDATE` webhooks 3109 | 3110 | ### 2020-09-14_1.164.9 3111 | 3112 | - Removed report_type from the request to `/credit/asset_report/freddie_mae/get` 3113 | 3114 | ### 2020-09-14_1.164.8 3115 | 3116 | - Add documentation for credit categories in the `/asset_report/get` endpoint 3117 | 3118 | ### 2020-09-14_1.164.7 3119 | 3120 | - Remove redundant parameters from the `/transfer/create` endpoint from docs and mark them as deprecated 3121 | 3122 | ### 2020-09-14_1.164.6 3123 | 3124 | - Add the following new currencies for the `/payment_initiation` API route group: PLN, SEK, DKK, NOK, CHF, CZK 3125 | 3126 | ### 2020-09-14_1.164.5 3127 | 3128 | - Update description for `/payment_initiation/payment/reverse` to indicate that this endpoint only works with virtual accounts 3129 | - Update description for `/wallet/transaction/execute` to indicate that settlement will take seconds to days 3130 | 3131 | ### 2020-09-14_1.164.4 3132 | 3133 | - Remove verification fields from `/credit/payroll_income/get` and `/income/verification/paystubs/get` 3134 | 3135 | ### 2020-09-14_1.164.3 3136 | 3137 | - Remove pull_id field from `/credit/payroll_income/get` 3138 | 3139 | ### 2020-09-14_1.164.2 3140 | 3141 | - Update external documentation links for the `/wallet/` API route group 3142 | - Update `/payment_initiation/payment/reverse` description to cover which payments are eligible for refunds 3143 | - Update `/payment_initiation/payment/create` reference field description to indicate that references should be unique and will be adjusted automatically 3144 | - Update `PaymentInitiationPaymentStatus` description to indicate that payments may take seconds to days to settle depending on the payment rail used 3145 | - Update `WalletTransactionStatus` description to indicate that transactions may take seconds to days to settle depending on the payment rail used 3146 | 3147 | ### 2020-09-14_1.164.1 3148 | 3149 | - Make `is_savings_or_money_market_account` field in `SignalEvaluateCoreAttributes` nullable 3150 | 3151 | ### 2020-09-14_1.164.0 3152 | 3153 | - Add new endpoint `/credit/asset_report/freddie_mac` 3154 | 3155 | ### 2020-09-14_1.163.0 3156 | 3157 | - Add `/link_delivery/create` endpoint 3158 | - Add `/link_delivery/get` endpoint 3159 | 3160 | ### 2020-09-14_1.162.2 3161 | 3162 | - Fix minimum and maximum values in `/signal/evaluate` scores 3163 | 3164 | ### 2020-09-14_1.162.1 3165 | 3166 | - Make holdings `institution_price_as_of` non-nullable 3167 | 3168 | ### 2020-09-14_1.162.0 3169 | 3170 | - Add `WalletTransactionStatusUpdateWebhook` object 3171 | - Update `WalletTransactionStatus` to include an additional `SETTLED` enum 3172 | - Update `PaymentInitiationPaymentStatus` to include an additional `PAYMENT_STATUS_SETTLED` enum 3173 | 3174 | ### 2020-09-14_1.161.5 3175 | 3176 | - Reverts the changes made in 2020-09-14_1.157.0 3177 | 3178 | ### 2020-09-14_1.161.4 3179 | 3180 | - Update description for webhook `USER_PERMISSION_REVOKED` 3181 | 3182 | ### 2020-09-14_1.161.3 3183 | 3184 | - Bug fix: Put quotes around the '529' account type to prevent generated client libraries from treating it as an integer. 3185 | - Add `RECURRING_TRANSACTIONS_UPDATE` to description of sandbox webhook testing endpoint 3186 | 3187 | ### 2020-09-14_1.161.2 3188 | 3189 | - Change the Item schema to refer to `PlaidError` rather than `Error` to avoid namespace conflicts in client libraries. 3190 | 3191 | ### 2020-09-14_1.161.1 3192 | 3193 | - Add required fields back to AssetReport schema 3194 | 3195 | ### 2020-09-14_1.161.0 3196 | 3197 | - Remove `access_token` request parameter from `/beta/partner/v1/customers/create` 3198 | 3199 | ### 2020-09-14_1.160.0 3200 | 3201 | - Add `user` fields to the `/link/token/create` `user` object. 3202 | 3203 | ### 2020-09-14_1.159.0 3204 | 3205 | - Add `RECURRING_TRANSACTIONS_UPDATE` webhook specification 3206 | - Fix typo in `/sandbox/item/fire_webhook` description 3207 | 3208 | ### 2020-09-14_1.158.1 3209 | 3210 | - Add x-plaid-validation for Credit Relay Tokens 3211 | 3212 | ### 2020-09-14_1.158.0 3213 | 3214 | - Add `address` and `id_number` fields to the `/link/token/create` `user` object. 3215 | 3216 | ### 2020-09-14_1.157.0 3217 | 3218 | - Update and add schemas referred by `AssetReportGetResponse` 3219 | 3220 | ### 2020-09-14_1.156.0 3221 | 3222 | - Add `payment_profile_id` to `/transfer/authorization/create` and `/transfer/create` 3223 | - Make `access_token` and `account_id` optional in `/transfer/authorization/create` and `/transfer/create` 3224 | 3225 | ### 2020-09-14_1.155.0 3226 | 3227 | - Add `payment_profile_id` as a field under `transfer` for `/link/token/create` 3228 | 3229 | ### 2020-09-14_1.154.0 3230 | 3231 | - Create `/credit/bank_income/pdf/get` to allow customers to retrieve the bank income product as a PDF 3232 | 3233 | ### 2020-09-14_1.153.1 3234 | 3235 | -- Add `personal_finance_category_icon_url` to `/beta/transactions/v1/enhance` response 3236 | 3237 | ### 2020-09-14_1.153.0 3238 | 3239 | -- Add new endpoint `/beta/partner/v1/customers/create` 3240 | 3241 | ### 2020-09-14_1.152.0 3242 | 3243 | - Add `form1099s` as part of the `credit/payroll_income/get` response. 3244 | - Add `Credit1099` object and corresponding subtypes. 3245 | 3246 | ### 2020-09-14_1.151.1 3247 | 3248 | - Update required fields list for guaranteed ACH customers 3249 | 3250 | ### 2020-09-14_1.151.0 3251 | 3252 | - Mark `verification` field under `paystubs` object in `/credit/payroll_income/get` as deprecated 3253 | 3254 | ### 2020-09-14_1.150.0 3255 | 3256 | - Make `user_present` under `/transfer/authorization/create` nullable 3257 | 3258 | ### 2020-09-14_1.149.1 3259 | 3260 | - Update fields description for guaranteed ACH customers 3261 | 3262 | ### 2020-09-14_1.149.0 3263 | 3264 | - Add `gave_consent` as a field under `identity_verification` for `/link/token/create` 3265 | - Remove `identity_verification.consent`, which is deprecated, from documentation for `/link/token/create` 3266 | 3267 | ### 2020-09-14_1.148.0 3268 | 3269 | - Add `user_present` a an optional field under `/transfer/authorization/create`, update fields description for guaranteed ACH customers 3270 | 3271 | ### 2020-09-14_1.147.1 3272 | 3273 | - Remove deprecated `reversed` status from Transfer schema 3274 | - Remove deprecated `reverse_swept` status from Transfer Event schema 3275 | 3276 | ### 2020-09-14_1.147.0 3277 | 3278 | - Add new endpoints `/credit/relay/get`, `/credit/relay/refresh` and `/credit/relay/remove` 3279 | 3280 | ### 2020-09-14_1.146.0 3281 | 3282 | - make item_logins field not required 3283 | 3284 | ### 2020-09-14_1.145.0 3285 | 3286 | - Make changes to IdentityMatchRequest to support options data 3287 | 3288 | ### 2020-09-14_1.144.0 3289 | 3290 | - Remove unsupported error_code (`PRODUCTS_NOT_SUPPORTED`) for the `force_error` config in Sandbox 3291 | 3292 | ### 2020-09-14_1.143.0 3293 | 3294 | - Make changes to support crypto in Investments product 3295 | 3296 | ### 2020-09-14_1.142.0 3297 | 3298 | - Add new endpoints `/payment_profile/get` and `/payment_profile/remove` 3299 | 3300 | ### 2020-09-14_1.141.1 3301 | 3302 | - Bug fix: add `identity_verification` to `Products` array 3303 | 3304 | ### 2020-09-14_1.141.0 3305 | 3306 | - Add a new endpoint `/payment_profile/create` 3307 | 3308 | ### 2020-09-14_1.140.1 3309 | 3310 | - Add `stated_income_sources` as a field under `income_verification` for `/link/token/create` 3311 | 3312 | ### 2020-09-14_1.140.0 3313 | 3314 | - Add `bin` as a field under `institution_metadata` for `/link/token/create` 3315 | 3316 | ### 2020-09-14_1.139.0 3317 | 3318 | - Add `international` IBAN numbers to `WalletNumbers` field in `/wallet/get` and `/wallet/list` responses. 3319 | - Wrap the `iban` field in the `WalletTransactionCounterpartyNumbers` under new field `international`. 3320 | 3321 | ### 2020-09-14_1.138.0 3322 | 3323 | - Add new `identity/match` endpoint, and `IdentityMatchRequest` and `IdentityMatchResponse` 3324 | 3325 | ### 2020-09-14_1.137.1 3326 | 3327 | - Update comment for the `recipient.name` field with recommendation to avoid long strings and special characters. 3328 | 3329 | ### 2020-09-14_1.137.0 3330 | 3331 | - Reverts the changes made in 2020-09-14_1.135.0. ProductAccess and AccountProductAccess once again have all fields explicitly defined. 3332 | 3333 | ### 2020-09-14_1.136.0 3334 | 3335 | - Add `products` in `asset_report/create` endpoint. 3336 | 3337 | ### 2020-09-14_1.135.0 3338 | 3339 | - Convert ProductAccess and AccountProductAccess to optional.Map 3340 | 3341 | ### 2020-09-14_1.134.0 3342 | 3343 | - Rename `merchant_website` and `merchant_logo_url` in `/beta/transactions/v1/enhance` to `website` and `logo_url` 3344 | 3345 | ### 2020-09-14_1.133.0 3346 | 3347 | - Update `/credit/payroll_income/get` response to have a `pull_id` instead of an `income_report_token` and add `pull_id` to `/credit/employment/get` response 3348 | 3349 | ### 2020-09-14_1.132.1 3350 | 3351 | - Made several fields nullable for `/signal/evaluate` 3352 | 3353 | ### 2020-09-14_1.132.0 3354 | 3355 | - Add `/credit/audit_copy_token/remove` to invalidate Audit Copy tokens 3356 | 3357 | ### 2020-09-14_1.131.3 3358 | 3359 | - Update external URL for `/transfer/migrate_account` endpoint 3360 | 3361 | ### 2020-09-14_1.131.2 3362 | 3363 | - Add `TRANSFER_LIMIT_REACHED` to enum `TransferAuthorizationDecisionRationaleCode` 3364 | 3365 | ### 2020-09-14_1.131.1 3366 | 3367 | - Update `/payment_initiation/consent/*` external docs URLs 3368 | 3369 | ### 2020-09-14_1.131.0 3370 | 3371 | - Add `iban` to `counterparty`'s `numbers` field in `/wallet/transaction/execute` 3372 | 3373 | ### 2020-09-14_1.130.0 3374 | 3375 | - Update description of `/user/create` to make it more clear what would happen when a client calls the user creation endpoint with the same client_user_id multiple times. 3376 | 3377 | ### 2020-09-14_1.129.0 3378 | 3379 | - Add `signal_description` for each risk signal in `/beta/credit/payroll_income/risk_signals/get` 3380 | - Change `DocumentRiskSignalInstitutionMetadata` to be nullable 3381 | 3382 | ### 2020-09-14_1.128.6 3383 | 3384 | - Fix category rules formatting 3385 | 3386 | ### 2020-09-14_1.128.5 3387 | 3388 | - Change description in `UserCustomPassword` to reflect that only top level fields are optional not all fields 3389 | 3390 | ### 2020-09-14_1.128.4 3391 | 3392 | - Move Category Rules description to `include_personal_finance_category` flag 3393 | 3394 | ### 2020-09-14_1.128.4 3395 | 3396 | - Add `identity_verification` as a new optional parameter for `/link/token/create` 3397 | 3398 | ### 2020-09-14_1.128.3 3399 | 3400 | - Add category rules beta to `personal_finance_category` field description 3401 | in `/transactions/get` 3402 | 3403 | ### 2020-09-14_1.128.2 3404 | 3405 | - Update description of `/investments/transactions/get` endpoint 3406 | - Update description of `cost_basis` field 3407 | 3408 | ### 2020-09-14_1.128.1 3409 | 3410 | - Add `merchant_website` and `merchant_logo_url` to `/beta/transactions/v1/enhance` response 3411 | 3412 | ### 2020-09-14_1.128.0 3413 | 3414 | - Add `auth_type_select_enabled`, `automated_microdeposits_enabled`, `instant_match_enabled`, and `same_day_microdeposits_enabled` to `/link/token/create` 3415 | - Marked `flow_type` parameter as deprecated 3416 | 3417 | ### 2020-09-14_1.127.0 3418 | 3419 | - Add `consent_id` filter to `/payment_initiation/payment/list` 3420 | - Add `consent_id` to `/link/token/create` 3421 | 3422 | ### 2020-09-14_1.126.0 3423 | 3424 | - Added `/credit/relay/create` endpoint 3425 | 3426 | ### 2020-09-14_1.125.0 3427 | 3428 | - Add `accounts` object to `/credit/payroll_income/get` response 3429 | 3430 | ### 2020-09-14_1.124.0 3431 | 3432 | - Added `include_fast_report` in `asset_report/create` endpoint. Added `fast_report` in `asset_report/get` endpoint 3433 | 3434 | ### 2020-09-14_1.123.1 3435 | 3436 | - Removed `reversed` and `reverse_swept` from possible event_type values in TransferEventListRequest docs 3437 | 3438 | ### 2020-09-14_1.123.0 3439 | 3440 | - Change `tokens` to `report_tokens` in `/credit/audit_copy_token/create` request 3441 | 3442 | ### 2020-09-14_1.122.0 3443 | 3444 | - Add `request_id` to all Identity Verification and Monitor responses 3445 | 3446 | ### 2020-09-14_1.121.2 3447 | 3448 | - Added sample user_id to INCOME_VERIFICATION webhook 3449 | 3450 | ### 2020-09-14_1.121.1 3451 | 3452 | - Pre-release API refinements to Monitor and Flow endpoints 3453 | 3454 | ### 2020-09-14_1.121.0 3455 | 3456 | - Add TimestampNullable type 3457 | 3458 | ### 2020-09-14_1.120.0 3459 | 3460 | - Removed `Uploaded`, `Created` and `APPROVAL_STATUS_APPROVED` enum strings from `PayrollItemStatus` field. 3461 | 3462 | ### 2020-09-14_1.119.0 3463 | 3464 | - Add `returned` to TransferStatus enum 3465 | - Add `return_swept` to TransferSweepStatus enum 3466 | - Add `returned` and `return_swept` to TransferEventType enum 3467 | 3468 | ### 2020-09-14_1.118.0 3469 | 3470 | - Added `employee_type` and `last_paystub_date` to `/credit/employment/get` response 3471 | 3472 | ### 2020-09-14_1.117.1 3473 | 3474 | - Make `/payment_initiation/consent/create` API more strict 3475 | 3476 | ### 2020-09-14_1.117.0 3477 | 3478 | - Add `/credit/audit_copy_token/create` endpoint 3479 | 3480 | ### 2020-09-14_1.116.0 3481 | 3482 | - Add `/wallet/list` endpoint 3483 | 3484 | ### 2020-09-14_1.115.2 3485 | 3486 | - Update description fields to fix formatting errors 3487 | - Reflect that `error.suggested_action` is `nullable` 3488 | 3489 | ### 2020-09-14_1.115.1 3490 | 3491 | - Update OpenAPI spec 3492 | 3493 | ### 2020-09-14_1.115.0 3494 | 3495 | - Added `income_report_token` to `/credit/payroll_income/get` response 3496 | 3497 | ### 2020-09-14_1.114.2 3498 | 3499 | - Add `/wallet/create` endpoint 3500 | 3501 | ### 2020-09-14_1.114.1 3502 | 3503 | - Add beta `additional_consented_products` field to `/link/token/create` 3504 | 3505 | ### 2020-09-14_1.113.1 3506 | 3507 | - Updated `/transactions/recurring/get` description 3508 | 3509 | ### 2020-09-14_1.113.0 3510 | 3511 | - Add webhooks for new Monitor and Identity Verification products 3512 | 3513 | ### 2020-09-14_1.112.0 3514 | 3515 | - Add endpoints for new Monitor and Identity Verification products 3516 | 3517 | ### 2020-09-14_1.111.15 3518 | 3519 | - Remove `emi_recipient_id` from Payment Initiation Recipient 3520 | 3521 | ### 2020-09-14_1.111.14 3522 | 3523 | - Add optional `iban` and `bacs` fields to `options` in the `/payment_initiation/consent/create` request 3524 | 3525 | ### 2020-09-14_1.111.13 3526 | 3527 | - Updated `/transactions/sync` description 3528 | 3529 | ### 2020-09-14_1.111.12 3530 | 3531 | - Add more accurate enum documentations to `/transactions/recurring/get` API doc 3532 | 3533 | ### 2020-09-14_1.111.11 3534 | 3535 | - Additional documentation for `/transactions/sync` 3536 | 3537 | ### 2020-09-14_1.111.9 3538 | 3539 | - Remove deprecated field `createdAt` from `/application/get` response 3540 | 3541 | ### 2020-09-14_1.111.8 3542 | 3543 | - Add field validation to `BankTransferDirection` 3544 | 3545 | ### 2020-09-14_1.111.7 3546 | 3547 | - Remove deprecated field `createdAt` from `/application/get` response 3548 | 3549 | ### 2020-09-14_1.111.6 3550 | 3551 | - Add external doc link to `transactions/recurring/get` 3552 | 3553 | ### 2020-09-14_1.111.5 3554 | 3555 | - Updating the API doc for Recurring Transactions 3556 | 3557 | ### 2020-09-14_1.111.4 3558 | 3559 | - Add `DisplayName` in `/application/get` response 3560 | 3561 | ### 2020-09-14_1.111.3 3562 | 3563 | - Updated sample responses for all Transfer endpoints 3564 | 3565 | ### 2020-09-14_1.111.2 3566 | 3567 | - Changing `beta/transactions/rules/` routes to `beta/transactions/rules/v1` 3568 | 3569 | ### 2020-09-14_1.111.1 3570 | 3571 | - Fixing `InsitututionMetadata` typo to `InstitutionMetadata` in private `/beta/credit/payroll_income/risk_signals/get`endpoint response 3572 | 3573 | ### 2020-09-14_1.111.0 3574 | 3575 | - Added `require_guarantee`, `guarantee_decision`, and `guarantee_decision_rationale` to `/transfer/intent` in order to support Guarantee when using Transfer UI. 3576 | 3577 | ### 2020-09-14_1.110.2 3578 | 3579 | - Add additional supported `type` enums in `WalletTransaction`. 3580 | 3581 | ### 2020-09-14_1.110.1 3582 | 3583 | - Add Additional History billing information for /asset_report/create. 3584 | 3585 | ### 2020-09-14_1.110.0 3586 | 3587 | - Add `user_id` to income verification webhook payload 3588 | 3589 | ### 2020-09-14_1.109.1 3590 | 3591 | - Make `consent_id` field nullable in `PaymentInitiationPayment`. 3592 | 3593 | ### 2020-09-14_1.109.0 3594 | 3595 | - Replace `initiated_refunds` with `refund_ids` in the `/payment_initiation/payment/get` and `/payment_initiation/payment/list` responses 3596 | 3597 | ### 2020-09-14_1.108.0 3598 | 3599 | - Added `/beta/credit/payroll_income/risk_signals/get` endpoint (currently private) 3600 | 3601 | ### 2020-09-14_1.107.4 3602 | 3603 | - Remove unsupported ACH classes from `bank_transfer/` and `transfer/` endpoints. 3604 | 3605 | ### 2020-09-14_1.107.3 3606 | 3607 | - Add `enable_multiple_items` parameter for bank income. 3608 | 3609 | ### 2020-09-14_1.107.2 3610 | 3611 | - Fix typo in `institution_name` parameter for credit endpoints. 3612 | 3613 | ### 2020-09-14_1.107.0 3614 | 3615 | - Added `reference` and `idempotency_key` fields to the `payment_initiation/payment/reverse` request. 3616 | 3617 | ### 2020-09-14_1.106.0 3618 | 3619 | - Added `is_update_mode` to `income_verification` in the `/link/token/create` body 3620 | 3621 | ### 2020-09-14_1.105.2 3622 | 3623 | - Consolidate item schemas 3624 | 3625 | ### 2020-09-14_1.105.1 3626 | 3627 | - Removed `client_id` and `secret` as required fields from `/transfer/intent/{get,create}` to match actual API behavior. 3628 | 3629 | ### 2020-09-14_1.105.0 3630 | 3631 | - Add `/credit/payroll_income/refresh` endpoint 3632 | 3633 | ### 2020-09-14_1.104.0 3634 | 3635 | - Added `/signal/prepare` 3636 | 3637 | ### 2020-09-14_1.102.0 3638 | 3639 | - Added `/watchlist_screening/individual/list` (currently private) 3640 | - Added `/watchlist_screening/individual/create` (currently private) 3641 | - Added `/watchlist_screening/individual/get` (currently private) 3642 | - Added `/watchlist_screening/individual/update` (currently private) 3643 | - Added `/watchlist_screening/individual/history/list` (currently private) 3644 | - Added `/watchlist_screening/individual/review/list` (currently private) 3645 | - Added `/watchlist_screening/individual/review/create` (currently private) 3646 | - Added `/watchlist_screening/individual/hit/list` (currently private) 3647 | - Added `/watchlist_screening/entity/list` (currently private) 3648 | - Added `/watchlist_screening/entity/create` (currently private) 3649 | - Added `/watchlist_screening/entity/get` (currently private) 3650 | - Added `/watchlist_screening/entity/update` (currently private) 3651 | - Added `/watchlist_screening/entity/history/list` (currently private) 3652 | - Added `/watchlist_screening/entity/hit/list` (currently private) 3653 | - Added `/watchlist_screening/entity/review/list` (currently private) 3654 | - Added `/watchlist_screening/entity/review/create` (currently private) 3655 | - Added `/watchlist_screening/individual/program/list` (currently private) 3656 | - Added `/watchlist_screening/individual/program/get` (currently private) 3657 | - Added `/watchlist_screening/entity/program/list` (currently private) 3658 | - Added `/watchlist_screening/entity/program/get` (currently private) 3659 | - Added `/dashboard_user/list` (currently private) 3660 | - Added `/dashboard_user/get` (currently private) 3661 | - Added `/identity_verification/list` (currently private) 3662 | - Added `/identity_verification/get` (currently private) 3663 | - Added `/identity_verification/retry` (currently private) 3664 | - Modified `/identity_verification/create` (currently private) 3665 | 3666 | ### 2020-09-14_1.101.0 3667 | 3668 | - Add endpoint for `/credit/bank_income/refresh` 3669 | 3670 | ### 2020-09-14_1.100.0 3671 | 3672 | - Add `include_original_description`, `include_personal_finance_category` options to `/transactions/sync` request. 3673 | 3674 | ### 2020-09-14_1.99.0 3675 | 3676 | - API changes for /credit/employment/get 3677 | 3678 | ### 2020-09-14_1.98.1 3679 | 3680 | - Add `gusto` as processor partner 3681 | 3682 | ### 2020-09-14_1.98.0 3683 | 3684 | - Add `user_token` as a request parameter for `/sandbox/public_token/create` 3685 | 3686 | ### 2020-09-14_1.97.1 3687 | 3688 | - Remove `auth`, `transactions_updates`, `investments_updates`, and `identity` as required fields from Item status to match actual API behavior. 3689 | 3690 | ### 2020-09-14_1.97.0 3691 | 3692 | - Rename some `Credit` refs that were preventing client library generation from completing successfully 3693 | 3694 | ### 2020-09-14_1.96.0 3695 | 3696 | - remove unused `payroll_income_id` from `/credit/payroll_income/get` field 3697 | - add status object to items in `/credit/payroll_income/get` response body 3698 | 3699 | ### 2020-09-14_1.95.1 3700 | 3701 | - Add `TransferEventsUpdateWebhook` schema 3702 | 3703 | ### 2020-09-14_1.95.0 3704 | 3705 | - Add `institution_data` parameter to `/link/token/create` 3706 | 3707 | ### 2020-09-14_1.94.2 3708 | 3709 | - Tidy up YAML 3710 | 3711 | ### 2020-09-14_1.94.1 3712 | 3713 | - Add `highnote` processor to `/processor/token/create` 3714 | 3715 | ### 2020-09-14_1.94.0 3716 | 3717 | - Add `use_case`, `company_legal_name`, `city`, `region`, `country_code`, `postal_code` as a required response field of `Application` 3718 | 3719 | ### 2020-09-14_1.93.2 3720 | 3721 | - Remove `income_verification_id` from income webhook example 3722 | - Fix incorrect URL for `/user/create` endpoint 3723 | 3724 | ### 2020-09-14_1.93.1 3725 | 3726 | - Remove deprecated `income_verification_id` from income webhooks 3727 | - Standardize income webhook casing 3728 | 3729 | ### 2020-09-14_1.93.0 3730 | 3731 | - Add several new fields to `/signal/evaluate` response 3732 | - 3733 | 3734 | ### 2020-09-14_1.92.4 3735 | 3736 | - Add `/sandbox/transfer/fire_webhook` endpoint 3737 | 3738 | ### 2020-09-14_1.91.4 3739 | 3740 | - Mark certain Income endpoints as deprecated in favor of the new `/credit/*` endpoints. 3741 | 3742 | ### 2020-09-14_1.91.3 3743 | 3744 | - Add `checkout` processor to `/processor/token/create` 3745 | 3746 | ### 2020-09-14_1.91.2 3747 | 3748 | - Add `webhook_type` parameter to `/sandbox/item/fire_webhook` 3749 | - Support for investments transactions, investments holdings and liabilities `DEFAULT_UPDATE` webhooks 3750 | 3751 | ### 2020-09-14_1.90.2 3752 | 3753 | - Add new warning type to `/credit/bank_income/get` response 3754 | 3755 | ### 2020-09-14_1.90.1 3756 | 3757 | - Add `marqeta` and `solid` as Auth processor partners 3758 | - Fix schema of `cause` parameter for Asset Reports 3759 | - Fix some invalid examples 3760 | 3761 | ### 2020-09-14_1.90.0 3762 | 3763 | - Add `/credit/employment/get` endpoint 3764 | - Add optional `access_tokens` array to `/credit/payroll_income/precheck` request 3765 | 3766 | ### 2020-09-14_1.89.3 3767 | 3768 | - Update description of `/sandbox/item/fire_webhook` 3769 | 3770 | ### 2020-09-14_1.89.2 3771 | 3772 | - Update description of `accounts/get` 3773 | 3774 | ### 2020-09-14_1.89.1 3775 | 3776 | - Added `AUTH_DATA_UPDATE` webhook code as valid input to `/sandbox/item/fire_webhook` 3777 | - Update description for `/sandbox/item/fire_webhook` 3778 | 3779 | ### 2020-09-14_1.89.0 3780 | 3781 | - Add `/transfer/migrate_account` endpoint 3782 | 3783 | ### 2020-09-14_1.88.2 3784 | 3785 | - Fix operationId for `/credit/payroll_income/precheck` 3786 | 3787 | ### 2020-09-14_1.88.1 3788 | 3789 | - Remove deprecated fields from `/item/application/list` 3790 | 3791 | ### 2020-09-14_1.88.0 3792 | 3793 | - Add `wire_routing_number` parameter to `/bank_transfer/migrate_account` 3794 | 3795 | ### 2020-09-14_1.87.1 3796 | 3797 | - Specify minimum length of 1 for `description` on `TransferIntentCreateRequest` 3798 | 3799 | ### 2020-09-14_1.87.0 3800 | 3801 | - Add `consent_id` support in the Institutions Search request 3802 | 3803 | ### 2020-09-14_1.86.1 3804 | 3805 | - Add `apex_clearing` as a processor partner 3806 | 3807 | ### 2020-09-14_1.86.0 3808 | 3809 | - Introduce Credit Payroll Income APIs 3810 | - Introduce Credit Precheck API 3811 | 3812 | ### 2020-09-14_1.85.1 3813 | 3814 | - Add `/identity_verification/create` endpoint, kept private for now 3815 | 3816 | ### 2020-09-14_1.85.0 3817 | 3818 | - Add `status` field to `ConnectedApplication` 3819 | 3820 | ### 2020-09-14_1.84.5 3821 | 3822 | - Added missing `asset_report_id` field to `/asset_report/relay/refresh` 3823 | 3824 | ### 2020-09-14_1.84.4 3825 | 3826 | - Change summary description and url for `/credit/bank_income/get` 3827 | 3828 | ### 2020-09-14_1.84.3 3829 | 3830 | - Slight wording change for `/credit/bank_income/get` response fields 3831 | 3832 | ### 2020-09-14_1.84.3 3833 | 3834 | - Move `user_token` to top level of `link/token/create` request 3835 | 3836 | ### 2020-09-14_1.84.2 3837 | 3838 | - Correct typo in enum value for Investment subtypes (`person` -> `pension`) 3839 | 3840 | ### 2020-09-14_1.84.1 3841 | 3842 | - Fix schema to properly handle personal finance categories in `/transactions/get` 3843 | 3844 | ### 2020-09-14_1.84.0 3845 | 3846 | - Add `user_token` parameter to `link/token/create` 3847 | 3848 | ### 2020-09-14_1.83.1 3849 | 3850 | - Add new fields to `/credit/bank_income/get` response 3851 | 3852 | ### 2020-09-14_1.83.0 3853 | 3854 | - Remove `permitted` decision for `/transfer/authorization/create` 3855 | 3856 | ### 2020-09-14_1.82.0 3857 | 3858 | - Add beta field `consented_products` to `/item/get/` endpoint response 3859 | 3860 | ### 2020-09-14_1.82.0 3861 | 3862 | - Revamp LinkTokenCreate.IncomeVerificationOptions for GA 3863 | 3864 | ### 2020-09-14_1.81.0 3865 | 3866 | - Add `/transaction/rules/create`, `/transaction/rules/list` and `/transaction/rules/remove` endpoints 3867 | 3868 | ### 2020-09-14_1.80.0 3869 | 3870 | - Added `/user/create` endpoint 3871 | 3872 | ### 2020-09-14_1.79.0 3873 | 3874 | - Update to include all changes up to `2020-09-14_1.77.4` (Undo revert from `1.78.x` updates) 3875 | 3876 | ### 2020-09-14_1.78.2 3877 | 3878 | - Revert to `2020-09-14_1.64.13` 3879 | 3880 | ### 2020-09-14_1.78.1 3881 | 3882 | - Revert to `2020-09-14_1.62.7` 3883 | 3884 | ### 2020-09-14_1.78.0 3885 | 3886 | - Revert to `2020-09-14_1.64.14` 3887 | 3888 | ### 2020-09-14_1.77.5 3889 | 3890 | - Add support for `IT` country code for use with Payments. 3891 | - More prominently highlight that the Identity response body changed in the 2019-05-29 API version. 3892 | 3893 | ### 2020-09-14_1.77.4 3894 | 3895 | - Remove the word "Asset" before "Relay" in every asset report relay related responses and request objects 3896 | 3897 | ### 2020-09-14_1.77.3 3898 | 3899 | - Add "AssetReport" at the beginning of relay related responses and request objects to match the same pattern as other assets related objects 3900 | 3901 | ### 2020-09-14_1.77.2 3902 | 3903 | - Add `ProductAccess` fields for upcoming partner 3904 | 3905 | ### 2020-09-14_1.77.1 3906 | 3907 | - Fix extraneous field in enum that caused issue in code generation 3908 | - Added `asset_report_id` to the example for `/asset_report/relay/refresh` 3909 | 3910 | ### 2020-09-14_1.77.0 3911 | 3912 | - Explicitly set `format: double` for non-integer numbers so generated fields prefer float64 3913 | 3914 | ### 2020-09-14_1.76.0 3915 | 3916 | - Add three new endpoints for Assets: `/asset_report/relay/create`, `/asset_report/relay/get`, and `/asset_report/relay/rmeove` 3917 | 3918 | ### 2020-09-14_1.75.0 3919 | 3920 | - Added `/asset_report/relay/refresh` endpoint 3921 | 3922 | ### 2020-09-14_1.74.0 3923 | 3924 | - Add `recurring_transactions` to list of products 3925 | 3926 | ### 2020-09-14_1.73.0 3927 | 3928 | - Add new endpoint for `/credit/bank_income/get` 3929 | 3930 | ### 2020-09-14_1.72.0 3931 | 3932 | - Updated documentation URLs for all product endpoints. They can now be found 3933 | at `/docs/api/products//#endpoint` instead of `/docs/api/products/#endpoint` 3934 | 3935 | ### 2020-09-14_1.71.0 3936 | 3937 | - internal changes 3938 | 3939 | ### 2020-09-14_1.70.0 3940 | 3941 | - Remove deprecated `income_verification_id` from `/sandbox/income/fire_webhook` 3942 | 3943 | ### 2020-09-14_1.69.1 3944 | 3945 | - Reorder processors enum 3946 | 3947 | ### 2020-09-14_1.69.0 3948 | 3949 | - Added `/beta/transactions/v1/enhance` endpoint 3950 | 3951 | ### 2020-09-14_1.68.1 3952 | 3953 | - Added `status` object to sample responses for `/institutions/get` and `institutions/search` endpoints 3954 | 3955 | ### 2020-09-14_1.68.0 3956 | 3957 | - Mark `include_personal_finance_category_beta` property as deprecated. 3958 | - Add new argument `include_personal_finance_category` to TransactionsGetRequestOptions. 3959 | - Update docs for `/transactions/get` request and response, referencing personal_finance_category taxonomy csv file. 3960 | 3961 | ### 2020-09-14_1.67.1 3962 | 3963 | - internal changes 3964 | 3965 | ### 2020-09-14_1.67.0 3966 | 3967 | - Removed unused `/income/verification/summary/get` endpoint 3968 | 3969 | ### 2020-09-14_1.66.0 3970 | 3971 | - Added Payment Consent endpoints 3972 | 3973 | ### 2020-09-14_1.65.0 3974 | 3975 | - Removed unused `/income/verification/paystub/get` endpoint 3976 | 3977 | ### 2020-09-14_1.64.15 3978 | 3979 | - De-anonymized enums: 3980 | - `PaymentInitiationPaymentReverseResponse.properties.status` => `PaymentInitiationRefundStatus` 3981 | - `PaymentInitiationPaymentCreateResponse.properties.status` => `PaymentInitiationPaymentCreateStatus` 3982 | - `PaymentInitiationRefund.properties.status` => `PaymentInitiationRefundStatus` 3983 | - `PaymentAmount.properties.currency` => `PaymentAmountCurrency` 3984 | - `InvestmentTransaction.properties.type` => `InvestmentTransactionType` 3985 | - `InvestmentTransaction.properties.subtype` => `InvestmentTransactionSubtype` 3986 | - `TransferAuthorizationDecisionRationale.properties.code` => `TransferAuthorizationDecisionRationaleCode` 3987 | - `TransferAuthorizationGuaranteeDecisionRationale.properties.code` => `TransferAuthorizationGuaranteeDecisionRationaleCode` 3988 | - `TransferAuthorization.properties.decision` => `TransferAuthorizationDecision` 3989 | - `TransferEventListRequest.properties.transfer_type` => `TransferEventListTransferType` 3990 | - `BankTransferEventListRequest.properties.bank_transfer_type` => `BankTransferEventListBankTransferType` 3991 | - `BankTransferEventListRequest.properties.direction` => `BankTransferEventListDirection` 3992 | - `TransferIntentCreate.properties.status` => `TransferIntentStatus` 3993 | - `TransferIntentGet.properties.status` => `TransferIntentStatus` 3994 | - `TransferIntentGet.properties.authorization_decision` => `TransferIntentAuthorizationDecision` 3995 | - `IncomeVerificationPrecheckMilitaryInfo.properties.branch` is now a string field (previously enum) 3996 | 3997 | ### 2020-09-14_1.64.15 3998 | 3999 | - Made `last_statement_balance` and `minimum_payment_amount` `nullable` for credit card liabilities schema to reflect existing API behavior. 4000 | 4001 | ### 2020-09-14_1.64.14 4002 | 4003 | - Made `last_payment_amount` and `last_statement_issue_date` `nullable` for credit card liabilities schema to reflect existing API behavior. 4004 | - Fix transfers examples to reflect more consistent usage of `region` field. 4005 | 4006 | ### 2020-09-14_1.64.13 4007 | 4008 | - Deprecate `idempotency_key` parameter in transfer/create 4009 | 4010 | ### 2020-09-14_1.64.12 4011 | 4012 | - Removed the unused `required_product_access` and `optional_product_access` parameters from `RequestedScopes` 4013 | 4014 | ### 2020-09-14_1.64.11 4015 | 4016 | - Fix some examples that were not consistent with their schemas 4017 | - Add `adjustments` as an investments transaction type to make OpenAPI file consistent with values returned by the API 4018 | - Clarify description field for `marital_status` to reflect possible values 4019 | 4020 | ### 2020-09-14_1.64.10 4021 | 4022 | - Updated the external docs URL for Bank Transfers sandbox endpoints 4023 | 4024 | ### 2020-09-14_1.64.9 4025 | 4026 | - De-anonymized the object filters under `LinkTokenCreateRequestAccountSubtypes`, as anonymous objects aren't compatible with the generated CLibs. 4027 | - De-anonymized some misc. objects 4028 | - `PaymentInitiationMetadata/properties/maximum_payment_amount` 4029 | - `PaystubOverride/properties/employer` 4030 | - `PaystubOverride/properties/employee` 4031 | - `PaystubOverride/properties/employee/properties/address` 4032 | - `LiabilitiesDefaultUpdateWebhook/properties/account_ids_with_updated_liabilities` 4033 | 4034 | ### 2020-09-14_1.64.8 4035 | 4036 | - Updated the description of the historical_balances array 4037 | 4038 | ### 2020-09-14_1.64.7 4039 | 4040 | - Add new possible enums for income verification earnings breakdown canonical description 4041 | 4042 | ### 2020-09-14_1.64.6 4043 | 4044 | - Hid a few product enum values that are deprecated or no longer valid for certain request fields. This affects the documentation only. 4045 | 4046 | ### 2020-09-14_1.64.5 4047 | 4048 | - Make guarantee fields required in Transfer endpoints 4049 | 4050 | ### 2020-09-14_1.64.4 4051 | 4052 | - Updated description for `failure_reason` field in Transfer endpoints 4053 | 4054 | ### 2020-09-14_1.64.3 4055 | 4056 | - Make `repayment_id` required in `/transfer/repayment/return/list` endpoint 4057 | 4058 | ### 2020-09-14_1.64.2 4059 | 4060 | - Update description for legal name field in `BankTransferUser` 4061 | 4062 | ### 2020-09-14_1.64.1 4063 | 4064 | - Update descriptions for `/transfer/repayment/list` and `/transfer/repayment/return/list` endpoints 4065 | 4066 | ### 2020-09-14_1.64.0 4067 | 4068 | - Remove `scheme_automatic_downgrade` from `/payment_initiation/payment/create` 4069 | 4070 | ### 2020-09-14_1.63.1 4071 | 4072 | - Update description for `/sandbox/transfer/sweep/simulate` endpoint 4073 | 4074 | ### 2020-09-14_1.63.0 4075 | 4076 | - Refactor account subtype enums for greater specificity. This has no changes to the API but is a major semver change for Python, Node, Go, and Java client library interfaces to the AccountSubtype object within account filtering contexts in `/link/token/create`. The `AccountSubtype` namespace in this context is now prefixed with the AccountType. (Example for Node: Old: `AccountSubtype.checking` New: `DepositoryAccountSubtype.checking`) 4077 | 4078 | ### 2020-09-14_1.62.7 4079 | 4080 | - Update description for `datetime` and `authorized_datetime` fields in Transactions endpoints 4081 | 4082 | ### 2020-09-14_1.62.6 4083 | 4084 | - Make `sweep_id` / `sweep_amount` fields on Transfer Event nullable 4085 | 4086 | ### 2020-09-14_1.62.6 4087 | 4088 | - Set `institution_status` to be nullable in `InstitutionsGetResponse` 4089 | 4090 | ### 2020-09-14_1.62.5 4091 | 4092 | - Update external docs URLs for Transfer and Bank Transfer endpoints 4093 | - Update description for `ach_return_code` field in Transfer endpoints 4094 | 4095 | ### 2020-09-14_1.62.4 4096 | 4097 | - Add `join_date` to `/application/get` and `/item/application/list` 4098 | - Remove `created_at` from `/application/get` 4099 | 4100 | ### 2020-09-14_1.62.3 4101 | 4102 | - Updated various description fields for Income 4103 | 4104 | ### 2020-09-14_1.62.2 4105 | 4106 | - Add `employment` as an available product in Product array. 4107 | 4108 | ### 2020-09-14_1.62.1 4109 | 4110 | - Add `minItems` and `minLength` validation to various fields in `/institution/*` request schemas 4111 | 4112 | ### 2020-09-14_1.62.0 4113 | 4114 | - Add guarantee_decision and guarantee_decision rationale fields to the transfer API 4115 | - Add repayment-related resources to the transfer API 4116 | 4117 | ### 2020-09-14_1.61.7 4118 | 4119 | - Remove `receiver_pending` and `receiver_posted` from bank transfer event types. 4120 | - Remove `BankTransferReceiverDetails` from bank transfer event types. 4121 | 4122 | ### 2020-09-14_1.61.6 4123 | 4124 | - Update description formatting for `sweep` and `amount` fields for sweep endpoints 4125 | 4126 | ### 2020-09-14_1.61.5 4127 | 4128 | - Added `NEW_ACCOUNTS_AVAILABLE` webhook code as valid input to `/sandbox/item/fire_webhook` 4129 | - Update description for `/sandbox/item/fire_webhook` 4130 | 4131 | ### 2020-09-14_1.61.4 4132 | 4133 | - Set the `minimum` for the `count` and `offset` fields in `InstitutionsGetRequest` 4134 | - Set `products`, `routing_numbers`, and `oauth` fields to be nullable in `InstitutionsGetRequestOptions` 4135 | - Set `products` to be nullable in `InstitutionsSearchRequest` 4136 | - Set `oauth`, `include_auth_metadata`, and `include_payment_initiation_metadata` fields to be nullable in `InstitutionsSearchRequestOptions` 4137 | - Set `payment_id` field to be nullable in `InstitutionsSearchPaymentInitiationOptions` 4138 | 4139 | ### 2020-09-14_1.61.3 4140 | 4141 | - Adds `DOCUMENT_TYPE_NONE` enum value for document metadata 4142 | 4143 | ### 2020-09-14_1.61.2 4144 | 4145 | - Relax length restrictions on the `currency` field in the `Pay` schema 4146 | 4147 | ### 2020-09-14_1.61.1 4148 | 4149 | - Use new payment statuses in `PaymentStatusUpdateWebhook` 4150 | 4151 | ### 2020-09-14_1.61.0 4152 | 4153 | - Added payment scheme support for EU payments 4154 | 4155 | ### 2020-09-14_1.60.7 4156 | 4157 | - Rename `created_at` field on `sweep` object to `created` 4158 | - Rename `start_time` and `end_time` fields on request to `/transfer/sweep/list` to `start_date` and `end_date` 4159 | 4160 | ### 2020-09-14_1.60.6 4161 | 4162 | - Added `iso_currency_code` to `/transfer/authorization/create`, `/transfer/create`, `/transfer/intent/create`, `/transfer/intent/get` and `Transfer` object 4163 | 4164 | ### 2020-09-14_1.60.5 4165 | 4166 | - Set the `routing_number` field in the `Institution` schema to be not nullable 4167 | 4168 | ### 2020-09-14_1.60.4 4169 | 4170 | - Removed Employer Address fields as required for `/income/verification/precheck` endpoint 4171 | 4172 | ### 2020-09-14_1.60.3 4173 | 4174 | - Update response from `/sandbox/transfer/sweep/simulate` to be nullable 4175 | 4176 | ### 2020-09-14_1.60.2 4177 | 4178 | - Added example response for `/income/verification/refresh/` 4179 | 4180 | ### 2020-09-14_1.60.2 4181 | 4182 | - Allowed empty string or nil values for the `webhook` field in the `/item/webhook/update` request 4183 | - Modified the `url` request validator to allow empty strings if the request field with `x-plaid-validation: url` is also nullable 4184 | 4185 | ### 2020-09-14_1.60.1 4186 | 4187 | - Removed `balance` from the `InstitutionStatus` object, as this field is no longer returned. 4188 | 4189 | ### 2020-09-14_1.60.0 4190 | 4191 | - Sets `format: date-time` on the `created` field in the `transfer/authorization/create` response 4192 | 4193 | ### 2020-09-14_1.59.2 4194 | 4195 | - Drop transfer_id from /sweep/list endpoint 4196 | - Amend semantics of simulate sweep endpoint 4197 | 4198 | ### 2020-09-14_1.59.1 4199 | 4200 | - Updated description for `VERIFICATION_STATUS_PROCESSING_COMPLETE` endpoint 4201 | - Deprecated `VERIFICATION_STATUS_DOCUMENT_REJECTED` endpoint 4202 | 4203 | ### 2020-09-14_1.59.0 4204 | 4205 | - Migrated embedded errors to `PlaidError` type 4206 | 4207 | ### 2020-09-14_1.58.4 4208 | 4209 | - Added missing nullable tag for `client_report_id` in `/asset_report/get` response 4210 | - Updated the description for `/accounts/get` 4211 | 4212 | ### 2020-09-14_1.58.3 4213 | 4214 | - Fixed `last_payment_date` to indicate that it is `nullable`. 4215 | - Fixed example enum for paystub `verification_status` 4216 | 4217 | ### 2020-09-14_1.58.2 4218 | 4219 | - Updating example response for `/income/verification/paystubs/get` 4220 | 4221 | ### 2020-09-14_1.58.1 4222 | 4223 | - Fixes duplicate entries in `PaymentInitiationPaymentStatus` 4224 | 4225 | ### 2020-09-14_1.58.0 4226 | 4227 | - Updated schema definitions for `/transfer/intent/create` and `/transfer/intent/get` paths 4228 | 4229 | ### 2020-09-14_1.57.1 4230 | 4231 | - Added `x-plaid-income-enum-lint` property to enums used by income team 4232 | 4233 | ### 2020-09-14_1.57.0 4234 | 4235 | - Added `PAYMENT_STATUS_REJECTED` to the `PaymentInitiationPaymentStatus` enum 4236 | 4237 | ### 2020-09-14_1.56.0 4238 | 4239 | - Added new payment statuses to `PaymentInitiationPaymentStatus` enum 4240 | 4241 | ### 2020-09-14_1.55.1 4242 | 4243 | - Added fields to example response for `/income/verification/precheck` 4244 | 4245 | ### 2020-09-14_1.55.0 4246 | 4247 | - Adds enums to `/income/verification/refresh` response 4248 | 4249 | ### 2020-09-14_1.54.2 4250 | 4251 | - Added `PAYMENT_STATUS_EXECUTED` to the list of allowed `PaymentInitiationPaymentStatus`s, as the API was already returning this. Also created a separate model for the enum instead of defining it inline. 4252 | 4253 | ### 2020-09-14_1.54.1 4254 | 4255 | - Removed `merchant_name` and `check_number` from `TransactionBase`'s required list as they're not actually required. 4256 | 4257 | ### 2020-09-14_1.54.0 4258 | 4259 | - internal changes 4260 | 4261 | ### 2020-09-14_1.53.0 4262 | 4263 | - define `/transfer/sweep/get` & `/transfer/sweep/list` paths 4264 | - update `/transfer/event/list` to accept `sweep_id` 4265 | - new event_types `swept` & `reverse_swept` 4266 | - new sweep_status field on Transfer 4267 | - `sandbox/transfer/sweep/simulate` endpoint to support creating / setting `sweep_status` in sandbox 4268 | 4269 | ### 2020-09-14_1.52.0 4270 | 4271 | - Adds `/wallet/transactions/list` endpoint 4272 | 4273 | ### 2020-09-14_1.51.0 4274 | 4275 | -- Replaces the `emi_account_id` field on Payment Initiation API routes with `wallet_id` 4276 | 4277 | ### 2020-09-14_1.50.0 4278 | 4279 | - Adds `/wallet/transaction/execute` endpoint 4280 | 4281 | ### 2020-09-14_1.49.0 4282 | 4283 | - Adds `/wallet/get` endpoint 4284 | 4285 | ### 2020-09-14_1.48.0 4286 | 4287 | - Adds `transfer` object to the `/link/token/create` request schema 4288 | 4289 | ### 2020-09-14_1.47.2 4290 | 4291 | - Removes the option for `additionalProperties` in `SignalReturnReportRequest` 4292 | - Adds `additionalProperties` to `SignalReturnReportResponse` 4293 | 4294 | ### 2020-09-14_1.47.1 4295 | 4296 | - Adds description updates and bug fix for Income Verification endpoints 4297 | - Adds German as supported language for Link 4298 | 4299 | ### 2020-09-14_1.47.0 4300 | 4301 | - Adds `/transfer/intent/create` and `/transfer/intent/get` endpoints for Transfer UI 4302 | 4303 | ### 2020-09-14_1.46.3 4304 | 4305 | - Fix for `/transactions/sync` response object 4306 | 4307 | ### 2020-09-14_1.46.2 4308 | 4309 | - Adds new options to `VerificationAttributes` enum 4310 | 4311 | ### 2020-09-14_1.46.1 4312 | 4313 | - Removes `confidence` field from `IncomeVerificationPrecheckConfidence`. This was typo introduced in version 1.45.2 4314 | 4315 | ### 2020-09-14_1.46.0 4316 | 4317 | - Adds `merchant_name` and `check_number` to the transaction base and therefore to the asset transaction schema. 4318 | 4319 | ### 2020-09-14_1.45.3 4320 | 4321 | - Changes the type of `sweep_id` from int to UUID string 4322 | 4323 | ### 2020-09-14_1.45.2 4324 | 4325 | - Updated `/income/` enums in responses to not use anonymous objects 4326 | 4327 | ### 2020-09-14_1.45.1 4328 | 4329 | - Add new webhook status `VERIFICATION_STATUS_PENDING_APPROVAL` in `income_verification` apis. 4330 | 4331 | ### 2020-09-14_1.45.0 4332 | 4333 | - Adds product field to item response 4334 | 4335 | ### 2020-09-14_1.44.2 4336 | 4337 | - Marks `/income/verification/create` and `/income/verification/summary/get` as deprecated 4338 | 4339 | ### 2020-09-14_1.44.1 4340 | 4341 | - Updates documentation for the `authorized` field in `/item/application/scopes/update` 4342 | 4343 | ### 2020-09-14_1.44.0 4344 | 4345 | - Add `/transactions/sync` endpoint 4346 | 4347 | ### 2020-09-14_1.43.2 4348 | 4349 | - Removes `income_breakdown` and `ytd_earnings` from required fields in `Paystub` 4350 | 4351 | ### 2020-09-14_1.43.1 4352 | 4353 | - Adds `transactions_access_tokens` to `/income/verification/precheck` to replace singular field. 4354 | 4355 | ### 2020-09-14_1.43.0 4356 | 4357 | - Fix field names on recently created and unused paystub verification fields 4358 | 4359 | ### 2020-09-14_1.42.0 4360 | 4361 | - Docs updates 4362 | - Deprecates `status` enum returned by `/institutions/` endpoints in favor of more granular data returned by the `breakdown` object 4363 | - Adds `DE` as a supported country code to support Payment Initiation 4364 | 4365 | ### 2020-09-14_1.41.3 4366 | 4367 | - Adds `item_id` in `IncomeVerificationStatusWebhook` 4368 | 4369 | ### 2020-09-14_1.41.2 4370 | 4371 | - Adds `account_product_access`, `account_product_access.tax_documents`, `account_product_access.statements`, and `account_product_access.account_data` fields to `AccountAccess` 4372 | 4373 | ### 2020-09-14_1.41.1 4374 | 4375 | - Include `doc_id` in `/income/verification/taxforms/get` 4376 | 4377 | ### 2020-09-14_1.41.0 4378 | 4379 | - Adding minimum and maximum string validation for `client_transaction_id` in `signal/` endpoints 4380 | 4381 | ### 2020-09-14_1.40.3 4382 | 4383 | - Fixing enum naming for verification object in `income/verification/paystubs/get` 4384 | 4385 | ### 2020-09-14_1.40.2 4386 | 4387 | - Fixes typos and updates descriptions 4388 | 4389 | ### 2020-09-14_1.40.1 4390 | 4391 | - Adds `user_present` as an optional field of `/signal/evaluate`. 4392 | - Adds `days_funds_on_hold` as an optional field of `/signal/decision/report`. 4393 | 4394 | ### 2020-09-14_1.40.0 4395 | 4396 | - Updating response body for `income/verification/paystubs/get` to return verification status for each paystub 4397 | 4398 | ### 2020-09-14_1.39.1 4399 | 4400 | - Adds `item_id` to `/sandbox/income/fire_webhook` request 4401 | 4402 | ### 2020-09-14_1.39.0 4403 | 4404 | - Adds `access_tokens` to `/income/verification/create` and `/link/token/create` for income verification. 4405 | 4406 | ### 2020-09-14_1.38.0 4407 | 4408 | - Updates the response body for `/income/verification/paystubs/get` to incorporate new fields that will begin to be populated, and marks old fields as deprecated which will be phased out 4409 | - Adds documentation for `/income/verification/taxforms/get` 4410 | - Adds documentation for `/employment/verification/get` 4411 | 4412 | ### 2020-09-14_1.37.7 4413 | 4414 | - Adds request requirements for `/transactions/recurring/get` 4415 | 4416 | ### 2020-09-14_1.37.6 4417 | 4418 | - Adds `inflow_streams` to required field of `/transactions/recurring/get`. 4419 | 4420 | ### 2020-09-14_1.37.5 4421 | 4422 | - Make default behavior of `include_insights` in `/asset_report/get` request explicit. 4423 | 4424 | ### 2020-09-14_1.37.4 4425 | 4426 | - Adds `url` to `employer` field of `/income/verification/precheck`. 4427 | 4428 | ### 2020-09-14_1.37.3 4429 | 4430 | - Adds `address` to `employer` field of `/income/verification/precheck`. Marks `income_verification_id` deprecated in `/link/token/create` 4431 | 4432 | ### 2020-09-14_1.37.2 4433 | 4434 | - Adds `precheck_id` to `/income/verification/create` and `/link/token/create` for income verification. 4435 | 4436 | ### 2020-09-14_1.37.1 4437 | 4438 | - Adds `document_type` to `/income/verification/paystubs/get` and `/income/verification/taxforms/get` 4439 | 4440 | ### 2020-09-14_1.37.0 4441 | 4442 | - Adding `employment/verification/get` route to the API 4443 | 4444 | ### 2020-09-14_1.36.5 4445 | 4446 | - Adds ability to fetch individual documents from `/income/verification/documents/download` 4447 | 4448 | ### 2020-09-14_1.36.4 4449 | 4450 | - Add additionalProperties to `SignalDecisionReportResponse` 4451 | - Add additionalProperties to `SignalReturnReportResponse` 4452 | - Make the `CoreAttributes` field of the `SignalEvaluateResponse` optional 4453 | 4454 | ### 2020-09-14_1.36.3 4455 | 4456 | - Make the `days_requested` field for `AssetReportRefreshRequest` nullable. 4457 | 4458 | ### 2020-09-14_1.36.2 4459 | 4460 | - Update examples 4461 | 4462 | ### 2020-09-14_1.36.1 4463 | 4464 | - Fixed a bug for `SignalEvaluateRequest` and removed `additionalProperties: true` for it. 4465 | 4466 | ### 2020-09-14_1.36.0 4467 | 4468 | - Add missing `last_statement_balance` liabilities field to OpenAPI file 4469 | 4470 | ### 2020-09-14_1.35.0 4471 | 4472 | - Add support for `BSV` currency 4473 | 4474 | ### 2020-09-14_1.34.2 4475 | 4476 | - Set the maximum `days_requested` to be 731 in the `AssetReportCreateRequest` and `AssetReportRefreshRequest` schemas 4477 | - Set the `client_report_id` and `webhook` fields to be nullable in the `AssetReportCreateRequest` and `AssetReportRefreshRequest` schemas 4478 | 4479 | ### 2020-09-14_1.34.1 4480 | 4481 | - Change "403b" to "403B" in the `InvestmentAccountSubtype` schema 4482 | 4483 | ### 2020-09-14_1.34.0 4484 | 4485 | - Add `/transactions/recurring/get` route to the API 4486 | 4487 | ### 2020-09-14_1.33.0 4488 | 4489 | - Add `update.account_selection_enabled` parameter to `/link/token/create` for Account Select v2 4490 | - Update descriptions for `TRANSACTIONS: INITIAL_UPDATE` AND `TRANSACTIONS: HISTORICAL_UPDATE` for Account Select v2 4491 | - Add `ITEMS: NEW_ACCOUNTS_AVAILABLE` webhook 4492 | 4493 | ### 2020-09-14_1.32.0 4494 | 4495 | - Add Sandbox custom password schema for income verification 4496 | 4497 | ### 2020-09-14_1.31.5 4498 | 4499 | - Update Link token shown in example response for `/link/token/create` 4500 | 4501 | ### 2020-09-14_1.31.4 4502 | 4503 | - Add `transfer` to products list 4504 | 4505 | ### 2020-09-14_1.31.3 4506 | 4507 | - Update description for `/transfer/authorization/create` in sandbox 4508 | 4509 | ### 2020-09-14_1.31.2 4510 | 4511 | - Made more fields on `/income/verification/precheck` optional 4512 | 4513 | ### 2020-09-14_1.31.1 4514 | 4515 | - Add additional enum for `canonical_description` 4516 | 4517 | ### 2020-09-14_1.31.0 4518 | 4519 | - Add `/income/verification/precheck` endpoint 4520 | 4521 | ### 2020-09-14_1.30.3 4522 | 4523 | - Update enum strings for `canonical_description` 4524 | 4525 | ### 2020-09-14_1.30.2 4526 | 4527 | - Added `initiated_refunds` field to `/payment_initiation/payment/get` and `/payment_initiation/payment/list` 4528 | 4529 | ### 2020-09-14_1.30.1 4530 | 4531 | - Add response for `income/verification/paystub/get` 4532 | 4533 | ### 2020-09-14_1.30.0 4534 | 4535 | - Add /bank_transfer/sweep/list endpoint 4536 | 4537 | ### 2020-09-14_1.29.1 4538 | 4539 | - Added description for 'SignalEvaluateRequest' 4540 | - Added description for 'SignalEvaluateResponse' 4541 | - Added description for 'SignalScores' 4542 | - Added description for 'SignalDecisionReportRequest' 4543 | - Added description for 'SignalDecisionReportResponse' 4544 | - Added description for 'SignalReturnReportRequest' 4545 | - Added description for 'SignalReturnReportResponse' 4546 | 4547 | ### 2020-09-14_1.29.0 4548 | 4549 | - Added `include_personal_finance_category_beta` as an optional field to the `TransactionsGetRequestOptions` component 4550 | - Added `personal_finance_category` as a nullable field to the `Transaction` component 4551 | 4552 | ### 2020-09-14_1.28.4 4553 | 4554 | - Remove iso_currency_code from `/transfer/authorization/create` response 4555 | 4556 | ### 2020-09-14_1.28.3 4557 | 4558 | - Remove direction for `/transfer` endpoints 4559 | - Remove receiver*details and receiver*\* event types for `/transfer` endpoints 4560 | - Remove iso_currency_code from `/transfer` endpoints 4561 | - Remove custom_tag from `/transfer` endpoints 4562 | - Remove description for authorization object 4563 | - Make ach_class required for `/transfer/create` 4564 | 4565 | ### 2020-09-14_1.28.2 4566 | 4567 | - Fix misspelled enum for `svb_api` 4568 | - Fix incorrect format string for `date_of_birth` from `date-time` to `date` 4569 | 4570 | ### 2020-09-14_1.28.1 4571 | 4572 | - Updated `balance` fields availability description for `/accounts/balance/get` 4573 | 4574 | ### 2020-09-14_1.28.0 4575 | 4576 | - Add `/payment_initiation/payment/reverse` endpoint 4577 | 4578 | ### 2020-09-14_1.27.0 4579 | 4580 | - Added `include_auth_metadata` field to `InstitutionsGetRequestOptions`, `InstitutionsSearchRequestOptions`, `InstitutionsGetByIdRequestOptions`. 4581 | - Added `auth_metadata` field to `Institution` object, which is included in `InstitutionsGetResponse`, `InstitutionsSearchResponse`, `InstitutionsGetByIdResponse`. 4582 | 4583 | ### 2020-09-14_1.26.2 4584 | 4585 | - Updates documentation for `income/verification/paystubs/get`. 4586 | 4587 | ### 2020-09-14_1.26.1 4588 | 4589 | - Fix bug with request generation for `/income/verification/paystub/get` 4590 | 4591 | ### 2020-09-14_1.26.0 4592 | 4593 | - Add `/bank_transfer/sweep/get` endpoint 4594 | 4595 | ### 2020-09-14_1.25.2 4596 | 4597 | - Fix cursor format for `/payment_initiation/payment/list` 4598 | - Update min/max requirements for `count` in `/payment_initiation/payment/list` 4599 | 4600 | ### 2020-09-14_1.25.1 4601 | 4602 | - Removed `bacs` and `iban` as required fields for certain Payment Initiation models, as only one of the two is required. 4603 | - Added `nullable` to the Income `canonical_description` property. 4604 | - Moved some properties that were next to references, which is invalid. 4605 | - Added `fixed annuity` to `AccountSubtype` model. 4606 | - Added `automatically_verified` to `verification_status` enum. 4607 | 4608 | ### 2020-09-14_1.25.0 4609 | 4610 | - Add schema for `/income/verification/paystub/get`. 4611 | 4612 | ### 2020-09-14_1.24.4 4613 | 4614 | - Added `income/verification/taxforms/get` documentation. 4615 | 4616 | ### 2020-09-14_1.24.3 4617 | 4618 | - Update required and nullable fields for `/transfer/authorization/create`. 4619 | 4620 | ### 2020-09-14_1.24.2 4621 | 4622 | - Added `treasury_prime` processor. 4623 | 4624 | ### 2020-09-14_1.24.1 4625 | 4626 | - Fix description for `/transfer/authorization/create` 4627 | 4628 | ### 2020-09-14_1.24.0 4629 | 4630 | - Changed `investment_transactions` type/subtype hierachy 4631 | 4632 | ### 2020-09-14_1.23.1 4633 | 4634 | - Add missing descriptions to `created_at` and `expired_at` webhook verification fields. 4635 | - Other small description fixes. 4636 | 4637 | ### 2020-09-14_1.23.0 4638 | 4639 | - Add Transfer endpoints 4640 | 4641 | ### 2020-09-14_1.22.1 4642 | 4643 | - Updated `IncomeVerificationPaystubResponse` to an updated schema. 4644 | 4645 | ### 2020-09-14_1.22.0 4646 | 4647 | - Added `holdings` `investment_transactions` as optional to custom sandbox account overrides. 4648 | - Added `holdings` `investment_transactions` and `securities` as optional custom sandbox return values. 4649 | 4650 | ### 2020-09-14_1.21.0 4651 | 4652 | - Add `check_number` field to `/transactions/get` endpoint 4653 | 4654 | ### 2020-09-14_1.20.8 4655 | 4656 | - Added `context` as a required value of `ItemApplicationScopesUpdateRequest`. 4657 | - Added `state` as an optional value of `ItemApplicationScopesUpdateRequest`. 4658 | 4659 | ### 2021-08-04_1.20.7 4660 | 4661 | - Added `min_last_updated_datetime` option to `/processor/balance/get` request. 4662 | 4663 | ### 2020-09-14_1.20.6 4664 | 4665 | - Added `format:` labels to all date and date-time strings 4666 | - Fix missing title attributes 4667 | - Converted some strings to enums 4668 | 4669 | ### 2020-09-14_1.20.5 4670 | 4671 | - Updated `Select Account` to `Account Select` 4672 | 4673 | ### 2020-09-14_1.20.4 4674 | 4675 | - Update Signal risk tier definitions 4676 | 4677 | ### 2020-09-14_1.20.3 4678 | 4679 | - Bug fixes to signal endpoints 4680 | 4681 | ### 2020-09-14_1.20.1 4682 | 4683 | - Added `/sandbox/oauth/select_accounts` endpoint. 4684 | 4685 | ### 2021-07-27_1.20.0 4686 | 4687 | - Added `liabilities_updates`, `liabilities`, and `investments` to institution schema 4688 | 4689 | ### 2020-09-14_1.20.0 4690 | 4691 | - Added `/signal/evaluate` endpoint 4692 | - Added `/signal/decision/report` endpoint 4693 | - Added `/signal/return/report` endpoint 4694 | - Added `/income/verification/refresh` endpoint. 4695 | 4696 | ### 2020-09-14_1.19.12 4697 | 4698 | - Added `alpaca`, `astra` and `moov` processors. 4699 | - Changed naming for some nullable parameters from `NullableParam` to `ParamNullable`. 4700 | - Added `/processor/bank_transfer/create` endpoint. 4701 | - Changed the inherited model for `AssetReportTransaction` from `Transaction` to `TransactionBase` which has fewer required fields. 4702 | 4703 | ### 2020-09-14_1.19.11 4704 | 4705 | - Added `logo_url` as a required value of `ConnectedApplications` 4706 | - Made `logo` a deprecated value of `ConnectedApplications` soon to be removed in future versions 4707 | 4708 | ### 2020-09-14_1.19.10 4709 | 4710 | - Added `income` back to the list of possible products as it's in sandbox return values. 4711 | - Made `switch_method` nullable as the sandbox deposit/switch response has it nulled. 4712 | 4713 | ### 2021-07-1_1.19.9 4714 | 4715 | - Added `CountryCode` to the request fields of `deposit_switch/create` and `deposit_switch/alt/create` 4716 | - Added `TransactionAccessTokens` to `DepositSwitchCreateOptions` 4717 | 4718 | ### 2020-09-14_1.19.8 4719 | 4720 | - Added `options` field to request body for `deposit_switch/create` and `deposit_switch/alt/create` endpoints 4721 | - Added webhook documentation for `deposit_switch/` 4722 | - Added a new state to the list of possible values for the `state` field in the response body, and updated descriptions of all states 4723 | 4724 | ### 2020-09-14_1.19.7 4725 | 4726 | - Added `ItemApplicationListUserAuth` component 4727 | - Added `user_auth` as a private field in `/item/application/list` request 4728 | - Changed `/item/application/list` request `access_token` field from `AccessToken` to `NullableAccessToken` to support `user_auth` flow (`/item/application/list` can be queried using `user_auth` instead of an access token for certain clients) 4729 | 4730 | ### 2020-09-14_1.19.6 4731 | 4732 | - Added the following response fields to the `/deposit_switch/get` docs: 4733 | - `switch_method` 4734 | - `employer_name` 4735 | - `employer_id` 4736 | - `institution_name` 4737 | - `institution_id` 4738 | 4739 | ### 2020-09-14_1.19.5 4740 | 4741 | - Added `required` to many fields where it was missing 4742 | - Removed `nullable: true` annotation incorrectly applied to some fields 4743 | - Added ``nullable: true` annotation incorrectly missing from some fields 4744 | - Fixed invalid example for `/processor/balance/get` 4745 | - Fixed incorrect formatting for certain `allOf` structures 4746 | - Added enum values for some strings that were not treated as enums 4747 | - Added missing `created_at` field to `Application` 4748 | - Added missing `null` enum to some nullable enums 4749 | - Added missing beta `include_original_description` and `original_description` fields to `Transaction` 4750 | - Various small description fixes 4751 | - Updated external docs URLs for Income endpoints 4752 | 4753 | ### 2020-09-14_1.19.4 4754 | 4755 | - Fixed description for `close_price` field returned in `/investments/holdings/get` response 4756 | 4757 | ### 2020-09-14_1.19.3 4758 | 4759 | - Updated the `/institutions/get/` description to explain filtering behavior 4760 | 4761 | ### 2020-09-14_1.19.2 4762 | 4763 | - Added `error` field to `/income/verification/summary/get` response body 4764 | 4765 | ### 2020-09-14_1.19.1 4766 | 4767 | - Fix links to income (beta) docs 4768 | - add income webhook example 4769 | 4770 | ### 2020-09-14_1.19.0 4771 | 4772 | - Added `/sandbox/income/fire_webhook` endpoint 4773 | 4774 | ### 2020-09-14_1.18.2 4775 | 4776 | - Added Lithic and SVB to the list of supported processors for `/processor/token/create` endpoint 4777 | 4778 | ### 2020-09-14_1.18.1 4779 | 4780 | - Fixed file to reflect that `category_id` and `next_payment_due_date` are nullable 4781 | - Removed spurious `paystub_id` field 4782 | - Added missing `SCHEDULED` value to `IncidentUpdate.status` enum 4783 | - Various description fixes 4784 | 4785 | ### 2020-09-14_1.18.0 4786 | 4787 | - Added `/item/application/scopes/update` endpoint 4788 | - Fixed incorrect enum values for `update_type` 4789 | - Fixed file to reflect that `current` balance field is nullable. 4790 | - Description and textual fixes 4791 | - Fix invalid format errors 4792 | - Add new investment subtypes 4793 | 4794 | ### 2020-09-14_1.17.0 4795 | 4796 | - Small description fix for `/income/verification/create` and `/employers/search` 4797 | - Fixed `ytd_net_income` value in `IncomeVerificationSummaryGetResponse` example 4798 | - Fixed references to `paystub` to be plural `paystubs` for `/income/verification/paystubs/get` route and schemas 4799 | - Added `PaystubEmployer` schema referenced in the `Paystub` object 4800 | 4801 | ### 2020-09-14_1.16.6 4802 | 4803 | - Added `ItemApplicationScopesUpdateRequest` and `ItemApplicationScopesUpdateResponse` schema 4804 | 4805 | ### 2020-09-14_1.16.5 4806 | 4807 | - Added `emi_account_id` field to `PaymentInitiationPayment` model for `/payment_initiation/payment/get` and `/payment_initiation/payment/list` response 4808 | - Added `emi_recipient_id` field to `PaymentInitiationRecipient` model for `/payment_initiation/recipient/get` and `/payment_initiation/recipient/list` response 4809 | 4810 | ### 2020-09-14_1.16.4 4811 | 4812 | - Removes erroneous `request_id` that was incorrectly shown to be returned in items from `/payment_initiation/payment/list` and `/payment_initiation/recipient/list`. 4813 | - Fix for `ExternalPaymentSchedule` to make `end_date` optional. 4814 | 4815 | ### 2020-09-14_1.16.3 4816 | 4817 | - Updated `/investments/transactions/get` count minimum to be 1 instead of 0 4818 | 4819 | ### 2020-09-14_1.16.2 4820 | 4821 | - Fixes for required parameters for `JWKPublicKey` and `Security`. 4822 | - Fix for `BankTransferMetadata` to be nullable. 4823 | 4824 | ### 2020-09-14_1.16.1 4825 | 4826 | - Fixes for descriptions and linter errors. 4827 | 4828 | ### 2020-09-14_1.16.0 4829 | 4830 | - Updated `/payment_initiation/payment/create` with ability to pass in iban or account and sort code. If provided, the end user will be able to send payments only from the specified bank account. 4831 | 4832 | ### 2020-09-14_1.15.1 4833 | 4834 | - Add clarifying max character line to client_name description. 4835 | 4836 | ### 2020-09-14_1.15.0 4837 | 4838 | - Removed erroneous `access_token` that was incorrectly shown to be returned by `/item/get`. 4839 | - Added `business` loan type. 4840 | - Clarified `date` format for `institution_price_as_of`. 4841 | - Various small description fixes. 4842 | 4843 | ### 2020-09-14_1.14.0 4844 | 4845 | - Updated `institutions/get`, `institutions/get_by_id`, and `institutions/search` to introduce an optional flag to return Payment Initiation metadata 4846 | - Updated `institutions/search` to accept additional options to filter institutions by various Payment Initiation configurations. 4847 | 4848 | ### 2020-09-14_1.13.3 4849 | 4850 | - Updated `/accounts/balance/get` documentation to show `INVALID_FIELD` and `LAST_UPDATED_DATETIME_OUT_OF_RANGE` errors that will be returned for `capone-oauth` 4851 | 4852 | ### 2020-09-14_1.13.2 4853 | 4854 | - Add specific format attribute to `date_of_birth` under `LinkTokenCreateRequestUser`. 4855 | 4856 | ### 2020-09-14_1.13.1 4857 | 4858 | - Remove `last_statement_balance` since it's never been populated and is being removed in the next version 4859 | - Correct investment transaction sells quantity to be negative 4860 | - Updated documentation to allow `minimum_payment_amount` to be set on loans with type `student`. 4861 | 4862 | ### 2020-09-14_1.13.0 4863 | 4864 | - Added `standing_orders` product type. 4865 | 4866 | ### 2021-09-14_1.12.0 4867 | 4868 | - Added `min_last_updated_datetime` option to `/accounts/balance/get` request. 4869 | - Added `last_updated_datetime` field to `Account` model for `/accounts/balance/get` response. 4870 | 4871 | ### 2020-09-14_1.11.0 4872 | 4873 | - Removed erroneous inclusion of `account_filters` as a parameter to `/institutions/search` 4874 | - Text fixes to descriptions 4875 | - Fixed incorrect field names in some models currently used only for documentation 4876 | 4877 | ### 2020-09-14_1.10.0 4878 | 4879 | - Added `BankTransfersEventsUpdateWebhook` schema 4880 | 4881 | ### 2020-09-14_1.9.0 4882 | 4883 | - Added new `auth` property to `/link/token/create` request to support Flexible Auth (currently in closed beta). 4884 | - Text fixes to descriptions. 4885 | 4886 | ### 2020-09-14_1.8.0 4887 | 4888 | - Added `additionalProperties` to all objects to prevent additive keys from breaking. 4889 | - Added new propery to `Transaction` model, `authorized_datetime`, `datetime`. 4890 | - Update `access_token` to `required` for `TransactionsGet`. 4891 | - Require `origination_account_id` in `BankTransferBalanceGetResponse` 4892 | - Add new endpoint `/sandbox/bank_transfer/fire_webhook` 4893 | 4894 | ### 2020-09-14_1.5.3 4895 | 4896 | - Added new payment processors. 4897 | 4898 | ### 2020-09-14_1.5.0 4899 | 4900 | Initial version 4901 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # plaid-OpenAPI 2 | 3 | Plaid uses the `OpenAPI 3.0.0` specification to schematize our [docs](https://plaid.com/docs) and to generate our supported client libraries. This provides for a consistent typing experience across our external interfaces. Below we have listed some examples and issues we have found when iterating on the specification. 4 | 5 | ## Using the OpenAPI generator 6 | 7 | You can find examples on the official [OpenApiGenerator docs](https://github.com/OpenAPITools/openapi-generator#3---usage). 8 | 9 | ### Generating Plaid supported client libraries 10 | 11 | The following are approximate commands that we use to generate our 5 client libraries: 12 | 13 | #### plaid-node 14 | OpenAPI Generator version: 5.1.1 15 | 16 | ```bash 17 | openapi-generator-cli generate -g typescript-axios \ 18 | -i 2020-09-14.yml \ 19 | -o build/generated-node \ 20 | -p npmName=plaid,supportsES6=true,modelPropertyNaming=original \ 21 | -t local/templates/typescript-axios 22 | ``` 23 | 24 | #### plaid-python 25 | OpenAPI Generator version: 6.1 26 | 27 | ```bash 28 | openapi-generator-cli generate -g python \ 29 | -i 2020-09-14.yml \ 30 | -o build/generated-python \ 31 | -p packageName=plaid \ 32 | --global-property apiTests=false,modelTests=false \ 33 | -t templates/python 34 | ``` 35 | 36 | #### plaid-ruby 37 | OpenAPI Generator version: 6.3 38 | 39 | ```bash 40 | openapi-generator-cli generate -g ruby \ 41 | -i 2020-09-14.yml \ 42 | -o build/generated-ruby \ 43 | --global-property=apiTests=false,modelTests=false,useAutoload=true \ 44 | --library=faraday \ 45 | -p gemName=plaid,gemRequiredRubyVersion=">= 3.0.0" \ 46 | -t local/templates/ruby 47 | 48 | ``` 49 | 50 | #### plaid-java 51 | OpenAPI Generator version: 5.1.1 52 | 53 | ```bash 54 | openapi-generator-cli generate -g java \ 55 | -i 2020-09-14.yml \ 56 | -o build/generated-java \ 57 | --library=retrofit2 \ 58 | --global-property apiDocs=false,modelDocs=false,apiTests=false,modelTests=false \ 59 | -p artifactId=plaid,apiPackage=com.plaid.client.request,modelPackage=com.plaid.client.model,dateLibrary=java8 \ 60 | -t templates/java \ 61 | --type-mappings=BigDecimal=Double 62 | ``` 63 | 64 | #### plaid-go 65 | OpenAPI Generator version: 5.2 66 | 67 | ```bash 68 | openapi-generator-cli -g go \ 69 | -i 2020-09-14.yml \ 70 | -o build/plaid-go \ 71 | --global-property=apiTests=false,modelTests=false,apiDocs=false,modelDocs=false \ 72 | -t templates/go \ 73 | -p packageName=plaid,enumClassPrefix=true, 74 | ``` 75 | 76 | All template edits can be found on their corresponding in the `/templates` folder for the associated library. 77 | 78 | ### Known issues with openapi-generator 79 | 80 | The [openapi-generator](https://github.com/OpenAPITools/openapi-generator) often uses different styles based on the language you are generating. 81 | 82 | - We found that we had to modify our mustache templates to get `servers` and `securitySchemes` working for some generators. If possible, try not to modify these templates as they cause breaking changes upon upgrading, but modifications might be necessary for cases like these. 83 | 84 | - Enums as used by Plaid are extensible; that is, the API may add new enum values at will. However, OpenAPI generator for some languages will enable enum validation by default. You must disable strict enum validation for responses in your generated libraries, or your users may experience crashes when encountering a newly-added enum value in a response. 85 | --------------------------------------------------------------------------------