Search employer database

v1.0.0

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

Input

{
  "type": "object",
  "description": "EmployersSearchRequest defines the request schema for `/employers/search`.",
  "required": [
    "products",
    "query"
  ],
  "properties": {
    "client_id": {
      "type": "string",
      "description": "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."
    },
    "products": {
      "type": "array",
      "description": "The Plaid products the returned employers should support. Currently, this field must be set to `\"deposit_switch\"`.",
      "items": {
        "type": "string"
      }
    },
    "query": {
      "type": "string",
      "description": "The employer name to be searched for."
    },
    "secret": {
      "type": "string",
      "description": "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."
    }
  }
}

Output

{
  "type": "object",
  "description": "EmployersSearchResponse defines the response schema for `/employers/search`.",
  "required": [
    "employers",
    "request_id"
  ],
  "properties": {
    "employers": {
      "type": "array",
      "description": "A list of employers matching the search criteria.",
      "items": {
        "type": "object",
        "description": "Data about the employer.",
        "required": [
          "employer_id",
          "name",
          "address",
          "confidence_score"
        ],
        "properties": {
          "address": {
            "description": "Data about the components comprising an address.",
            "type": "object"
          },
          "confidence_score": {
            "type": "number",
            "format": "double",
            "description": "A number from 0 to 1 indicating Plaid's level of confidence in the pairing between the employer and the institution (not yet implemented)."
          },
          "employer_id": {
            "type": "string",
            "description": "Plaid's unique identifier for the employer."
          },
          "name": {
            "type": "string",
            "description": "The name of the employer"
          }
        }
      }
    },
    "request_id": {
      "type": "string",
      "description": "A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive."
    }
  }
}