exoapi_stripe v0.1.4

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

description: A VerificationReport is the result of an attempt to collect and verify data from a user. The collection of verification checks performed is determined from the type and options parameters used. You can find the result of each verification check performed in the appropriate sub-resource: document, id_number, selfie.

Each VerificationReport contains a copy of any data collected by the user as well as reference IDs which can be used to access collected images through the FileUpload API. To configure and create VerificationReports, use the VerificationSession API.

Related guides: Accessing verification results.

:created :: :integer

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

:document :: ExOAPI.Stripe.Schemas.GelatoDocumentReport

:id :: :string

Unique identifier for the object.

:id_number :: ExOAPI.Stripe.Schemas.GelatoIdNumberReport

:livemode :: :boolean

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

:object :: :string

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

:options :: ExOAPI.Stripe.Schemas.GelatoVerificationReportOptions

:selfie :: ExOAPI.Stripe.Schemas.GelatoSelfieReport

:type :: :string

Type of report.

:verification_session :: :string

ID of the VerificationSession that created this report.

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_verificationReport{
  created: integer() | nil,
  document: ExOAPI.Stripe.Schemas.GelatoDocumentReport.t() | nil,
  id: String.t() | nil,
  id_number: ExOAPI.Stripe.Schemas.GelatoIdNumberReport.t() | nil,
  livemode: boolean() | nil,
  object: :"identity.verification_report" | nil,
  options: ExOAPI.Stripe.Schemas.GelatoVerificationReportOptions.t() | nil,
  selfie: ExOAPI.Stripe.Schemas.GelatoSelfieReport.t() | nil,
  type: (:id_number | :document) | nil,
  verification_session: String.t() | nil
}

Link to this section Functions

Link to this function

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

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