Stripe.Params.Identity.VerificationSessionUpdateParams (tiger_stripe v0.3.0)

Copy Markdown View Source

Parameters for verification session update.

Summary

Types

options()
provided_details()
t()

Types

options()

@type options() :: %{
  optional(:document) => map() | nil,
  optional(String.t()) => term()
}

provided_details()

@type provided_details() :: %{
  optional(:email) => String.t() | nil,
  optional(:phone) => String.t() | nil,
  optional(String.t()) => term()
}
  • email - Email of user being verified
  • phone - Phone number of user being verified

t()

@type t() :: %Stripe.Params.Identity.VerificationSessionUpdateParams{
  expand: [String.t()] | nil,
  metadata: %{required(String.t()) => String.t()} | nil,
  options: options() | nil,
  provided_details: provided_details() | nil,
  type: String.t() | nil
}
  • expand - Specifies which fields in the response should be expanded.
  • metadata - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
  • options - A set of options for the session’s verification checks.
  • provided_details - Details provided about the user being verified. These details may be shown to the user.
  • type - The type of verification check to be performed. Possible values: document, id_number.