Plaid.Employer (elixir_plaid v0.1.4) View Source
Plaid Employer API calls and schema.
🏗 Waiting on plaid to enable the deposit_switch product so I can fully test this endpoin.
Link to this section Summary
Functions
Search employers information.
Link to this section Types
Specs
t() :: %Plaid.Employer{
address: Plaid.Address.t() | nil,
confidence_score: number() | nil,
employer_id: String.t(),
name: String.t()
}
Link to this section Functions
Specs
search(String.t(), [String.t()], Plaid.config()) :: {:ok, Plaid.Employer.SearchResponse.t()} | {:error, Plaid.Error.t()}
Search employers information.
Does a POST /employers/search call to search Plaid’s database of known employers,
for use with Deposit Switch
Params:
query- The employer name to be searched for.products- The Plaid products the returned employers should support.
Currently in the Plaid API,
productsmust be set to["deposit_switch"].
Examples
search("Plaid", ["deposit_switch"], client_id: "123", secret: "abc")
{:ok, %Plaid.Employer.SearchResponse{}}