plaid

(Deprecated) 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 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.

post/employers/search

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.

querystring required

The employer name to be searched for.

productsstring[] required

The Plaid products the returned employers should support. Currently, this field must be set to "deposit_switch".

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

Changed in 6 of the 53 revisions of this API.154

    • endpoint deprecated

      endpoint-deprecated

    • added the new ASSETS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new CRA_MONITORING_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new CREDIT_PROFILE_REPORT_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new ENCOMPASS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new ENRICH_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new FRAUD_INSIGHTS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new FREDDIE_MAC_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new LINK_DELIVERY_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new PROFILE_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new RECURRING_TRANSACTIONS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new STATEMENTS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new TRANSFER_RECURRING_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new TRANSFER_REFUND_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new IDEMPOTENCY_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new BASE_REPORT_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the IDENTITY_ERROR enum value from the response property for the response status

      response-property-enum-value-removed