Plaid

Plaid Base Report API

The Plaid Base Report API is a tool that allows users to access and analyze detailed financial data from various sources, such as bank accounts, credit cards, and investment accounts. This API provides a comprehensive overview of an individual's financial transactions and balances, allowing users to track their spending habits, monitor their financial health, and make informed decisions about their financial future. With the Plaid Base Report API, users can securely and efficiently access their financial information in one centralized location, making it easier to manage and optimize their financial well-being.

GitHub OpenAPI

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/plaid/refs/heads/main/openapi/plaid-cra--openapi-original.yml

OpenAPI Specification

plaid-cra--openapi-original.yml Raw ↑ 
openapi: 3.0.0
servers:
  - description: Production
    url: https://production.plaid.com
  - description: Development
    url: https://development.plaid.com
  - description: Sandbox
    url: https://sandbox.plaid.com
info:
  title: 'Plaid cra/'
  version: 2020-09-14_1.517.0
  description: Needs description.
  contact:
    name: Plaid Developer Team
    url: https://plaid.com
  termsOfService: https://plaid.com/legal/
tags:
  - name: Plaid
security:
  - clientId: []
    secret: []
    plaidVersion: []
paths:
  /cra/base_report/get:
    x-plaid-business-unit-context: BUSINESS_UNIT_CRA
    post:
      summary: Plaid Retrieve a Base Report
      tags:
        - Plaid
      operationId: baseReportGet
      x-hidden-from-docs: true
      externalDocs:
        url: /none/
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseReportGetRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseReportGetResponse'
              examples:
                example-1:
                  value:
                    report:
                      report_id: 028e8404-a013-4a45-ac9e-002482f9cafc
                      date_generated: '2023-03-30T18:27:37Z'
                      days_requested: 5
                      items:
                        - accounts:
                            - balances:
                                available: 43200
                                current: 43200
                                iso_currency_code: USD
                                unofficial_currency_code:
                                limit:
                              days_available: 5
                              historical_balances:
                                - current: 49050
                                  date: '2023-03-29'
                                  iso_currency_code: USD
                                  unofficial_currency_code:
                                - current: 49050
                                  date: '2023-03-28'
                                  iso_currency_code: USD
                                  unofficial_currency_code:
                                - current: 49050
                                  date: '2023-03-27'
                                  iso_currency_code: USD
                                  unofficial_currency_code:
                                - current: 49050
                                  date: '2023-03-26'
                                  iso_currency_code: USD
                                  unofficial_currency_code:
                                - current: 49050
                                  date: '2023-03-25'
                                  iso_currency_code: USD
                                  unofficial_currency_code:
                              mask: '4444'
                              name: Plaid Money Market
                              official_name: >-
                                Plaid Platinum Standard 1.85% Interest Money
                                Market
                              owners:
                                - addresses:
                                    - data:
                                        city: Malakoff
                                        country: US
                                        region: NY
                                        street: 2992 Cameron Road
                                        postal_code: '14236'
                                      primary: true
                                    - data:
                                        city: San Matias
                                        country: US
                                        region: CA
                                        street: 2493 Leisure Lane
                                        postal_code: 93405-2255
                                      primary: false
                                  emails:
                                    - data: [email protected]
                                      primary: true
                                      type: primary
                                    - data: [email protected]
                                      primary: false
                                      type: secondary
                                    - data: >-
                                        extraordinarily.long.email.username.123456@reallylonghostname.com
                                      primary: false
                                      type: other
                                  names:
                                    - Alberta Bobbeth Charleson
                                  phone_numbers:
                                    - data: '1112223333'
                                      primary: false
                                      type: home
                                    - data: '1112224444'
                                      primary: false
                                      type: work
                                    - data: '1112225555'
                                      primary: false
                                      type: mobile
                              ownership_type:
                              subtype: money market
                              transactions:
                                - amount: 5850
                                  date: '2023-03-30'
                                  iso_currency_code: USD
                                  original_description: ACH Electronic CreditGUSTO PAY 123456
                                  pending: false
                                  unofficial_currency_code:
                              type: depository
                            - balances:
                                available: 100
                                current: 110
                                iso_currency_code: USD
                                unofficial_currency_code:
                                limit:
                              days_available: 5
                              historical_balances:
                                - current: 110
                                  date: '2023-03-29'
                                  iso_currency_code: USD
                                  unofficial_currency_code:
                                - current: -390
                                  date: '2023-03-28'
                                  iso_currency_code: USD
                                  unofficial_currency_code:
                                - current: -373.67
                                  date: '2023-03-27'
                                  iso_currency_code: USD
                                  unofficial_currency_code:
                                - current: -284.27
                                  date: '2023-03-26'
                                  iso_currency_code: USD
                                  unofficial_currency_code:
                                - current: -284.27
                                  date: '2023-03-25'
                                  iso_currency_code: USD
                                  unofficial_currency_code:
                              mask: '0000'
                              name: Plaid Checking
                              official_name: Plaid Gold Standard 0% Interest Checking
                              owners:
                                - addresses:
                                    - data:
                                        city: Malakoff
                                        country: US
                                        region: NY
                                        street: 2992 Cameron Road
                                        postal_code: '14236'
                                      primary: true
                                    - data:
                                        city: San Matias
                                        country: US
                                        region: CA
                                        street: 2493 Leisure Lane
                                        postal_code: 93405-2255
                                      primary: false
                                  emails:
                                    - data: [email protected]
                                      primary: true
                                      type: primary
                                    - data: [email protected]
                                      primary: false
                                      type: secondary
                                    - data: >-
                                        extraordinarily.long.email.username.123456@reallylonghostname.com
                                      primary: false
                                      type: other
                                  names:
                                    - Alberta Bobbeth Charleson
                                  phone_numbers:
                                    - data: '1112223333'
                                      primary: false
                                      type: home
                                    - data: '1112224444'
                                      primary: false
                                      type: work
                                    - data: '1112225555'
                                      primary: false
                                      type: mobile
                              ownership_type:
                              subtype: checking
                              transactions:
                                - amount: 89.4
                                  date: '2023-03-27'
                                  iso_currency_code: USD
                                  original_description: SparkFun
                                  pending: false
                                  unofficial_currency_code:
                                - amount: 12
                                  date: '2023-03-28'
                                  iso_currency_code: USD
                                  original_description: 'McDonalds #3322'
                                  pending: false
                                  unofficial_currency_code:
                                - amount: 4.33
                                  date: '2023-03-28'
                                  iso_currency_code: USD
                                  original_description: Starbucks
                                  pending: false
                                  unofficial_currency_code:
                                - amount: -500
                                  date: '2023-03-29'
                                  iso_currency_code: USD
                                  original_description: United Airlines **** REFUND ****
                                  pending: false
                                  unofficial_currency_code:
                              type: depository
                          date_last_updated: '2023-03-30T18:25:26Z'
                          institution_id: ins_109508
                          institution_name: First Platypus Bank
                    request_id: GVzMdiDd8DDAQK4
      description: >-
        This endpoint allows the customer to retrieve a Base Report. Customers
        should pass in the `user_token` created in `/link/token/create`.
  /cra/base_report/create:
    x-plaid-business-unit-context: BUSINESS_UNIT_CRA
    post:
      summary: Plaid Create a Base Report
      tags:
        - Plaid
      operationId: baseReportCreate
      x-hidden-from-docs: true
      externalDocs:
        url: /none/
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseReportCreateRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseReportCreateResponse'
              examples:
                example-1:
                  value:
                    request_id: GVzMdiDd8DDAQK4
      description: >-
        This endpoint allows the customer to create a Base Report by passing in
        a user token. The Base Report will be generated based on the most
        recently linked item from the user token.
  /cra/bank_income/get:
    x-plaid-business-unit-context: BUSINESS_UNIT_CRA
    post:
      summary: Plaid Retrieve information from the bank accounts used for income verification
      tags:
        - Plaid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CraBankIncomeGetResponse'
              examples:
                example-1:
                  value:
                    request_id: LhQf0THi8SH1yJm
                    bank_income:
                      - bank_income_id: abc123
                        generated_time: '2022-01-31T22:47:53Z'
                        days_requested: 90
                        items:
                          - last_updated_time: '2022-01-31T22:47:53Z'
                            institution_id: ins_0
                            institution_name: Plaid Bank
                            bank_income_accounts:
                              - mask: '8888'
                                name: Plaid Checking Account
                                official_name: Plaid Checking Account
                                type: depository
                                subtype: 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: [email protected]
                                        primary: true
                                        type: primary
                                      - data: [email protected]
                                        primary: false
                                        type: secondary
                                      - data: >-
                                          extraordinarily.long.email.username.123456@reallylonghostname.com
                                        primary: false
                                        type: other
                                    names:
                                      - Alberta Bobbeth Charleson
                                    phone_numbers:
                                      - data: '1112223333'
                                        primary: false
                                        type: home
                                      - data: '1112224444'
                                        primary: false
                                        type: work
                                      - data: '1112225555'
                                        primary: false
                                        type: mobile
                            bank_income_sources:
                              - income_source_id: “f17efbdd-caab-4278-8ece-963511cd3d51”
                                income_description: “PLAID_INC_DIRECT_DEP_PPD”
                                income_category: SALARY
                                start_date: '2021-11-15'
                                end_date: '2022-01-15'
                                pay_frequency: MONTHLY
                                total_amount: 300
                                iso_currency_code: USD
                                unofficial_currency_code:
                                transaction_count: 1
                                next_payment_date: '2022-12-15'
                                historical_average_monthly_gross_income: 390
                                historical_average_monthly_income: 300
                                forecasted_average_monthly_income: 300
                                forecasted_average_monthly_income_prediction_intervals:
                                  - lower_bound: 200
                                    upper_bound: 400
                                    probability: 0.8
                                employer:
                                  name: Plaid Inc
                                historical_summary:
                                  - start_date: '2021-11-02'
                                    end_date: '2021-11-30'
                                    total_amounts:
                                      - amount: 100
                                        iso_currency_code: USD
                                        unofficial_currency_code:
                                    transactions:
                                      - amount: -100
                                        date: '2021-11-15'
                                        name: “PLAID_INC_DIRECT_DEP_PPD”
                                        original_description: PLAID_INC_DIRECT_DEP_PPD 123
                                        pending: false
                                        check_number:
                                        iso_currency_code: USD
                                        unofficial_currency_code:
                                  - start_date: '2021-12-01'
                                    end_date: '2021-12-31'
                                    total_amounts:
                                      - amount: 100
                                        iso_currency_code: USD
                                        unofficial_currency_code:
                                    transactions:
                                      - amount: -100
                                        date: '2021-12-15'
                                        name: “PLAID_INC_DIRECT_DEP_PPD”
                                        original_description: PLAID_INC_DIRECT_DEP_PPD 123
                                        pending: false
                                        check_number:
                                        iso_currency_code: USD
                                        unofficial_currency_code:
                                  - start_date: '2022-01-01'
                                    end_date: '2022-01-31'
                                    total_amounts:
                                      - amount: 100
                                        iso_currency_code: USD
                                        unofficial_currency_code:
                                    transactions:
                                      - amount: -100
                                        date: '2022-01-31'
                                        name: “PLAID_INC_DIRECT_DEP_PPD”
                                        original_description: PLAID_INC_DIRECT_DEP_PPD 123
                                        pending: false
                                        check_number:
                                        iso_currency_code: USD
                                        unofficial_currency_code:
                        bank_income_summary:
                          total_amounts:
                            - amount: 300
                              iso_currency_code: USD
                              unofficial_currency_code:
                          start_date: '2021-11-15'
                          end_date: '2022-01-15'
                          income_sources_count: 1
                          income_categories_count: 1
                          income_transactions_count: 1
                          historical_average_monthly_gross_income:
                            - amount: 390
                              iso_currency_code: USD
                              unofficial_currency_code:
                          historical_average_monthly_income:
                            - amount: 300
                              iso_currency_code: USD
                              unofficial_currency_code:
                          forecasted_average_monthly_income:
                            - amount: 300
                              iso_currency_code: USD
                              unofficial_currency_code:
                          historical_annual_gross_income:
                            - amount: 4680
                              iso_currency_code: USD
                              unofficial_currency_code:
                          historical_annual_income:
                            - amount: 3600
                              iso_currency_code: USD
                              unofficial_currency_code:
                          forecasted_annual_income:
                            - amount: 3600
                              iso_currency_code: USD
                              unofficial_currency_code:
                          historical_summary:
                            - start_date: '2021-11-02'
                              end_date: '2021-11-30'
                              total_amounts:
                                - amount: 100
                                  iso_currency_code: USD
                                  unofficial_currency_code:
                              transactions:
                                - amount: -100
                                  date: '2021-11-15'
                                  name: “PLAID_INC_DIRECT_DEP_PPD”
                                  original_description: PLAID_INC_DIRECT_DEP_PPD 123
                                  pending: false
                                  check_number:
                                  iso_currency_code: USD
                                  unofficial_currency_code:
                            - start_date: '2021-12-01'
                              end_date: '2021-12-31'
                              total_amounts:
                                - amount: 100
                                  iso_currency_code: USD
                                  unofficial_currency_code:
                              transactions:
                                - amount: -100
                                  date: '2021-12-15'
                                  name: “PLAID_INC_DIRECT_DEP_PPD”
                                  original_description: PLAID_INC_DIRECT_DEP_PPD 123
                                  pending: false
                                  check_number:
                                  iso_currency_code: USD
                                  unofficial_currency_code:
                            - start_date: '2022-01-01'
                              end_date: '2022-01-31'
                              total_amounts:
                                - amount: 100
                                  iso_currency_code: USD
                                  unofficial_currency_code:
                              transactions:
                                - amount: -100
                                  date: '2022-01-31'
                                  name: “PLAID_INC_DIRECT_DEP_PPD”
                                  original_description: PLAID_INC_DIRECT_DEP_PPD 123
                                  pending: false
                                  check_number:
                                  iso_currency_code: USD
                                  unofficial_currency_code:
                        warnings: []
      externalDocs:
        url: /api/products/income/#crabank_incomeget
      operationId: craBankIncomeGet
      description: >-
        `/cra/bank_income/get` returns the bank income report(s) for a specified
        user.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CraBankIncomeGetRequest'
  /cra/bank_income/create:
    x-plaid-business-unit-context: BUSINESS_UNIT_CRA
    post:
      summary: Plaid Create a CRA report for income verification
      tags:
        - Plaid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CraBankIncomeCreateResponse'
              examples:
                example-1:
                  value:
                    request_id: LhQf0THi8SH1yJm
      externalDocs:
        url: /api/products/income/#crabank_incomecreate
      operationId: craBankIncomeCreate
      description: '`/cra/bank_income/create` creates a CRA report for income verification'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CraBankIncomeCreateRequest'
  /cra/partner_insights/get:
    x-plaid-business-unit-context: BUSINESS_UNIT_CRA
    post:
      summary: >-
        Plaid Retrieve cash flow insights from the bank accounts used for income verification
      tags:
        - Plaid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CraPartnerInsightsGetResponse'
              examples:
                example-1:
                  value:
                    request_id: LhQf0THi8SH1yJm
                    report:
                      - report_id: abc123
                        generated_time: '2022-01-31T22:47:53Z'
                        items:
                          - institution_id: ins_0
                            institution_name: Plaid Bank
                            item_id: ABC123
                            accounts:
                              - mask: '8888'
                                name: Plaid Checking Account
                                official_name: Plaid Checking Account
                                type: depository
                                subtype: 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: [email protected]
                                        primary: true
                                        type: primary
                                      - data: [email protected]
                                        primary: false
                                        type: secondary
                                      - data: >-
                                          extraordinarily.long.email.username.123456@reallylonghostname.com
                                        primary: false
                                        type: other
                                    names:
                                      - Alberta Bobbeth Charleson
                                    phone_numbers:
                                      - data: '1112223333'
                                        primary: false
                                        type: home
                                      - data: '1112224444'
                                        primary: false
                                        type: work
                                      - data: '1112225555'
                                        primary: false
                                        type: mobile
                        prism:
                          insights:
                            version: 3
                            result:
                              l6m_cumbal_acc: 1
                          cash_score:
                            version: 3
                            score: 900
                            reason_codes:
                              - CASHFLOW_D11
                            metadata:
                              max_age: 20
                              min_age: 1
                              min_age_credit: 0
                              min_age_debit: 1
                              max_age_debit: 20
                              max_age_credit: 0
                              num_trxn_credit: 0
                              num_trxn_debit: 40
                              l1m_credit_value_cnt: 0
                              l1m_debit_value_cnt: 40
                          detect:
                            version: 3
                            score: 900
                            reason_codes:
                              - CASHFLOW_D11
                            metadata:
                              max_age: 20
                              min_age: 1
                              min_age_credit: 0
                              min_age_debit: 1
                              max_age_debit: 20
                              max_age_credit: 0
                              num_trxn_credit: 0
                              num_trxn_debit: 40
                              l1m_credit_value_cnt: 0
                              l1m_debit_value_cnt: 40
                          status: SUCCESS
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaidError'
      externalDocs:
        url: /api/products/income/#crapartner_insightsget
      operationId: craPartnerInsightsGet
      description: >-
        `/cra/partner_insights/get` returns cash flow insights for a specified
        user.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CraPartnerInsightsGetRequest'
  /cra/loans/applications/register:
    x-plaid-business-unit-context: BUSINESS_UNIT_CRA
    post:
      tags:
        - Plaid
      summary: Plaid Register loan applications and decisions.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CraLoansApplicationsRegisterResponse'
              examples:
                example-1:
                  value:
                    request_id: LhQf0THi8SH1yJm
      operationId: craLoansApplicationsRegister
      externalDocs:
        url: /none/
      description: >-
        `/cra/loans/applications/register` registers loan applications and
        decisions.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CraLoansApplicationsRegisterRequest'
  /cra/loans/register:
    x-plaid-business-unit-context: BUSINESS_UNIT_CRA
    post:
      tags:
        - Plaid
      summary: Plaid Register a list of loans to their applicants.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CraL

# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/plaid/refs/heads/main/openapi/plaid-cra--openapi-original.yml