Employer endpoints

API reference for searching employers

/employers/search

Search employer database

/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 Verification of Income product progresses through the beta period, 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.

employers/search

Request fields and example

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.
queryrequiredstring
The employer name to be searched for.
productsrequired[string]
The Plaid products the returned employers should support. Currently, this field must be set to "deposit_switch".
1
// Use Beta libraries
employers/search

Response fields and example

employers[object]
A list of employers matching the search criteria.
employer_idstring
Plaid's unique identifier for the employer.
namestring
The name of the employer
addressnullableobject
Data about the components comprising an address.
citystring
The full city name
regionnullablestring
The region or state Example: "NC"
streetstring
The full street address Example: "564 Main Street, APT 15"
postal_codenullablestring
The postal code
countrystring
The ISO 3166-1 alpha-2 country code
confidence_scorenullablenumber
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_idstring
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"employers": [
{
"name": "Plaid Inc.",
"address": {
"city": "San Francisco",
"country": "US",
"postal_code": "94103",
"region": "CA",
"street": "1098 Harrison St"
},
"confidence_score": 1,
"employer_id": "emp_1"
}
],
"request_id": "ixTBLZGvhD4NnmB"
}