Search employer database

POST /employers/search

/employers/search allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow.

The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.

Request Body

Required

EmployersSearchRequest defines the request schema for /employers/search.

Parameters

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.
query
required, string
The employer name to be searched for.
products
required, array[string]
The Plaid products the returned employers should support. Currently, this field must be set to "deposit_switch".

Response

EmployersSearchResponse defines the response schema for /employers/search.

Response Properties

employers
required, array[object]
A list of employers matching the search criteria.
employer_id
required, string
Plaid’s unique identifier for the employer.
name
required, string
The name of the employer
address
required, object
Data about the components comprising an address.
confidence_score
required, number
A number from 0 to 1 indicating Plaid’s level of confidence in the pairing between the employer and the institution (not yet implemented).
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.