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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
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 typing import ClassVar, List, Optional
from typing_extensions import Literal, NotRequired, TypedDict, Unpack
class VerificationReport(ListableAPIResource["VerificationReport"]):
"""
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](https://stripe.com/docs/api/files)
API. To configure and create VerificationReports, use the
[VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API.
Related guide: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results).
"""
OBJECT_NAME: ClassVar[Literal["identity.verification_report"]] = (
"identity.verification_report"
)
class Document(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.
"""
class Error(StripeObject):
code: Optional[
Literal[
"document_expired",
"document_type_not_supported",
"document_unverified_other",
]
]
"""
A short machine-readable string giving the reason for the verification failure.
"""
reason: Optional[str]
"""
A human-readable message giving the reason for the failure. These messages can be shown to your users.
"""
class ExpirationDate(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.
"""
class IssuedDate(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]
"""
Address as it appears in the document.
"""
dob: Optional[Dob]
"""
Date of birth as it appears in the document.
"""
error: Optional[Error]
"""
Details on the verification error. Present when status is `unverified`.
"""
expiration_date: Optional[ExpirationDate]
"""
Expiration date of the document.
"""
files: Optional[List[str]]
"""
Array of [File](https://stripe.com/docs/api/files) ids containing images for this document.
"""
first_name: Optional[str]
"""
First name as it appears in the document.
"""
issued_date: Optional[IssuedDate]
"""
Issued date of the document.
"""
issuing_country: Optional[str]
"""
Issuing country of the document.
"""
last_name: Optional[str]
"""
Last name as it appears in the document.
"""
number: Optional[str]
"""
Document ID number.
"""
status: Literal["unverified", "verified"]
"""
Status of this `document` check.
"""
type: Optional[Literal["driving_license", "id_card", "passport"]]
"""
Type of the document.
"""
_inner_class_types = {
"address": Address,
"dob": Dob,
"error": Error,
"expiration_date": ExpirationDate,
"issued_date": IssuedDate,
}
class Email(StripeObject):
class Error(StripeObject):
code: Optional[
Literal[
"email_unverified_other", "email_verification_declined"
]
]
"""
A short machine-readable string giving the reason for the verification failure.
"""
reason: Optional[str]
"""
A human-readable message giving the reason for the failure. These messages can be shown to your users.
"""
email: Optional[str]
"""
Email to be verified.
"""
error: Optional[Error]
"""
Details on the verification error. Present when status is `unverified`.
"""
status: Literal["unverified", "verified"]
"""
Status of this `email` check.
"""
_inner_class_types = {"error": Error}
class IdNumber(StripeObject):
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.
"""
class Error(StripeObject):
code: Optional[
Literal[
"id_number_insufficient_document_data",
"id_number_mismatch",
"id_number_unverified_other",
]
]
"""
A short machine-readable string giving the reason for the verification failure.
"""
reason: Optional[str]
"""
A human-readable message giving the reason for the failure. These messages can be shown to your users.
"""
dob: Optional[Dob]
"""
Date of birth.
"""
error: Optional[Error]
"""
Details on the verification error. Present when status is `unverified`.
"""
first_name: Optional[str]
"""
First name.
"""
id_number: Optional[str]
"""
ID number. When `id_number_type` is `us_ssn`, only the last 4 digits are present.
"""
id_number_type: Optional[Literal["br_cpf", "sg_nric", "us_ssn"]]
"""
Type of ID number.
"""
last_name: Optional[str]
"""
Last name.
"""
status: Literal["unverified", "verified"]
"""
Status of this `id_number` check.
"""
_inner_class_types = {"dob": Dob, "error": Error}
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 IdNumber(StripeObject):
pass
document: Optional[Document]
id_number: Optional[IdNumber]
_inner_class_types = {"document": Document, "id_number": IdNumber}
class Phone(StripeObject):
class Error(StripeObject):
code: Optional[
Literal[
"phone_unverified_other", "phone_verification_declined"
]
]
"""
A short machine-readable string giving the reason for the verification failure.
"""
reason: Optional[str]
"""
A human-readable message giving the reason for the failure. These messages can be shown to your users.
"""
error: Optional[Error]
"""
Details on the verification error. Present when status is `unverified`.
"""
phone: Optional[str]
"""
Phone to be verified.
"""
status: Literal["unverified", "verified"]
"""
Status of this `phone` check.
"""
_inner_class_types = {"error": Error}
class Selfie(StripeObject):
class Error(StripeObject):
code: Optional[
Literal[
"selfie_document_missing_photo",
"selfie_face_mismatch",
"selfie_manipulated",
"selfie_unverified_other",
]
]
"""
A short machine-readable string giving the reason for the verification failure.
"""
reason: Optional[str]
"""
A human-readable message giving the reason for the failure. These messages can be shown to your users.
"""
document: Optional[str]
"""
ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check.
"""
error: Optional[Error]
"""
Details on the verification error. Present when status is `unverified`.
"""
selfie: Optional[str]
"""
ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check.
"""
status: Literal["unverified", "verified"]
"""
Status of this `selfie` check.
"""
_inner_class_types = {"error": Error}
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["VerificationReport.ListParamsCreated|int"]
"""
Only return VerificationReports 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.
"""
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.
"""
type: NotRequired[Literal["document", "id_number"]]
"""
Only return VerificationReports of this type
"""
verification_session: NotRequired[str]
"""
Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID.
"""
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 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.
"""
created: int
"""
Time at which the object was created. Measured in seconds since the Unix epoch.
"""
document: Optional[Document]
"""
Result from a document check
"""
email: Optional[Email]
"""
Result from a email check
"""
id: str
"""
Unique identifier for the object.
"""
id_number: Optional[IdNumber]
"""
Result from an id_number check
"""
livemode: bool
"""
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
"""
object: Literal["identity.verification_report"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
options: Optional[Options]
phone: Optional[Phone]
"""
Result from a phone check
"""
selfie: Optional[Selfie]
"""
Result from a selfie check
"""
type: Literal["document", "id_number", "verification_flow"]
"""
Type of report.
"""
verification_flow: Optional[str]
"""
The configuration token of a verification flow from the dashboard.
"""
verification_session: Optional[str]
"""
ID of the VerificationSession that created this report.
"""
@classmethod
def list(
cls, **params: Unpack["VerificationReport.ListParams"]
) -> ListObject["VerificationReport"]:
"""
List all verification reports.
"""
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["VerificationReport.ListParams"]
) -> ListObject["VerificationReport"]:
"""
List all verification reports.
"""
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 retrieve(
cls, id: str, **params: Unpack["VerificationReport.RetrieveParams"]
) -> "VerificationReport":
"""
Retrieves an existing VerificationReport
"""
instance = cls(id, **params)
instance.refresh()
return instance
@classmethod
async def retrieve_async(
cls, id: str, **params: Unpack["VerificationReport.RetrieveParams"]
) -> "VerificationReport":
"""
Retrieves an existing VerificationReport
"""
instance = cls(id, **params)
await instance.refresh_async()
return instance
_inner_class_types = {
"document": Document,
"email": Email,
"id_number": IdNumber,
"options": Options,
"phone": Phone,
"selfie": Selfie,
}
|
