From 68077a9a3d4cd8ea91cdc252cef93fad8b7e2a19 Mon Sep 17 00:00:00 2001 From: Aaroh Mankad Date: Wed, 19 Nov 2025 09:37:33 -0800 Subject: [PATCH] OpenAPI generated code at 2025-11-19T17:37:29Z --- 2020-09-14.yml | 53 ++++++++++++++++++++++++-------------------------- CHANGELOG.md | 12 ++++++++++++ 2 files changed, 37 insertions(+), 28 deletions(-) diff --git a/2020-09-14.yml b/2020-09-14.yml index fcb78d4..4440e05 100644 --- a/2020-09-14.yml +++ b/2020-09-14.yml @@ -6,7 +6,7 @@ servers: url: https://sandbox.plaid.com info: title: The Plaid API - version: 2020-09-14_1.673.1 + version: 2020-09-14_1.674.0 description: The Plaid REST API. Please see https://plaid.com/docs/api for more details. contact: name: Plaid Developer Team @@ -3399,7 +3399,6 @@ paths: schema: $ref: '#/components/schemas/CraCheckReportVerificationGetRequest' /cra/check_report/verification/pdf/get: - x-hidden-from-docs: true post: summary: Retrieve Consumer Reports as a Verification PDF tags: @@ -3423,7 +3422,12 @@ paths: externalDocs: url: /api/products/check/#cracheck_reportverificationpdfget operationId: craCheckReportVerificationPdfGet - description: '`/cra/check_report/verification/pdf/get` retrieves the most recent Consumer Report in PDF format, formatted specifically for verification use cases. The `report_type` field specifies which verification format to use.' + description: |- + The `/cra/check_report/verification/pdf/get` endpoint retrieves the most recent Consumer Report in PDF format, + specifically formatted for Home Lending verification use cases. Before calling this endpoint, ensure that you've created a + VOA report through Link or the `/cra/check_report/create` endpoint, and have received the `CHECK_REPORT_READY` webhook. + + The response to `/cra/check_report/verification/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. requestBody: required: true content: @@ -26387,9 +26391,9 @@ components: type: boolean description: If `true`, enable linking multiple items in the same Link session. Defaults to `false`. user_id: + description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. **Required** if the `user` object isn't included. If this field is included, then the remaining `user` object fields are ignored. allOf: - $ref: '#/components/schemas/NewUserID' - - description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. **Required** if the `user` object isn't included. If this field is included, then the remaining `user` object fields are ignored. required: - client_name - language @@ -26508,9 +26512,9 @@ components: $ref: '#/components/schemas/SessionTokenCreateRequestUser' user_id: x-hidden-from-docs: true + description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. **Required** if the `user` object isn't included. If this field is included, then the remaining `user` object fields are ignored. allOf: - $ref: '#/components/schemas/NewUserID' - - description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. **Required** if the `user` object isn't included. If this field is included, then the remaining `user` object fields are ignored. redirect_uri: $ref: '#/components/schemas/LinkTokenCreateRequestRedirectUri' android_package_name: @@ -27533,7 +27537,6 @@ components: - CHECK_REPORT_ERROR - CONSUMER_REPORT_ERROR - USER_ERROR - - IDENTITY_ERROR AccountType: type: string title: AccountType @@ -41386,7 +41389,6 @@ components: LinkTokenCreateRequestCraOptionsCashflowInsights: title: LinkTokenCreateRequestCraOptionsCashflowInsights type: object - x-hidden-from-docs: true description: Specifies options for initializing Link for use with the Cashflow Insights product. properties: plaid_check_score_version: @@ -41403,7 +41405,6 @@ components: LinkTokenCreateRequestCraOptionsNetworkInsights: title: LinkTokenCreateRequestCraOptionsNetworkInsights type: object - x-hidden-from-docs: true description: Specifies options for initializing Link for use with the CRA Network Insights product. properties: network_insights_version: @@ -46508,9 +46509,9 @@ components: $ref: '#/components/schemas/UserToken' user_id: x-hidden-from-docs: true + description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. allOf: - $ref: '#/components/schemas/NewUserID' - - description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. webhook_codes: type: array description: Webhook codes corresponding to the Cash Flow Updates events to be simulated. @@ -50852,9 +50853,9 @@ components: description: The item ID to subscribe for Cash Flow Updates. user_id: x-hidden-from-docs: true + description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. allOf: - $ref: '#/components/schemas/NewUserID' - - description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. webhook: type: string description: URL to which Plaid will send Cash Flow Updates webhooks, for example when the requested Cash Flow Updates report is ready. @@ -50866,7 +50867,6 @@ components: $ref: '#/components/schemas/CreditBankIncomeCategory' nullable: true required: - - user_token - webhook CraMonitoringInsightsSubscribeResponse: type: object @@ -50917,13 +50917,12 @@ components: $ref: '#/components/schemas/UserToken' user_id: x-hidden-from-docs: true + description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. allOf: - $ref: '#/components/schemas/NewUserID' - - description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. consumer_report_permissible_purpose: $ref: '#/components/schemas/MonitoringConsumerReportPermissiblePurpose' required: - - user_token - consumer_report_permissible_purpose CraMonitoringInsightsGetResponse: type: object @@ -51221,9 +51220,9 @@ components: $ref: '#/components/schemas/ThirdPartyUserToken' user_id: x-hidden-from-docs: true + description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. allOf: - $ref: '#/components/schemas/NewUserID' - - description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. add_ons: type: array description: Use this field to include other reports in the PDF. @@ -51259,9 +51258,9 @@ components: $ref: '#/components/schemas/ThirdPartyUserToken' user_id: x-hidden-from-docs: true + description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. allOf: - $ref: '#/components/schemas/NewUserID' - - description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. item_ids: type: array description: The item IDs to include in the Base Report. If not provided, all items associated with the user will be included. @@ -51498,7 +51497,7 @@ components: client_user_id: type: string nullable: true - description: An identifier you determine and submit for the user. If using the Credit Dashboard, Customers should pass in the `user_token` created in `/user/create`. + description: An identifier you determine and submit for the user. first_name: type: string nullable: true @@ -55482,12 +55481,12 @@ components: type: string example: Pawnee title: CityName - description: City from the end user's address. A string with at least one non-whitespace alphabetical character, with a max length of 100 characters." + description: City from the end user's address. A string with at least one non-whitespace alphabetical character, with a max length of 100 characters. CityNullable: type: string example: Pawnee title: CityName - description: City from the end user's address. A string with at least one non-whitespace alphabetical character, with a max length of 100 characters." + description: City from the end user's address. A string with at least one non-whitespace alphabetical character, with a max length of 100 characters. nullable: true ClientUserID: type: string @@ -59964,9 +59963,9 @@ components: $ref: '#/components/schemas/UserToken' user_id: x-hidden-from-docs: true + description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. allOf: - $ref: '#/components/schemas/NewUserID' - - description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. third_party_user_token: $ref: '#/components/schemas/ThirdPartyUserToken' CraCheckReportIncomeInsightsGetResponse: @@ -60551,7 +60550,6 @@ components: consumer_report_permissible_purpose: $ref: '#/components/schemas/ConsumerReportPermissiblePurpose' required: - - user_token - webhook - consumer_report_permissible_purpose - days_requested @@ -60603,9 +60601,9 @@ components: $ref: '#/components/schemas/UserToken' user_id: x-hidden-from-docs: true + description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. allOf: - $ref: '#/components/schemas/NewUserID' - - description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. third_party_user_token: $ref: '#/components/schemas/ThirdPartyUserToken' partner_insights: @@ -61067,9 +61065,9 @@ components: $ref: '#/components/schemas/UserToken' user_id: x-hidden-from-docs: true + description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. allOf: - $ref: '#/components/schemas/NewUserID' - - description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. third_party_user_token: $ref: '#/components/schemas/ThirdPartyUserToken' options: @@ -61087,9 +61085,9 @@ components: $ref: '#/components/schemas/UserToken' user_id: x-hidden-from-docs: true + description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. allOf: - $ref: '#/components/schemas/NewUserID' - - description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. third_party_user_token: $ref: '#/components/schemas/ThirdPartyUserToken' options: @@ -61146,7 +61144,6 @@ components: title: CraCheckReportNetworkInsightsGetOptions type: object nullable: true - x-hidden-from-docs: true description: Defines configuration options to generate Network Insights properties: network_insights_version: @@ -61321,9 +61318,9 @@ components: $ref: '#/components/schemas/UserToken' user_id: x-hidden-from-docs: true + description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. allOf: - $ref: '#/components/schemas/NewUserID' - - description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. options: $ref: '#/components/schemas/CraCheckReportNetworkInsightsGetOptions' third_party_user_token: @@ -61411,9 +61408,9 @@ components: $ref: '#/components/schemas/UserToken' user_id: x-hidden-from-docs: true + description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. allOf: - $ref: '#/components/schemas/NewUserID' - - description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. required: - reports_requested CraCheckReportVerificationGetReportType: @@ -61475,9 +61472,9 @@ components: $ref: '#/components/schemas/ThirdPartyUserToken' user_id: x-hidden-from-docs: true + description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. allOf: - $ref: '#/components/schemas/NewUserID' - - description: A unique ID generated by Plaid representing the end user. Typically, this ID will come from the `/user/create` response, when the endpoint is invoked with the `with_upgraded_user` request field set to `true`. If this field is included, then the `user_token` object field is ignored. report_type: $ref: '#/components/schemas/CraCheckReportVerificationPdfReportType' required: @@ -66238,9 +66235,9 @@ components: amount: $ref: '#/components/schemas/ProtectIncidentAmount' access_token: + description: An access token associated with the Item related to this incident. allOf: - $ref: '#/components/schemas/AccessTokenNullable' - - description: An access token associated with the Item related to this incident. ProtectIncidentEventResponse: nullable: true type: object diff --git a/CHANGELOG.md b/CHANGELOG.md index daac92b..09ffe60 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,15 @@ +### 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`