Moov.Enrichment (Moov v1.0.0)

Copy Markdown View Source

"Form shortening" lookups that autofill form fields from publicly available data, so your users have fewer fields to type (and fewer typos to make).

See https://docs.moov.io/api/enrichment/form-shortening/.

Summary

Functions

Address autocomplete. opts[:query]: [search: "123 Main"] (and similar narrowing fields).

Retrieves a generated avatar image for a given unique ID (e.g. an account ID).

Lists valid industries (the values accepted by Moov.Accounts.create/2's :industry field).

Enriches a business profile from an email address. opts[:query]: [email: "..."].

Looks up an ACH-participating financial institution by routing number. opts[:query]: [routing_number: "..."].

Functions

address(client, opts \\ [])

@spec address(
  Moov.Client.t(),
  keyword()
) :: {:ok, [map()]} | {:error, Moov.Error.t()}

Address autocomplete. opts[:query]: [search: "123 Main"] (and similar narrowing fields).

avatar(client, unique_id)

@spec avatar(Moov.Client.t(), String.t()) :: {:ok, term()} | {:error, Moov.Error.t()}

Retrieves a generated avatar image for a given unique ID (e.g. an account ID).

industries(client, opts \\ [])

@spec industries(
  Moov.Client.t(),
  keyword()
) :: {:ok, [map()]} | {:error, Moov.Error.t()}

Lists valid industries (the values accepted by Moov.Accounts.create/2's :industry field).

profile(client, opts \\ [])

@spec profile(
  Moov.Client.t(),
  keyword()
) :: {:ok, map()} | {:error, Moov.Error.t()}

Enriches a business profile from an email address. opts[:query]: [email: "..."].

search_ach_institution(client, opts \\ [])

@spec search_ach_institution(
  Moov.Client.t(),
  keyword()
) :: {:ok, [map()]} | {:error, Moov.Error.t()}

Looks up an ACH-participating financial institution by routing number. opts[:query]: [routing_number: "..."].