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

Copy Markdown View Source

Parameters for verification session create.

Summary

Types

options()
provided_details()
related_person()
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

related_person()

@type related_person() :: %{
  optional(:account) => String.t() | nil,
  optional(:person) => String.t() | nil,
  optional(String.t()) => term()
}
  • account - A token representing a connected account. If provided, the person parameter is also required and must be associated with the account. Max length: 5000.
  • person - A token referencing a Person resource that this verification is being used to verify. Max length: 5000.

t()

@type t() :: %Stripe.Params.Identity.VerificationSessionCreateParams{
  client_reference_id: String.t() | nil,
  expand: [String.t()] | nil,
  metadata: %{required(String.t()) => String.t()} | nil,
  options: options() | nil,
  provided_details: provided_details() | nil,
  related_customer: String.t() | nil,
  related_customer_account: String.t() | nil,
  related_person: related_person() | nil,
  return_url: String.t() | nil,
  type: String.t() | nil,
  verification_flow: String.t() | nil
}
  • client_reference_id - A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. Max length: 5000.
  • 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.
  • related_customer - Customer ID Max length: 5000.
  • related_customer_account - The ID of the Account representing a customer. Max length: 5000.
  • related_person - Tokens referencing a Person resource and it's associated account.
  • return_url - The URL that the user will be redirected to upon completing the verification flow.
  • type - The type of verification check to be performed. You must provide a type if not passing verification_flow. Possible values: document, id_number.
  • verification_flow - The ID of a verification flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows. Max length: 5000.