LatticeStripe.TaxId.Verification (LatticeStripe v2.0.0)

Copy Markdown View Source

The verification object embedded in a Stripe Tax ID.

Reachable from LatticeStripe.TaxId.t/0. :status is the field to match on before trusting a customer-supplied tax ID — see the Tax guide for the full status set and what each one means for invoicing.

This struct holds PII. :verified_name and :verified_address are redacted in Inspect output to keep them out of logs and IEx sessions; read them explicitly by field when you need them.

Embedded value struct: fields are additive. Keys Stripe adds later appear under :extra rather than being dropped, so a new field never breaks decoding.

Summary

Types

t()

@type t() :: %LatticeStripe.TaxId.Verification{
  extra: map(),
  status: atom() | String.t() | nil,
  verified_address: String.t() | nil,
  verified_name: String.t() | nil
}

Functions

from_map(map)

@spec from_map(map() | nil) :: t() | nil