Retrieve information from the bank accounts used for employment verification
POST /beta/credit/v1/bank_employment/get
/credit/bank_employment/get returns the employment report(s) derived from bank transaction data for a specified user.
Request Body
Required
CreditBankEmploymentGetRequest defines the request schema for /beta/credit/v1/bank_employment/get.
Parameters
client_id
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
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
The user token associated with the User data is being requested for.
Response
CreditBankEmploymentGetResponse defines the response schema for /beta/credit/v1/bank_employment/get.
Response Properties
bank_employment_reports
Bank Employment data. Each entry in the array will be a distinct bank employment report.
bank_employment_report_id
The unique identifier associated with the Bank Employment Report.
generated_time
The time when the Bank Employment Report was generated, in ISO 8601 format (e.g. “2018-04-12T03:32:11Z”).
days_requested
The number of days requested by the customer for the Bank Employment Report.
items
The list of Items in the report along with the associated metadata about the Item.
item_id
The unique identifier for the Item.
last_updated_time
The time when this Item’s data was last retrieved from the financial institution, in ISO 8601 format (e.g. “2018-04-12T03:32:11Z”).
institution_id
The unique identifier of the institution associated with the Item.
institution_name
The name of the institution associated with the Item.
bank_employments
The bank employment information for this Item. Each entry in the array is a different employer found.
bank_employment_id
A unique identifier for the bank employment.
account_id
Plaid’s unique identifier for the account.
employer
Object containing employer data.
name
Name of the employer.
latest_deposit_date
The date of the most recent deposit from this employer.
earliest_deposit_date
The date of the earliest deposit from this employer from within the period of the days requested.
bank_employment_accounts
The Item’s accounts that have Bank Employment data.
account_id
Plaid’s unique identifier for the account.
mask
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
The name of the bank account.
official_name
The official name of the bank account.
subtype
Valid account subtypes for depository accounts. For a list containing descriptions of each subtype, see Account schemas.
type
The account type. This will always be
depository.
owners
Data returned by the financial institution about the account owner or owners. Identity information is optional, so field may return an empty array.
names
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
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.
emails
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.
addresses
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.
warnings
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
The warning type which will always be
BANK_EMPLOYMENT_WARNING.
warning_code
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
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
A broad categorization of the error. Safe for programmatic use.
error_code
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
A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
display_message
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
The
item_id of the Item associated with this warning.
request_id
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.