plaid

Retrieve information from the bank accounts used for employment verification

Changed on

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

post/beta/credit/v1/bank_employment/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/beta/credit/v1/bank_employment/get
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

client_idstring

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.

secretstring

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_tokenstring 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.

Response

OK

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

  • e07a869352e8Revision changes
    • breaking

      the response property /////////// became nullable for the status