---
title: "Retrieve information from the bank accounts used for employment verification"
method: POST
path: "/beta/credit/v1/bank_employment/get"
tags: ["plaid"]
---

# Retrieve information from the bank accounts used for employment verification

`POST /beta/credit/v1/bank_employment/get`

`/beta/credit/v1/bank_employment/get` returns the employment report(s) derived from bank transaction data for a specified user.

## Request body

- CreditBankEmploymentGetRequest — CreditBankEmploymentGetRequest defines the request schema for `/beta/credit/v1/bank_employment/get`.
  - `client_id` string — Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
  - `secret` string — Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
  - `user_token` string, required — The user token associated with the user for which data is being requested. This field is used only by customers with pre-existing integrations that already use the `user_token` field. All other customers should use the `user_id` instead. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis).

## Response `200`

OK

- CreditBankEmploymentGetResponse — CreditBankEmploymentGetResponse defines the response schema for `/beta/credit/v1/bank_employment/get`.
  - `bank_employment_reports` CreditBankEmploymentReport[], required — Bank Employment data. Each entry in the array will be a distinct bank employment report.
    - `bank_employment_report_id` string, required — The unique identifier associated with the Bank Employment Report.
    - `generated_time` string, date-time, required — The time when the Bank Employment Report was generated, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (e.g. "2018-04-12T03:32:11Z").
    - `days_requested` integer, required — The number of days requested by the customer for the Bank Employment Report.
    - `items` CreditBankEmploymentItem[], required — The list of Items in the report along with the associated metadata about the Item.
      - `item_id` string, required — The unique identifier for the Item.
      - `last_updated_time` string, date-time, required — The time when this Item's data was last retrieved from the financial institution, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (e.g. "2018-04-12T03:32:11Z").
      - `institution_id` string, required — The unique identifier of the institution associated with the Item.
      - `institution_name` string, required — The name of the institution associated with the Item.
      - `bank_employments` CreditBankEmployment[], required — The bank employment information for this Item. Each entry in the array is a different employer found.
        - `bank_employment_id` string, required — A unique identifier for the bank employment.
        - `account_id` string, required — Plaid's unique identifier for the account.
        - `employer` CreditBankEmployer, required — Object containing employer data.
          - `name` string, required — Name of the employer.
        - `latest_deposit_date` string, date, required — The date of the most recent deposit from this employer.
        - `earliest_deposit_date` string, date, required — The date of the earliest deposit from this employer from within the period of the days requested.
      - `bank_employment_accounts` CreditBankIncomeAccount[], required — The Item's accounts that have Bank Employment data.
        - `account_id` string, required — Plaid's unique identifier for the account.
        - `mask` string, nullable, required — 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, and it may also not match the mask that the bank displays to the user.
        - `name` string, required — The name of the bank account.
        - `official_name` string, nullable, required — The official name of the bank account.
        - `subtype` 'checking' | 'savings' | 'hsa' | 'cd' | 'money market' | 'paypal' | 'prepaid' | 'cash management' | 'ebt' | 'limited purpose checking' | 'all', required — Valid account subtypes for depository accounts. For a list containing descriptions of each subtype, see [Account schemas](https://plaid.com/docs/api/accounts/#StandaloneAccountType-depository).
        - `type` 'depository', required — The account type. This will always be `depository`.
        - `owners` Owner[], required — Data returned by the financial institution about the account owner or owners. Identity information is optional, so field may return an empty array.
          - `names` string[], required — A list of names associated with the account by the financial institution. In the case of a joint account, Plaid will make a best effort to report the names of all account holders. If an Item contains multiple accounts with different owner names, some institutions will report all names associated with the Item in each account's `names` array.
          - `phone_numbers` PhoneNumber[], required — A list of phone numbers associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.
            - `data` string, required — The phone number.
            - `primary` boolean, required — When `true`, identifies the phone number as the primary number on an account.
            - `type` 'home' | 'work' | 'office' | 'mobile' | 'mobile1' | 'other', required — The type of phone number.
          - `emails` Email[], required — A list of email addresses associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.
            - `data` string, required — The email address.
            - `primary` boolean, required — When `true`, identifies the email address as the primary email on an account.
            - `type` 'primary' | 'secondary' | 'other', required — The type of email account as described by the financial institution.
          - `addresses` Address[], required — Data about the various addresses associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.
            - `data` AddressData, required — Data about the components comprising an address.
              - …
            - `primary` boolean — When `true`, identifies the address as the primary address on an account.
    - `warnings` CreditBankEmploymentWarning[], required — If data from the Bank Employment report was unable to be retrieved, the warnings will contain information about the error that caused the data to be incomplete.
      - `warning_type` 'BANK_EMPLOYMENT_WARNING', required — The warning type which will always be `BANK_EMPLOYMENT_WARNING`.
      - `warning_code` 'IDENTITY_UNAVAILABLE' | 'TRANSACTIONS_UNAVAILABLE' | 'ITEM_UNAPPROVED' | 'REPORT_DELETED' | 'DATA_UNAVAILABLE', required — The warning code identifies a specific kind of warning. `IDENTITY_UNAVAILABLE`: Unable to extract identity for the Item `TRANSACTIONS_UNAVAILABLE`: Unable to extract transactions for the Item `ITEM_UNAPPROVED`: User exited flow before giving permission to share data for the Item `REPORT_DELETED`: Report deleted due to customer or consumer request `DATA_UNAVAILABLE`: No relevant data was found for the Item
      - `cause` CreditBankIncomeCause, required — An error object and associated `item_id` used to identify a specific Item and error when a batch operation operating on multiple Items has encountered an error in one of the Items.
        - `error_type` 'INTERNAL_SERVER_ERROR' | 'INSUFFICIENT_CREDENTIALS' | 'ITEM_LOCKED' | 'USER_SETUP_REQUIRED' | 'COUNTRY_NOT_SUPPORTED' | 'INSTITUTION_DOWN' | 'INSTITUTION_NO_LONGER_SUPPORTED' | 'INSTITUTION_NOT_RESPONDING' | 'INVALID_CREDENTIALS' | 'INVALID_MFA' | 'INVALID_SEND_METHOD' | 'ITEM_LOGIN_REQUIRED' | 'MFA_NOT_SUPPORTED' | 'NO_ACCOUNTS' | 'ITEM_NOT_SUPPORTED' | 'ACCESS_NOT_GRANTED', required — A broad categorization of the error. Safe for programmatic use.
        - `error_code` string, required — We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be `null` if no error has occurred.
        - `error_message` string, required — A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
        - `display_message` string, required — A user-friendly representation of the error code. null if the error is not related to user action. This may change over time and is not safe for programmatic use.
        - `item_id` string, required — The `item_id` of the Item associated with this warning.
  - `request_id` string, required — A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

## Other responses

- `default` — Error response

---

[API](https://skmtc.net/plaid/apis/the-plaid-api.md) · [All operations](https://skmtc.net/plaid/apis/the-plaid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/plaid/the-plaid-api/revisions/e536704a333f/schema)