View Source ExOAPI.Stripe.SDK.Identity (exoapi_stripe v0.1.4)

description: A VerificationSession object can be canceled when it is in <code>requires_input</code> <a href="/docs/identity/how-sessions-work">status</a>.

post_identity_verification_sessions_session_redact(client, body, session)

description: Redact a VerificationSession to remove all collected information from Stripe. This will redact the VerificationSession and all objects related to it, including VerificationReports, Events, request logs, etc.

Link to this section Types

get_identity_verification_reports_opts()

@type get_identity_verification_reports_opts() ::
  {:verification_session, String.t()}
  | {:type, String.t()}
  | {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:created, String.t()}

get_identity_verification_reports_report_opts()

@type get_identity_verification_reports_report_opts() :: {:expand, String.t()}

get_identity_verification_sessions_opts()

@type get_identity_verification_sessions_opts() ::
  {:status, String.t()}
  | {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:created, String.t()}

get_identity_verification_sessions_session_opts()

@type get_identity_verification_sessions_session_opts() :: {:expand, String.t()}

Link to this section Functions

get_identity_verification_reports(client, opts \\ [])

@spec get_identity_verification_reports(client :: ExOAPI.Client.t(), [
  get_identity_verification_reports_opts()
]) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | %{
       url: String.t(),
       object: String.t() | :list,
       has_more: boolean(),
       data: [ExOAPI.Stripe.Schemas.Identity_verificationReport.t()]
     }
   | map()}
  | {:error, any()}

description: List all verification reports.

get_identity_verification_reports_report(client, report, opts \\ [])

@spec get_identity_verification_reports_report(
  client :: ExOAPI.Client.t(),
  report :: String.t(),
  [get_identity_verification_reports_report_opts()]
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.Identity_verificationReport.t()
   | map()}
  | {:error, any()}

description: Retrieves an existing VerificationReport

get_identity_verification_sessions(client, opts \\ [])

@spec get_identity_verification_sessions(client :: ExOAPI.Client.t(), [
  get_identity_verification_sessions_opts()
]) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | %{
       url: String.t(),
       object: String.t() | :list,
       has_more: boolean(),
       data: [ExOAPI.Stripe.Schemas.Identity_verificationSession.t()]
     }
   | map()}
  | {:error, any()}

description: Returns a list of VerificationSessions

get_identity_verification_sessions_session(client, session, opts \\ [])

@spec get_identity_verification_sessions_session(
  client :: ExOAPI.Client.t(),
  session :: String.t(),
  [get_identity_verification_sessions_session_opts()]
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.Identity_verificationSession.t()
   | map()}
  | {:error, any()}

description: Retrieves the details of a VerificationSession that was previously created.

When the session status is requires_input, you can use this method to retrieve a validclient_secret or url to allow re-submission.

post_identity_verification_sessions(client, body)

@spec post_identity_verification_sessions(
  client :: ExOAPI.Client.t(),
  body ::
    %{
      type: String.t() | :document | :id_number,
      return_url: String.t(),
      options: %{
        document:
          String.t()
          | %{
              require_matching_selfie: boolean(),
              require_live_capture: boolean(),
              require_id_number: boolean(),
              allowed_types: [
                String.t() | :driving_license | :id_card | :passport
              ]
            }
      },
      metadata: map(),
      expand: [String.t()]
    }
    | map()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.Identity_verificationSession.t()
   | map()}
  | {:error, any()}

description: Creates a VerificationSession object.

After the VerificationSession is created, display a verification modal using the session client_secret or send your users to the session’s url.

If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.

post_identity_verification_sessions_session(client, body, session)

@spec post_identity_verification_sessions_session(
  client :: ExOAPI.Client.t(),
  body ::
    %{
      type: String.t() | :document | :id_number,
      options: %{
        document:
          String.t()
          | %{
              require_matching_selfie: boolean(),
              require_live_capture: boolean(),
              require_id_number: boolean(),
              allowed_types: [
                String.t() | :driving_license | :id_card | :passport
              ]
            }
      },
      metadata: map(),
      expand: [String.t()]
    }
    | map(),
  session :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.Identity_verificationSession.t()
   | map()}
  | {:error, any()}

description: Updates a VerificationSession object.

When the session status is requires_input, you can use this method to update theverification check and options.

post_identity_verification_sessions_session_cancel(client, body, session)

@spec post_identity_verification_sessions_session_cancel(
  client :: ExOAPI.Client.t(),
  body :: %{expand: [String.t()]} | map(),
  session :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.Identity_verificationSession.t()
   | map()}
  | {:error, any()}

description: A VerificationSession object can be canceled when it is in <code>requires_input</code> <a href="/docs/identity/how-sessions-work">status</a>.

Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.

post_identity_verification_sessions_session_redact(client, body, session)

@spec post_identity_verification_sessions_session_redact(
  client :: ExOAPI.Client.t(),
  body :: %{expand: [String.t()]} | map(),
  session :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.Identity_verificationSession.t()
   | map()}
  | {:error, any()}

A VerificationSession object can be redacted when it is in requires_input or verifiedstatus. Redacting a VerificationSession in requires_action state will automatically cancel it.

The redaction process may take up to four days. When the redaction process is in progress, theVerificationSession’s redaction.status field will be set to processing; when the process is finished, it will change to redacted and an identity.verification_session.redacted event will be emitted.

Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all thefields that contain personal data will be replaced by the string [redacted] or a similar placeholder. The metadata field will also be erased. Redacted objects cannot be updated or used for any purpose.

Learn more.

Settings View Source ExOAPI.Stripe.SDK.Identity (exoapi_stripe v0.1.4)

Link to this section Summary

Types

Functions

Link to this section Types

get_identity_verification_reports_opts()

get_identity_verification_reports_report_opts()

get_identity_verification_sessions_opts()

get_identity_verification_sessions_session_opts()

Link to this section Functions

get_identity_verification_reports(client, opts \\ [])

get_identity_verification_reports_report(client, report, opts \\ [])

get_identity_verification_sessions(client, opts \\ [])

get_identity_verification_sessions_session(client, session, opts \\ [])

post_identity_verification_sessions(client, body)

post_identity_verification_sessions_session(client, body, session)

post_identity_verification_sessions_session_cancel(client, body, session)

post_identity_verification_sessions_session_redact(client, body, session)

View Source ExOAPI.Stripe.SDK.Identity (exoapi_stripe v0.1.4)