stripity_stripe
v3.1.1

View Source Stripe.Identity.VerificationReport (stripity_stripe v3.1.1)

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.

Link to this section Summary

Types

created()
t()

The identity.verification_report type.

Functions

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

List all verification reports.

retrieve(report, params \\ %{}, opts \\ [])

Retrieves an existing VerificationReport

Link to this section Types

Link to this type

created()

View Source 
@type created() :: %{
  optional(:gt) => integer(),
  optional(:gte) => integer(),
  optional(:lt) => integer(),
  optional(:lte) => integer()
}
Link to this type

t()

View Source 
@type t() :: %Stripe.Identity.VerificationReport{
  created: integer(),
  document: term(),
  id: binary(),
  id_number: term(),
  livemode: boolean(),
  object: binary(),
  options: term(),
  selfie: term(),
  type: binary(),
  verification_session: binary() | nil
}

The identity.verification_report type.

  • created Time at which the object was created. Measured in seconds since the Unix epoch.
  • document
  • id Unique identifier for the object.
  • id_number
  • livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
  • object String representing the object's type. Objects of the same type share the same value.
  • options
  • selfie
  • type Type of report.
  • verification_session ID of the VerificationSession that created this report.

Link to this section Functions

Link to this function

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

View Source 
@spec list(
  params :: %{
    optional(:created) => created() | integer(),
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:starting_after) => binary(),
    optional(:type) => :document | :id_number,
    optional(:verification_session) => binary()
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

List all verification reports.

Details

  • Method: get
  • Path: /v1/identity/verification_reports
Link to this function

retrieve(report, params \\ %{}, opts \\ [])

View Source 
@spec retrieve(
  report :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieves an existing VerificationReport

Details

  • Method: get
  • Path: /v1/identity/verification_reports/{report}