exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.Schemas.Identity_verificationSession (exoapi_stripe v0.1.4)

description: A VerificationSession guides you through the process of collecting and verifying the identities of your users. It contains details about the type of verification, such as what verification check to perform. Only create one VerificationSession for each verification in your system.

A VerificationSession transitions through multiple statuses throughout its lifetime as it progresses through the verification flow. The VerificationSession contains the user’s verified data after verification checks are complete.

Related guide: The Verification Sessions API

:client_secret :: :string

The short-lived client secret used by Stripe.js to show a verification modal inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on passing the client secret to the frontend to learn more.

:created :: :integer

Time at which the object was created. Measured in seconds since the Unix epoch.

:id :: :string

Unique identifier for the object.

:last_error :: ExOAPI.Stripe.Schemas.GelatoSessionLastError

If present, this property tells you the last error encountered when processing the verification.

:last_verification_report :: ExOAPI.Stripe.Schemas.Identity_verificationReport | :string

ID of the most recent VerificationReport. Learn more about accessing detailed verification results.

:livemode :: :boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

:metadata :: :map

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.

:object :: :string

String representing the object's type. Objects of the same type share the same value.

:options :: ExOAPI.Stripe.Schemas.GelatoVerificationSessionOptions

:redaction :: ExOAPI.Stripe.Schemas.VerificationSessionRedaction

Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.

:status :: :string

Status of this VerificationSession. Learn more about the lifecycle of sessions.

:type :: :string

The type of verification check to be performed.

:url :: :string

The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on verifying identity documents to learn how to redirect users to Stripe.

:verified_outputs :: ExOAPI.Stripe.Schemas.GelatoVerifiedOutputs

The user’s verified data.

Link to this section Summary

Types

params()
t()

Functions

changeset(struct \\ %__MODULE__{}, params)

Link to this section Types

Link to this type

params()

View Source 
@type params() :: map()
Link to this type

t()

View Source 
@type t() :: %ExOAPI.Stripe.Schemas.Identity_verificationSession{
  client_secret: String.t() | nil,
  created: integer() | nil,
  id: String.t() | nil,
  last_error: ExOAPI.EctoTypes.AnyOf.t() | nil,
  last_verification_report: ExOAPI.EctoTypes.AnyOf.t() | nil,
  livemode: boolean() | nil,
  metadata: map() | nil,
  object: :"identity.verification_session" | nil,
  options: ExOAPI.Stripe.Schemas.GelatoVerificationSessionOptions.t() | nil,
  redaction: ExOAPI.EctoTypes.AnyOf.t() | nil,
  status: (:verified | :requires_input | :processing | :canceled) | nil,
  type: (:id_number | :document) | nil,
  url: String.t() | nil,
  verified_outputs: ExOAPI.EctoTypes.AnyOf.t() | nil
}

Link to this section Functions

Link to this function

changeset(struct \\ %__MODULE__{}, params)

View Source 
@spec changeset(t(), params()) :: Ecto.Changeset.t()