Stripe.Identity.VerificationReport (stripity_stripe_fb v2.13.1) View Source

document() :: %{
  address: %{
    city: String.t(),
    country: String.t(),
    line1: String.t(),
    line2: String.t(),
    postal_code: String.t(),
    state: String.t()
  },
  dob: %{day: integer(), month: integer(), year: integer()},
  error: %{code: String.t(), reason: String.t()},
  expiration_date: %{day: integer(), month: integer(), year: integer()},
  files: [Stripe.id()],
  first_name: String.t(),
  issued_date: String.t(),
  issuing_country: String.t(),
  last_name: String.t(),
  number: String.t(),
  status: String.t(),
  type: String.t()
}

id_number()

Specs

id_number() :: %{
  dob: %{day: integer(), month: integer(), year: integer()},
  error: %{code: String.t(), reason: String.t()},
  first_name: String.t(),
  id_number: String.t(),
  id_number_type: String.t(),
  last_name: String.t(),
  status: String.t()
}

options()

Specs

options() :: %{
  document: %{
    allowed_types: [String.t()],
    require_id_number: boolean(),
    require_live_capture: boolean(),
    require_matching_selfie: boolean()
  },
  id_number: map()
}

selfie()

Specs

selfie() :: %{
  document: String.t(),
  error: %{code: String.t(), reason: String.t()},
  selfie: String.t(),
  status: String.t()
}

t()

Specs

t() :: %Stripe.Identity.VerificationReport{
  created: Stripe.timestamp(),
  document: document(),
  id: Stripe.id(),
  id_number: id_number(),
  livemode: boolean(),
  object: String.t(),
  options: options(),
  selfie: selfie(),
  type: String.t(),
  verification_session: Stripe.id()
}

Link to this section Functions

list(params \\ %{}, opts \\ [])

Specs

list(params, Stripe.options()) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params: %{
       optional(:created) => Stripe.date_query(),
       optional(:type) => String.t(),
       optional(:verification_session) =>
         Stripe.Identity.VerificationSession.t() | Stripe.id(),
       optional(:ending_before) => t() | Stripe.id(),
       optional(:limit) => 1..100,
       optional(:starting_after) => t() | Stripe.id()
     }

List all Verification Reports.

retrieve(id, opts \\ [])

Specs

retrieve(Stripe.id() | t(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

Retrieves an existing VerificationReport.