diff --git a/2020-09-14.yml b/2020-09-14.yml index e1a3209..122cdab 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.664.0 + version: 2020-09-14_1.667.0 description: The Plaid REST API. Please see https://plaid.com/docs/api for more details. contact: name: Plaid Developer Team @@ -591,31 +591,881 @@ paths: income: income_sources: - income_source_id: f17efbdd-caab-4278-8ece-963511cd3d51 - income_description: “PLAID_INC_DIRECT_DEP_PPD” + income_description: PLAID_INC_DIRECT_DEP_PPD income_category: SALARY last_transaction_date: "2023-03-30" forecasted_monthly_income: - baseline_amount: 10000 current_amount: 12000 total_monthly_income: - baseline_amount: 10770.93 current_amount: 20000.31 historical_annual_income: - baseline_amount: 120000 current_amount: 144000 income_sources_counts: - baseline_count: 1 current_count: 1 loans: loan_payments_counts: - baseline_count: 1 current_count: 1 loan_payment_merchants_counts: - baseline_count: 1 current_count: 1 loan_disbursements_count: 1 + accounts: + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + attributes: + total_inflow_amount: + amount: -2500 + iso_currency_code: USD + unofficial_currency_code: null + total_inflow_amount_30d: + amount: -1000 + iso_currency_code: USD + unofficial_currency_code: null + total_inflow_amount_60d: + amount: -2500 + iso_currency_code: USD + unofficial_currency_code: null + total_inflow_amount_90d: + amount: -2500 + iso_currency_code: USD + unofficial_currency_code: null + total_outflow_amount: + amount: 2500 + iso_currency_code: USD + unofficial_currency_code: null + total_outflow_amount_30d: + amount: 1000 + iso_currency_code: USD + unofficial_currency_code: null + total_outflow_amount_60d: + amount: 2500 + iso_currency_code: USD + unofficial_currency_code: null + total_outflow_amount_90d: + amount: 2500 + iso_currency_code: USD + unofficial_currency_code: null + balances: + available: 5000 + average_balance: 4956.12 + average_monthly_balances: + - average_balance: + amount: 4956.12 + iso_currency_code: USD + unofficial_currency_code: null + end_date: "2024-07-31" + start_date: "2024-07-01" + current: 5000 + iso_currency_code: USD + limit: null + most_recent_thirty_day_average_balance: 4956.125 + unofficial_currency_code: null + consumer_disputes: [] + days_available: 365 + mask: "1208" + metadata: + start_date: "2024-01-01" + end_date: "2024-07-16" + name: Checking + official_name: Plaid checking + owners: + - addresses: + - data: + city: Malakoff + country: US + postal_code: "14236" + region: NY + street: 2992 Cameron Road + primary: true + - data: + city: San Matias + country: US + postal_code: 93405-2255 + region: CA + street: 2493 Leisure Lane + primary: false + emails: + - data: accountholder0@example.com + primary: true + type: primary + - data: accountholder1@example.com + primary: false + type: secondary + - data: extraordinarily.long.email.username.123456@reallylonghostname.com + primary: false + type: other + names: + - Alberta Bobbeth Charleson + phone_numbers: + - data: +1 111-555-3333 + primary: false + type: home + - data: +1 111-555-4444 + primary: false + type: work + - data: +1 111-555-5555 + primary: false + type: mobile + ownership_type: null + subtype: checking + transactions: + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 37.07 + check_number: null + credit_category: + detailed: GENERAL_MERCHANDISE_ONLINE_MARKETPLACES + primary: GENERAL_MERCHANDISE + date: "2024-07-12" + date_posted: "2024-07-12T00:00:00Z" + date_transacted: "2024-07-12" + iso_currency_code: USD + location: + address: null + city: null + country: null + lat: null + lon: null + postal_code: null + region: null + state: null + store_number: null + zip: null + merchant_name: Amazon + original_description: AMZN Mktp US*11111111 Amzn.com/bill WA AM + pending: false + transaction_id: XA7ZLy8rXzt7D3j9B6LMIgv5VxyQkAhbKjzmp + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 51.61 + check_number: null + credit_category: + detailed: DINING_DINING + primary: DINING + date: "2024-07-12" + date_posted: "2024-07-12T00:00:00Z" + date_transacted: "2024-07-12" + iso_currency_code: USD + location: + address: null + city: null + country: null + lat: null + lon: null + postal_code: null + region: null + state: null + store_number: null + zip: null + merchant_name: Domino's + original_description: DOMINO's XXXX 111-222-3333 + pending: false + transaction_id: VEPeMbWqRluPVZLQX4MDUkKRw41Ljzf9gyLBW + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 7.55 + check_number: null + credit_category: + detailed: GENERAL_MERCHANDISE_FURNITURE_AND_HARDWARE + primary: GENERAL_MERCHANDISE + date: "2024-07-12" + date_posted: "2024-07-12T00:00:00Z" + date_transacted: "2024-07-12" + iso_currency_code: USD + location: + address: null + city: Chicago + country: null + lat: null + lon: null + postal_code: null + region: null + state: null + store_number: null + zip: null + merchant_name: IKEA + original_description: IKEA CHICAGO + pending: false + transaction_id: 6GQZARgvroCAE1eW5wpQT7w3oB6nvzi8DKMBa + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 12.87 + check_number: null + credit_category: + detailed: GENERAL_MERCHANDISE_SPORTING_GOODS + primary: GENERAL_MERCHANDISE + date: "2024-07-12" + date_posted: "2024-07-12T00:00:00Z" + date_transacted: "2024-07-12" + iso_currency_code: USD + location: + address: null + city: Redlands + country: null + lat: null + lon: null + postal_code: null + region: CA + state: CA + store_number: null + zip: null + merchant_name: Nike + original_description: NIKE REDLANDS CA + pending: false + transaction_id: DkbmlP8BZxibzADqNplKTeL8aZJVQ1c3WR95z + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 44.21 + check_number: null + credit_category: + detailed: DINING_DINING + primary: DINING + date: "2024-07-12" + date_posted: "2024-07-12T00:00:00Z" + date_transacted: "2024-07-12" + iso_currency_code: USD + location: + address: null + city: null + country: null + lat: null + lon: null + postal_code: null + region: null + state: null + store_number: null + zip: null + merchant_name: null + original_description: POKE BROS * POKE BRO IL + pending: false + transaction_id: RpdN7W8GmRSdjZB9Jm7ATj4M86vdnktapkrgL + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 36.82 + check_number: null + credit_category: + detailed: GENERAL_MERCHANDISE_DISCOUNT_STORES + primary: GENERAL_MERCHANDISE + date: "2024-07-13" + date_posted: "2024-07-13T00:00:00Z" + date_transacted: "2024-07-13" + iso_currency_code: USD + location: + address: null + city: null + country: null + lat: null + lon: null + postal_code: null + region: null + state: null + store_number: null + zip: null + merchant_name: Family Dollar + original_description: FAMILY DOLLAR + pending: false + transaction_id: 5AeQWvo5KLtAD9wNL68PTdAgPE7VNWf5Kye1G + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 13.27 + check_number: null + credit_category: + detailed: FOOD_RETAIL_GROCERIES + primary: FOOD_RETAIL + date: "2024-07-13" + date_posted: "2024-07-13T00:00:00Z" + date_transacted: "2024-07-13" + iso_currency_code: USD + location: + address: null + city: null + country: null + lat: null + lon: null + postal_code: null + region: null + state: null + store_number: null + zip: null + merchant_name: Instacart + original_description: INSTACART HTTPSINSTACAR CA + pending: false + transaction_id: Jjlr3MEVg1HlKbdkZj39ij5a7eg9MqtB6MWDo + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 36.03 + check_number: null + credit_category: + detailed: DINING_DINING + primary: DINING + date: "2024-07-13" + date_posted: "2024-07-13T00:00:00Z" + date_transacted: "2024-07-13" + iso_currency_code: USD + location: + address: null + city: null + country: null + lat: null + lon: null + postal_code: null + region: null + state: null + store_number: null + zip: null + merchant_name: null + original_description: POKE BROS * POKE BRO IL + pending: false + transaction_id: kN9KV7yAZJUMPn93KDXqsG9MrpjlyLUL6Dgl8 + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 54.74 + check_number: null + credit_category: + detailed: FOOD_RETAIL_GROCERIES + primary: FOOD_RETAIL + date: "2024-07-13" + date_posted: "2024-07-13T00:00:00Z" + date_transacted: "2024-07-13" + iso_currency_code: USD + location: + address: null + city: Whittier + country: null + lat: null + lon: null + postal_code: null + region: CA + state: CA + store_number: null + zip: null + merchant_name: Smart & Final + original_description: POS SMART AND FINAL 111 WHITTIER CA + pending: false + transaction_id: lPvrweZAMqHDar43vwWKs547kLZVEzfpogGVJ + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 37.5 + check_number: null + credit_category: + detailed: DINING_DINING + primary: DINING + date: "2024-07-13" + date_posted: "2024-07-13T00:00:00Z" + date_transacted: "2024-07-13" + iso_currency_code: USD + location: + address: 1627 N 24th St + city: Phoenix + country: null + lat: null + lon: null + postal_code: "85008" + region: AZ + state: AZ + store_number: null + zip: "85008" + merchant_name: Taqueria El Guerrerense + original_description: TAQUERIA EL GUERRERO PHOENIX AZ + pending: false + transaction_id: wka74WKqngiyJ3pj7dl5SbpLGQBZqyCPZRDbP + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 41.42 + check_number: null + credit_category: + detailed: GENERAL_MERCHANDISE_ONLINE_MARKETPLACES + primary: GENERAL_MERCHANDISE + date: "2024-07-14" + date_posted: "2024-07-14T00:00:00Z" + date_transacted: "2024-07-14" + iso_currency_code: USD + location: + address: null + city: null + country: null + lat: null + lon: null + postal_code: null + region: null + state: null + store_number: null + zip: null + merchant_name: Amazon + original_description: AMZN Mktp US*11111111 Amzn.com/bill WA AM + pending: false + transaction_id: BBGnV4RkerHjn8WVavGyiJbQ95VNDaC4M56bJ + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: -1077.93 + check_number: null + credit_category: + detailed: INCOME_OTHER + primary: INCOME + date: "2024-07-14" + date_posted: "2024-07-14T00:00:00Z" + date_transacted: "2024-07-14" + iso_currency_code: USD + location: + address: null + city: null + country: null + lat: null + lon: null + postal_code: null + region: null + state: null + store_number: null + zip: null + merchant_name: Lyft + original_description: LYFT TRANSFER + pending: false + transaction_id: 3Ej78yKJlQu1Abw7xzo4U4JR6pmwzntZlbKDK + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 47.17 + check_number: null + credit_category: + detailed: FOOD_RETAIL_GROCERIES + primary: FOOD_RETAIL + date: "2024-07-14" + date_posted: "2024-07-14T00:00:00Z" + date_transacted: "2024-07-14" + iso_currency_code: USD + location: + address: null + city: Whittier + country: null + lat: null + lon: null + postal_code: null + region: CA + state: CA + store_number: null + zip: null + merchant_name: Smart & Final + original_description: POS SMART AND FINAL 111 WHITTIER CA + pending: false + transaction_id: rMzaBpJw8jSZRJQBabKdteQBwd5EaWc7J9qem + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 12.37 + check_number: null + credit_category: + detailed: FOOD_RETAIL_GROCERIES + primary: FOOD_RETAIL + date: "2024-07-14" + date_posted: "2024-07-14T00:00:00Z" + date_transacted: "2024-07-14" + iso_currency_code: USD + location: + address: null + city: Whittier + country: null + lat: null + lon: null + postal_code: null + region: CA + state: CA + store_number: null + zip: null + merchant_name: Smart & Final + original_description: POS SMART AND FINAL 111 WHITTIER CA + pending: false + transaction_id: zWPZjkmzynTyel89ZjExS59DV6WAaZflNBJ56 + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 44.18 + check_number: null + credit_category: + detailed: FOOD_RETAIL_GROCERIES + primary: FOOD_RETAIL + date: "2024-07-14" + date_posted: "2024-07-14T00:00:00Z" + date_transacted: "2024-07-14" + iso_currency_code: USD + location: + address: null + city: Portland + country: null + lat: null + lon: null + postal_code: null + region: OR + state: OR + store_number: "1111" + zip: null + merchant_name: Safeway + original_description: 'SAFEWAY #1111 PORTLAND OR 111111' + pending: false + transaction_id: K7qzx1nP8ptqgwaRMbxyI86XrqADMluRpkWx5 + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 45.37 + check_number: null + credit_category: + detailed: DINING_DINING + primary: DINING + date: "2024-07-14" + date_posted: "2024-07-14T00:00:00Z" + date_transacted: "2024-07-14" + iso_currency_code: USD + location: + address: null + city: null + country: null + lat: null + lon: null + postal_code: null + region: null + state: null + store_number: null + zip: null + merchant_name: Uber Eats + original_description: UBER EATS + pending: false + transaction_id: qZrdzLRAgNHo5peMdD9xIzELl3a1NvcgrPAzL + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 15.22 + check_number: null + credit_category: + detailed: GENERAL_MERCHANDISE_ONLINE_MARKETPLACES + primary: GENERAL_MERCHANDISE + date: "2024-07-15" + date_posted: "2024-07-15T00:00:00Z" + date_transacted: "2024-07-15" + iso_currency_code: USD + location: + address: null + city: null + country: null + lat: null + lon: null + postal_code: null + region: null + state: null + store_number: null + zip: null + merchant_name: Amazon + original_description: AMZN Mktp US*11111111 Amzn.com/bill WA AM + pending: false + transaction_id: NZzx4oRPkAHzyRekpG4PTZkWnBPqEyiy6pB1M + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 26.33 + check_number: null + credit_category: + detailed: DINING_DINING + primary: DINING + date: "2024-07-15" + date_posted: "2024-07-15T00:00:00Z" + date_transacted: "2024-07-15" + iso_currency_code: USD + location: + address: null + city: null + country: null + lat: null + lon: null + postal_code: null + region: null + state: null + store_number: null + zip: null + merchant_name: Domino's + original_description: DOMINO's XXXX 111-222-3333 + pending: false + transaction_id: x84eNArKbESz8Woden6LT3nvyogeJXc64Pp35 + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 39.8 + check_number: null + credit_category: + detailed: GENERAL_MERCHANDISE_DISCOUNT_STORES + primary: GENERAL_MERCHANDISE + date: "2024-07-15" + date_posted: "2024-07-15T00:00:00Z" + date_transacted: "2024-07-15" + iso_currency_code: USD + location: + address: null + city: null + country: null + lat: null + lon: null + postal_code: null + region: null + state: null + store_number: null + zip: null + merchant_name: Family Dollar + original_description: FAMILY DOLLAR + pending: false + transaction_id: dzWnyxwZ4GHlZPGgrNyxiMG7qd5jDgCJEz5jL + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 45.06 + check_number: null + credit_category: + detailed: FOOD_RETAIL_GROCERIES + primary: FOOD_RETAIL + date: "2024-07-15" + date_posted: "2024-07-15T00:00:00Z" + date_transacted: "2024-07-15" + iso_currency_code: USD + location: + address: null + city: null + country: null + lat: null + lon: null + postal_code: null + region: null + state: null + store_number: null + zip: null + merchant_name: Instacart + original_description: INSTACART HTTPSINSTACAR CA + pending: false + transaction_id: 4W7eE9rZqMToDArbPeLNIREoKpdgBMcJbVNQD + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 34.91 + check_number: null + credit_category: + detailed: FOOD_RETAIL_GROCERIES + primary: FOOD_RETAIL + date: "2024-07-15" + date_posted: "2024-07-15T00:00:00Z" + date_transacted: "2024-07-15" + iso_currency_code: USD + location: + address: null + city: Whittier + country: null + lat: null + lon: null + postal_code: null + region: CA + state: CA + store_number: null + zip: null + merchant_name: Smart & Final + original_description: POS SMART AND FINAL 111 WHITTIER CA + pending: false + transaction_id: j4yqDjb7QwS7woGzqrgDIEG1NaQVZwf6Wmz3D + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 49.78 + check_number: null + credit_category: + detailed: FOOD_RETAIL_GROCERIES + primary: FOOD_RETAIL + date: "2024-07-15" + date_posted: "2024-07-15T00:00:00Z" + date_transacted: "2024-07-15" + iso_currency_code: USD + location: + address: null + city: Portland + country: null + lat: null + lon: null + postal_code: null + region: OR + state: OR + store_number: "1111" + zip: null + merchant_name: Safeway + original_description: 'SAFEWAY #1111 PORTLAND OR 111111' + pending: false + transaction_id: aqgWnze7xoHd6DQwLPnzT5dgPKjB1NfZ5JlBy + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 54.24 + check_number: null + credit_category: + detailed: FOOD_RETAIL_GROCERIES + primary: FOOD_RETAIL + date: "2024-07-15" + date_posted: "2024-07-15T00:00:00Z" + date_transacted: "2024-07-15" + iso_currency_code: USD + location: + address: null + city: Portland + country: null + lat: null + lon: null + postal_code: null + region: OR + state: OR + store_number: "1111" + zip: null + merchant_name: Safeway + original_description: 'SAFEWAY #1111 PORTLAND OR 111111' + pending: false + transaction_id: P13aP8b7nmS3WQoxg1PMsdvMK679RNfo65B4G + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 41.79 + check_number: null + credit_category: + detailed: GENERAL_MERCHANDISE_ONLINE_MARKETPLACES + primary: GENERAL_MERCHANDISE + date: "2024-07-16" + date_posted: "2024-07-16T00:00:00Z" + date_transacted: "2024-07-16" + iso_currency_code: USD + location: + address: null + city: null + country: null + lat: null + lon: null + postal_code: null + region: null + state: null + store_number: null + zip: null + merchant_name: Amazon + original_description: AMZN Mktp US*11111111 Amzn.com/bill WA AM + pending: false + transaction_id: 7nZMG6pXz8SADylMqzx7TraE4qjJm7udJyAGm + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 33.86 + check_number: null + credit_category: + detailed: FOOD_RETAIL_GROCERIES + primary: FOOD_RETAIL + date: "2024-07-16" + date_posted: "2024-07-16T00:00:00Z" + date_transacted: "2024-07-16" + iso_currency_code: USD + location: + address: null + city: null + country: null + lat: null + lon: null + postal_code: null + region: null + state: null + store_number: null + zip: null + merchant_name: Instacart + original_description: INSTACART HTTPSINSTACAR CA + pending: false + transaction_id: MQr3ap7PWEIrQG7bLdaNsxyBV7g1KqCL6pwoy + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 27.08 + check_number: null + credit_category: + detailed: DINING_DINING + primary: DINING + date: "2024-07-16" + date_posted: "2024-07-16T00:00:00Z" + date_transacted: "2024-07-16" + iso_currency_code: USD + location: + address: null + city: null + country: null + lat: null + lon: null + postal_code: null + region: null + state: null + store_number: null + zip: null + merchant_name: null + original_description: POKE BROS * POKE BRO IL + pending: false + transaction_id: eBAk9dvwNbHPZpr8W69dU3rekJz47Kcr9BRwl + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 25.94 + check_number: null + credit_category: + detailed: GENERAL_MERCHANDISE_FURNITURE_AND_HARDWARE + primary: GENERAL_MERCHANDISE + date: "2024-07-16" + date_posted: "2024-07-16T00:00:00Z" + date_transacted: "2024-07-16" + iso_currency_code: USD + location: + address: null + city: null + country: null + lat: null + lon: null + postal_code: null + region: null + state: null + store_number: null + zip: null + merchant_name: The Home Depot + original_description: THE HOME DEPOT + pending: false + transaction_id: QLx4jEJZb9SxRm7aWbjAio3LrgZ5vPswm64dE + unofficial_currency_code: null + - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E + account_owner: null + amount: 27.57 + check_number: null + credit_category: + detailed: GENERAL_MERCHANDISE_OTHER_GENERAL_MERCHANDISE + primary: GENERAL_MERCHANDISE + date: "2024-07-16" + date_posted: "2024-07-16T00:00:00Z" + date_transacted: "2024-07-16" + iso_currency_code: USD + location: + address: null + city: null + country: null + lat: null + lon: null + postal_code: null + region: null + state: null + store_number: null + zip: null + merchant_name: null + original_description: The Press Club + pending: false + transaction_id: ZnQ1ovqBldSQ6GzRbroAHLdQP68BrKceqmAjX + unofficial_currency_code: null + type: depository request_id: m8MDnv9okwxFNBV - description: This endpoint allows you to retrieve a Monitoring Insights report by passing in the `user_token` referred to in the webhook you received. + description: This endpoint allows you to retrieve a Cash Flow Updates report by passing in the `user_token` referred to in the webhook you received. /credit/audit_copy_token/update: post: tags: @@ -1004,6 +1854,39 @@ paths: report: date_generated: "2024-07-16T01:52:42.912331716Z" days_requested: 365 + attributes: + total_inflow_amount: + amount: -2500 + iso_currency_code: USD + unofficial_currency_code: null + total_inflow_amount_30d: + amount: -1000 + iso_currency_code: USD + unofficial_currency_code: null + total_inflow_amount_60d: + amount: -2500 + iso_currency_code: USD + unofficial_currency_code: null + total_inflow_amount_90d: + amount: -2500 + iso_currency_code: USD + unofficial_currency_code: null + total_outflow_amount: + amount: 2500 + iso_currency_code: USD + unofficial_currency_code: null + total_outflow_amount_30d: + amount: 1000 + iso_currency_code: USD + unofficial_currency_code: null + total_outflow_amount_60d: + amount: 2500 + iso_currency_code: USD + unofficial_currency_code: null + total_outflow_amount_90d: + amount: 2500 + iso_currency_code: USD + unofficial_currency_code: null items: - accounts: - account_id: NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E @@ -2069,10 +2952,6 @@ paths: report: report_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D generated_time: "2022-01-31T22:47:53Z" - plaid_check_score: - score: 80 - reason_codes: - - Balance Volatility attributes: cash_reliance_atm_withdrawal_amt_cv_90d: 180.1 default: @@ -2094,10 +2973,10 @@ paths: application/json: schema: $ref: '#/components/schemas/CraCheckReportCashflowInsightsGetRequest' - /cra/check_report/plaid_credit_score/get: + /cra/check_report/lend_score/get: x-hidden-from-docs: true post: - summary: Retrieve the plaid credit score from your user's banking data + summary: Retrieve the lend score from your user's banking data tags: - plaid responses: @@ -2106,7 +2985,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CraCheckReportPlaidCreditScoreGetResponse' + $ref: '#/components/schemas/CraCheckReportLendScoreGetResponse' examples: example-1: value: @@ -2114,7 +2993,7 @@ paths: report: report_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D generated_time: "2022-01-31T22:47:53Z" - plaid_credit_score: + lend_score: score: 80 reason_codes: - Balance Volatility @@ -2125,18 +3004,18 @@ paths: schema: $ref: '#/components/schemas/PlaidError' externalDocs: - url: /api/products/check/#cracheck_reportplaid_credit_scoreget - operationId: craCheckReportPlaidCreditScoreGet + url: /api/products/check/#cracheck_reportlend_scoreget + operationId: craCheckReportLendScoreGet description: |- - This endpoint allows you to retrieve the Plaid Credit Score report for your user. You should call this endpoint after you've received the `CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn’t have sufficient data to generate the insights, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. + This endpoint allows you to retrieve the Lend Score report for your user. You should call this endpoint after you've received the `CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn’t have sufficient data to generate the insights, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. - If you did not initialize Link with the `cra_plaid_credit_score` product or call `/cra/check_report/create` with the `cra_plaid_credit_score` product, we will generate the insights when you call this endpoint. In this case, you may optionally provide parameters under `options` to configure which insights you want to receive. + If you did not initialize Link with the `cra_lend_score` product or call `/cra/check_report/create` with the `cra_lend_score` product, we will generate the insights when you call this endpoint. In this case, you may optionally provide parameters under `options` to configure which insights you want to receive. requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/CraCheckReportPlaidCreditScoreGetRequest' + $ref: '#/components/schemas/CraCheckReportLendScoreGetRequest' /cra/check_report/network_insights/get: post: summary: Retrieve network attributes for the user @@ -2207,7 +3086,7 @@ paths: days_requested: 90 attributes: total_inflow_amount: - amount: 345.12 + amount: -345.12 iso_currency_code: USD unofficial_currency_code: null total_outflow_amount: @@ -2720,7 +3599,7 @@ paths: externalDocs: url: /api/consent/#consenteventsget operationId: consentEventsGet - description: List a historical log of Item consent events. Consent logs are only available for events occurring on or after November 7, 2024. Up to three years of consent logs will be available via the endpoint. + description: List a historical log of Item consent events. Consent logs are only available for events occurring on or after November 7, 2024. Extremely recent events (occurring within the past 12 hours) may not be available via this endpoint. Up to three years of consent logs will be available via the endpoint. responses: "200": description: OK @@ -2995,7 +3874,7 @@ paths: - identity - transactions consented_data_scopes: - - account_and_balance_info + - account_balance_info - contact_info - transactions consented_use_cases: @@ -3031,7 +3910,7 @@ paths: externalDocs: url: /api/products/layer/#user_accountsessionget operationId: userAccountSessionGet - description: Returns user permissioned account data including identity and Item access tokens. + description: This endpoint returns user permissioned account data, including identity and Item access tokens, for use with [Plaid Layer](https://plaid.com/docs/layer). Note that end users are permitted to edit the prefilled identity data in the Link flow before sharing it with you; you should treat any identity data returned by this endpoint as user-submitted, unverified data. For a verification layer, you can add [Identity Verification](https://plaid.com/docs/identity-verification/) to your flow, or check the submitted identity data against bank account data from linked accounts using [Identity Match](https://plaid.com/docs/identity/#identity-match). responses: "200": description: success @@ -3502,7 +4381,7 @@ paths: As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. - `/transactions/refresh` is offered as an optional add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. + `/transactions/refresh` is offered as an optional add-on to Transactions and has a separate [fee model](https://plaid.com/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. requestBody: required: true content: @@ -5251,14 +6130,15 @@ paths: security: [] tags: - plaid - summary: Get categories + summary: (Deprecated) Get legacy categories + deprecated: true externalDocs: url: /api/products/transactions/#categoriesget operationId: categoriesGet description: |- - Send a request to the `/categories/get` endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication. + Send a request to the `/categories/get` endpoint to get detailed information on legacy categories returned by Plaid. This endpoint does not require authentication. - All implementations are recommended to use the newer `personal_finance_category` taxonomy instead of the older `category` taxonomy supported by this endpoint. The [`personal_finance_category taxonomy` CSV file](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) is available for download and is not accessible via API. + All implementations are recommended to [use the newer `personal_finance_category` taxonomy](https://plaid.com/docs/transactions/pfc-migration/) instead of the legacy `category` taxonomy supported by this endpoint. The [`personal_finance_category taxonomy` CSV file](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) is available for download and is not accessible via API. responses: "200": description: success @@ -5395,7 +6275,7 @@ paths: `USER_PERMISSION_REVOKED`: Indicates an end user has revoked the permission that they previously granted to access an Item. May not always fire upon revocation, as some institutions’ consent portals do not trigger this webhook. Upon receiving this webhook, it is recommended to delete any stored data from Plaid associated with the account or Item. - `USER_ACCOUNT_REVOKED`: Fired when an end user has revoked access to their account on the Data Provider's portal. This webhook is currently sent only for Chase and PNC Items, but may be sent in the future for other financial institutions. Upon receiving this webhook, it is recommended to delete any stored data from Plaid associated with the account or Item. + `USER_ACCOUNT_REVOKED`: Fired when an end user has revoked access to their account on the Data Provider's portal. This webhook is currently sent only for PNC Items, but may be sent in the future for other financial institutions. Upon receiving this webhook, it is recommended to delete any stored data from Plaid associated with the account or Item. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production (except for webhooks of type `TRANSFER`). responses: @@ -5967,7 +6847,7 @@ paths: As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. - `/identity/refresh` is offered as an add-on to Identity and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. + `/identity/refresh` is offered as an add-on to Identity and has a separate [fee model](https://plaid.com/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. requestBody: required: true content: @@ -9272,7 +10152,7 @@ paths: As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. - `/processor/transactions/refresh` is offered as an add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. + `/processor/transactions/refresh` is offered as an add-on to Transactions and has a separate [fee model](https://plaid.com/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. requestBody: required: true content: @@ -9424,7 +10304,7 @@ paths: description: |- Use `/processor/signal/evaluate` to evaluate a planned ACH transaction as a processor to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. - In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If `/processor/signal/evaluate` is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to our error documentation on [item errors](/docs/errors/item/) and [Link in Update Mode](/docs/link/update-mode/). + In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If `/processor/signal/evaluate` is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to our error documentation on [item errors](https://plaid.com/docs/errors/item/) and [Link in Update Mode](https://plaid.com/docs/link/update-mode/). Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time. To reduce this latency, you can call `/signal/prepare` on the Item before you need to request Signal data. responses: @@ -10712,6 +11592,71 @@ paths: $ref: '#/components/schemas/UserCreateRequest' parameters: - $ref: '#/components/parameters/PlaidNewUserApiEnabledHeader' + /user/get: + x-hidden-from-docs: true + post: + tags: + - plaid + summary: Retrieve user identity and information. + externalDocs: + url: /api/users/#userget + operationId: userGet + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/UserGetResponse' + examples: + example-1: + value: + user_id: usr_8c6ZbDAYjacUXF + client_user_id: uid_12345 + created_at: "2019-02-15T15:51:39Z" + updated_at: "2019-02-15T15:52:39Z" + request_id: m8MDnv9okwxFNBV + identity: + name: + given_name: Alice + family_name: Johnson + date_of_birth: "1988-07-22" + emails: + - data: alice.johnson@example.com + primary: true + - data: alice.j@workmail.com + primary: false + phone_numbers: + - data: "+15551234567" + primary: true + - data: "+15559876543" + primary: false + addresses: + - street_1: 123 Main St + street_2: Apt 4B + city: Anytown + region: CA + country: US + postal_code: "90210" + primary: true + id_numbers: + - value: "1234" + type: us_ssn_last_4 + default: + description: Error response. + content: + application/json: + schema: + $ref: '#/components/schemas/PlaidError' + description: Retrieve user identity and information using a Plaid generated user ID. This endpoint returns user details including the most recent Identity object that was added to the given User. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UserGetRequest' + parameters: + - $ref: '#/components/parameters/PlaidNewUserApiEnabledHeader' /user/update: post: tags: @@ -10738,6 +11683,8 @@ paths: application/json: schema: $ref: '#/components/schemas/UserUpdateRequest' + parameters: + - $ref: '#/components/parameters/PlaidNewUserApiEnabledHeader' /user/remove: post: tags: @@ -10825,6 +11772,7 @@ paths: schema: $ref: '#/components/schemas/UserItemsGetRequest' /user/items/list: + x-hidden-from-docs: true post: tags: - plaid @@ -10881,6 +11829,7 @@ paths: schema: $ref: '#/components/schemas/UserItemsListRequest' /user/items/associate: + x-hidden-from-docs: true post: tags: - plaid @@ -11720,7 +12669,7 @@ paths: As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. - `/investments/refresh` is offered as an add-on to Investments and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. + `/investments/refresh` is offered as an add-on to Investments and has a separate [fee model](https://plaid.com/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. requestBody: required: true content: @@ -12008,7 +12957,7 @@ paths: processor_token: processor-sandbox-0asd1-a92nc request_id: xrQNYZ7Zoh6R7gV operationId: processorTokenCreate - description: Used to create a token suitable for sending to one of Plaid's partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see `/processor/stripe/bank_account_token/create` for creating tokens for use with Stripe integrations. If using multiple processors, multiple different processor tokens can be created for a single access token. Once created, a processor token for a given Item cannot be modified or updated. To revoke the processor's access, the entire Item must be deleted by calling `/item/remove`. + description: Used to create a token suitable for sending to one of Plaid's partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see `/processor/stripe/bank_account_token/create` for creating tokens for use with Stripe integrations. If using multiple processors, multiple different processor tokens can be created for a single access token. Once created, a processor token for a given Item can be modified by calling `/processor/token/permissions/set`. To revoke the processor's access, the entire Item must be deleted by calling `/item/remove`. requestBody: required: true content: @@ -12416,6 +13365,7 @@ paths: name: Citizens Bank public_token: public-sandbox-44ba202e-bf6b-45c6-a5ba-d526765626a9 cra_item_add_results: [] + cra_update_results: [] bank_income_results: [] payroll_income_results: [] document_income_results: null @@ -12492,12 +13442,7 @@ paths: link_token: link-sandbox-af1a0311-da53-4636-b754-dd15cc058176 expiration: "2020-03-27T12:56:34Z" request_id: XQVgFigpGHXkb0b - description: |- - Any Plaid experience a user sees such as connecting a bank account, verifying identity, or sharing a credit report is considered a session. Today, most sessions happen through Link and the token to start these Link session is a link token created and configured via `link/token/create`. - Sessions are a higher level abstraction where configuration primarily happens in Plaid Dashboard. - Depending on the template id provided, the session may a Link session, specified by a Link token, or may be another experience in the future. A primary benefit is that configuration changes can be done in Dashboard with no code changes required. - - Currently, this endpoint is only supported for Layer templates and Link but is reserved in the future to initialize other end-user Plaid experiences. The returned Link token is used as an parameter when initializing the Link SDK. For more details, see the [Link flow overview](https://plaid.com/docs/link/#link-flow-overview). + description: '`/session/token/create` is used to create a Link token for Layer. The returned Link token is used as an parameter when initializing the Link SDK. For more details, see the [Link flow overview](https://plaid.com/docs/link/#link-flow-overview).' requestBody: required: true content: @@ -13887,7 +14832,7 @@ paths: application/json: schema: $ref: '#/components/schemas/TransferEventSyncRequest' - description: '`/transfer/event/sync` allows you to request up to the next 25 transfer events that happened after a specific `event_id`. Use the `/transfer/event/sync` endpoint to guarantee you have seen all transfer events.' + description: '`/transfer/event/sync` allows you to request up to the next 500 transfer events that happened after a specific `event_id`. Use the `/transfer/event/sync` endpoint to guarantee you have seen all transfer events.' /bank_transfer/event/sync: post: summary: Sync bank transfer events @@ -14708,10 +15653,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PlaidError' - description: |- - Use the `/transfer/refund/create` endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days. - - Refunds come out of the available balance of the ledger used for the original debit transfer. If there are not enough funds in the available balance to cover the refund amount, the refund will be rejected. You can create a refund at any time. Plaid does not impose any hold time on refunds. + description: "Use the `/transfer/refund/create` endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days.\n\nRefunds come out of the available balance of the ledger used for the original debit transfer. If there are not enough funds in the available balance to cover the refund amount, the refund will be rejected. You can create a refund at any time. Plaid does not impose any hold time on refunds.\n\nA refund can still be issued even if the Item's `access_token` is no longer valid (e.g. if the user revoked OAuth consent or the Item was deleted via `/item/remove`), as long as the account and routing number pair used to make the original transaction is still valid. A refund cannot be issued if the Item has an [invalidated TAN](https://plaid.com/docs/auth/#tokenized-account-numbers), which can occur at Chase or PNC. " requestBody: required: true content: @@ -17561,7 +18503,7 @@ paths: description: |- Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. - In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If `/signal/evaluate` is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to the error documentation on [Item errors](/docs/errors/item/) and [Link in Update Mode](/docs/link/update-mode/). + In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If `/signal/evaluate` is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to the error documentation on [Item errors](https://plaid.com/docs/errors/item/) and [Link in Update Mode](https://plaid.com/docs/link/update-mode/). Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time. responses: @@ -18882,6 +19824,18 @@ paths: production: ENABLED production_enablement_date: "2022-12-19" classic_disablement_date: null + - name: Bank of America + institution_id: ins_1 + environments: + production: ATTENTION_REQUIRED + production_enablement_date: null + classic_disablement_date: null + errors: + - error_type: PARTNER_ERROR + error_code: OAUTH_REGISTRATION_ERROR + error_message: Application logo is required + display_message: null + request_id: 4zlKapIkTm8p5KM request_id: 4zlKapIkTm8p5KM default: description: Error response @@ -19804,7 +20758,10 @@ components: properties: historical_balances: type: array - description: Calculated data about the historical balances on the account. + description: |- + Calculated data about the historical balances on the account. + + Available for `credit` and `depository` type accounts. items: $ref: '#/components/schemas/CashflowReportHistoricalBalance' monthly_summaries: @@ -20556,7 +21513,7 @@ components: properties: products: type: array - description: Filter the Institutions based on which products they support. Will only return institutions that support all listed products. When filtering based on `auth`, an institution must support Instant Auth to match the criterion. + description: Filter the Institutions based on which products they support. Will only return institutions that support all listed products. When filtering based on `auth`, an institution must support Instant Auth to match the criterion. To filter for Signal support, use `balance`. To filter for Transfer support, use `auth`. nullable: true minItems: 1 items: @@ -20578,7 +21535,6 @@ components: - payment_initiation - standing_orders - transactions - - transfer routing_numbers: type: array description: Specify an array of routing numbers to filter institutions. The response will only return institutions that match all of the routing numbers in the array. Routing number records used for this matching are generally comprehensive; however, failure to match a given routing number to an institution does not necessarily mean that the institution is unsupported by Plaid. Invalid routing numbers (numbers that are not 9 digits in length or do not have a valid checksum) will be filtered from the array before the response is processed. If all provided routing numbers are invalid, an `INVALID_REQUEST` error with the code of `INVALID_FIELD` will be returned. @@ -20636,7 +21592,7 @@ components: minLength: 1 products: type: array - description: Filter the Institutions based on whether they support all products listed in `products`. Provide `null` to get institutions regardless of supported products. Note that when `auth` is specified as a product, if you are enabled for Instant Match or Automated Micro-deposits, institutions that support those products will be returned even if `auth` is not present in their product array. + description: Filter the Institutions based on whether they support all products listed in `products`. Provide `null` to get institutions regardless of supported products. Note that when `auth` is specified as a product, if you are enabled for Instant Match or Automated Micro-deposits, institutions that support those products will be returned even if `auth` is not present in their product array. To search for Transfer support, use `auth`; to search for Signal support, use `balance`. minItems: 1 nullable: true items: @@ -20655,7 +21611,6 @@ components: - standing_orders - statements - transactions - - transfer country_codes: type: array description: | @@ -22205,6 +23160,8 @@ components: minLength: 0 consumer_report_user_identity: $ref: '#/components/schemas/ConsumerReportUserIdentity' + identity: + $ref: '#/components/schemas/ClientUserIdentity' required: - client_user_id UserCreateResponse: @@ -22218,9 +23175,51 @@ components: $ref: '#/components/schemas/UserId' request_id: $ref: '#/components/schemas/RequestID' + identity_creation_result: + $ref: '#/components/schemas/IdentityCreationResult' required: - user_id - request_id + UserGetRequest: + type: object + description: UserGetRequest defines the request schema for `/user/get`. + properties: + client_id: + $ref: '#/components/schemas/APIClientID' + secret: + $ref: '#/components/schemas/APISecret' + user_id: + $ref: '#/components/schemas/NewUserID' + required: + - user_id + UserGetResponse: + type: object + additionalProperties: true + description: UserGetResponse defines the response schema for `/user/get`. + properties: + request_id: + $ref: '#/components/schemas/RequestID' + user_id: + $ref: '#/components/schemas/NewUserID' + client_user_id: + type: string + nullable: true + description: Client provided user ID. + created_at: + type: string + format: date-time + description: Timestamp of user creation. + updated_at: + type: string + format: date-time + description: Timestamp of last user update. + identity: + $ref: '#/components/schemas/ClientUserIdentity' + required: + - request_id + - user_id + - client_user_id + - created_at UserUpdateRequest: type: object description: UserUpdateRequest defines the request schema for `/user/update` @@ -22233,9 +23232,10 @@ components: $ref: '#/components/schemas/UserToken' consumer_report_user_identity: $ref: '#/components/schemas/ConsumerReportUserIdentity' - required: - - user_token - - consumer_report_user_identity + user_id: + $ref: '#/components/schemas/NewUserID' + identity: + $ref: '#/components/schemas/ClientUserIdentity' UserUpdateResponse: type: object additionalProperties: true @@ -22243,6 +23243,8 @@ components: properties: request_id: $ref: '#/components/schemas/RequestID' + identity_creation_result: + $ref: '#/components/schemas/IdentityCreationResult' required: - request_id UserRemoveRequest: @@ -22560,6 +23562,140 @@ components: - emails - date_of_birth - primary_address + ClientUserIdentityName: + type: object + description: User name information. + properties: + given_name: + type: string + description: User's given name. + family_name: + type: string + description: User's family name. + required: + - given_name + - family_name + ClientUserIdentityPhoneNumber: + type: object + description: User phone number information. + properties: + data: + type: string + description: User's phone number. + primary: + type: boolean + description: Indicates whether this is the primary phone number for the User. + required: + - data + - primary + ClientUserIdentityEmail: + type: object + description: User email information. + properties: + data: + type: string + description: User's email. + primary: + type: boolean + description: Indicates whether this is the primary email for the User. + required: + - data + - primary + ClientUserIdentityAddress: + type: object + description: User address information. + properties: + street_1: + type: string + description: First line of street address. + street_2: + type: string + nullable: true + description: Second line of street address. + city: + type: string + description: City name. + region: + type: string + description: State, province or region. + country: + type: string + description: Country code. + postal_code: + type: string + description: Postal or ZIP code. + primary: + type: boolean + description: Indicates whether this is the primary address for the User. + required: + - street_1 + - city + - region + - country + - postal_code + - primary + ClientUserIdentity: + type: object + nullable: true + x-hidden-from-docs: true + additionalProperties: true + description: ClientUserIdentity is the shared user identity construct across /user/* routes. + properties: + name: + $ref: '#/components/schemas/ClientUserIdentityName' + date_of_birth: + description: The user's date of birth, to be provided in the format "yyyy-mm-dd". + type: string + nullable: true + format: date + emails: + description: The user's emails. + type: array + items: + $ref: '#/components/schemas/ClientUserIdentityEmail' + phone_numbers: + description: 'The user''s phone numbers, in E.164 format: +{countrycode}{number}. For example: "+14157452130". Phone numbers provided in other formats will be parsed on a best-effort basis. Phone number input is validated against valid number ranges; number strings that do not match a real-world phone numbering scheme may cause the request to fail, even in the Sandbox test environment.' + type: array + items: + $ref: '#/components/schemas/ClientUserIdentityPhoneNumber' + addresses: + type: array + description: The user's addresses. + items: + $ref: '#/components/schemas/ClientUserIdentityAddress' + id_numbers: + type: array + description: The user's ID numbers. + items: + $ref: '#/components/schemas/UserIDNumber' + IdentityCreationResultType: + type: string + description: The outcome of the identity creation operation. + enum: + - SUCCEEDED + - FAILED + - NOT_PROVIDED + IdentityCreationResult: + type: object + x-hidden-from-docs: true + description: The result of creating an identity, indicating success or failure with optional error details. + properties: + result: + $ref: '#/components/schemas/IdentityCreationResultType' + error_type: + allOf: + - $ref: '#/components/schemas/PlaidErrorType' + nullable: true + error_code: + type: string + description: Specific error code indicating the nature of the failure. Safe for programmatic use. + nullable: true + error_message: + type: string + description: Human-readable error message providing details about the failure. + nullable: true + required: + - result CreditSessionsGetRequest: type: object description: CreditSessionsGetRequest defines the request schema for `/credit/sessions/get` @@ -23155,7 +24291,7 @@ components: `UNAUTHORISED`: Consent created, but requires user authorisation. - `REJECTED`: Consent authorisation was rejected by the user and/or the bank. + `REJECTED`: Consent authorisation was rejected by the bank. `AUTHORISED`: Consent is active and ready to be used. @@ -23909,9 +25045,7 @@ components: - cra_income_insights - cra_partner_insights - cra_network_insights - - cra_cashflow_insights - cra_monitoring - - cra_plaid_credit_score - layer - protect_linked_bank nullable: true @@ -24032,7 +25166,7 @@ components: - $ref: '#/components/schemas/ConsumerReportPermissiblePurpose' - type: string description: |- - Describes the reason you are generating a Consumer Report for this user. This parameter is required if you want to generate a Consumer Report for the user automatically after the Link session. If you omit this parameter during Link token creation, you can later call the `/cra/check_report/create` endpoint to generate a report. + Describes the reason you are generating a Consumer Report for this user. This parameter is required when Plaid Check (CRA) products. If you omit this parameter during Link token creation, you must call the `/cra/check_report/create` endpoint to generate a report. If the Link session is not configured to use any Plaid Check (CRA) products, this parameter cannot be used and will cause an error if included. `ACCOUNT_REVIEW_CREDIT`: In connection with a consumer credit transaction for the review or collection of an account pursuant to FCRA Section 604(a)(3)(A). @@ -24092,7 +25226,7 @@ components: user_id: 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 PLAID-NEW-USER-API-ENABLED header. **Required** if the `user` object isn't included. If this field is included, then the remaining `user` object fields are ignored. + - 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 PLAID-NEW-USER-API-ENABLED header. **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 @@ -24210,7 +25344,7 @@ components: user_id: 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 PLAID-NEW-USER-API-ENABLED header. **Required** if the `user` object isn't included. If this field is included, then the remaining `user` object fields are ignored. + - 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 PLAID-NEW-USER-API-ENABLED header. **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: @@ -24253,7 +25387,7 @@ components: type: boolean default: false description: | - This indicates whether the client is opening hosted Link in a mobile app in an out of process web view (OOPWV) (i.e., an `AsWebAuthenticationSession` / `SFSafariViewController` or Android Custom Tab). + This indicates whether the client is opening hosted Link in a mobile app in an `AsWebAuthenticationSession` or Chrome custom tab. LinkTokenCreateIdentity: type: object description: Identity object used to specify document upload @@ -24719,6 +25853,11 @@ components: description: The set of Plaid Check Item adds for the Link session. items: $ref: '#/components/schemas/LinkSessionCraItemAddResult' + cra_update_results: + type: array + description: The set of Plaid Check Item updates for the Link session. + items: + $ref: '#/components/schemas/LinkSessionCraUpdateResult' bank_income_results: type: array description: The set of bank income verifications for the Link session. @@ -24738,6 +25877,7 @@ components: required: - item_add_results - cra_item_add_results + - cra_update_results - bank_income_results - payroll_income_results - document_income_results @@ -24779,6 +25919,25 @@ components: - item_id - accounts - institution + LinkSessionCraUpdateResult: + type: object + description: The details of a Plaid Check Item update via Update Mode in Link. + additionalProperties: true + properties: + item_id: + description: The Plaid Check Item ID. The `item_id` is always unique; linking the same account at the same institution twice will result in two Items with different `item_id` values. The `item_id` is case-sensitive. + type: string + accounts: + type: array + description: A list of accounts attached to the connected Item. If Account Select is enabled via the developer dashboard, `accounts` will only include selected accounts. + items: + $ref: '#/components/schemas/LinkSessionSuccessMetadataAccount' + institution: + $ref: '#/components/schemas/LinkSessionSuccessMetadataInstitution' + required: + - item_id + - accounts + - institution LinkSessionBankIncomeResult: type: object description: The details of a bank income verification in Link. @@ -24887,10 +26046,10 @@ components: description: The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts. It may also not match the mask that the bank displays to the user. type: type: string - description: The account type. See the [Account schema](/docs/api/accounts#account-type-schema) for a full list of possible values + description: The account type. See the [Account schema](https://plaid.com/docs/api/accounts#account-type-schema) for a full list of possible values subtype: type: string - description: The account subtype. See the [Account schema](/docs/api/accounts#account-type-schema) for a full list of possible values + description: The account subtype. See the [Account schema](https://plaid.com/docs/api/accounts#account-type-schema) for a full list of possible values verification_status: nullable: true type: string @@ -24931,10 +26090,10 @@ components: type: string nullable: true description: |- - The status of a transfer. Returned only when [Transfer UI](/docs/transfer/using-transfer-ui) is implemented. + The status of a transfer. Returned only when [Transfer UI](https://plaid.com/docs/transfer/using-transfer-ui) is implemented. - `COMPLETE` – The transfer was completed. - - `INCOMPLETE` – The transfer could not be completed. For help, see [Troubleshooting transfers](/docs/transfer/using-transfer-ui#troubleshooting-transfers). + - `INCOMPLETE` – The transfer could not be completed. For help, see [Troubleshooting transfers](https://plaid.com/docs/transfer/using-transfer-ui#troubleshooting-transfers). enum: - COMPLETE - INCOMPLETE @@ -26738,7 +27897,7 @@ components: description: The official name of the institution. products: type: array - description: A list of the Plaid products supported by the institution. Note that only institutions that support Instant Auth will return `auth` in the product array; institutions that do not list `auth` may still support other Auth methods such as Instant Match or Automated Micro-deposit Verification. To identify institutions that support those methods, use the `auth_metadata` object. For more details, see [Full Auth coverage](https://plaid.com/docs/auth/coverage/). The `income_verification` product here indicates support for Bank Income. + description: 'A list of the Plaid products supported by the institution. Note that only institutions that support Instant Auth will return `auth` in the product array; institutions that do not list `auth` may still support other Auth methods such as Instant Match or Automated Micro-deposit Verification. To identify institutions that support those methods, use the `auth_metadata` object. For more details, see [Full Auth coverage](https://plaid.com/docs/auth/coverage/). The `income_verification` product here indicates support for Bank Income. Note: For Signal and Transfer, listed institutions may be incomplete or incorrect. Instead, use the following: `balance` support also indicates coverage of Signal; `auth` support also indicates coverage of Transfer.' items: $ref: '#/components/schemas/Products' country_codes: @@ -29494,6 +30653,7 @@ components: - cra_network_insights - cra_cashflow_insights - cra_monitoring + - cra_lend_score - cra_plaid_credit_score - layer - pay_by_bank @@ -31003,7 +32163,7 @@ components: title: BankTransfersEventsUpdateWebhookForAuth type: object additionalProperties: true - description: Fired when new ACH events are available. To begin receiving this webhook, you must first register your webhook listener endpoint via the [webhooks page in the Dashboard](https://dashboard.plaid.com/team/webhooks). The `BANK_TRANSFERS_EVENTS_UPDATE` webhook can be used to track the progress of ACH transfers used in [micro-deposit verification](/docs/auth/coverage/microdeposit-events/). Receiving this webhook indicates you should fetch the new events from `/bank_transfer/event/sync`. Note that [Transfer](https://plaid.com/docs/transfer) customers should use Transfer webhooks instead of using `BANK_TRANSFERS_EVENTS_UPDATE`; see [micro-deposit events documentation](https://plaid.com/docs/auth/coverage/microdeposit-events/) for more details. + description: Fired when new ACH events are available. To begin receiving this webhook, you must first register your webhook listener endpoint via the [webhooks page in the Dashboard](https://dashboard.plaid.com/team/webhooks). The `BANK_TRANSFERS_EVENTS_UPDATE` webhook can be used to track the progress of ACH transfers used in [micro-deposit verification](https:///docs/auth/coverage/microdeposit-events/). Receiving this webhook indicates you should fetch the new events from `/bank_transfer/event/sync`. Note that [Transfer](https://plaid.com/docs/transfer) customers should use Transfer webhooks instead of using `BANK_TRANSFERS_EVENTS_UPDATE`; see [micro-deposit events documentation](https://plaid.com/docs/auth/coverage/microdeposit-events/) for more details. x-examples: example-1: webhook_type: BANK_TRANSFERS @@ -31049,7 +32209,7 @@ components: title: LayerAuthenticationPassedWebhook type: object additionalProperties: true - description: Fired when user authentication event occurs within Layer. Receiving this webhook indicates that Plaid's authentication process has completed for a user. + description: Indicates that Plaid's authentication process has completed for a user and that Plaid has verified that the user owns their phone number. If you receive this webhook, you should skip your own OTP phone number verification flow for the user, even if the user does not complete the entire Link flow. If the user doesn't complete the full Link flow, it is recommended that you implement [webhook verification](https://plaid.com/docs/api/webhooks/webhook-verification/) or another technique to avoid webhook spoofing attacks. x-examples: example-1: webhook_type: LAYER @@ -33272,9 +34432,10 @@ components: nullable: true expected_settlement_date: type: string - description: The date when settlement will occur between Plaid and the receiving bank (RDFI). For ACH debits, this is the date funds will be pulled from the bank account being debited. For ACH credits, this is the date funds will be delivered to the bank account being credited. Only set for ACH transfers; `null` for non-ACH transfers. This will be of the form YYYY-MM-DD. + description: Deprecated for Plaid Ledger clients, use `expected_funds_available_date` instead. format: date nullable: true + deprecated: true expected_funds_available_date: type: string description: The expected date when funds from a transfer will be made available and can be withdrawn from the associated ledger balance, assuming the debit does not return before this date. If the transfer does return before this date, this field will be null. Only applies to debit transfers. This will be of the form YYYY-MM-DD. @@ -34281,7 +35442,7 @@ components: For transfers submitted as `rtp`, Plaid will automatically route between Real Time Payment rail by TCH or FedNow rails as necessary. If a transfer is submitted as `rtp` and the counterparty account is not eligible for RTP, the `/transfer/authorization/create` request will fail with an `INVALID_FIELD` error code. To pre-check to determine whether a counterparty account can support RTP, call `/transfer/capabilities/get` before calling `/transfer/authorization/create`. - Wire transfers are currently in early availability. To request access to `wire` as a payment network, contact your Account Manager. For transfers submitted as `wire`, the `type` must be `credit`; wire debits are not supported. The cutoff to submit a wire payment is 4:30 PM Eastern Time on a business day; wires submitted after that time will be processed on the next business day. The transaction limit for a wire is $999,999.99. Authorization requests sent with an amount greater than $999,999.99 will fail. + Wire transfers are currently in early availability. To request access to `wire` as a payment network, contact your Account Manager. For transfers submitted as `wire`, the `type` must be `credit`; wire debits are not supported. The cutoff to submit a wire payment is 6:30 PM Eastern Time on a business day; wires submitted after that time will be processed on the next business day. The transaction limit for a wire is $999,999.99. Authorization requests sent with an amount greater than $999,999.99 will fail. enum: - ach - same-day-ach @@ -34519,7 +35680,7 @@ components: $ref: '#/components/schemas/TransferAmount' description: type: string - description: "The transfer description, maximum of 15 characters. Should represent why the money is moving, not your company name. For recommendations on setting the `description` field to avoid ACH returns, see [Description field recommendations](https://www.plaid.com/docs/transfer/creating-transfers/#description-field-recommendations). \n\nIf reprocessing a returned transfer, the `description` field must be `\"Retry 1\"` or `\"Retry 2\"`. You may retry a transfer up to 2 times, within 180 days of creating the original transfer. Only transfers that were returned with code `R01` or `R09` may be retried." + description: "The transfer description, maximum of 15 characters (RTP transactions) or 10 characters (ACH transactions). Should represent why the money is moving, not your company name. For recommendations on setting the `description` field to avoid ACH returns, see [Description field recommendations](https://www.plaid.com/docs/transfer/creating-transfers/#description-field-recommendations). \n\nIf reprocessing a returned transfer, the `description` field must be `\"Retry 1\"` or `\"Retry 2\"`. You may retry a transfer up to 2 times, within 180 days of creating the original transfer. Only transfers that were returned with code `R01` or `R09` may be retried." maxLength: 15 ach_class: x-hidden-from-docs: true @@ -35863,9 +37024,9 @@ components: minimum: 0 count: type: integer - default: 25 + default: 100 minimum: 1 - maximum: 25 + maximum: 500 description: The maximum number of transfer events to return. nullable: true required: @@ -38970,8 +40131,8 @@ components: $ref: '#/components/schemas/LinkTokenCreateRequestCraOptionsBaseReport' cashflow_insights: $ref: '#/components/schemas/LinkTokenCreateRequestCraOptionsCashflowInsights' - plaid_credit_score: - $ref: '#/components/schemas/LinkTokenCreateRequestCraOptionsPlaidCreditScore' + lend_score: + $ref: '#/components/schemas/LinkTokenCreateRequestCraOptionsLendScore' include_investments: type: boolean nullable: true @@ -39023,19 +40184,20 @@ 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: $ref: '#/components/schemas/PlaidCheckScoreVersion' attributes_version: $ref: '#/components/schemas/CashflowAttributesVersion' - LinkTokenCreateRequestCraOptionsPlaidCreditScore: - title: LinkTokenCreateRequestCraOptionsPlaidCreditScore + LinkTokenCreateRequestCraOptionsLendScore: + title: LinkTokenCreateRequestCraOptionsLendScore type: object x-hidden-from-docs: true - description: Specifies options for initializing Link for use with the Plaid Credit Score product. + description: Specifies options for initializing Link for use with the CRA Lend Score product. properties: - plaid_credit_score_version: + lend_score_version: $ref: '#/components/schemas/PlaidCheckScoreVersion' LinkTokenCreateRequestCreditPartnerInsights: title: LinkTokenCreateRequestCreditPartnerInsights @@ -43906,7 +45068,7 @@ components: items: type: string consented_data_scopes: - description: A list of strings containing the full list of data scopes the end user has consented to for the Item. These correspond to consented products; see the [full mapping](/docs/link/data-transparency-messaging-migration-guide/#data-scopes-by-product) of data scopes and products. + description: A list of strings containing the full list of data scopes the end user has consented to for the Item. These correspond to consented products; see the [full mapping](https://plaid.com/docs/link/data-transparency-messaging-migration-guide/#data-scopes-by-product) of data scopes and products. type: array items: type: string @@ -44130,10 +45292,10 @@ components: user_token: $ref: '#/components/schemas/UserToken' user_id: + x-hidden-from-docs: true 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 `PLAID-NEW-USER-API-ENABLED` header. If this field is included, then the `user_token` object field is ignored. - - 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 `PLAID-NEW-USER-API-ENABLED` header. 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. @@ -45937,7 +47099,7 @@ components: - cra_income_insights - cra_partner_insights create_link_customization: - description: If `true`, the end customer's default Link customization will be set to match the partner's. You can always change the end customer's Link customization in the Plaid Dashboard. See the [Link Customization docs](https://plaid.com/docs/link/customization/) for more information. + description: "If `true`, the end customer's default Link customization will be set to match the partner's. You can always change the end customer's Link customization in the Plaid Dashboard. See the [Link Customization docs](https://plaid.com/docs/link/customization/) for more information. If you require the ability to programmatically create end customers using multiple different Link customization profiles, contact your Plaid Account Manager for assistance. \n\nImportant: Data Transparency Messaging (DTM) use cases will not be copied to the end customer's Link customization unless the **Publish changes** button is clicked after the use cases are applied. Link will not work in Production unless the end customer's DTM use cases are configured. For more details, see [Data Transparency Messaging](https://plaid.com/docs/link/data-transparency-messaging-migration-guide/). " type: boolean logo: description: Base64-encoded representation of the end customer's logo. Must be a PNG of size 1024x1024 under 4MB. The logo will be shared with financial institutions and shown to the end user during Link flows. A logo is required if `create_link_customization` is `true`. If `create_link_customization` is `false` and the logo is omitted, the partner's logo will be used if one exists, otherwise a stock logo will be used. @@ -46110,6 +47272,11 @@ components: type: string description: The date on which non-OAuth Item adds will no longer be supported for this institution, or an empty string if no such date has been set by the institution. nullable: true + errors: + type: array + description: The errors encountered while registering the end customer's application with the institutions. + items: + $ref: '#/components/schemas/PlaidError' PartnerEndCustomerOAuthInstitutionEnvironments: description: Registration statuses by environment. type: object @@ -46468,7 +47635,7 @@ components: type: object additionalProperties: true description: |- - The `USER_ACCOUNT_REVOKED` webhook is fired when an end user has revoked access to their account on the Data Provider's portal. This webhook is currently sent only for Chase and PNC Items, but may be sent in the future for other financial institutions that allow account-level permissions revocation through their portals. Upon receiving this webhook, it is recommended to delete any Plaid-derived data you have stored that is associated with the revoked account. + The `USER_ACCOUNT_REVOKED` webhook is fired when an end user has revoked access to their account on the Data Provider's portal. This webhook is currently sent only for PNC Items, but may be sent in the future for other financial institutions that allow account-level permissions revocation through their portals. Upon receiving this webhook, it is recommended to delete any Plaid-derived data you have stored that is associated with the revoked account. If you are using Auth and receive this webhook, this webhook indicates that the TAN associated with the revoked account is no longer valid and cannot be used to create new transfers. You should not create new ACH transfers for the account that was revoked until access has been re-granted. @@ -46954,7 +48121,7 @@ components: - cra_partner_insights - cra_network_insights - cra_monitoring - - cra_plaid_credit_score + - cra_lend_score failed_products: type: array description: Specifies a list of products that have failed to generate for the report. Additional detail on what caused the failure can be found by calling the product /get endpoint. @@ -46968,7 +48135,7 @@ components: - cra_partner_insights - cra_network_insights - cra_monitoring - - cra_plaid_credit_score + - cra_lend_score item_ids: type: array items: @@ -47956,14 +49123,17 @@ components: $ref: '#/components/schemas/APISecret' user_token: $ref: '#/components/schemas/UserToken' + item_id: + type: string + description: The item ID to subscribe for Cash Flow Updates. user_id: + x-hidden-from-docs: true 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 `PLAID-NEW-USER-API-ENABLED` header. If this field is included, then the `user_token` object field is ignored. - - 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 `PLAID-NEW-USER-API-ENABLED` header. If this field is included, then the `user_token` object field is ignored. webhook: type: string - description: URL to which Plaid will send Monitoring Insights webhooks, for example when the requested Monitoring Insights is ready. + description: URL to which Plaid will send Cash Flow Updates webhooks, for example when the requested Cash Flow Updates report is ready. income_categories: type: array description: Income categories to include in Cash Flow Updates. If empty or `null`, this field will default to including all possible categories. @@ -48021,10 +49191,10 @@ components: user_token: $ref: '#/components/schemas/UserToken' user_id: + x-hidden-from-docs: true 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 `PLAID-NEW-USER-API-ENABLED` header. If this field is included, then the `user_token` object field is ignored. - - 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 `PLAID-NEW-USER-API-ENABLED` header. If this field is included, then the `user_token` object field is ignored. consumer_report_permissible_purpose: $ref: '#/components/schemas/MonitoringConsumerReportPermissiblePurpose' required: @@ -48177,12 +49347,14 @@ components: properties: baseline_amount: type: number + nullable: true + deprecated: true + x-hidden-from-docs: true description: The aggregated income for the 30 days prior to subscription date current_amount: type: number description: The aggregated income of the last 30 days required: - - baseline_amount - current_amount IncomeSourcesCounts: title: IncomeSourcesCounts @@ -48192,12 +49364,14 @@ components: properties: baseline_count: type: number + nullable: true + deprecated: true + x-hidden-from-docs: true description: The number of income sources detected at the subscription date current_count: type: number description: The number of income sources currently detected required: - - baseline_count - current_count MonitoringLoanInsights: title: MonitoringLoanInsights @@ -48224,12 +49398,14 @@ components: properties: baseline_count: type: number + nullable: true + deprecated: true + x-hidden-from-docs: true description: The number of unique loan payment merchants detected in the 30 days before the subscription date current_count: type: number description: The current number of unique loan payment merchants detected in the last 30 days required: - - baseline_count - current_count LoanPaymentsCounts: title: LoanPaymentsCounts @@ -48239,12 +49415,14 @@ components: properties: baseline_count: type: number + nullable: true + deprecated: true + x-hidden-from-docs: true description: The number of loan payments made in the 30 days before the subscription date current_count: type: number description: The current number of loan payments made in the last 30 days required: - - baseline_count - current_count MonitoringIncomeSource: title: MonitoringIncomeSource @@ -48277,12 +49455,14 @@ components: properties: baseline_amount: type: number + nullable: true + deprecated: true + x-hidden-from-docs: true description: The forecasted monthly income at the time of subscription current_amount: type: number description: The current forecasted monthly income required: - - baseline_amount - current_amount HistoricalAnnualIncome: title: HistoricalAnnualIncome @@ -48292,12 +49472,14 @@ components: properties: baseline_amount: type: number + nullable: true + deprecated: true + x-hidden-from-docs: true description: The historical annual income at the time of subscription current_amount: type: number description: The current historical annual income required: - - baseline_amount - current_amount CraCheckReportPDFGetRequest: title: CraCheckReportPDFGetRequest @@ -48313,10 +49495,10 @@ components: third_party_user_token: $ref: '#/components/schemas/ThirdPartyUserToken' user_id: + x-hidden-from-docs: true 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 `PLAID-NEW-USER-API-ENABLED` header. If this field is included, then the `user_token` object field is ignored. - - 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 `PLAID-NEW-USER-API-ENABLED` header. 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. @@ -48349,10 +49531,10 @@ components: third_party_user_token: $ref: '#/components/schemas/ThirdPartyUserToken' user_id: + x-hidden-from-docs: true 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 `PLAID-NEW-USER-API-ENABLED` header. If this field is included, then the `user_token` object field is ignored. - - 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 `PLAID-NEW-USER-API-ENABLED` header. 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. @@ -48772,7 +49954,10 @@ components: $ref: '#/components/schemas/OwnershipType' historical_balances: type: array - description: Calculated data about the historical balances on the account. + description: |- + Calculated data about the historical balances on the account. + + Available for `credit` and `depository` type accounts. items: $ref: '#/components/schemas/HistoricalBalance' required: @@ -49293,6 +50478,10 @@ components: - amount - iso_currency_code - unofficial_currency_code + example: + amount: -2500 + iso_currency_code: USD + unofficial_currency_code: null TotalReportInflowAmount30d: type: object description: Total amount of debit transactions into the report's accounts in the last 30 days. This field only takes into account USD transactions from the accounts. @@ -49310,6 +50499,10 @@ components: - amount - iso_currency_code - unofficial_currency_code + example: + amount: -1000 + iso_currency_code: USD + unofficial_currency_code: null TotalReportInflowAmount60d: type: object description: Total amount of debit transactions into the report's accounts in the last 60 days. This field only takes into account USD transactions from the accounts. @@ -49327,6 +50520,10 @@ components: - amount - iso_currency_code - unofficial_currency_code + example: + amount: -2500 + iso_currency_code: USD + unofficial_currency_code: null TotalReportInflowAmount90d: type: object description: Total amount of debit transactions into the report's account in the last 90 days. This field only takes into account USD transactions from the accounts. @@ -49344,6 +50541,10 @@ components: - amount - iso_currency_code - unofficial_currency_code + example: + amount: -2500 + iso_currency_code: USD + unofficial_currency_code: null TotalReportOutflowAmount: type: object description: Total amount of credit transactions into the report's accounts in the time period of the report. This field only takes into account USD transactions from the accounts. @@ -49361,6 +50562,10 @@ components: - amount - iso_currency_code - unofficial_currency_code + example: + amount: 2500 + iso_currency_code: USD + unofficial_currency_code: null TotalReportOutflowAmount30d: type: object description: Total amount of credit transactions into the report's accounts in the last 30 days. This field only takes into account USD transactions from the accounts. @@ -49378,6 +50583,10 @@ components: - amount - iso_currency_code - unofficial_currency_code + example: + amount: 1000 + iso_currency_code: USD + unofficial_currency_code: null TotalReportOutflowAmount60d: type: object description: Total amount of credit transactions into the report's accounts in the last 60 days. This field only takes into account USD transactions from the accounts. @@ -49395,6 +50604,10 @@ components: - amount - iso_currency_code - unofficial_currency_code + example: + amount: 2500 + iso_currency_code: USD + unofficial_currency_code: null TotalReportOutflowAmount90d: type: object description: Total amount of credit transactions into the report's accounts in the last 90 days. This field only takes into account USD transactions from the accounts. @@ -49412,6 +50625,10 @@ components: - amount - iso_currency_code - unofficial_currency_code + example: + amount: 2500 + iso_currency_code: USD + unofficial_currency_code: null BaseReportItem: title: BaseReportItem type: object @@ -49484,7 +50701,7 @@ components: description: The duration of transaction history available within this report for this Item, typically defined as the time since the date of the earliest transaction in that account. transactions: type: array - description: Transaction history associated with the account. Transaction history returned by endpoints such as `/transactions/get` or `/investments/transactions/get` will be returned in the top-level `transactions` field instead. + description: Transaction history associated with the account. Transaction history returned by endpoints such as `/transactions/get` or `/investments/transactions/get` will be returned in the top-level `transactions` field instead. Some transactions may have their details masked in accordance to FCRA. items: $ref: '#/components/schemas/BaseReportTransaction' owners: @@ -56224,10 +57441,10 @@ components: user_token: $ref: '#/components/schemas/UserToken' user_id: + x-hidden-from-docs: true 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 `PLAID-NEW-USER-API-ENABLED` header. If this field is included, then the `user_token` object field is ignored. - - 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 `PLAID-NEW-USER-API-ENABLED` header. If this field is included, then the `user_token` object field is ignored. third_party_user_token: $ref: '#/components/schemas/ThirdPartyUserToken' CraCheckReportIncomeInsightsGetResponse: @@ -56729,10 +57946,10 @@ components: user_token: $ref: '#/components/schemas/UserToken' user_id: + x-hidden-from-docs: true 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 `PLAID-NEW-USER-API-ENABLED` header. If this field is included, then the `user_token` object field is ignored. - - 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 `PLAID-NEW-USER-API-ENABLED` header. If this field is included, then the `user_token` object field is ignored. webhook: type: string description: | @@ -56761,15 +57978,15 @@ components: - cra_cashflow_insights - cra_partner_insights - cra_network_insights - - cra_plaid_credit_score + - cra_lend_score base_report: $ref: '#/components/schemas/CraCheckReportCreateBaseReportOptions' cashflow_insights: $ref: '#/components/schemas/CraCheckReportCashflowInsightsGetOptions' partner_insights: $ref: '#/components/schemas/CraCheckReportCreatePartnerInsightsOptions' - plaid_credit_score: - $ref: '#/components/schemas/CraCheckReportPlaidCreditScoreGetOptions' + lend_score: + $ref: '#/components/schemas/CraCheckReportLendScoreGetOptions' include_investments: type: boolean nullable: true @@ -56829,10 +58046,10 @@ components: user_token: $ref: '#/components/schemas/UserToken' user_id: + x-hidden-from-docs: true 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 `PLAID-NEW-USER-API-ENABLED` header. If this field is included, then the `user_token` object field is ignored. - - 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 `PLAID-NEW-USER-API-ENABLED` header. If this field is included, then the `user_token` object field is ignored. third_party_user_token: $ref: '#/components/schemas/ThirdPartyUserToken' partner_insights: @@ -57293,19 +58510,19 @@ components: user_token: $ref: '#/components/schemas/UserToken' user_id: + x-hidden-from-docs: true 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 `PLAID-NEW-USER-API-ENABLED` header. If this field is included, then the `user_token` object field is ignored. - - 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 `PLAID-NEW-USER-API-ENABLED` header. If this field is included, then the `user_token` object field is ignored. third_party_user_token: $ref: '#/components/schemas/ThirdPartyUserToken' options: $ref: '#/components/schemas/CraCheckReportCashflowInsightsGetOptions' - CraCheckReportPlaidCreditScoreGetRequest: - title: CraCheckReportPlaidCreditScoreGetRequest + CraCheckReportLendScoreGetRequest: + title: CraCheckReportLendScoreGetRequest x-hidden-from-docs: true type: object - description: CraCheckReportPlaidCreditScoreGetRequest defines the request schema for `/cra/check_report/plaid_credit_score/get`. + description: CraCheckReportLendScoreGetRequest defines the request schema for `/cra/check_report/lend_score/get`. properties: client_id: $ref: '#/components/schemas/APIClientID' @@ -57316,7 +58533,7 @@ components: third_party_user_token: $ref: '#/components/schemas/ThirdPartyUserToken' options: - $ref: '#/components/schemas/CraCheckReportPlaidCreditScoreGetOptions' + $ref: '#/components/schemas/CraCheckReportLendScoreGetOptions' CraCheckReportCreateBaseReportOptions: title: CraCheckReportCreateBaseReportOptions type: object @@ -57357,19 +58574,19 @@ components: $ref: '#/components/schemas/PlaidCheckScoreVersion' attributes_version: $ref: '#/components/schemas/CashflowAttributesVersion' - CraCheckReportPlaidCreditScoreGetOptions: - title: CraCheckReportPlaidCreditScoreGetOptions + CraCheckReportLendScoreGetOptions: + title: CraCheckReportLendScoreGetOptions type: object nullable: true x-hidden-from-docs: true - description: Defines configuration options to generate the Plaid Credit Score + description: Defines configuration options to generate the Lend Score properties: - plaid_credit_score_version: + lend_score_version: $ref: '#/components/schemas/PlaidCheckScoreVersion' PlaidCheckScoreVersion: x-hidden-from-docs: true type: string - description: The version of the Plaid Credit Score + description: The version of the Lend Score nullable: true enum: - v1.0 @@ -57443,33 +58660,33 @@ components: error_reason: type: string nullable: true - description: Human-readable description of why the Plaid Credit score could not be computed. + description: Human-readable description of why the Lend Score could not be computed. CashflowAttributesSchema: type: object title: CashflowAttributes description: A map of cashflow attributes, where the key is a string, and the value is a float, int, or boolean. - CraCheckReportPlaidCreditScoreGetResponse: - title: CraCheckReportPlaidCreditScoreGetResponse + CraCheckReportLendScoreGetResponse: + title: CraCheckReportLendScoreGetResponse additionalProperties: true x-hidden-from-docs: true type: object - description: CraCheckReportPlaidCreditScoreGetResponse defines the response schema for `/cra/check_report/plaid_credit_score/get`. + description: CraCheckReportLendScoreGetResponse defines the response schema for `/cra/check_report/lend_score/get`. properties: report: - $ref: '#/components/schemas/CraPlaidCreditScoreReport' + $ref: '#/components/schemas/CraLendScoreReport' request_id: $ref: '#/components/schemas/RequestID' warnings: type: array - description: If the Plaid Credit Score generation was successful but a subset of data could not be retrieved, this array will contain information about the errors causing information to be missing + description: If the Lend Score generation was successful but a subset of data could not be retrieved, this array will contain information about the errors causing information to be missing items: $ref: '#/components/schemas/CheckReportWarning' required: - report - request_id - CraPlaidCreditScoreReport: + CraLendScoreReport: type: object - description: Contains data for the CRA Plaid Credit Score Report. + description: Contains data for the CRA Lend Score Report. additionalProperties: true properties: report_id: @@ -57479,30 +58696,30 @@ components: type: string description: The time when the Network Attributes Report was generated. format: date-time - plaid_credit_score: - $ref: '#/components/schemas/PlaidCreditScore' + lend_score: + $ref: '#/components/schemas/LendScore' required: - report_id - generated_time - PlaidCreditScore: + LendScore: type: object additionalProperties: true - description: The results of the Plaid Credit Score + description: The results of the Lend Score nullable: true properties: score: type: integer - description: The score returned by the Plaid Credit Score model. Will be an integer in the range 1 to 99. + description: The score returned by the Lend Score model. Will be an integer in the range 1 to 99. nullable: true reason_codes: type: array - description: The reasons for an individual having risk according to the Plaid Credit score. + description: The reasons for an individual having risk according to the Lend Score. items: type: string error_reason: type: string nullable: true - description: Human-readable description of why the Plaid Credit score could not be computed. + description: Human-readable description of why the Lend Score could not be computed. CraCheckReportNetworkInsightsGetRequest: title: CraCheckReportNetworkInsightsGetRequest type: object @@ -57515,10 +58732,10 @@ components: user_token: $ref: '#/components/schemas/UserToken' user_id: + x-hidden-from-docs: true 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 `PLAID-NEW-USER-API-ENABLED` header. If this field is included, then the `user_token` object field is ignored. - - 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 `PLAID-NEW-USER-API-ENABLED` header. If this field is included, then the `user_token` object field is ignored. third_party_user_token: $ref: '#/components/schemas/ThirdPartyUserToken' CraCheckReportNetworkInsightsGetResponse: @@ -57603,10 +58820,10 @@ components: user_token: $ref: '#/components/schemas/UserToken' user_id: + x-hidden-from-docs: true 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 `PLAID-NEW-USER-API-ENABLED` header. If this field is included, then the `user_token` object field is ignored. - - 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 `PLAID-NEW-USER-API-ENABLED` header. If this field is included, then the `user_token` object field is ignored. required: - reports_requested CraCheckReportVerificationGetReportType: @@ -57848,7 +59065,10 @@ components: nullable: true historical_balances: type: array - description: Calculated data about the historical balances on the account. + description: |- + Calculated data about the historical balances on the account. + + Available for `credit` and `depository` type accounts. items: $ref: '#/components/schemas/CraVoaReportAccountHistoricalBalance' average_balance_30_days: @@ -60092,7 +61312,7 @@ components: $ref: '#/components/schemas/Products' consented_products: description: | - A list of products that the user has consented to for the Item via [Data Transparency Messaging](/docs/link/data-transparency-messaging-migration-guide). This will consist of all products where both of the following are true: the user has consented to the required data scopes for that product and you have Production access for that product. + A list of products that the user has consented to for the Item via [Data Transparency Messaging](https://plaid.com/docs/link/data-transparency-messaging-migration-guide). This will consist of all products where both of the following are true: the user has consented to the required data scopes for that product and you have Production access for that product. type: array items: $ref: '#/components/schemas/Products' @@ -60161,17 +61381,17 @@ components: format: date-time consented_use_cases: type: array - description: "A list of use cases that the user has consented to for the Item via [Data Transparency Messaging](/docs/link/data-transparency-messaging-migration-guide). \n\nYou can see the full list of use cases or update the list of use cases to request at any time via the Link Customization section of the [Plaid Dashboard](https://dashboard.plaid.com/link/data-transparency-v5)." + description: "A list of use cases that the user has consented to for the Item via [Data Transparency Messaging](https://plaid.com/docs/link/data-transparency-messaging-migration-guide). \n\nYou can see the full list of use cases or update the list of use cases to request at any time via the Link Customization section of the [Plaid Dashboard](https://dashboard.plaid.com/link/data-transparency-v5)." items: type: string consented_data_scopes: type: array - description: A list of data scopes that the user has consented to for the Item via [Data Transparency Messaging](/docs/link/data-transparency-messaging-migration-guide). These are based on the `consented_products`; see the [full mapping](/docs/link/data-transparency-messaging-migration-guide/#data-scopes-by-product) of data scopes and products. + description: A list of data scopes that the user has consented to for the Item via [Data Transparency Messaging](https://plaid.com/docs/link/data-transparency-messaging-migration-guide). These are based on the `consented_products`; see the [full mapping](https://plaid.com/docs/link/data-transparency-messaging-migration-guide/#data-scopes-by-product) of data scopes and products. items: $ref: '#/components/schemas/ItemConsentedDataScope' ItemConsentedDataScope: title: Consented Data Scope - description: A data scope for the products that a user can consent to in [Data Transparency Messaging](/docs/link/data-transparency-messaging-migration-guide) + description: A data scope for the products that a user can consent to in [Data Transparency Messaging](https://plaid.com/docs/link/data-transparency-messaging-migration-guide) type: string enum: - account_balance_info @@ -60317,10 +61537,12 @@ components: enum: - urn:plaid:params:tokens:user - urn:plaid:params:oauth:user-token + - urn:plaid:params:credit:multi-user description: |- The type of the subject token. `urn:plaid:params:tokens:user` allows exchanging a Plaid-issued user token for an OAuth token. When using this token type, `audience` must be the same as the `client_id`. `subject_token` must be a Plaid-issued user token issued from the `/user/create` endpoint. `urn:plaid:params:oauth:user-token` allows exchanging a refresh token for an OAuth token to another `client_id`. The other `client_id` is provided in `audience`. `subject_token` must be an OAuth refresh token issued from the `/oauth/token` endpoint. + `urn:plaid:params:credit:multi-user` allows exchanging a Plaid-issued user token for an OAuth token. When using this token type, `audience` may be a client id or a supported CRA partner URN. `audience` supports a comma-delimited list of clients. When multiple clients are specified in the `audience` a multi-party token is created which can be used by all parties in the audience in conjunction with their `client_id` and `client_secret`. OAuthTokenRequest: type: object required: @@ -60344,7 +61566,12 @@ components: example: https://production.plaid.com audience: type: string - description: Used when exchanging a token. The meaning depends on the `subject_token_type`. + description: |- + Used when exchanging a token. The meaning depends on the `subject_token_type`: + + - For `urn:plaid:params:tokens:user`: Must be the same as the `client_id`. + - For `urn:plaid:params:oauth:user-token`: The other `client_id` to exchange tokens to. + - For `urn:plaid:params:credit:multi-user`: a `client_id` or one of the supported CRA partner URNs: `urn:plaid:params:cra-partner:experian`, `urn:plaid:params:cra-partner:fannie-mae`, or `urn:plaid:params:cra-partner:freddie-mac`. example: 68028ce48d2b0dec68747f6c subject_token: type: string @@ -60776,7 +62003,7 @@ components: account_id: type: string description: |- - The Plaid `account_id` of the account that is the funding source for the proposed transaction. The `account_id` is returned in the `/accounts/get` endpoint as well as the [`onSuccess`](/docs/link/ios/#link-ios-onsuccess-linkSuccess-metadata-accounts-id) callback metadata. + The Plaid `account_id` of the account that is the funding source for the proposed transaction. The `account_id` is returned in the `/accounts/get` endpoint as well as the [`onSuccess`](https://plaid.com/docs/link/ios/#link-ios-onsuccess-linkSuccess-metadata-accounts-id) callback metadata. This will return an [`INVALID_ACCOUNT_ID`](https://plaid.com/docs/errors/invalid-input/#invalid_account_id) error if the account has been removed at the bank or if the `account_id` is no longer valid. client_transaction_id: @@ -60866,7 +62093,7 @@ components: account_id: type: string description: |- - The Plaid `account_id` of the account that is the funding source for the proposed transaction. The `account_id` is returned in the `/accounts/get` endpoint as well as the [`onSuccess`](/docs/link/ios/#link-ios-onsuccess-linkSuccess-metadata-accounts-id) callback metadata. + The Plaid `account_id` of the account that is the funding source for the proposed transaction. The `account_id` is returned in the `/accounts/get` endpoint as well as the [`onSuccess`](https://plaid.com/docs/link/ios/#link-ios-onsuccess-linkSuccess-metadata-accounts-id) callback metadata. This will return an [`INVALID_ACCOUNT_ID`](https://plaid.com/docs/errors/invalid-input/#invalid_account_id) error if the account has been removed at the bank or if the `account_id` is no longer valid. client_transaction_id: diff --git a/CHANGELOG.md b/CHANGELOG.md index a7f87b0..8765ef1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,69 @@ +### 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 + ### 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.