UNPKG

plaid

Version:

A node.js client for the Plaid API

848 lines (599 loc) 205 kB
See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md). # 45.0.0 - Updating to OAS 2020-09-14_1.708.0 ## OpenAPI Schema Changes ### 2020-09-14_1.708.0 - [Breaking] Preserve arbitrary JSON value types in `/cra/report/get` product `metadata` and `attributes` maps and scalar values in `/cra/credit_profile/report/get` cash flow and network insight attribute maps generated by client libraries. ### 2020-09-14_1.707.1 - Add `increase` to the `processor` enum on `/processor/token/create`, for creating processor tokens for the Increase integration. ### 2020-09-14_1.707.0 - Add hidden `user_id` request fields to `/credit/sessions/get` and `/credit/bank_statements/uploads/get`. # 44.0.0 - Updating to OAS 2020-09-14_1.706.1 ## Breaking changes in this version - [BREAKING] For `/cra/check_report/create`, replace `CraCheckReportCashflowInsightsGetOptions`, `CraCheckReportIncomeInsightsGetOptions`, `CraCheckReportLendScoreGetOptions`, `CraCheckReportNetworkInsightsGetOptions`, and `CraCheckReportVerificationGetEmploymentRefreshOptions` with the corresponding `CraCheckReportCreate*Options` interfaces. The old interfaces remain available for the deprecated `/get` options, and request JSON is unchanged. (OAS 2020-09-14_1.700.0) - [BREAKING] Use `ProductsTerminateReasonCode` for both Item and user product termination; `ItemProductsTerminateReasonCode` and `UserProductsTerminateReasonCode` were removed. Accepted wire values are unchanged. (OAS 2020-09-14_1.701.1) - [BREAKING] Object-literal fixtures for `BankTransferEvent`, `CreditSessionDocumentIncomeResult`, `LinkEventsWebhook`, `PayrollIncomeObject`, or `Security` must now include the required `receiver_details`, `num_i20s_uploaded`, `environment`, `i20s`, or `figi` property, respectively. Ordinary API response consumption is unchanged. (OAS 2020-09-14_1.699.0, 1.699.5, 1.701.0, 1.701.1, and 1.703.0) - [BREAKING] `FDXInitiatorFiAttribute.value` is now a `string` instead of `FDXPartyType`. This schema is not referenced by an endpoint. (OAS 2020-09-14_1.703.0) - [BREAKING] `StudentRepaymentPlanType.InterestOnly` now serializes as `"interest only"` instead of `"interest-only"`, matching the value returned by the API. (OAS 2020-09-14_1.699.1) ## OpenAPI Schema Changes ### 2020-09-14_1.706.1 - Make product `metadata` and `attributes` nullable when unavailable in `/cra/report/get` responses. ### 2020-09-14_1.706.0 - Add the `/transfer/return/recover` endpoint, which lets clients report that they have recovered some or all of the loss on a returned guaranteed transfer. - Add the `guarantee_reimbursed`, `client_return_recovered`, and `plaid_return_recovered` transfer event types, and add a nullable signed `event_amount` field to the transfer event object. ### 2020-09-14_1.705.4 - Mark superseded products, endpoints, and fields as `deprecated`: the Beacon product (`/beacon/*` endpoints and webhooks, plus the `beacon_user_id` field on Identity Verification responses); Bank Transfer (except the `/bank_transfer/event/*` endpoints, still used for Auth micro-deposits); `/employers/search`; the legacy Cash Flow Updates webhooks superseded by `CASH_FLOW_INSIGHTS_UPDATED`; and the `PaymentInitiationConsentScope`, `TransferCreditFundsSource`, and `RiskReason` schemas. - Quote `type: string` certain enum values (Prism version number strings, Freddie Mac "yes/no" API string responses) that YAML parsers were coercing to numbers or booleans. - Expose `/cra/report/get` and its request/response schemas in generated client libraries. The endpoint remains hidden from public documentation. ### 2020-09-14_1.705.3 - Document the `ip_address` field on the `/identity_verification/create` `user` object: accepted only here (not via `/link/token/create`) and captured automatically by the Link SDK, for backend-only integrations that need IP-based risk checks. ### 2020-09-14_1.705.2 - Clarified the `/oauth/token` response `token_type` description (it is `Bearer` for OAuth access tokens); dropped the inaccurate "always Bearer" wording. ### 2020-09-14_1.705.1 - internal changes only ### 2020-09-14_1.705.0 - Type the `product` field of the `CraReportUpdatedWebhook` (`CRA_REPORT`/`CRA_REPORT_UPDATED`) `successful_products`/`failed_products` entries against the `Products` enum instead of a free-form string, matching the sibling `/cra/report/get` product schemas. ### 2020-09-14_1.704.2 - internal changes only ### 2020-09-14_1.704.1 - internal changes only ### 2020-09-14_1.704.0 - internal changes only ### 2020-09-14_1.703.0 - Add the `environment` field to the `LinkEventsWebhook` (`LINK`/`EVENTS`) schema, matching actual behavior. - Change `FDXInitiatorFiAttribute.value` from the `FDXPartyType` enum to a string, matching the sibling `FDXFiAttribute` (this schema is not referenced by any endpoint). - Fixed a `TransactionsRuleDetails.query` description that referenced a nonexistent `NAME` field (the enum value is `MERCHANT_NAME`), and a `/cra/encompass/get_reports` example whose `report_status` was not a valid value and whose `generated_at` key should be `created_at`. - Fixed additional example/consistency issues: `/transactions/get` and `/processor/transactions/get` examples now report the correct `total_transactions`; the Identity Verification `Strategy` note references the `watchlist_screening` step; the `US_SDN` watchlist code label is consistent; `SelfieCapture` examples reflect that only one of `image_url`/`video_url` is populated; the `/institutions/get_by_id` example nests `liabilities` correctly; the `/oauth/token` scope description calls `urn:plaid:params:oauth:user-token` a subject token type; and a `/cra/encompass/load/existing` example was corrected to match its schema. ### 2020-09-14_1.702.4 - Add `hide_gse_details` to `/cra/check_report/verification/pdf/get`. When `true`, the GSE identifiers (the Report ID and `gse_reference_id`) are omitted from the returned Home Lending Report PDF. Defaults to `false`. These identifiers are always present in the `/cra/check_report/verification/get` JSON response regardless of this field. ### 2020-09-14_1.702.3 - Add the `error`, `repairable_items`, and `failed_products` fields to the `CHECK_REPORT_FAILED` and `USER_CHECK_REPORT_FAILED` webhooks. ### 2020-09-14_1.702.2 - Add `tax_lots` to the `/investments/holdings/get` sample response, showing both a holding with per-lot detail and a holding with an empty `tax_lots` array. ### 2020-09-14_1.702.1 - Update descriptions for the CRA `/get` endpoints. ### 2020-09-14_1.702.0 - Add `timestamp` to `/protect/compute` responses to indicate when the Trust Index score and fraud attributes were computed. ### 2020-09-14_1.701.4 - Add `ip_address` (optional, nullable) to the `user` object (`IdentityVerificationCreateRequestUser`) on `/identity_verification/create`. Lets backend-only integrations supply the end user's IP address for IP-based risk checks without launching the Link SDK. ### 2020-09-14_1.701.3 - Add `exclusion_code` to the `CraPartnerInsightsUltraFicoScoreResult` object, exposing the FICO exclusion code that explains why an UltraFICO® score could not be computed due to consumer-data conditions (e.g. insufficient account history). ### 2020-09-14_1.701.2 - Add private-visibility `error`, `repairable_items`, and `failed_products` to the `CHECK_REPORT_FAILED` and `USER_CHECK_REPORT_FAILED` webhooks. ### 2020-09-14_1.701.1 - Add the nullable `receiver_details` field to the `BankTransferEvent` schema returned by `/bank_transfer/event/list` and `/bank_transfer/event/sync`, matching what the API already emits. Currently always `null`. - [Breaking] Change the generated `reason_code` type for `/item/products/terminate` and `/user/products/terminate` from the unusable `ItemProductsTerminateReasonCode` and `UserProductsTerminateReasonCode` wrapper types to `ProductsTerminateReasonCode`. The accepted JSON values are unchanged. - Make `home_lending_report_options` visible in the docs for `/cra/check_report/create` and `/link/token/create`. ### 2020-09-14_1.701.0 - Add `figi` to the `Security` schema: the 12-character OpenFIGI identifier, which stays stable across most corporate actions (ticker/CUSIP/name changes) and is the preferred identifier for tracking a security across its lifecycle. Null until Plaid has enriched the security with FIGI data. ### 2020-09-14_1.700.1 - Add the `/sandbox/fdx/consent/seed` endpoint for seeding a test FDX consent grant on Sandbox data partner accounts. Takes `customer_id` and `application_id` (and an optional `consent_id`) and returns the seeded `consent_id`. ### 2020-09-14_1.700.0 - [Breaking] Rename the `/cra/check_report/create` request options schemas for `cashflow_insights`, `lend_score`, `network_insights`, `income_insights`, and the Home Lending Report's `employment_refresh_options` to `CraCheckReportCreate*Options`. The JSON request is unchanged. - Deprecate the request-time generation config on the CRA `/get` endpoints (`options`, `partner_insights`, `employment_refresh_options`); no longer accepted for new clients (created on or after 2026-07-01). ### 2020-09-14_1.699.6 - Add `cash advance`, `late fee`, `membership fee`, `returned item fee` to the `transaction_code` enum. ### 2020-09-14_1.699.5 - Add `num_i20s_uploaded` to the `document_income_results` object in the `/credit/sessions/get` and `/link/token/get` responses ### 2020-09-14_1.699.4 - Add private-visibility scaffolding for the `CRA_REPORT_UPDATED` webhook (`CRA_REPORT` type), fired when a subscribed CRA report is updated; lists the `successful_products` and `failed_products` for the update. Hidden from the public spec/docs until launch (customer-facing entry follows when `x-private-visibility` flips). ### 2020-09-14_1.699.3 - Add `kick` to the `processor` enum on `/processor/token/create`, for creating processor tokens for the Kick integration. ### 2020-09-14_1.699.2 - Adds `DOCUMENT_TYPE_US_STUDENT_I20` enum value (Form I-20 student document) for document metadata - Add `/fdx/consents`, `/fdx/consents/{consentId}`, and `/fdx/consents/{consentId}/revocation` for managing FDX consent grants. These endpoints remain hidden from public documentation. ### 2020-09-14_1.699.1 - Additions and corrections of enum values returned by API but not mentioned in OpenAPI spec. No actual changes to API behavior. - `PlaidErrorType`: add 13 error types (`ASSETS_ERROR`, `ENRICH_ERROR`, `STATEMENTS_ERROR`, `RECURRING_TRANSACTIONS_ERROR`, `CRA_MONITORING_ERROR`, `CREDIT_PROFILE_REPORT_ERROR`, `ENCOMPASS_ERROR`, `FRAUD_INSIGHTS_ERROR`, `FREDDIE_MAC_ERROR`, `LINK_DELIVERY_ERROR`, `PROFILE_ERROR`, `TRANSFER_RECURRING_ERROR`, `TRANSFER_REFUND_ERROR` - Asset Report `warning_code`: add the 5 `BANK_INCOME_INSIGHTS_*` codes - watchlist `source`: add `retro` enum value - `TransferNetwork`: add `rfp` enum value (request for payment; closed beta, debit-only) - `StudentRepaymentPlan.type`: `interest-only` → `interest only` (match the emitted value) ### 2020-09-14_1.699.0 - Add support for the Form I-20 US immigration student document on `/credit/payroll_income/get`. This form now returns an `i20` array which extraction data on uploaded I-20 documents. # 43.0.0 - Updating to OAS 2020-09-14_1.698.7 ## Breaking changes in this version - [BREAKING] Remove `protect_results` from `LinkSessionResults` in `/link/token/get` responses. The API no longer populates this field. (OAS 2020-09-14_1.697.0) - [BREAKING] `Recaptcha_RequiredError`: change `http_code` from `string` to `integer`. The API already returns an integer; only the spec was wrong. (OAS 2020-09-14_1.695.0) - [BREAKING] Replace `report_requested` field with `reports_requested` array field in `/cra/check_report/verification/pdf/get`. (OAS 2020-09-14_1.691.0) - [BREAKING] Remove `/item/handle_fraud_report` endpoint and its `ItemHandleFraudReportRequest` and `ItemHandleFraudReportResponse` schemas. The endpoint was never wired up for any customer. (OAS 2020-09-14_1.688.9) ## OpenAPI Schema Changes ### 2020-09-14_1.698.7 - Add `kanmon` to the `processor` enum on `/processor/token/create`, for creating processor tokens for the Kanmon integration. ### 2020-09-14_1.698.6 - Add `natural` to the `processor` enum on `/processor/token/create`, for creating processor tokens for the Natural integration. ### 2020-09-14_1.698.5 - Add `pay` to the `processor` enum on `/processor/token/create`, for creating processor tokens for the Pay.com integration. ### 2020-09-14_1.698.4 - Remove the 1024-character `maxLength` constraint from `notes` on `/protect/report/create`. ### 2020-09-14_1.698.3 - Add `FRAUD_TRANSACTION` to the `reason_code` enum (`ProductsTerminateReasonCode`) accepted by `/item/products/terminate` and `/user/products/terminate`, for terminating an Item due to transaction-level fraud (e.g. unauthorized transactions, card testing, chargebacks, ACH returns, or disputes). - Add `/cra/report/get` endpoint with CRA report schemas (CraReportGetRequest, CraReportGetResponse, CraReportGetReport, CraReportGetResponseProduct, CraReportGetProductAttributes, CraReportGetProductMetadata). ### 2020-09-14_1.698.2 - Correct stylization, acronym expansions, and factual errors in schema descriptions: "Bacs" (was "BACS"), "International Bank Account Number", "Business Identifier Code", "Government-Sponsored Enterprise" (was "Government Sponsored Entity"), "Registered Disability Savings Plan (RDSP)" (was "RSDP"), "FATCA" filing requirement (description only; was "FACTA"), "E.164" phone format (was "E. 164"), and "Social Security". Also clarified that `balances.available` and `balances.current` may both be `null` for limited-purpose checking accounts, and corrected an endpoint reference in a description (`/processor/stripe/bank_account_token/create`), and normalized two endpoint summaries to refer to the product as a singular "Consumer Report", and normalized "realtime" to the hyphenated "real-time" in balance descriptions. No changes to API behavior. ### 2020-09-14_1.698.1 - Clarify that `/protect/report/create` requires either `user_id` or at least one supported `incident_event` identifier, and that contextual fields alone do not satisfy this requirement. ### 2020-09-14_1.698.0 - Add `guarantee_details` (optional) to `Transfer` and `TransferAuthorization` schemas to surface adaptive guarantee settlement information. Introduces `TransferGuaranteeOutcome` enum, `AuthorizationGuaranteeScheduleItem` and `TransferGuaranteeScheduleItem` objects, `AuthorizationGuaranteeDetails` (outcome + schedule), and `TransferGuaranteeDetails` (guaranteed_amount + schedule). The authorization schedule omits `observation_window_expiration_time`, which is only meaningful on a created transfer. `guarantee_details` is `null` when no guarantee was attempted. The existing `guarantee_decision` and `guarantee_decision_rationale` fields are deprecated in favor of `guarantee_details`. - Add `requested_amount` to the `proposed_transfer` object on the `/transfer/authorization/create` response. Surfaces the amount the client originally requested, which can differ from the proposed `amount` when only a partial amount is offered for an adaptive guarantee. ### 2020-09-14_1.697.5 - Document support for UltraFICO® scores through the CRA Partner Insights product. ### 2020-09-14_1.697.4 - Correct spec to reflect two missing enum values: add missing `in_epic` enum value to `IDNumberType` and add missing `IDEMPOTENCY_ERROR` enum value to `ErrorType` schema. No changes to actual API behavior. ### 2020-09-14_1.697.4 - Update `Holding.tax_lots` description: remove stale "Absent from the response when the tax lots feature is not yet enabled" clause. ### 2020-09-14_1.697.3 - Add `atomicfi` value to the `processor` enum on `/processor/token/create`. ### 2020-09-14_1.697.2 - Add `payment` and `refund` values to the `transaction_code` enum, and update the field description to note that `transaction_code` is now populated for certain US institutions, in addition to European institutions. ### 2020-09-14_1.697.1 - Add `sub_programs` (`array<string>`) to `WatchlistScreeningHit` and `EntityWatchlistScreeningHit`. Surfaces the sub-program designations published by the issuing authority (for example OFAC SDN program codes like `SDGT`, `SDNTK`, `IRAN`, `RUSSIA-EO14024`). ### 2020-09-14_1.697.0 - [Breaking] Remove `protect_results` from `LinkSessionResults` in `/link/token/get` responses. The API no longer populates this field. ### 2020-09-14_1.696.1 - Add `tax_lots` array field to `Holding` and introduce `HoldingTaxLot` schema with 7 fields: `institution_lot_id`, `original_purchase_datetime`, `quantity`, `purchase_price`, `cost_basis`, `current_value`, and `position_type`. Introduce `HoldingTaxLotPositionType` enum (`LONG`, `SHORT`). ### 2020-09-14_1.696.0 - Add `ACCOUNT_FUNDING` and `AUTO_REFUND` values to the `WalletTransaction.type` enum. These transaction types are already returned for virtual-account unexpected-payment handling and were documented but missing from the spec. ### 2020-09-14_1.695.0 - [Breaking] `Recaptcha_RequiredError`: change `http_code` from `string` to `integer`. The API already returns an integer; only the spec was wrong. - Add `BASE_REPORT_ERROR` to the `error_type` enum (`PlaidErrorType`). - `IncomeVerificationRiskSignalsStatusWebhook`: fix the `required` list to reference `risk_signals_status` instead of a non-existent `status` field. - `Recaptcha_RequiredError`: mark `display_message` nullable and remove `link_user_experience`, `common_causes`, and `troubleshooting_steps` from `required`. This schema object is used for documentation only; describing these fields as required is misleading. - Remove `database_insights_pending` from the `verification_status` description on product-endpoint account schemas — it is only returned in the Link `onSuccess` metadata, not by these endpoints. - Add `STARTED` and `INTERNAL_ERROR` to the `CreditSessionBankIncomeStatus` enum. - Add `STARTED` and `INTERNAL_ERROR` to the `CreditSessionBankEmploymentStatus` enum. - Fix various webhook and error response examples to conform to their schemas. ### 2020-09-14_1.694.0 - Add `custom_attributes` field to `TransferAuthorizationCreateRequest`. ### 2020-09-14_1.693.0 - Add `reason_codes` array to `CraPartnerInsightsBaseFicoScore` and `negative_reason_codes` / `positive_reason_codes` arrays to `CraPartnerInsightsUltraFicoScore`. The corresponding individual `reason_code_1` through `reason_code_4` and `positive_reason_code_1` through `positive_reason_code_4` fields are now deprecated. ### 2020-09-14_1.692.7 - Add `model_version` string field to `PrismInsights` and deprecate the integer `version` field. Required to surface Prism Insights v4.1 and any future non-integeter model versions. ### 2020-09-14_1.692.6 - Add private-visibility scaffolding for `POST /fraud_insights/connection_event/send` (501 stub; customer-facing entry follows when `x-private-visibility` flips). ### 2020-09-14_1.692.5 - Add `interchecks` value to the `processor` enum on `/processor/token/create`. ### 2020-09-14_1.692.4 - Redeclare `name`, `official_name`, `mask`, and `verification_name` on the second `allOf` piece of `InvestmentAccount`, `BusinessAccount`, `AccountIdentity`, and `AccountIdentityMatchScore`. The fields are already declared on `AccountBase`; the redeclaration prevents the `plaid-python` SDK (>= 39.0.0) from routing them through its `additional_properties_type` handler, which upconverts date-shaped string values (e.g. an account literally named `"June - 529"`) into `datetime.date` objects in `to_dict()`. No change to the API response shape. ### 2020-09-14_1.692.3 - Add private-visibility scaffolding for `POST /fraud_insights/connection_risk_score/get` (501 stub; customer-facing entry follows when `x-private-visibility` flips). ### 2020-09-14_1.692.2 - Update `CraUserCheckReportFailedWebhook` (`USER_CHECK_REPORT_FAILED`) description to document that customers can call `/user/items/get` and inspect non-null `error` objects on the associated Items to retrieve error details, matching the existing guidance on `CraCheckReportFailedWebhook` (`CHECK_REPORT_FAILED`). ### 2020-09-14_1.692.1 - Correct the `/statements/download` success response content type from `application/json` to `application/pdf` to match the binary PDF body the endpoint actually returns. ### 2020-09-14_1.692.0 - `/cra/check_report/income_insights/get`: `income_streams` is now marked as required on `CraIncomeInsights` and is always present on the response. When there are no income streams for the report, it is returned as an empty array (`[]`) instead of being omitted. ### 2020-09-14_1.691.2 - Update `/user/products/terminate` description to clarify which subscription bundles are terminated, the billing impact, and the CRA Monitoring carve-out. - Restore the `/user/items/remove` description paragraph that points users to `/user/products/terminate` for stopping billing and to the Consumer Service Center for user-initiated data deletion. ### 2020-09-14_1.691.1 - Add `frame` value to the `processor` enum on `/processor/token/create`. ### 2020-09-14_1.691.0 - [Breaking] Replace `report_requested` field with `reports_requested` array field in `/cra/check_report/verification/pdf/get`. - Add `income` value to `CraCheckReportVerificationPdfReportType`. ### 2020-09-14_1.690.1 - Expose `/user/products/terminate` in the public OpenAPI spec (previously hidden from client libraries). ### 2020-09-14_1.690.0 - Add an optional `subscores` object to the `/protect/compute` response and a new `ProtectComputeSubscores` schema. For cash-advance models, exposes per-bucket subscores (`cash_advance_bucket_0_25` through `cash_advance_bucket_400_500`) where each scored bucket is a 0-100 trust index score (higher = lower fraud risk). Both the wrapper `subscores` field and each individual bucket key are omitted from the response when not scored: models that do not produce subscores will not include the `subscores` key in the response at all, and partially-scored responses include only the bucket keys that were scored. ### 2020-09-14_1.689.0 - Add optional `user_id` field to `CraCreditProfileReportGetResponse`. ### 2020-09-14_1.688.10 - Add `reason_code` enum values to `/item/products/terminate` and `/user/products/terminate` ### 2020-09-14_1.688.9 - [Breaking] Remove `/item/handle_fraud_report` endpoint and its `ItemHandleFraudReportRequest` and `ItemHandleFraudReportResponse` schemas. The endpoint was never wired up for any customer. ### 2020-09-14_1.688.8 - Expose the `limited_purpose_types` filter on `LinkTokenCreateDepositoryFilter` and `DepositoryFilter`, and the `LimitedPurposeTypes` and `LimitedPurposeType` schemas, in the public OpenAPI spec (previously hidden from client libraries). Used in conjunction with the `limited purpose checking` depository subtype to restrict which kinds of limited purpose checking accounts may be connected in Link. ### 2020-09-14_1.688.7 - Add income schema types (`CraVerificationIncome*`) to CRA Home Lending Verification Report - Add `income` field to `CraVerificationReport` - Add `INCOME` to `CraCheckReportVerificationGetReportType` enum - Document that `/sandbox/transactions/create` only applies custom transactions to the depository account on `user_transactions_dynamic` Items # 42.2.0 - Updating to OAS 2020-09-14_1.688.6 ## OpenAPI Schema Changes ### 2020-09-14_1.688.6 - Updated `/user_account/session/get` sample response to include `identity_edit_history` ### 2020-09-14_1.688.5 - Expose `/cra/credit_profile/report/get` and its request/response schemas in the public OpenAPI spec (previously hidden from client libraries) - Mark `/credit/bank_income/refresh` as `deprecated: true`. The backend implementation was removed, and the endpoint returns `Unimplemented` at runtime. To refresh Bank Income data, send the user through Link Update Mode, or migrate to CRA Income Insights and call `/cra/check_report/create`. ### 2020-09-14_1.688.4 - Document that `/transfer/metrics/get` returns static placeholder values in the Sandbox environment ### 2020-09-14_1.688.3 - Mark `/protect/event/send` and `/protect/event/get` as `deprecated: true` ### 2020-09-14_1.688.2 - Hide `/protect/event/send` and `/protect/event/get` endpoints from public API docs ### 2020-09-14_1.688.1 - Add `/sandbox/item/application/seed` endpoint for seeding connected applications on Permissions Manager sandbox items # 42.1.0 - Updating to OAS 2020-09-14_1.688.0 ## OpenAPI Schema Changes ### 2020-09-14_1.688.0 - Add additional fields to CRA Partner Insights UltraFICO response (hidden from docs) ### 2020-09-14_1.687.1 - Add `limited purpose checking` to `DepositoryAccountSubtype`, `DepositoryAccount`, and `AccountSubtype` schemas - Add `limited_purpose_types` filter field to `DepositoryFilter` and `LinkTokenCreateDepositoryFilter` (hidden from docs) - Add `LimitedPurposeTypes` and `LimitedPurposeType` schemas (hidden from docs) ### 2020-09-14_1.687.0 - Add new field `disconnect_time` to `PendingDisconnectWebhook` ### 2020-09-14_1.686.4 - Income Insights doc fixes ### 2020-09-14_1.686.3 - Update `/cra/check_report/income_insights/get` sample response to V2 schema ### 2020-09-14_1.686.2 - Unhide Income Insights V2 fields and hide Income Insights v1 fields ### 2020-09-14_1.686.1 - Add `home_lending_report_options` to `CraCheckReportCreateBaseReportOptions` and `LinkTokenCreateRequestCraOptionsBaseReport` for configuring Home Lending Report generation (VOA, Employment Refresh) on base report creation # 42.0.0 - Updating to OAS 2020-09-14_1.686.0 ## Breaking changes in this version - [BREAKING] Remove deprecated beta `recurrence` field from `Enrichments` schema in `/transactions/enrich` response and remove `Recurrence` and `RecurringFrequency` schema definitions - [BREAKING] Update `InvestmentsHoldingsGetResponse`, `InvestmentsTransactionsGetResponse`, `InvestmentsAuthGetResponse`, `ProcessorInvestmentsHoldingsGetResponse`, and `ProcessorInvestmentsTransactionsGetResponse` to use `InvestmentAccount` instead of `AccountBase` - [Breaking] `CraPartnerInsightsPrism` is now nullable. The `prism` field will be omitted from `/cra/check_report/partner_insights/get` responses when Prism Data was not included in the request. Clients that always expect `prism` to be present should update to handle a null or missing value. - [Breaking] Remove Plaid Check Score references from the API. Plaid Check Score is not in active use by customers and has been deprecated in favor of the Plaid LendScore. ## OpenAPI Schema Changes ### 2020-09-14_1.686.0 - Add Income Insights V2 schemas and fields to client libraries (hidden from docs) ### 2020-09-14_1.685.3 - Add `cfi_code` field to the Investments `Security` schema. ### 2020-09-14_1.685.2 - Add `protect_transactions` to the public `Products` and `UserBasedProducts` enums and expose it in `/link/token/create` product array docs. ### 2020-09-14_1.685.1 - Add Item IDs to FAILED CHECK_REPORT webhooks for closed beta ### 2020-09-14_1.685.0 - [BREAKING] Remove deprecated beta `recurrence` field from `Enrichments` schema in `/transactions/enrich` response and remove `Recurrence` and `RecurringFrequency` schema definitions ### 2020-09-14_1.684.1 - Add missing investment account subtypes to `InvestmentAccountSubtype` and `InvestmentAccountSubtypeStandalone` schemas: `fhsa`, `line of credit`, `roth 403B`, `roth 457b`, `roth pension`, `roth profit sharing plan`, `roth thrift savings plan`, and `thrift savings plan`. Add these subtypes plus `qshr` to the `AccountSubtype` enum. ### 2020-09-14_1.684.0 - Add `InvestmentAccountBalance` and `InvestmentAccount` schemas to expose `margin_loan_amount` on investment endpoints - [BREAKING] Update `InvestmentsHoldingsGetResponse`, `InvestmentsTransactionsGetResponse`, `InvestmentsAuthGetResponse`, `ProcessorInvestmentsHoldingsGetResponse`, and `ProcessorInvestmentsTransactionsGetResponse` to use `InvestmentAccount` instead of `AccountBase` ### 2020-09-14_1.683.2 ### 2020-09-14_1.683.1 - Add version `4.1` to `PrismDetectVersion`, `PrismCashScoreVersion`, `PrismExtendVersion`, and `PrismInsightsVersion` enums for Prism v4.1 support in `/cra/check_report/partner_insights/get`. ### 2020-09-14_1.683.0 - Add OpenAPI spec for `/item/products/terminate` and `/item/handle_fraud_report` endpoints ### 2020-09-14_1.683.0 - Add `user_id` field to `CreditBankIncomeGetRequest`, `CreditBankIncomePDFGetRequest`, `CreditBankIncomeRefreshRequest`, `CreditBankIncomeWebhookUpdateRequest`, `CreditPayrollIncomeParsingConfigUpdateRequest`, `CreditPayrollIncomeRiskSignalsGetRequest`, `CreditPayrollIncomeGetRequest`, `CreditPayrollIncomePrecheckRequest`, and `CreditPayrollIncomeRefreshRequest`. ### 2020-09-14_1.682.12 - Update `with_guarantee` field in `/transfer/authorization/create` with clearer wording ### 2020-09-14_1.682.11 - Update `/user/items/remove` description with clearer wording ### 2020-09-14_1.682.10 - Add `cfi_code` to the Investments `Security` model. ### 2020-09-14_1.682.9 - Make `with_upgraded_user` field in `/user/create` visible in docs ### 2020-09-14_1.682.8 - Remove deprecated `prism_products` field from `CraCheckReportCreatePartnerInsightsOptions`, `CraCheckReportPartnerInsightsGetOptions`, `LinkTokenCreateRequestCraOptionsPartnerInsights`, and `LinkTokenCreateRequestCreditPartnerInsights` schemas. Remove deprecated `PrismProduct` enum. Use `prism_versions` instead. ### 2020-09-14_1.682.7 [Breaking] `CraPartnerInsightsPrism` is now nullable. The `prism` field will be omitted from `/cra/check_report/partner_insights/get` responses when Prism Data was not included in the request. Clients that always expect `prism` to be present should update to handle a null or missing value. ### 2020-09-14_1.682.6 ### 2020-09-14_1.682.5 Update copy for Layer email availability ### 2020-09-14_1.682.4 - Add `link_session_id` field to `ProtectUserEventWebhook` - ### 2020-09-14_1.682.3 [Breaking] Remove Plaid Check Score references from the API. Plaid Check Score is not in active use by customers and has been deprecated in favor of the Plaid LendScore. # 41.4.0 - Updating to OAS 2020-09-14_1.682.2 ## OpenAPI Schema Changes ### 2020-09-14_1.682.2 - Add personal_finance_category to BaseReportTransaction model. ### 2020-09-14_1.682.1 - Update `ProtectComputeResponse`: promote `score` and `model` to top-level fields, rename `fraud_attributes` to `attributes`, and remove `trust_index` and `subscores` - Mark `ProtectComputeResponse.score` as nullable so it is omitted from the API response when no trust index score is present, preventing clients from seeing a spurious `"score": 0` ### 2020-09-14_1.682.0 - Add `has_null_available_balance` field to `OverrideAccounts` schema. When set to `true`, the Sandbox test account will always return `null` for its available balance. Cannot be set together with `force_available_balance`. ### 2020-09-14_1.681.9 - Add `fico` field to `CraCheckReportPartnerInsightsGetPartnerInsights`, `CraCheckReportCreatePartnerInsightsOptions`, and `LinkTokenCreateRequestCraOptionsPartnerInsights` schemas to support UltraFICO score generation; add new `CraPartnerInsightsFicoInput`, `CraPartnerInsightsUltraFicoScoreRequest`, `CraPartnerInsightsBaseFicoScore`, `CraPartnerInsightsUltraFicoScoreVersion`, `CraPartnerInsightsBureau`, and `CraPartnerInsightsBaseFicoScoreVersion` schemas ### 2020-09-14_1.681.8 - Update `beta/transactions/rules/v1` endpoints to use `client_user_id` instead of `access_token` - Split `personal_finance_category` into `pfc_primary_category` and `pfc_detailed_category` on rule request/response schemas; add optional `pfc_version` field - Rename `TransactionsRuleField` enum value `NAME` to `MERCHANT_NAME` - Add `updated_at` and `client_user_id` to `TransactionsCategoryRule`; replace `item_id` and `personal_finance_category` ### 2020-09-14_1.681.7 - Add `sdk` field to `ProtectModelInputs` on `ProtectComputeRequest`. ### 2020-09-14_1.681.6 - Clarify `/protect/compute` `model` field: version suffix is required and must be `major.minor` format; removed references to versionless model names - Expand `require_extracted_data` field description to document HTTP 400 / `FAILED_PRECONDITION` behavior when set to `true` - Add readiness error to `/protect/compute` endpoint description: for link-session models, calling the endpoint before the Link session is complete returns HTTP 400 with `error_type` = `INVALID_REQUEST` and `error_code` = `FAILED_PRECONDITION` # 41.3.0 - Updating to OAS 2020-09-14_1.681.5 ## OpenAPI Schema Changes ### 2020-09-14_1.681.5 - Add `ELIGIBILITY_FOR_GOVT_BENEFITS` permissible purpose to `ConsumerReportPermissiblePurpose` schema # 41.2.0 - Updating to OAS 2020-09-14_1.681.4 ## OpenAPI Schema Changes ### 2020-09-14_1.681.4 - Add `client_user_id` field to `ProtectUserEventWebhook` ### 2020-09-14_1.681.2 - Add `edits_current` field to `UserAccountIdentityEditCounts` schema. This field tracks the number of edits made to a specific identity field during the current session. ### 2020-09-14_1.681.1 - Add `user_id` field to the following webhook schemas: `SyncUpdatesAvailableWebhook`, `ItemPendingExpirationWebhook`, `ItemErrorWebhook`, `ItemLoginRepairedWebhook`, `InvestmentsTransactionsDefaultUpdateWebhook`, `InvestmentsTransactionsHistoricalUpdateWebhook`, `HoldingsDefaultUpdateWebhook`, `LiabilitiesDefaultUpdateWebhook`, `ItemPendingDisconnectWebhook`, `ItemUserPermissionRevokedWebhook`, `NewAccountsAvailableWebhook`, `UserAccountRevokedWebhook`, `LinkSessionFinishedWebhook` ### 2020-09-14_1.681.0 - Add `trust_index_score` field to `risk_check` schema for IDV endpoints. ### 2020-09-14_1.680.9 - Add `payee_verification_status` field to `WalletTransaction` schema. This field indicates the result of payee verification checks for EUR payouts. # 41.1.0 - Updating to OAS 2020-09-14_1.680.8 ## OpenAPI Schema Changes ### 2020-09-14_1.680.8 - Add `cra_plaid_credit_score` value to Products enum. Note that this value is deprecated and is added only to reflect current API behavior, as it is present in the supported products array returned by insititutions endpoints. `cra_plaid_credit_score` should not be used in any requests to `/link/token/create` and is planned to be removed from the API. ### 2020-09-14_1.680.7 - Add `environment` field to `ProtectUserEventWebhook` ### 2020-09-14_1.680.6 - Add 'investment_auth' as an available product in the request to `/partner/customer/create` ### 2020-09-14_1.680.6 - Add `201` response to `/user/create` ### 2020-09-14_1.680.5 - Add `/user/items/remove` endpoint ### 2020-09-14_1.680.4 - (hidden) Add `/user/identity/remove` endpoint to allow customers to explicitly purge identity data ### 2020-09-14_1.680.3 - Mark `is_investments_fallback_item` as an optional rather than required parameter in the response schema for `/processor/investments/holdings/get` endpoint (not yet currently used in Production by any customers), to achieve consistency with `/investments/holdings/get`. ### 2020-09-14_1.680.2 - Add `/user_account/session/event/send` endpoint for Layer customer event tracking ### 2020-09-14_1.680.1 - Update /verification/pdf/get endpoint request attribute from `report_type` to `report_requested`. # 41.0.0 - Updating to OAS 2020-09-14_1.680.0 ## Breaking changes in this version - [BREAKING] Make Personal Financial Category version fields enums. - [Breaking] Remove `/user/items/list` endpoint (not used by or exposed to any customers) ## OpenAPI Schema Changes ### 2020-09-14_1.680.0 - Add Facial Duplicate data to IDV APIs. ### 2020-09-14_1.679.1 - Fix description and summary field for `/user/get` ### 2020-09-14_1.679.0 - Fix invalid OpenAPI syntax in `IdentityVerificationListRequest` schema object - Extensive documentation changes (including field re-ordering) to support new `user_id` and new user APIs ### 2020-09-14_1.678.3 - [Breaking] Remove `/user/items/list` endpoint (not used by or exposed to any customers) ### 2020-09-14_1.678.2 - Add `required_account_subtypes` and `provided_account_subtypes` to `Error` response object for NO_ACCOUNTS errors (currently only populated when `investments_auth` present in `enabled_products`) ### 2020-09-14_1.678.1 - Internal changes only ### 2020-09-14_1.678.0 - Add `request_guarantee` to `/transfer/authorization/create` - Mark `with_guarantee` deprecated in `/transfer/authorization/create` ### 2020-09-14_1.677.3 - Add user_id to `/link/token/get` response. - Remove beta from NewUserID description. ### 2020-09-14_1.677.2 - Add user_id to `/sandbox/public_token/create` request object ### 2020-09-14_1.677.1 - [BREAKING for Go] Add user_id to `/user/items/get` request object and make user_token optional. ### 2020-09-14_1.677.0 - [BREAKING for Go] (beta) Add user_id to `/sandbox/user/reset_login` request object and make user_token optional. ### 2020-09-14_1.676.0 - [BREAKING] Make Personal Financial Category version fields enums. # 40.0.0 - Updating to OAS 2020-09-14_1.675.0 ## Breaking changes in this version - [Breaking for Go] make user_token not required for `sandbox/cra/cashflow_updates/update` - [Breaking] make user_token not required for `cra/monitoring_insights/get`, `cra/check_report/create` and `cra/monitoring_insights/subscribe` ## OpenAPI Schema Changes ### 2020-09-14_1.675.0 - [Breaking for Go] make user_token not required for `sandbox/cra/cashflow_updates/update` ### 2020-09-14_1.674.1 - (beta) Add `/user/products/terminate` endpoint ### 2020-09-14_1.674.0 - [Breaking] make user_token not required for `cra/monitoring_insights/get`, `cra/check_report/create` and `cra/monitoring_insights/subscribe` ### 2020-09-14_1.673.4 - (beta) Remove unused IDENTITY_ERROR error type ### 2020-09-14_1.673.3 - Fix validation errors in OpenAPI spec ### 2020-09-14_1.673.2 - Add `network_insights` to `cra_options` ### 2020-09-14_1.673.1 - Add `income_provider` field to `bank_income_sources` objects returned by `/cra/check_report/income_insights/get` ### 2020-09-14_1.673.0 - Add `status` field to `/cra/check_report/income_insights/get`'s `bank_income_source` object ### 2020-09-14_1.672.5 - Add CRA User webhooks ### 2020-09-14_1.672.5 - (beta) Remove references to the `PLAID-NEW-USER-API-ENABLED` header in favor of the `with_upgraded_user` request field ### 2020-09-14_1.672.4 - Make `latest_scored_protect_event` visible on `/identity_verification/get`, `/identity_verification/create` and `/identity_verification/retry` response - Make `user_id` visible on `/link/token/create` response ### 2020-09-14_1.672.3 - (beta) removed `IdentityCreationResult` from `/user/create` and `/user/update` ### 2020-09-14_1.672.2 - (beta) Add new error type USER_ERROR - (beta) Add new error type IDENTITY_ERROR ### 2020-09-14_1.672.1 - Make `IncomeProvider` nullable in `/cra/check_report/income_insights/get` ### 2020-09-14_1.672.0 - Add sub-fields to new Account Insights (Europe only) object: `minimum_balance`, `transfers_in`, `total_income`, and `income_excluding_transfers`. - Fix `category_details` missing a `type` definition (`type: array`) within the `LoanDisbursementsIndicators` object. - Add document `issue_date` to Identity Verification endpoints ### 2020-09-14_1.671.6 - Add CFU V2 webhook object ### 2020-09-14_1.671.5 ### 2020-09-14_1.671.4 ### 2020-09-14_1.671.4 - (beta) Rename `require_upgraded_user` boolean field in `/user/create` to `with_upgraded_user` ### 2020-09-14_1.671.3 - Add `IncomeProvider` to `/cra/check_report/income_insights/get` ### 2020-09-14_1.671.2 - (beta) Add `require_upgraded_user` boolean field to the `/user/create` request ### 2020-09-14_1.671.1 - Remove PlaidError schema from irrelevant endpoints ### 2020-09-14_1.671.0 - Add missing PlaidError schema to all endpoints # 39.1.0 - Updating to OAS 2020-09-14_1.670.0 ## OpenAPI Schema Changes ### 2020-09-14_1.670.0 - Add support for investments to `/cra/check_report/verification/get` ### 2020-09-14_1.669.0 - Add `AccountInsights` to `/asset_report/get` ### 2020-09-14_1.668.3 - Update `identity_creation_result` to be `null` for V0 `/user/create` routes ### 2020-09-14_1.668.2 - (beta) use user_id in `/user/third_party_token/create` ### 2020-09-14_1.668.1 - Add `options` for `network_insights` in `link/token/create`, `cra/check_report/create`, and `cra/check_report/network_insights/get` ### 2020-09-14_1.668.0 - Add support for Cashflow Insights and LendScore, including adding `cra_cashflow_insights` and `cra_lend_score` to Products array and creating new `PlaidLendScoreVersion` schema object. - Documentation-only changes to support a single, shared Signal Rules-based integration path for Balance and Signal Transaction Scores using `/signal/evaluate`. - Documentation-only changes to support Transfer for Platforms. ### 2020-09-14_1.667.6 - (beta) new `/protect/report/create` endpoint ### 2020-09-14_1.667.5 - Publish `/transfer/platform/originator/create` to docs - Publish `/transfer/platform/person/create` to docs - Publish `/transfer/platform/requirement/submit` to docs ### 2020-09-14_1.667.4 - Fixed a broken documentation link ### 2020-09-14_1.667.3 - Add cra_partner_insights as possible add_ons for `cra/check_report/pdf/get` ### 2020-09-14_1.667.2 - (beta) updated street_1, city, region, and postal_code to no longer be required ### 2020-09-14_1.667.1 - (beta) Allow ClientUserIdentityName to be nullable # 39.0.0 - Updating to OAS 2020-09-14_1.667.0 ## Breaking changes in this version - (breaking) Remove `cra/check_report/plaid_credit_score/get` - [BREAKING] Add `item_id` to `/cra/monitoring_insights/subscribe` request ## OpenAPI Schema Changes ### 2020-09-14_1.667.0 - Add `errors` field to `institutions` objects in `/partner/customer/oauth_institutions/get` response ### 2020-09-14_1.666.10 - Add `cra_update_results` field to `results` objects in `/link/token/get` response ### 2020-09-14_1.666.9 - Updated `count` field from `TransferEventSyncRequest` to maximum of 500 and default of 100 ### 2020-09-14_1.666.8 - Removed unused `id_numbers` field from `UserCreateRequest` (field was never processed by application logic) - (beta) updated `ClientUserIdentity.id_numbers` to use `UserIDNumber` from cognito.yml instead of the custom `ClientUserIdentityIdNumber` schema ### 2020-09-14_1.666.7 - (beta) remove `ClientUserIdentityAddressType` from `ClientUserIdentityAddress` ### 2020-09-14_1.666.6 - (beta) added `primary` boolean to `ClientUserIdentityEmail`, `ClientUserIdentityPhoneNumber`, and `ClientUserIdentityAddress` ### 2020-09-14_1.666.5 - (beta) added `SSN` to `ClientUserIdNumberType` ### 2020-09-14_1.666.4 - (beta) updated 'IdentityCreationResultType' enums to be capital - (beta) update `SSN_LAST_4` to `SSN_LAST_FOUR` ### 2020-09-14_1.666.3 - Updated `/user/get` `client_user_id` field properties to be nullable - Removed `/user/get` `updated_at` field nullable property ### 2020-09-14_1.666.2 - (beta) Add `cra_lend_score` support to `link/token/create`, `cra/check_report/create`, and `cra/check_report/lend_score/get` - (breaking) Remove `cra/check_report/plaid_credit_score/get` ### 2020-09-14_1.666.1 - (beta) updated `ErrorType` on `IdentityCreationResult` to be optional ### 2020-09-14_1.666.0 - (beta) Add `/user/get` endpoint to retrieve user identity and information. ### 2020-09-14_1.665.6 - (beta) Add new version of `/user/update` ### 2020-09-14_1.665.5 - Mark `expected_settlement_date` deprecated in `transfer` ### 2020-09-14_1.665.4 - (beta) updated `UserCreateRequest` to include `identity` - (beta) updated `UserCreateResponse` to include `identity_creation_result` - (beta) renamed `UserIdentity` to `ClientUserIdentity` ### 2020-09-14_1.665.3 - (beta) created `IdentityCreationResult` shared object ### 2020-09-14_1.665.2 - (beta) created `UserIdentity` shared object ### 2020-09-14_1.665.1 - Hide `cashflow_insights` references ### 2020-09-14_1.665.0 - [BREAKING] Add `item_id` to `/cra/monitoring_insights/subscribe` request ### 2020-09-14_1.664.1 - Deprecate baseline values in `/cra/monitoring_insights/get` response # 38.1.0 - Updating to OAS 2020-09-14_1.664.0 ## OpenAPI Schema Changes ### 2020-09-14_1.664.0 - Add `investments_auth` to enum values for the `additional_consented_products` array in the `/link/token/create` request schema. ### 2020-09-14_1.663.3 - (beta) Add `cra_plaid_credit_score` support to `link/token/create` - (beta) Add `cra_plaid_credit_score` support to `cra/check_report/create` - (beta) Add `cra/check_report/plaid_credit_score/get` endpoint ### 2020-09-14_1.663.2 - Add `user_id` to `cra/*` endpoints ### 2020-09-14_1.663.1 - Add `overdraft` account type to the `LoanAccountSubtype` object, where it was erroneously missing - Correct missing and incorrect enum values for `ItemConsentedDataScope` object ### 2020-09-14_1.663.0 - (beta) Add `/user/items/associate` endpoint ### 2020-09-14_1.662.1 - Internal changes only ### 2020-09-14_1.662.0 - Add `balance_to_transaction_amount_ratio` to `/signal/evaluate` ### 2020-09-14_1.661.0 - Add `personal_finance_category_version` to `/transactions/get`, `/transactions/sync` and `/transactions/enrich` request options as well as version field in response. ### 2020-09-14_1.660.0 - Add `gse_options` to `base_report` options in `/link/token/create` and `cra/check_report/create` ### 2020-09-14_1.659.0 - Deprecate the `sedol` field in the Investments `Security` object. - Deprecate the `sedol` field in the Investments `SecurityOverride` object. # 38.0.0 - Updating to OAS 2020-09-14_1.658.0 ## Breaking changes in this version - [BREAKING] To improve consistency and resolve a bug in a third-party client library, changed `MonitoringConsumerReportPermissiblePurpose` schema object title from `ConsumerReportPermissiblePurpose` to `MonitoringConsumerReportPermissiblePurpose`. This may be a breaking change for certain client libraries. ## OpenAPI Schema Changes ### 2020-09-14_1.658.0 - (beta) Add `user_id` field to `/session/token/create` request. - [BREAKING for Go] (beta) Make `user` object optional in `/session/token/create` if `user_id` is included. ### 2020-09-14_1.657.0 Add Add `subtype` property to the `Security` model. ### 2020-09-14_1.656.1 - Renamed `protect_sdk_session_id` field in the request of `/protect/event/send` to `protect_session_id` for consistency across endpoints. ### 2020-09-14_1.656.0 - Added `aamva_verification` object in the responses of `documentary_verification.documents[].analysis`. This impacts the following endpoints: - `identity_verification/create` - `identity_verification/get` - `identity_verification/list` - `identity_verification/retry` ### 2020-09-14_1.655.0 - Add `max_amount` and `iso_currency_code` to `rfp` in `/transfer/capabilitied/get` response ### 2020-09-14_1.654.0 - [BREAKING] To improve consistency and resolve a bug in a third-party client library, changed `MonitoringConsumerReportPermissiblePurpose` schema object title from `ConsumerReportPermissiblePurpose` to `MonitoringConsumerReportPermissiblePurpose`. This may be a breaking change for certain client libraries. ### 2020-09-14_1.653.0 - (beta) Add optional `user_id` field to `identity_verification/create` and `identity_verification/list` requests. When `user_id` is present during creation and `client_user_id` is not, the `client_user_id` from the associated user will be set on the created identity verification. If `user_id` is present during creation, the `user` object may not also be present. Modifying user data should be done via the `user/update` endpoint. - [BREAKING for Go] (beta) Make `client_user_id` optional in `identity_verification/list` if `user_id` is included. - (beta) Add nullable `user_id` to the response of all of the identity verification endpoints: - `identity_verification/create` - `identity_verification/get` - `identity_verification/list` - `identity_verification/retry` ### 2020-09-14_1.652.3 - Added support for `cra_monitoring` to `Products` array. ### 2020-09-14_1.652.2 - (beta) Add `/user/items/list` endpoint ### 2020-09-14_1.652.1 - Add `/transfer/ledger/event/list` endpoint # 37.0.0 - Updating to OAS 2020-09-14_1.652.0 ## Breaking changes in this version - [Breaking] Replacing `voe` references to instead be `employment_refresh` in `/cra/check_report/verification/get` and `/cra/check_report/create` - `/cra/check_report/verification/get`'s `reports_requested` options are now `VOA` and `employment_refresh` - `voe_options` in the request is now `employment_refresh_options` - `/cra/check_report/verification/get`'s response now has `report.employment_refresh` instead of `report.voe` - `gse_options.report_type` in `/cra/check_report/create` are now `VOA` and `employment_refresh` ## OpenAPI Schema Changes ### 2020-09-14_1.652.0 - Add optional `cursor` and `count` fields to the `/payment_initiation/recipient/list` request and `next_cursor` to its response ### 2020-09-14_1.651.2 - (beta) Add `user_id` field to `link/token/create` request - [BREAKING for Go] (beta) Make `user` object optional in `link/token/create` if `user_id` is included ### 2020-09-14_1.651.1 - Add `error` field to `WALLET_TRANSACTION_STATUS_UPDATE` webhook and to responses of `/wallet/transaction/get` and `/wallet/transaction/list`, containing error details for failed transactions. ### 2020-09-14_1.651.0 - Rename all `/verify/client/*` routes to `/protect/client/*` and update request/response body and field names accordingly. ### 2020-09-14_1.650.1 - Update description for `days_required` ### 2020-09-14_1.650.0 - Add `account_numbers` to `Counterparty` in `/transaction/get` and `/transaction/sync` ### 2020-09-14_1.649.2 - Add `InsitutionID` and `InstitutionName` to `/cra/monitoring_insights/get` response ### 2020-09-14_1.649.1 - Update max value for `cra_options.days_requested` in `link/token/create` to 731 (2 years + 1 days for leap year) - Reduce max value for `cra_opt