View Source ExOAPI.Stripe.SDK.Identity (exoapi_stripe v0.1.1)
Link to this section Summary
Functions
description: <p>List all verification reports.</p>
description: <p>Retrieves an existing VerificationReport</p>
description: <p>Returns a list of VerificationSessions</p>
description: <p>Retrieves the details of a VerificationSession that was previously created.</p>
description: <p>Creates a VerificationSession object.</p>
description: <p>Updates a VerificationSession object.</p>
description: <p>A VerificationSession object can be canceled when it is in <code>requires_input</code> <a href="/docs/identity/how-sessions-work">status</a>.</p>
description: <p>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.</p>
Link to this section Types
Link to this section Functions
@spec get_identity_verification_reports(client :: ExOAPI.Client.t(), [ get_identity_verification_reports_opts() ]) :: {:ok, any()} | {:error, any()}
description: <p>List all verification reports.</p>
get_identity_verification_reports_report(client, report, opts \\ [])
View Source@spec get_identity_verification_reports_report( client :: ExOAPI.Client.t(), report :: String.t(), [get_identity_verification_reports_report_opts()] ) :: {:ok, any()} | {:error, any()}
description: <p>Retrieves an existing VerificationReport</p>
@spec get_identity_verification_sessions(client :: ExOAPI.Client.t(), [ get_identity_verification_sessions_opts() ]) :: {:ok, any()} | {:error, any()}
description: <p>Returns a list of VerificationSessions</p>
get_identity_verification_sessions_session(client, session, opts \\ [])
View Source@spec get_identity_verification_sessions_session( client :: ExOAPI.Client.t(), session :: String.t(), [get_identity_verification_sessions_session_opts()] ) :: {:ok, any()} | {:error, any()}
description: <p>Retrieves the details of a VerificationSession that was previously created.</p>
When the session status is requires_input
, you can use this method to retrieve a validclient_secret
or url
to allow re-submission.
@spec post_identity_verification_sessions(client :: ExOAPI.Client.t(), body :: map()) :: {:ok, any()} | {:error, any()}
description: <p>Creates a VerificationSession object.</p>
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.
Related guide: Verify your users’ identity documents.
post_identity_verification_sessions_session(client, body, session)
View Source@spec post_identity_verification_sessions_session( client :: ExOAPI.Client.t(), body :: map(), session :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Updates a VerificationSession object.</p>
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)
View Source@spec post_identity_verification_sessions_session_cancel( client :: ExOAPI.Client.t(), body :: map(), session :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>A VerificationSession object can be canceled when it is in <code>requires_input</code> <a href="/docs/identity/how-sessions-work">status</a>.</p>
Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.
post_identity_verification_sessions_session_redact(client, body, session)
View Source@spec post_identity_verification_sessions_session_redact( client :: ExOAPI.Client.t(), body :: map(), session :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>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.</p>
A VerificationSession object can be redacted when it is in requires_input
or verified
status. 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.