1090 lines
44 KiB
Python
1090 lines
44 KiB
Python
# -*- coding: utf-8 -*-
|
|
# File generated from our OpenAPI spec
|
|
from stripe._createable_api_resource import CreateableAPIResource
|
|
from stripe._expandable_field import ExpandableField
|
|
from stripe._list_object import ListObject
|
|
from stripe._listable_api_resource import ListableAPIResource
|
|
from stripe._request_options import RequestOptions
|
|
from stripe._stripe_object import StripeObject
|
|
from stripe._updateable_api_resource import UpdateableAPIResource
|
|
from stripe._util import class_method_variant, sanitize_id
|
|
from typing import ClassVar, Dict, List, Optional, cast, overload
|
|
from typing_extensions import (
|
|
Literal,
|
|
NotRequired,
|
|
TypedDict,
|
|
Unpack,
|
|
TYPE_CHECKING,
|
|
)
|
|
|
|
if TYPE_CHECKING:
|
|
from stripe.identity._verification_report import VerificationReport
|
|
|
|
|
|
class VerificationSession(
|
|
CreateableAPIResource["VerificationSession"],
|
|
ListableAPIResource["VerificationSession"],
|
|
UpdateableAPIResource["VerificationSession"],
|
|
):
|
|
"""
|
|
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](https://docs.stripe.com/docs/identity/verification-checks) to perform. Only create one VerificationSession for
|
|
each verification in your system.
|
|
|
|
A VerificationSession transitions through [multiple
|
|
statuses](https://docs.stripe.com/docs/identity/how-sessions-work) 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](https://stripe.com/docs/identity/verification-sessions)
|
|
"""
|
|
|
|
OBJECT_NAME: ClassVar[Literal["identity.verification_session"]] = (
|
|
"identity.verification_session"
|
|
)
|
|
|
|
class LastError(StripeObject):
|
|
code: Optional[
|
|
Literal[
|
|
"abandoned",
|
|
"consent_declined",
|
|
"country_not_supported",
|
|
"device_not_supported",
|
|
"document_expired",
|
|
"document_type_not_supported",
|
|
"document_unverified_other",
|
|
"email_unverified_other",
|
|
"email_verification_declined",
|
|
"id_number_insufficient_document_data",
|
|
"id_number_mismatch",
|
|
"id_number_unverified_other",
|
|
"phone_unverified_other",
|
|
"phone_verification_declined",
|
|
"selfie_document_missing_photo",
|
|
"selfie_face_mismatch",
|
|
"selfie_manipulated",
|
|
"selfie_unverified_other",
|
|
"under_supported_age",
|
|
]
|
|
]
|
|
"""
|
|
A short machine-readable string giving the reason for the verification or user-session failure.
|
|
"""
|
|
reason: Optional[str]
|
|
"""
|
|
A message that explains the reason for verification or user-session failure.
|
|
"""
|
|
|
|
class Options(StripeObject):
|
|
class Document(StripeObject):
|
|
allowed_types: Optional[
|
|
List[Literal["driving_license", "id_card", "passport"]]
|
|
]
|
|
"""
|
|
Array of strings of allowed identity document types. If the provided identity document isn't one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
|
|
"""
|
|
require_id_number: Optional[bool]
|
|
"""
|
|
Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document's extracted name and date of birth.
|
|
"""
|
|
require_live_capture: Optional[bool]
|
|
"""
|
|
Disable image uploads, identity document images have to be captured using the device's camera.
|
|
"""
|
|
require_matching_selfie: Optional[bool]
|
|
"""
|
|
Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user's face. [Learn more](https://stripe.com/docs/identity/selfie).
|
|
"""
|
|
|
|
class Email(StripeObject):
|
|
require_verification: Optional[bool]
|
|
"""
|
|
Request one time password verification of `provided_details.email`.
|
|
"""
|
|
|
|
class IdNumber(StripeObject):
|
|
pass
|
|
|
|
class Matching(StripeObject):
|
|
dob: Optional[Literal["none", "similar"]]
|
|
"""
|
|
Strictness of the DOB matching policy to apply.
|
|
"""
|
|
name: Optional[Literal["none", "similar"]]
|
|
"""
|
|
Strictness of the name matching policy to apply.
|
|
"""
|
|
|
|
class Phone(StripeObject):
|
|
require_verification: Optional[bool]
|
|
"""
|
|
Request one time password verification of `provided_details.phone`.
|
|
"""
|
|
|
|
document: Optional[Document]
|
|
email: Optional[Email]
|
|
id_number: Optional[IdNumber]
|
|
matching: Optional[Matching]
|
|
phone: Optional[Phone]
|
|
_inner_class_types = {
|
|
"document": Document,
|
|
"email": Email,
|
|
"id_number": IdNumber,
|
|
"matching": Matching,
|
|
"phone": Phone,
|
|
}
|
|
|
|
class ProvidedDetails(StripeObject):
|
|
email: Optional[str]
|
|
"""
|
|
Email of user being verified
|
|
"""
|
|
phone: Optional[str]
|
|
"""
|
|
Phone number of user being verified
|
|
"""
|
|
|
|
class Redaction(StripeObject):
|
|
status: Literal["processing", "redacted"]
|
|
"""
|
|
Indicates whether this object and its related objects have been redacted or not.
|
|
"""
|
|
|
|
class RelatedPerson(StripeObject):
|
|
account: str
|
|
"""
|
|
Token referencing the associated Account of the related Person resource.
|
|
"""
|
|
person: str
|
|
"""
|
|
Token referencing the related Person resource.
|
|
"""
|
|
|
|
class VerifiedOutputs(StripeObject):
|
|
class Address(StripeObject):
|
|
city: Optional[str]
|
|
"""
|
|
City, district, suburb, town, or village.
|
|
"""
|
|
country: Optional[str]
|
|
"""
|
|
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
|
"""
|
|
line1: Optional[str]
|
|
"""
|
|
Address line 1 (e.g., street, PO Box, or company name).
|
|
"""
|
|
line2: Optional[str]
|
|
"""
|
|
Address line 2 (e.g., apartment, suite, unit, or building).
|
|
"""
|
|
postal_code: Optional[str]
|
|
"""
|
|
ZIP or postal code.
|
|
"""
|
|
state: Optional[str]
|
|
"""
|
|
State, county, province, or region.
|
|
"""
|
|
|
|
class Dob(StripeObject):
|
|
day: Optional[int]
|
|
"""
|
|
Numerical day between 1 and 31.
|
|
"""
|
|
month: Optional[int]
|
|
"""
|
|
Numerical month between 1 and 12.
|
|
"""
|
|
year: Optional[int]
|
|
"""
|
|
The four-digit year.
|
|
"""
|
|
|
|
address: Optional[Address]
|
|
"""
|
|
The user's verified address.
|
|
"""
|
|
dob: Optional[Dob]
|
|
"""
|
|
The user's verified date of birth.
|
|
"""
|
|
email: Optional[str]
|
|
"""
|
|
The user's verified email address
|
|
"""
|
|
first_name: Optional[str]
|
|
"""
|
|
The user's verified first name.
|
|
"""
|
|
id_number: Optional[str]
|
|
"""
|
|
The user's verified id number.
|
|
"""
|
|
id_number_type: Optional[Literal["br_cpf", "sg_nric", "us_ssn"]]
|
|
"""
|
|
The user's verified id number type.
|
|
"""
|
|
last_name: Optional[str]
|
|
"""
|
|
The user's verified last name.
|
|
"""
|
|
phone: Optional[str]
|
|
"""
|
|
The user's verified phone number
|
|
"""
|
|
sex: Optional[Literal["[redacted]", "female", "male", "unknown"]]
|
|
"""
|
|
The user's verified sex.
|
|
"""
|
|
unparsed_place_of_birth: Optional[str]
|
|
"""
|
|
The user's verified place of birth as it appears in the document.
|
|
"""
|
|
unparsed_sex: Optional[str]
|
|
"""
|
|
The user's verified sex as it appears in the document.
|
|
"""
|
|
_inner_class_types = {"address": Address, "dob": Dob}
|
|
|
|
class CancelParams(RequestOptions):
|
|
expand: NotRequired[List[str]]
|
|
"""
|
|
Specifies which fields in the response should be expanded.
|
|
"""
|
|
|
|
class CreateParams(RequestOptions):
|
|
client_reference_id: NotRequired[str]
|
|
"""
|
|
A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
|
|
"""
|
|
expand: NotRequired[List[str]]
|
|
"""
|
|
Specifies which fields in the response should be expanded.
|
|
"""
|
|
metadata: NotRequired[Dict[str, str]]
|
|
"""
|
|
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
"""
|
|
options: NotRequired["VerificationSession.CreateParamsOptions"]
|
|
"""
|
|
A set of options for the session's verification checks.
|
|
"""
|
|
provided_details: NotRequired[
|
|
"VerificationSession.CreateParamsProvidedDetails"
|
|
]
|
|
"""
|
|
Details provided about the user being verified. These details may be shown to the user.
|
|
"""
|
|
related_customer: NotRequired[str]
|
|
"""
|
|
Customer ID
|
|
"""
|
|
related_person: NotRequired[
|
|
"VerificationSession.CreateParamsRelatedPerson"
|
|
]
|
|
"""
|
|
Tokens referencing a Person resource and it's associated account.
|
|
"""
|
|
return_url: NotRequired[str]
|
|
"""
|
|
The URL that the user will be redirected to upon completing the verification flow.
|
|
"""
|
|
type: NotRequired[Literal["document", "id_number"]]
|
|
"""
|
|
The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`.
|
|
"""
|
|
verification_flow: NotRequired[str]
|
|
"""
|
|
The ID of a verification flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows.
|
|
"""
|
|
|
|
class CreateParamsOptions(TypedDict):
|
|
document: NotRequired[
|
|
"Literal['']|VerificationSession.CreateParamsOptionsDocument"
|
|
]
|
|
"""
|
|
Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document).
|
|
"""
|
|
|
|
class CreateParamsOptionsDocument(TypedDict):
|
|
allowed_types: NotRequired[
|
|
List[Literal["driving_license", "id_card", "passport"]]
|
|
]
|
|
"""
|
|
Array of strings of allowed identity document types. If the provided identity document isn't one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
|
|
"""
|
|
require_id_number: NotRequired[bool]
|
|
"""
|
|
Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document's extracted name and date of birth.
|
|
"""
|
|
require_live_capture: NotRequired[bool]
|
|
"""
|
|
Disable image uploads, identity document images have to be captured using the device's camera.
|
|
"""
|
|
require_matching_selfie: NotRequired[bool]
|
|
"""
|
|
Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user's face. [Learn more](https://stripe.com/docs/identity/selfie).
|
|
"""
|
|
|
|
class CreateParamsProvidedDetails(TypedDict):
|
|
email: NotRequired[str]
|
|
"""
|
|
Email of user being verified
|
|
"""
|
|
phone: NotRequired[str]
|
|
"""
|
|
Phone number of user being verified
|
|
"""
|
|
|
|
class CreateParamsRelatedPerson(TypedDict):
|
|
account: str
|
|
"""
|
|
A token representing a connected account. If provided, the person parameter is also required and must be associated with the account.
|
|
"""
|
|
person: str
|
|
"""
|
|
A token referencing a Person resource that this verification is being used to verify.
|
|
"""
|
|
|
|
class ListParams(RequestOptions):
|
|
client_reference_id: NotRequired[str]
|
|
"""
|
|
A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
|
|
"""
|
|
created: NotRequired["VerificationSession.ListParamsCreated|int"]
|
|
"""
|
|
Only return VerificationSessions that were created during the given date interval.
|
|
"""
|
|
ending_before: NotRequired[str]
|
|
"""
|
|
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
|
|
"""
|
|
expand: NotRequired[List[str]]
|
|
"""
|
|
Specifies which fields in the response should be expanded.
|
|
"""
|
|
limit: NotRequired[int]
|
|
"""
|
|
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
|
"""
|
|
related_customer: NotRequired[str]
|
|
starting_after: NotRequired[str]
|
|
"""
|
|
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
|
|
"""
|
|
status: NotRequired[
|
|
Literal["canceled", "processing", "requires_input", "verified"]
|
|
]
|
|
"""
|
|
Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).
|
|
"""
|
|
|
|
class ListParamsCreated(TypedDict):
|
|
gt: NotRequired[int]
|
|
"""
|
|
Minimum value to filter by (exclusive)
|
|
"""
|
|
gte: NotRequired[int]
|
|
"""
|
|
Minimum value to filter by (inclusive)
|
|
"""
|
|
lt: NotRequired[int]
|
|
"""
|
|
Maximum value to filter by (exclusive)
|
|
"""
|
|
lte: NotRequired[int]
|
|
"""
|
|
Maximum value to filter by (inclusive)
|
|
"""
|
|
|
|
class ModifyParams(RequestOptions):
|
|
expand: NotRequired[List[str]]
|
|
"""
|
|
Specifies which fields in the response should be expanded.
|
|
"""
|
|
metadata: NotRequired[Dict[str, str]]
|
|
"""
|
|
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
"""
|
|
options: NotRequired["VerificationSession.ModifyParamsOptions"]
|
|
"""
|
|
A set of options for the session's verification checks.
|
|
"""
|
|
provided_details: NotRequired[
|
|
"VerificationSession.ModifyParamsProvidedDetails"
|
|
]
|
|
"""
|
|
Details provided about the user being verified. These details may be shown to the user.
|
|
"""
|
|
type: NotRequired[Literal["document", "id_number"]]
|
|
"""
|
|
The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.
|
|
"""
|
|
|
|
class ModifyParamsOptions(TypedDict):
|
|
document: NotRequired[
|
|
"Literal['']|VerificationSession.ModifyParamsOptionsDocument"
|
|
]
|
|
"""
|
|
Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document).
|
|
"""
|
|
|
|
class ModifyParamsOptionsDocument(TypedDict):
|
|
allowed_types: NotRequired[
|
|
List[Literal["driving_license", "id_card", "passport"]]
|
|
]
|
|
"""
|
|
Array of strings of allowed identity document types. If the provided identity document isn't one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
|
|
"""
|
|
require_id_number: NotRequired[bool]
|
|
"""
|
|
Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document's extracted name and date of birth.
|
|
"""
|
|
require_live_capture: NotRequired[bool]
|
|
"""
|
|
Disable image uploads, identity document images have to be captured using the device's camera.
|
|
"""
|
|
require_matching_selfie: NotRequired[bool]
|
|
"""
|
|
Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user's face. [Learn more](https://stripe.com/docs/identity/selfie).
|
|
"""
|
|
|
|
class ModifyParamsProvidedDetails(TypedDict):
|
|
email: NotRequired[str]
|
|
"""
|
|
Email of user being verified
|
|
"""
|
|
phone: NotRequired[str]
|
|
"""
|
|
Phone number of user being verified
|
|
"""
|
|
|
|
class RedactParams(RequestOptions):
|
|
expand: NotRequired[List[str]]
|
|
"""
|
|
Specifies which fields in the response should be expanded.
|
|
"""
|
|
|
|
class RetrieveParams(RequestOptions):
|
|
expand: NotRequired[List[str]]
|
|
"""
|
|
Specifies which fields in the response should be expanded.
|
|
"""
|
|
|
|
client_reference_id: Optional[str]
|
|
"""
|
|
A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
|
|
"""
|
|
client_secret: Optional[str]
|
|
"""
|
|
The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/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](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more.
|
|
"""
|
|
created: int
|
|
"""
|
|
Time at which the object was created. Measured in seconds since the Unix epoch.
|
|
"""
|
|
id: str
|
|
"""
|
|
Unique identifier for the object.
|
|
"""
|
|
last_error: Optional[LastError]
|
|
"""
|
|
If present, this property tells you the last error encountered when processing the verification.
|
|
"""
|
|
last_verification_report: Optional[ExpandableField["VerificationReport"]]
|
|
"""
|
|
ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results)
|
|
"""
|
|
livemode: bool
|
|
"""
|
|
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
"""
|
|
metadata: Dict[str, str]
|
|
"""
|
|
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
"""
|
|
object: Literal["identity.verification_session"]
|
|
"""
|
|
String representing the object's type. Objects of the same type share the same value.
|
|
"""
|
|
options: Optional[Options]
|
|
"""
|
|
A set of options for the session's verification checks.
|
|
"""
|
|
provided_details: Optional[ProvidedDetails]
|
|
"""
|
|
Details provided about the user being verified. These details may be shown to the user.
|
|
"""
|
|
redaction: Optional[Redaction]
|
|
"""
|
|
Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.
|
|
"""
|
|
related_customer: Optional[str]
|
|
"""
|
|
Customer ID
|
|
"""
|
|
related_person: Optional[RelatedPerson]
|
|
status: Literal["canceled", "processing", "requires_input", "verified"]
|
|
"""
|
|
Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).
|
|
"""
|
|
type: Literal["document", "id_number", "verification_flow"]
|
|
"""
|
|
The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.
|
|
"""
|
|
url: Optional[str]
|
|
"""
|
|
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](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe.
|
|
"""
|
|
verification_flow: Optional[str]
|
|
"""
|
|
The configuration token of a verification flow from the dashboard.
|
|
"""
|
|
verified_outputs: Optional[VerifiedOutputs]
|
|
"""
|
|
The user's verified data.
|
|
"""
|
|
|
|
@classmethod
|
|
def _cls_cancel(
|
|
cls, session: str, **params: Unpack["VerificationSession.CancelParams"]
|
|
) -> "VerificationSession":
|
|
"""
|
|
A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work).
|
|
|
|
Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel).
|
|
"""
|
|
return cast(
|
|
"VerificationSession",
|
|
cls._static_request(
|
|
"post",
|
|
"/v1/identity/verification_sessions/{session}/cancel".format(
|
|
session=sanitize_id(session)
|
|
),
|
|
params=params,
|
|
),
|
|
)
|
|
|
|
@overload
|
|
@staticmethod
|
|
def cancel(
|
|
session: str, **params: Unpack["VerificationSession.CancelParams"]
|
|
) -> "VerificationSession":
|
|
"""
|
|
A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work).
|
|
|
|
Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel).
|
|
"""
|
|
...
|
|
|
|
@overload
|
|
def cancel(
|
|
self, **params: Unpack["VerificationSession.CancelParams"]
|
|
) -> "VerificationSession":
|
|
"""
|
|
A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work).
|
|
|
|
Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel).
|
|
"""
|
|
...
|
|
|
|
@class_method_variant("_cls_cancel")
|
|
def cancel( # pyright: ignore[reportGeneralTypeIssues]
|
|
self, **params: Unpack["VerificationSession.CancelParams"]
|
|
) -> "VerificationSession":
|
|
"""
|
|
A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work).
|
|
|
|
Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel).
|
|
"""
|
|
return cast(
|
|
"VerificationSession",
|
|
self._request(
|
|
"post",
|
|
"/v1/identity/verification_sessions/{session}/cancel".format(
|
|
session=sanitize_id(self.get("id"))
|
|
),
|
|
params=params,
|
|
),
|
|
)
|
|
|
|
@classmethod
|
|
async def _cls_cancel_async(
|
|
cls, session: str, **params: Unpack["VerificationSession.CancelParams"]
|
|
) -> "VerificationSession":
|
|
"""
|
|
A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work).
|
|
|
|
Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel).
|
|
"""
|
|
return cast(
|
|
"VerificationSession",
|
|
await cls._static_request_async(
|
|
"post",
|
|
"/v1/identity/verification_sessions/{session}/cancel".format(
|
|
session=sanitize_id(session)
|
|
),
|
|
params=params,
|
|
),
|
|
)
|
|
|
|
@overload
|
|
@staticmethod
|
|
async def cancel_async(
|
|
session: str, **params: Unpack["VerificationSession.CancelParams"]
|
|
) -> "VerificationSession":
|
|
"""
|
|
A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work).
|
|
|
|
Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel).
|
|
"""
|
|
...
|
|
|
|
@overload
|
|
async def cancel_async(
|
|
self, **params: Unpack["VerificationSession.CancelParams"]
|
|
) -> "VerificationSession":
|
|
"""
|
|
A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work).
|
|
|
|
Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel).
|
|
"""
|
|
...
|
|
|
|
@class_method_variant("_cls_cancel_async")
|
|
async def cancel_async( # pyright: ignore[reportGeneralTypeIssues]
|
|
self, **params: Unpack["VerificationSession.CancelParams"]
|
|
) -> "VerificationSession":
|
|
"""
|
|
A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work).
|
|
|
|
Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel).
|
|
"""
|
|
return cast(
|
|
"VerificationSession",
|
|
await self._request_async(
|
|
"post",
|
|
"/v1/identity/verification_sessions/{session}/cancel".format(
|
|
session=sanitize_id(self.get("id"))
|
|
),
|
|
params=params,
|
|
),
|
|
)
|
|
|
|
@classmethod
|
|
def create(
|
|
cls, **params: Unpack["VerificationSession.CreateParams"]
|
|
) -> "VerificationSession":
|
|
"""
|
|
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.
|
|
|
|
Related guide: [Verify your users' identity documents](https://docs.stripe.com/docs/identity/verify-identity-documents)
|
|
"""
|
|
return cast(
|
|
"VerificationSession",
|
|
cls._static_request(
|
|
"post",
|
|
cls.class_url(),
|
|
params=params,
|
|
),
|
|
)
|
|
|
|
@classmethod
|
|
async def create_async(
|
|
cls, **params: Unpack["VerificationSession.CreateParams"]
|
|
) -> "VerificationSession":
|
|
"""
|
|
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.
|
|
|
|
Related guide: [Verify your users' identity documents](https://docs.stripe.com/docs/identity/verify-identity-documents)
|
|
"""
|
|
return cast(
|
|
"VerificationSession",
|
|
await cls._static_request_async(
|
|
"post",
|
|
cls.class_url(),
|
|
params=params,
|
|
),
|
|
)
|
|
|
|
@classmethod
|
|
def list(
|
|
cls, **params: Unpack["VerificationSession.ListParams"]
|
|
) -> ListObject["VerificationSession"]:
|
|
"""
|
|
Returns a list of VerificationSessions
|
|
"""
|
|
result = cls._static_request(
|
|
"get",
|
|
cls.class_url(),
|
|
params=params,
|
|
)
|
|
if not isinstance(result, ListObject):
|
|
raise TypeError(
|
|
"Expected list object from API, got %s"
|
|
% (type(result).__name__)
|
|
)
|
|
|
|
return result
|
|
|
|
@classmethod
|
|
async def list_async(
|
|
cls, **params: Unpack["VerificationSession.ListParams"]
|
|
) -> ListObject["VerificationSession"]:
|
|
"""
|
|
Returns a list of VerificationSessions
|
|
"""
|
|
result = await cls._static_request_async(
|
|
"get",
|
|
cls.class_url(),
|
|
params=params,
|
|
)
|
|
if not isinstance(result, ListObject):
|
|
raise TypeError(
|
|
"Expected list object from API, got %s"
|
|
% (type(result).__name__)
|
|
)
|
|
|
|
return result
|
|
|
|
@classmethod
|
|
def modify(
|
|
cls, id: str, **params: Unpack["VerificationSession.ModifyParams"]
|
|
) -> "VerificationSession":
|
|
"""
|
|
Updates a VerificationSession object.
|
|
|
|
When the session status is requires_input, you can use this method to update the
|
|
verification check and options.
|
|
"""
|
|
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
|
|
return cast(
|
|
"VerificationSession",
|
|
cls._static_request(
|
|
"post",
|
|
url,
|
|
params=params,
|
|
),
|
|
)
|
|
|
|
@classmethod
|
|
async def modify_async(
|
|
cls, id: str, **params: Unpack["VerificationSession.ModifyParams"]
|
|
) -> "VerificationSession":
|
|
"""
|
|
Updates a VerificationSession object.
|
|
|
|
When the session status is requires_input, you can use this method to update the
|
|
verification check and options.
|
|
"""
|
|
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
|
|
return cast(
|
|
"VerificationSession",
|
|
await cls._static_request_async(
|
|
"post",
|
|
url,
|
|
params=params,
|
|
),
|
|
)
|
|
|
|
@classmethod
|
|
def _cls_redact(
|
|
cls, session: str, **params: Unpack["VerificationSession.RedactParams"]
|
|
) -> "VerificationSession":
|
|
"""
|
|
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.
|
|
|
|
A VerificationSession object can be redacted when it is in requires_input or verified
|
|
[status](https://docs.stripe.com/docs/identity/how-sessions-work). 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, the
|
|
VerificationSession'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 the
|
|
fields 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](https://docs.stripe.com/docs/identity/verification-sessions#redact).
|
|
"""
|
|
return cast(
|
|
"VerificationSession",
|
|
cls._static_request(
|
|
"post",
|
|
"/v1/identity/verification_sessions/{session}/redact".format(
|
|
session=sanitize_id(session)
|
|
),
|
|
params=params,
|
|
),
|
|
)
|
|
|
|
@overload
|
|
@staticmethod
|
|
def redact(
|
|
session: str, **params: Unpack["VerificationSession.RedactParams"]
|
|
) -> "VerificationSession":
|
|
"""
|
|
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.
|
|
|
|
A VerificationSession object can be redacted when it is in requires_input or verified
|
|
[status](https://docs.stripe.com/docs/identity/how-sessions-work). 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, the
|
|
VerificationSession'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 the
|
|
fields 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](https://docs.stripe.com/docs/identity/verification-sessions#redact).
|
|
"""
|
|
...
|
|
|
|
@overload
|
|
def redact(
|
|
self, **params: Unpack["VerificationSession.RedactParams"]
|
|
) -> "VerificationSession":
|
|
"""
|
|
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.
|
|
|
|
A VerificationSession object can be redacted when it is in requires_input or verified
|
|
[status](https://docs.stripe.com/docs/identity/how-sessions-work). 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, the
|
|
VerificationSession'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 the
|
|
fields 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](https://docs.stripe.com/docs/identity/verification-sessions#redact).
|
|
"""
|
|
...
|
|
|
|
@class_method_variant("_cls_redact")
|
|
def redact( # pyright: ignore[reportGeneralTypeIssues]
|
|
self, **params: Unpack["VerificationSession.RedactParams"]
|
|
) -> "VerificationSession":
|
|
"""
|
|
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.
|
|
|
|
A VerificationSession object can be redacted when it is in requires_input or verified
|
|
[status](https://docs.stripe.com/docs/identity/how-sessions-work). 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, the
|
|
VerificationSession'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 the
|
|
fields 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](https://docs.stripe.com/docs/identity/verification-sessions#redact).
|
|
"""
|
|
return cast(
|
|
"VerificationSession",
|
|
self._request(
|
|
"post",
|
|
"/v1/identity/verification_sessions/{session}/redact".format(
|
|
session=sanitize_id(self.get("id"))
|
|
),
|
|
params=params,
|
|
),
|
|
)
|
|
|
|
@classmethod
|
|
async def _cls_redact_async(
|
|
cls, session: str, **params: Unpack["VerificationSession.RedactParams"]
|
|
) -> "VerificationSession":
|
|
"""
|
|
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.
|
|
|
|
A VerificationSession object can be redacted when it is in requires_input or verified
|
|
[status](https://docs.stripe.com/docs/identity/how-sessions-work). 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, the
|
|
VerificationSession'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 the
|
|
fields 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](https://docs.stripe.com/docs/identity/verification-sessions#redact).
|
|
"""
|
|
return cast(
|
|
"VerificationSession",
|
|
await cls._static_request_async(
|
|
"post",
|
|
"/v1/identity/verification_sessions/{session}/redact".format(
|
|
session=sanitize_id(session)
|
|
),
|
|
params=params,
|
|
),
|
|
)
|
|
|
|
@overload
|
|
@staticmethod
|
|
async def redact_async(
|
|
session: str, **params: Unpack["VerificationSession.RedactParams"]
|
|
) -> "VerificationSession":
|
|
"""
|
|
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.
|
|
|
|
A VerificationSession object can be redacted when it is in requires_input or verified
|
|
[status](https://docs.stripe.com/docs/identity/how-sessions-work). 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, the
|
|
VerificationSession'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 the
|
|
fields 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](https://docs.stripe.com/docs/identity/verification-sessions#redact).
|
|
"""
|
|
...
|
|
|
|
@overload
|
|
async def redact_async(
|
|
self, **params: Unpack["VerificationSession.RedactParams"]
|
|
) -> "VerificationSession":
|
|
"""
|
|
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.
|
|
|
|
A VerificationSession object can be redacted when it is in requires_input or verified
|
|
[status](https://docs.stripe.com/docs/identity/how-sessions-work). 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, the
|
|
VerificationSession'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 the
|
|
fields 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](https://docs.stripe.com/docs/identity/verification-sessions#redact).
|
|
"""
|
|
...
|
|
|
|
@class_method_variant("_cls_redact_async")
|
|
async def redact_async( # pyright: ignore[reportGeneralTypeIssues]
|
|
self, **params: Unpack["VerificationSession.RedactParams"]
|
|
) -> "VerificationSession":
|
|
"""
|
|
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.
|
|
|
|
A VerificationSession object can be redacted when it is in requires_input or verified
|
|
[status](https://docs.stripe.com/docs/identity/how-sessions-work). 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, the
|
|
VerificationSession'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 the
|
|
fields 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](https://docs.stripe.com/docs/identity/verification-sessions#redact).
|
|
"""
|
|
return cast(
|
|
"VerificationSession",
|
|
await self._request_async(
|
|
"post",
|
|
"/v1/identity/verification_sessions/{session}/redact".format(
|
|
session=sanitize_id(self.get("id"))
|
|
),
|
|
params=params,
|
|
),
|
|
)
|
|
|
|
@classmethod
|
|
def retrieve(
|
|
cls, id: str, **params: Unpack["VerificationSession.RetrieveParams"]
|
|
) -> "VerificationSession":
|
|
"""
|
|
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 valid
|
|
client_secret or url to allow re-submission.
|
|
"""
|
|
instance = cls(id, **params)
|
|
instance.refresh()
|
|
return instance
|
|
|
|
@classmethod
|
|
async def retrieve_async(
|
|
cls, id: str, **params: Unpack["VerificationSession.RetrieveParams"]
|
|
) -> "VerificationSession":
|
|
"""
|
|
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 valid
|
|
client_secret or url to allow re-submission.
|
|
"""
|
|
instance = cls(id, **params)
|
|
await instance.refresh_async()
|
|
return instance
|
|
|
|
_inner_class_types = {
|
|
"last_error": LastError,
|
|
"options": Options,
|
|
"provided_details": ProvidedDetails,
|
|
"redaction": Redaction,
|
|
"related_person": RelatedPerson,
|
|
"verified_outputs": VerifiedOutputs,
|
|
}
|