1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import Optional, cast
from typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe.identity._verification_session import VerificationSession
from stripe.params.identity._verification_session_cancel_params import (
VerificationSessionCancelParams,
)
from stripe.params.identity._verification_session_create_params import (
VerificationSessionCreateParams,
)
from stripe.params.identity._verification_session_list_params import (
VerificationSessionListParams,
)
from stripe.params.identity._verification_session_redact_params import (
VerificationSessionRedactParams,
)
from stripe.params.identity._verification_session_retrieve_params import (
VerificationSessionRetrieveParams,
)
from stripe.params.identity._verification_session_update_params import (
VerificationSessionUpdateParams,
)
class VerificationSessionService(StripeService):
def list(
self,
params: Optional["VerificationSessionListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[VerificationSession]":
"""
Returns a list of VerificationSessions
"""
return cast(
"ListObject[VerificationSession]",
self._request(
"get",
"/v1/identity/verification_sessions",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["VerificationSessionListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[VerificationSession]":
"""
Returns a list of VerificationSessions
"""
return cast(
"ListObject[VerificationSession]",
await self._request_async(
"get",
"/v1/identity/verification_sessions",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: Optional["VerificationSessionCreateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "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",
self._request(
"post",
"/v1/identity/verification_sessions",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: Optional["VerificationSessionCreateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "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 self._request_async(
"post",
"/v1/identity/verification_sessions",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
session: str,
params: Optional["VerificationSessionRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "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.
"""
return cast(
"VerificationSession",
self._request(
"get",
"/v1/identity/verification_sessions/{session}".format(
session=sanitize_id(session),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
session: str,
params: Optional["VerificationSessionRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "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.
"""
return cast(
"VerificationSession",
await self._request_async(
"get",
"/v1/identity/verification_sessions/{session}".format(
session=sanitize_id(session),
),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
session: str,
params: Optional["VerificationSessionUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "VerificationSession":
"""
Updates a VerificationSession object.
When the session status is requires_input, you can use this method to update the
verification check and options.
"""
return cast(
"VerificationSession",
self._request(
"post",
"/v1/identity/verification_sessions/{session}".format(
session=sanitize_id(session),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
session: str,
params: Optional["VerificationSessionUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "VerificationSession":
"""
Updates a VerificationSession object.
When the session status is requires_input, you can use this method to update the
verification check and options.
"""
return cast(
"VerificationSession",
await self._request_async(
"post",
"/v1/identity/verification_sessions/{session}".format(
session=sanitize_id(session),
),
base_address="api",
params=params,
options=options,
),
)
def cancel(
self,
session: str,
params: Optional["VerificationSessionCancelParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "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(session),
),
base_address="api",
params=params,
options=options,
),
)
async def cancel_async(
self,
session: str,
params: Optional["VerificationSessionCancelParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "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(session),
),
base_address="api",
params=params,
options=options,
),
)
def redact(
self,
session: str,
params: Optional["VerificationSessionRedactParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "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(session),
),
base_address="api",
params=params,
options=options,
),
)
async def redact_async(
self,
session: str,
params: Optional["VerificationSessionRedactParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "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(session),
),
base_address="api",
params=params,
options=options,
),
)
|
