Plaid

Plaid Credit API

Plaid Credit API is a financial service that allows users to access their credit information in real time. By connecting to various financial institutions, Plaid Credit API can provide an overview of a users credit score, outstanding balances, payment history, and other important credit-related information. This data can be used by developers and businesses to create personalized financial tools and services that help users better manage their credit and make informed financial decisions. With its secure and reliable platform, Plaid Credit API simplifies the process of accessing credit information and empowers users to take control of their financial well-being.

GitHub OpenAPI

Specifications

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

OpenAPI Specification

plaid-credit--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 credit/'
  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:
  /credit/audit_copy_token/update:
    x-plaid-business-unit-context: BUSINESS_UNIT_PLAID
    post:
      tags:
        - Plaid
      summary: Plaid Update an Audit Copy Token
      externalDocs:
        url: /none/
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditAuditCopyTokenUpdateResponse'
              examples:
                example-1:
                  value:
                    request_id: eYupqX1mZkEuQRx
                    updated: true
      operationId: creditAuditCopyTokenUpdate
      description: >-
        The `/credit/audit_copy_token/update` endpoint updates an existing  Audit Copy Token by adding the report tokens in the `report_tokens`
        field to the `audit_copy_token`. If the Audit Copy Token already
        contains a report of a certain type, it will be replaced with the token
        provided in the `report_tokens` field.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditAuditCopyTokenUpdateRequest'
  /credit/sessions/get:
    x-plaid-business-unit-context: BUSINESS_UNIT_PLAID
    post:
      tags:
        - Plaid
      summary: Plaid Retrieve Link sessions for your user
      externalDocs:
        url: /api/products/income/#creditsessionsget
      operationId: creditSessionsGet
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditSessionsGetResponse'
              examples:
                example-1:
                  value:
                    request_id: Aim3b
                    sessions:
                      - link_session_id: 356dbb28-7f98-44d1-8e6d-0cec580f3171
                        results:
                          item_add_results:
                            - public_token: >-
                                public-sandbox-5c224a01-8314-4491-a06f-39e193d5cddc
                              item_id: M5eVJqLnv3tbzdngLDp9FL5OlDNxlNhlE55op
                              institution_id: ins_56
                          bank_income_results:
                            - status: APPROVED
                              item_id: M5eVJqLnv3tbzdngLDp9FL5OlDNxlNhlE55op
                              institution_id: ins_56
                        session_start_time: '2022-09-30T23:40:30.946225Z'
                      - link_session_id: f742cae8-31e4-49cc-a621-6cafbdb26fb9
                        results:
                          payroll_income_results:
                            - num_paystubs_retrieved: 2
                              num_w2s_retrieved: 1
                              institution_id: ins_92
                        session_start_time: '2022-09-26T23:40:30.946225Z'
      description: >-
        This endpoint can be used for your end users after they complete the
        Link flow. This endpoint returns a list of Link sessions that your user
        completed, where each session includes the results from the Link flow.


        These results include details about the Item that was created and some
        product related metadata (showing, for example, whether the user
        finished the bank income verification step).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditSessionsGetRequest'
  /credit/audit_copy_token/create:
    x-plaid-business-unit-context: BUSINESS_UNIT_PLAID
    post:
      tags:
        - Plaid
      summary: Plaid Create Asset or Income Report Audit Copy Token
      externalDocs:
        url: /api/products/income/#creditaudit_copy_tokencreate
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditAuditCopyTokenCreateResponse'
              examples:
                example-1:
                  value:
                    audit_copy_token: a-production-3tau2cwvybdvrhucaaai27ulu4
                    request_id: Iam3b
      operationId: creditAuditCopyTokenCreate
      description: >-
        Plaid can create an Audit Copy token of an Asset Report and/or Income
        Report to share with participating Government Sponsored Entity (GSE). If
        you participate in the Day 1 Certainty™ program, Plaid can supply an
        Audit Copy token directly to Fannie Mae on your behalf. An Audit Copy
        token contains the same underlying data as the Asset Report and/or
        Income Report (result of /credit/payroll_income/get).


        Use the `/credit/audit_copy_token/create` endpoint to create an
        `audit_copy_token` and then pass that token to the GSE who needs access.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditAuditCopyTokenCreateRequest'
  /credit/audit_copy_token/remove:
    x-plaid-business-unit-context: BUSINESS_UNIT_PLAID
    post:
      tags:
        - Plaid
      summary: Plaid Remove an Audit Copy token
      externalDocs:
        url: /api/products/income/#creditaudit_copy_tokenremove
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditAuditCopyTokenRemoveResponse'
              examples:
                example-1:
                  value:
                    removed: true
                    request_id: m8MDnv9okwxFNBV
      operationId: creditReportAuditCopyRemove
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditAuditCopyTokenRemoveRequest'
        description: ''
      description: >-
        The `/credit/audit_copy_token/remove` endpoint allows you to remove an
        Audit Copy. Removing an Audit Copy invalidates the `audit_copy_token`
        associated with it, meaning both you and any third parties holding the
        token will no longer be able to use it to access Report data. Items
        associated with the Report data and other Audit Copies of it are not
        affected and will remain accessible after removing the given Audit Copy.
  /credit/asset_report/freddie_mac/get:
    x-plaid-business-unit-context: BUSINESS_UNIT_PLAID
    post:
      tags:
        - Plaid
      summary: >-
        Plaid Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.
      externalDocs:
        url: /none/
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetReportFreddieGetResponse'
              examples:
                example-1:
                  value:
                    SchemaVersion: 1
                    DEAL:
                      LOANS:
                        LOAN:
                          LOAN_IDENTIFIERS:
                            LOAN_IDENTIFIER:
                              LoanIdentifier: '100016746'
                              LoanIdentifierType: LenderLoan
                      PARTIES:
                        PARTY:
                          - INDIVIDUAL:
                              NAME:
                                FirstName: John
                                LastName: Deere
                            ROLES:
                              ROLE:
                                ROLE_DETAIL:
                                  PartyRoleType: Borrower
                            TAXPAYER_IDENTIFIERS:
                              TAXPAYER_IDENTIFIER:
                                TaxpayerIdentifierType: SocialSecurityNumber
                                TaxpayerIdentifierValue: 123-45-6789
                      SERVICES:
                        SERVICE:
                          VERIFICATION_OF_ASSET:
                            REPORTING_INFORMATION:
                              ReportingInformationIdentifier: a-prod-kol4xb5y4nf2zecqalb2d55mze
                            SERVICE_PRODUCT_FULFILLMENT:
                              SERVICE_PRODUCT_FULFILLMENT_DETAIL:
                                VendorOrderIdentifier: PLAID
                                ServiceProductFulfillmentIdentifier: VOA
                            VERIFICATION_OF_ASSET_RESPONSE:
                              ASSETS:
                                ASSET:
                                  - ASSET_DETAIL:
                                      AssetAccountIdentifier: '3847'
                                      AssetUniqueIdentifier: c251a55e-c503-471b-a3b1-11a9243bc189
                                      AssetAsOfDate: '2022-07-27'
                                      AssetDescription: Unlimited Cash Rewards Visa Signature
                                      AssetAvailableBalanceAmount: 2073.99
                                      AssetCurrentBalanceAmount: 2007.09
                                      AssetType: Other
                                      AssetTypeAdditionalDescription: credit card
                                      AssetDaysRequestedCount: 61
                                      AssetOwnershipType:
                                    ASSET_OWNERS:
                                      ASSET_OWNER:
                                        - AssetOwnerText: Alberta Bobbeth Charleson
                                    ASSET_HOLDER:
                                      NAME:
                                        FullName: Wells Fargo
                                    ASSET_TRANSACTIONS:
                                      ASSET_TRANSACTION:
                                        - ASSET_TRANSACTION_DETAIL:
                                            AssetTransactionUniqueIdentifier: 7jagxo9Eq6cXPKM8eMNJUgeeNnbgQdSDw6zgN
                                            AssetTransactionAmount: 34.43
                                            AssetTransactionDate: '2022-07-19'
                                            AssetTransactionPostDate: '2022-07-19'
                                            AssetTransactionType: Debit
                                            AssetTransactionPaidByName:
                                            AssetTransactionTypeAdditionalDescription:
                                            AssetTransactionCategoryType: FoodDining
                                            FinancialInstitutionTransactionIdentifier:
                                          ASSET_TRANSACTION_DESCRIPTON:
                                            - AssetTransactionDescription: TONYS PIZZA NAPOLETANA SAN FRANCISCOCA
                                    VALIDATION_SOURCES:
                                      VALIDATION_SOURCE:
                                        - ValidationSourceName: ''
                                          ValidationSourceReferenceIdentifier: ''
                          STATUSES:
                            STATUS:
                              StatusCode: success
                              StatusDescription:
                    request_id: eYupqX1mZkEuQRx
      operationId: creditAssetReportFreddieMacGet
      description: >-
        The `credit/asset_report/freddie_mac/get` endpoint retrieves the Asset
        Report in Freddie Mac's JSON format.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetReportFreddieGetRequest'
        description: ''
  /credit/freddie_mac/reports/get:
    x-plaid-business-unit-context: BUSINESS_UNIT_PLAID
    post:
      tags:
        - Plaid
      summary: >-
        Plaid Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint.
      externalDocs:
        url: /none/
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditFreddieMacReportsGetResponse'
              examples:
                example-1:
                  value:
                    SchemaVersion: 2.4
                    DEAL:
                      LOANS:
                        LOAN:
                          LoanRoleType: SubjectLoan
                          LOAN_IDENTIFIERS:
                            LOAN_IDENTIFIER:
                              - LoanIdentifier: '100016746'
                                LoanIdentifierType: LenderLoan
                      PARTIES:
                        PARTY:
                          - INDIVIDUAL:
                              NAME:
                                FirstName: John
                                LastName: Deere
                                MiddleName: S
                            ROLES:
                              ROLE:
                                ROLE_DETAIL:
                                  PartyRoleType: Borrower
                            TAXPAYER_IDENTIFIERS:
                              TAXPAYER_IDENTIFIER:
                                TaxpayerIdentifierType: SocialSecurityNumber
                                TaxpayerIdentifierValue: 123-45-6789
                      SERVICES:
                        SERVICE:
                          VERIFICATION_OF_ASSET:
                            - REPORTING_INFORMATION:
                                ReportIdentifierType: ReportID
                                ReportDateTime: ''
                                ReportingInformationParentIdentifier: a-prod-kol4xb5y4nf2zecqalb2d55mze
                                ReportingInformationIdentifier: >-
                                  assets-prod-20746587-2ad7-407f-a201-0669e1368cf7
                              SERVICE_PRODUCT_FULFILLMENT:
                                SERVICE_PRODUCT_FULFILLMENT_DETAIL:
                                  VendorOrderIdentifier: PLAID
                                  ServiceProductFulfillmentIdentifier: VOE
                              VERIFICATION_OF_ASSET_RESPONSE:
                                ASSETS:
                                  ASSET:
                                    - ASSET_DETAIL:
                                        AssetAccountIdentifier: '3847'
                                        AssetUniqueIdentifier: c251a55e-c503-471b-a3b1-11a9243bc189
                                        AssetAsOfDate: '2022-07-27'
                                        AssetDescription: Unlimited Cash Rewards Visa Signature
                                        AssetAvailableBalanceAmount: 0
                                        AssetCurrentBalanceAmount: 0
                                        AssetType: Other
                                        AssetTypeAdditionalDescription: credit card
                                        AssetDaysRequestedCount: 61
                                        AssetOwnershipType:
                                      ASSET_OWNERS:
                                        ASSET_OWNER:
                                          - AssetOwnerText: Alberta Bobbeth Charleson
                                      ASSET_HOLDER:
                                        NAME:
                                          FullName: Wells Fargo
                                      ASSET_TRANSACTIONS:
                                        ASSET_TRANSACTION:
                                          - ASSET_TRANSACTION_DETAIL:
                                              AssetTransactionCategoryType: Reimbursement
                                              AssetTransactionAmount: 0
                                              AssetTransactionDate: '2022-07-28'
                                              AssetTransactionPostDate: '2022-07-28'
                                              AssetTransactionType: Credit
                                              AssetTransactionPaidByName:
                                              AssetTransactionPaidToName:
                                              AssetTransactionTypeAdditionalDescription:
                                              AssetTransactionUniqueIdentifier: 8XQ2rJzjagxp87SJLNPKM8eMNJUgeeNnbg
                                              FinancialInstitutionTransactionIdentifier:
                                            ASSET_TRANSACTION_DESCRIPTION:
                                              - AssetTransactionDescription: UNITED AIRLINES SAN FRANCISCOCA
                                      VALIDATION_SOURCES:
                                        VALIDATION_SOURCE:
                                          - ValidationSourceName: ''
                                            ValidationSourceReferenceIdentifier: ''
                            - REPORTING_INFORMATION:
                                ReportDateTime: ''
                                ReportingInformationParentIdentifier: a-prod-kol4xb5y4nf2zecqalb2d55mze
                                ReportingInformationIdentifier: >-
                                  assets-prod-20746587-2ad7-407f-a201-0669e1368cf7
                                ReportIdentifierType: ReportID
                              SERVICE_PRODUCT_FULFILLMENT:
                                SERVICE_PRODUCT_FULFILLMENT_DETAIL:
                                  VendorOrderIdentifier: PLAID
                                  ServiceProductFulfillmentIdentifier: VOA
                              VERIFICATION_OF_ASSET_RESPONSE:
                                ASSETS:
                                  ASSET:
                                    - ASSET_DETAIL:
                                        AssetAccountIdentifier: '3847'
                                        AssetUniqueIdentifier: c251a55e-c503-471b-a3b1-11a9243bc189
                                        AssetAsOfDate: '2022-07-27'
                                        AssetDescription: Unlimited Cash Rewards Visa Signature
                                        AssetAvailableBalanceAmount: 2073.99
                                        AssetCurrentBalanceAmount: 2007.09
                                        AssetType: Other
                                        AssetTypeAdditionalDescription: credit card
                                        AssetDaysRequestedCount: 61
                                        AssetOwnershipType:
                                      ASSET_OWNERS:
                                        ASSET_OWNER:
                                          - AssetOwnerText: Alberta Bobbeth Charleson
                                      ASSET_HOLDER:
                                        NAME:
                                          FullName: Wells Fargo
                                      ASSET_TRANSACTIONS:
                                        ASSET_TRANSACTION:
                                          - ASSET_TRANSACTION_DETAIL:
                                              AssetTransactionUniqueIdentifier: 7jagxo9Eq6cXPKM8eMNJUgeeNnbgQdSDw6zgN
                                              AssetTransactionAmount: 34.43
                                              AssetTransactionDate: '2022-07-19'
                                              AssetTransactionPostDate: '2022-07-19'
                                              AssetTransactionType: Debit
                                              AssetTransactionPaidByName:
                                              AssetTransactionTypeAdditionalDescription:
                                              AssetTransactionCategoryType: FoodDining
                                              FinancialInstitutionTransactionIdentifier:
                                            ASSET_TRANSACTION_DESCRIPTION:
                                              - AssetTransactionDescription: TONYS PIZZA NAPOLETANA SAN FRANCISCOCA
                                      VALIDATION_SOURCES:
                                        VALIDATION_SOURCE:
                                          - ValidationSourceName: ''
                                            ValidationSourceReferenceIdentifier: ''
                          STATUSES:
                            STATUS:
                              StatusCode: success
                              StatusDescription:
                    request_id: eYupqX1mZkEuQRx
      operationId: creditFreddieMacReportsGet
      description: >-
        The `credit/asset_report/freddie_mac/get` endpoint retrieves the
        Verification of Assets and Verification of Employment reports.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditFreddieMacReportsGetRequest'
        description: ''
  /beta/credit/v1/bank_employment/get:
    x-plaid-business-unit-context: BUSINESS_UNIT_PLAID
    post:
      summary: >-
        Plaid Retrieve information from the bank accounts used for employment verification
      tags:
        - Plaid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditBankEmploymentGetResponse'
              examples:
                example-1:
                  value:
                    request_id: LhQf0THi8SH1yJm
                    bank_employment_reports:
                      - bank_employment_report_id: 0a7eaed6-5da7-4846-baaf-ad787306575e
                        generated_time: '2023-01-23T22:47:53Z'
                        days_requested: 90
                        items:
                          - item_id: eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6
                            last_updated_time: '2023-01-23T22:47:53Z'
                            institution_id: ins_0
                            institution_name: Plaid Bank
                            bank_employments:
                              - bank_employment_id: f17efbdd-caab-4278-8ece-963511cd3d51
                                account_id: GeooLPBGDEunl54q7N3ZcyD5aLPLEai1nkzM9
                                employer:
                                  name: Plaid Inc.
                                latest_deposit_date: '2023-01-15'
                                earliest_deposit_date: '2022-01-15'
                            bank_employment_accounts:
                              - account_id: GeooLPBGDEunl54q7N3ZcyD5aLPLEai1nkzM9
                                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
                        warnings: []
      externalDocs:
        url: /api/products/income/#creditbank_employmentget
      operationId: creditBankEmploymentGet
      description: >-
        `/credit/bank_employment/get` returns the employment report(s) derived
        from bank transaction data for a specified user.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditBankEmploymentGetRequest'
  /credit/bank_income/get:
    x-plaid-business-unit-context: BUSINESS_UNIT_PLAID
    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/CreditBankIncomeGetResponse'
              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
                            item_id: “eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6”
                            bank_income_accounts:
                              - account_id: “GeooLPBGDEunl54q7N3ZcyD5aLPLEai1nkzM9”
                                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:
                              - account_id: GeooLPBGDEunl54q7N3ZcyD5aLPLEai1nkzM9
                                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
                                transaction_count: 1
                                historical_summary:
                                  - start_date: '2021-11-02'
                                    end_date: '2021-11-30'
                                    total_amount: 100
                                    iso_currency_code: USD
                                    unofficial_currency_code:
                                    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
                                        transaction_id: 6RddrWNwE1uM63Ex5GKLhzlBl76aAZfgzlQNm
                                        check_number:
                                        iso_currency_code: USD
                                        unofficial_currency_code:
                                  - start_date: '2021-12-01'
                                    end_date: '2021-12-31'
                                    total_amount: 100
                                    iso_currency_code: USD
                                    unofficial_currency_code:
                                    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
     

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