-
Notifications
You must be signed in to change notification settings - Fork 744
/
Accounts.d.ts
1402 lines (1145 loc) · 55.1 KB
/
Accounts.d.ts
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
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// File generated from our OpenAPI spec
declare module 'stripe' {
namespace Stripe {
/**
* This is an object representing a Stripe account. You can retrieve it to see
* properties on the account like its current requirements or if the account is
* enabled to make live charges or receive payouts.
*
* For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection)
* is `application`, which includes Custom accounts, the properties below are always
* returned.
*
* For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection)
* is `stripe`, which includes Standard and Express accounts, some properties are only returned
* until you create an [Account Link](https://stripe.com/api/account_links) or [Account Session](https://stripe.com/api/account_sessions)
* to start Connect Onboarding. Learn about the [differences between accounts](https://stripe.com/connect/accounts).
*/
interface Account {
/**
* Unique identifier for the object.
*/
id: string;
/**
* String representing the object's type. Objects of the same type share the same value.
*/
object: 'account';
/**
* Business information about the account.
*/
business_profile?: Account.BusinessProfile | null;
/**
* The business type. After you create an [Account Link](https://stripe.com/api/account_links) or [Account Session](https://stripe.com/api/account_sessions), this property is only returned for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
*/
business_type?: Account.BusinessType | null;
capabilities?: Account.Capabilities;
/**
* Whether the account can create live charges.
*/
charges_enabled: boolean;
company?: Account.Company;
controller?: Account.Controller;
/**
* The account's country.
*/
country?: string;
/**
* Time at which the account was connected. Measured in seconds since the Unix epoch.
*/
created?: number;
/**
* Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts).
*/
default_currency?: string;
/**
* Always true for a deleted object
*/
deleted?: void;
/**
* Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true.
*/
details_submitted: boolean;
/**
* An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform.
*/
email: string | null;
/**
* External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where `controller[is_controller]` is true.
*/
external_accounts?: ApiList<Stripe.ExternalAccount>;
future_requirements?: Account.FutureRequirements;
/**
* This is an object representing a person associated with a Stripe account.
*
* A platform cannot access a person for an account where [account.controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.
*
* See the [Standard onboarding](https://stripe.com/connect/standard-accounts) or [Express onboarding](https://stripe.com/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](https://stripe.com/connect/handling-api-verification#person-information).
*/
individual?: Stripe.Person;
/**
* 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.
*/
metadata?: Stripe.Metadata;
/**
* Whether Stripe can send payouts to this account.
*/
payouts_enabled: boolean;
requirements?: Account.Requirements;
/**
* Options for customizing how the account functions within Stripe.
*/
settings?: Account.Settings | null;
tos_acceptance?: Account.TosAcceptance;
/**
* The Stripe account type. Can be `standard`, `express`, `custom`, or `none`.
*/
type: Account.Type;
}
namespace Account {
interface BusinessProfile {
/**
* The applicant's gross annual revenue for its preceding fiscal year.
*/
annual_revenue: BusinessProfile.AnnualRevenue | null;
/**
* An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.
*/
estimated_worker_count: number | null;
/**
* [The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.
*/
mcc: string | null;
monthly_estimated_revenue?: BusinessProfile.MonthlyEstimatedRevenue;
/**
* The customer-facing business name.
*/
name: string | null;
/**
* Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes.
*/
product_description?: string | null;
/**
* A publicly available mailing address for sending support issues to.
*/
support_address: Stripe.Address | null;
/**
* A publicly available email address for sending support issues to.
*/
support_email: string | null;
/**
* A publicly available phone number to call with support issues.
*/
support_phone: string | null;
/**
* A publicly available website for handling support issues.
*/
support_url: string | null;
/**
* The business's publicly available website.
*/
url: string | null;
}
namespace BusinessProfile {
interface AnnualRevenue {
/**
* A non-negative integer representing the amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
*/
amount: number | null;
/**
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
*/
currency: string | null;
/**
* The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.
*/
fiscal_year_end: string | null;
}
interface MonthlyEstimatedRevenue {
/**
* A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
*/
amount: number;
/**
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
*/
currency: string;
}
}
type BusinessType =
| 'company'
| 'government_entity'
| 'individual'
| 'non_profit';
interface Capabilities {
/**
* The status of the Canadian pre-authorized debits payments capability of the account, or whether the account can directly process Canadian pre-authorized debits charges.
*/
acss_debit_payments?: Capabilities.AcssDebitPayments;
/**
* The status of the Affirm capability of the account, or whether the account can directly process Affirm charges.
*/
affirm_payments?: Capabilities.AffirmPayments;
/**
* The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges.
*/
afterpay_clearpay_payments?: Capabilities.AfterpayClearpayPayments;
/**
* The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments.
*/
amazon_pay_payments?: Capabilities.AmazonPayPayments;
/**
* The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges.
*/
au_becs_debit_payments?: Capabilities.AuBecsDebitPayments;
/**
* The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges.
*/
bacs_debit_payments?: Capabilities.BacsDebitPayments;
/**
* The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges.
*/
bancontact_payments?: Capabilities.BancontactPayments;
/**
* The status of the customer_balance payments capability of the account, or whether the account can directly process customer_balance charges.
*/
bank_transfer_payments?: Capabilities.BankTransferPayments;
/**
* The status of the blik payments capability of the account, or whether the account can directly process blik charges.
*/
blik_payments?: Capabilities.BlikPayments;
/**
* The status of the boleto payments capability of the account, or whether the account can directly process boleto charges.
*/
boleto_payments?: Capabilities.BoletoPayments;
/**
* The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards
*/
card_issuing?: Capabilities.CardIssuing;
/**
* The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges.
*/
card_payments?: Capabilities.CardPayments;
/**
* The status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency.
*/
cartes_bancaires_payments?: Capabilities.CartesBancairesPayments;
/**
* The status of the Cash App Pay capability of the account, or whether the account can directly process Cash App Pay payments.
*/
cashapp_payments?: Capabilities.CashappPayments;
/**
* The status of the EPS payments capability of the account, or whether the account can directly process EPS charges.
*/
eps_payments?: Capabilities.EpsPayments;
/**
* The status of the FPX payments capability of the account, or whether the account can directly process FPX charges.
*/
fpx_payments?: Capabilities.FpxPayments;
/**
* The status of the giropay payments capability of the account, or whether the account can directly process giropay charges.
*/
giropay_payments?: Capabilities.GiropayPayments;
/**
* The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges.
*/
grabpay_payments?: Capabilities.GrabpayPayments;
/**
* The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges.
*/
ideal_payments?: Capabilities.IdealPayments;
/**
* The status of the india_international_payments capability of the account, or whether the account can process international charges (non INR) in India.
*/
india_international_payments?: Capabilities.IndiaInternationalPayments;
/**
* The status of the JCB payments capability of the account, or whether the account (Japan only) can directly process JCB credit card charges in JPY currency.
*/
jcb_payments?: Capabilities.JcbPayments;
/**
* The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges.
*/
klarna_payments?: Capabilities.KlarnaPayments;
/**
* The status of the konbini payments capability of the account, or whether the account can directly process konbini charges.
*/
konbini_payments?: Capabilities.KonbiniPayments;
/**
* The status of the legacy payments capability of the account.
*/
legacy_payments?: Capabilities.LegacyPayments;
/**
* The status of the link_payments capability of the account, or whether the account can directly process Link charges.
*/
link_payments?: Capabilities.LinkPayments;
/**
* The status of the MobilepPay capability of the account, or whether the account can directly process MobilePay charges.
*/
mobilepay_payments?: Capabilities.MobilepayPayments;
/**
* The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges.
*/
oxxo_payments?: Capabilities.OxxoPayments;
/**
* The status of the P24 payments capability of the account, or whether the account can directly process P24 charges.
*/
p24_payments?: Capabilities.P24Payments;
/**
* The status of the paynow payments capability of the account, or whether the account can directly process paynow charges.
*/
paynow_payments?: Capabilities.PaynowPayments;
/**
* The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges.
*/
promptpay_payments?: Capabilities.PromptpayPayments;
/**
* The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments.
*/
revolut_pay_payments?: Capabilities.RevolutPayPayments;
/**
* The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges.
*/
sepa_debit_payments?: Capabilities.SepaDebitPayments;
/**
* The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges.
*/
sofort_payments?: Capabilities.SofortPayments;
/**
* The status of the Swish capability of the account, or whether the account can directly process Swish payments.
*/
swish_payments?: Capabilities.SwishPayments;
/**
* The status of the tax reporting 1099-K (US) capability of the account.
*/
tax_reporting_us_1099_k?: Capabilities.TaxReportingUs1099K;
/**
* The status of the tax reporting 1099-MISC (US) capability of the account.
*/
tax_reporting_us_1099_misc?: Capabilities.TaxReportingUs1099Misc;
/**
* The status of the transfers capability of the account, or whether your platform can transfer funds to the account.
*/
transfers?: Capabilities.Transfers;
/**
* The status of the banking capability, or whether the account can have bank accounts.
*/
treasury?: Capabilities.Treasury;
/**
* The status of the US bank account ACH payments capability of the account, or whether the account can directly process US bank account charges.
*/
us_bank_account_ach_payments?: Capabilities.UsBankAccountAchPayments;
/**
* The status of the Zip capability of the account, or whether the account can directly process Zip charges.
*/
zip_payments?: Capabilities.ZipPayments;
}
namespace Capabilities {
type AcssDebitPayments = 'active' | 'inactive' | 'pending';
type AffirmPayments = 'active' | 'inactive' | 'pending';
type AfterpayClearpayPayments = 'active' | 'inactive' | 'pending';
type AmazonPayPayments = 'active' | 'inactive' | 'pending';
type AuBecsDebitPayments = 'active' | 'inactive' | 'pending';
type BacsDebitPayments = 'active' | 'inactive' | 'pending';
type BancontactPayments = 'active' | 'inactive' | 'pending';
type BankTransferPayments = 'active' | 'inactive' | 'pending';
type BlikPayments = 'active' | 'inactive' | 'pending';
type BoletoPayments = 'active' | 'inactive' | 'pending';
type CardIssuing = 'active' | 'inactive' | 'pending';
type CardPayments = 'active' | 'inactive' | 'pending';
type CartesBancairesPayments = 'active' | 'inactive' | 'pending';
type CashappPayments = 'active' | 'inactive' | 'pending';
type EpsPayments = 'active' | 'inactive' | 'pending';
type FpxPayments = 'active' | 'inactive' | 'pending';
type GiropayPayments = 'active' | 'inactive' | 'pending';
type GrabpayPayments = 'active' | 'inactive' | 'pending';
type IdealPayments = 'active' | 'inactive' | 'pending';
type IndiaInternationalPayments = 'active' | 'inactive' | 'pending';
type JcbPayments = 'active' | 'inactive' | 'pending';
type KlarnaPayments = 'active' | 'inactive' | 'pending';
type KonbiniPayments = 'active' | 'inactive' | 'pending';
type LegacyPayments = 'active' | 'inactive' | 'pending';
type LinkPayments = 'active' | 'inactive' | 'pending';
type MobilepayPayments = 'active' | 'inactive' | 'pending';
type OxxoPayments = 'active' | 'inactive' | 'pending';
type P24Payments = 'active' | 'inactive' | 'pending';
type PaynowPayments = 'active' | 'inactive' | 'pending';
type PromptpayPayments = 'active' | 'inactive' | 'pending';
type RevolutPayPayments = 'active' | 'inactive' | 'pending';
type SepaDebitPayments = 'active' | 'inactive' | 'pending';
type SofortPayments = 'active' | 'inactive' | 'pending';
type SwishPayments = 'active' | 'inactive' | 'pending';
type TaxReportingUs1099K = 'active' | 'inactive' | 'pending';
type TaxReportingUs1099Misc = 'active' | 'inactive' | 'pending';
type Transfers = 'active' | 'inactive' | 'pending';
type Treasury = 'active' | 'inactive' | 'pending';
type UsBankAccountAchPayments = 'active' | 'inactive' | 'pending';
type ZipPayments = 'active' | 'inactive' | 'pending';
}
interface Company {
address?: Stripe.Address;
/**
* The Kana variation of the company's primary address (Japan only).
*/
address_kana?: Company.AddressKana | null;
/**
* The Kanji variation of the company's primary address (Japan only).
*/
address_kanji?: Company.AddressKanji | null;
/**
* Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided).
*/
directors_provided?: boolean;
/**
* Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided.
*/
executives_provided?: boolean;
/**
* The export license ID number of the company, also referred as Import Export Code (India only).
*/
export_license_id?: string;
/**
* The purpose code to use for export transactions (India only).
*/
export_purpose_code?: string;
/**
* The company's legal name.
*/
name?: string | null;
/**
* The Kana variation of the company's legal name (Japan only).
*/
name_kana?: string | null;
/**
* The Kanji variation of the company's legal name (Japan only).
*/
name_kanji?: string | null;
/**
* Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together).
*/
owners_provided?: boolean;
/**
* This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
*/
ownership_declaration?: Company.OwnershipDeclaration | null;
/**
* The company's phone number (used for verification).
*/
phone?: string | null;
/**
* The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details.
*/
structure?: Company.Structure;
/**
* Whether the company's business ID number was provided.
*/
tax_id_provided?: boolean;
/**
* The jurisdiction in which the `tax_id` is registered (Germany-based companies only).
*/
tax_id_registrar?: string;
/**
* Whether the company's business VAT number was provided.
*/
vat_id_provided?: boolean;
/**
* Information on the verification state of the company.
*/
verification?: Company.Verification | null;
}
namespace Company {
interface AddressKana {
/**
* City/Ward.
*/
city: string | null;
/**
* Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
*/
country: string | null;
/**
* Block/Building number.
*/
line1: string | null;
/**
* Building details.
*/
line2: string | null;
/**
* ZIP or postal code.
*/
postal_code: string | null;
/**
* Prefecture.
*/
state: string | null;
/**
* Town/cho-me.
*/
town: string | null;
}
interface AddressKanji {
/**
* City/Ward.
*/
city: string | null;
/**
* Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
*/
country: string | null;
/**
* Block/Building number.
*/
line1: string | null;
/**
* Building details.
*/
line2: string | null;
/**
* ZIP or postal code.
*/
postal_code: string | null;
/**
* Prefecture.
*/
state: string | null;
/**
* Town/cho-me.
*/
town: string | null;
}
interface OwnershipDeclaration {
/**
* The Unix timestamp marking when the beneficial owner attestation was made.
*/
date: number | null;
/**
* The IP address from which the beneficial owner attestation was made.
*/
ip: string | null;
/**
* The user-agent string from the browser where the beneficial owner attestation was made.
*/
user_agent: string | null;
}
type Structure =
| 'free_zone_establishment'
| 'free_zone_llc'
| 'government_instrumentality'
| 'governmental_unit'
| 'incorporated_non_profit'
| 'incorporated_partnership'
| 'limited_liability_partnership'
| 'llc'
| 'multi_member_llc'
| 'private_company'
| 'private_corporation'
| 'private_partnership'
| 'public_company'
| 'public_corporation'
| 'public_partnership'
| 'registered_charity'
| 'single_member_llc'
| 'sole_establishment'
| 'sole_proprietorship'
| 'tax_exempt_government_instrumentality'
| 'unincorporated_association'
| 'unincorporated_non_profit'
| 'unincorporated_partnership';
interface Verification {
document: Verification.Document;
}
namespace Verification {
interface Document {
/**
* The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`.
*/
back: string | Stripe.File | null;
/**
* A user-displayable string describing the verification state of this document.
*/
details: string | null;
/**
* One of `document_corrupt`, `document_expired`, `document_failed_copy`, `document_failed_greyscale`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_not_readable`, `document_not_uploaded`, `document_type_not_supported`, or `document_too_large`. A machine-readable code specifying the verification state for this document.
*/
details_code: string | null;
/**
* The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`.
*/
front: string | Stripe.File | null;
}
}
}
interface Controller {
fees?: Controller.Fees;
/**
* `true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://stripe.com/docs/connect/platform-controls-for-standard-accounts). Otherwise, this field is null.
*/
is_controller?: boolean;
losses?: Controller.Losses;
/**
* A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account.
*/
requirement_collection?: Controller.RequirementCollection;
stripe_dashboard?: Controller.StripeDashboard;
/**
* The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself.
*/
type: Controller.Type;
}
namespace Controller {
interface Fees {
/**
* A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior).
*/
payer: Fees.Payer;
}
namespace Fees {
type Payer =
| 'account'
| 'application'
| 'application_custom'
| 'application_express';
}
interface Losses {
/**
* A value indicating who is liable when this account can't pay back negative balances from payments.
*/
payments: Losses.Payments;
}
namespace Losses {
type Payments = 'application' | 'stripe';
}
type RequirementCollection = 'application' | 'stripe';
interface StripeDashboard {
/**
* A value indicating the Stripe dashboard this account has access to independent of the Connect application.
*/
type: StripeDashboard.Type;
}
namespace StripeDashboard {
type Type = 'express' | 'full' | 'none';
}
type Type = 'account' | 'application';
}
interface FutureRequirements {
/**
* Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
*/
alternatives: Array<FutureRequirements.Alternative> | null;
/**
* Date on which `future_requirements` merges with the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning.
*/
current_deadline: number | null;
/**
* Fields that need to be collected to keep the account enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.
*/
currently_due: Array<string> | null;
/**
* This is typed as a string for consistency with `requirements.disabled_reason`.
*/
disabled_reason: string | null;
/**
* Fields that are `currently_due` and need to be collected again because validation or verification failed.
*/
errors: Array<FutureRequirements.Error> | null;
/**
* Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well.
*/
eventually_due: Array<string> | null;
/**
* Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.
*/
past_due: Array<string> | null;
/**
* Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.
*/
pending_verification: Array<string> | null;
}
namespace FutureRequirements {
interface Alternative {
/**
* Fields that can be provided to satisfy all fields in `original_fields_due`.
*/
alternative_fields_due: Array<string>;
/**
* Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
*/
original_fields_due: Array<string>;
}
interface Error {
/**
* The code for the type of error.
*/
code: Error.Code;
/**
* An informative message that indicates the error type and provides additional details about the error.
*/
reason: string;
/**
* The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
*/
requirement: string;
}
namespace Error {
type Code =
| 'invalid_address_city_state_postal_code'
| 'invalid_address_highway_contract_box'
| 'invalid_address_private_mailbox'
| 'invalid_business_profile_name'
| 'invalid_business_profile_name_denylisted'
| 'invalid_company_name_denylisted'
| 'invalid_dob_age_over_maximum'
| 'invalid_dob_age_under_18'
| 'invalid_dob_age_under_minimum'
| 'invalid_product_description_length'
| 'invalid_product_description_url_match'
| 'invalid_representative_country'
| 'invalid_statement_descriptor_business_mismatch'
| 'invalid_statement_descriptor_denylisted'
| 'invalid_statement_descriptor_length'
| 'invalid_statement_descriptor_prefix_denylisted'
| 'invalid_statement_descriptor_prefix_mismatch'
| 'invalid_street_address'
| 'invalid_tax_id'
| 'invalid_tax_id_format'
| 'invalid_tos_acceptance'
| 'invalid_url_denylisted'
| 'invalid_url_format'
| 'invalid_url_length'
| 'invalid_url_web_presence_detected'
| 'invalid_url_website_business_information_mismatch'
| 'invalid_url_website_empty'
| 'invalid_url_website_inaccessible'
| 'invalid_url_website_inaccessible_geoblocked'
| 'invalid_url_website_inaccessible_password_protected'
| 'invalid_url_website_incomplete'
| 'invalid_url_website_incomplete_cancellation_policy'
| 'invalid_url_website_incomplete_customer_service_details'
| 'invalid_url_website_incomplete_legal_restrictions'
| 'invalid_url_website_incomplete_refund_policy'
| 'invalid_url_website_incomplete_return_policy'
| 'invalid_url_website_incomplete_terms_and_conditions'
| 'invalid_url_website_incomplete_under_construction'
| 'invalid_url_website_other'
| 'invalid_value_other'
| 'verification_directors_mismatch'
| 'verification_document_address_mismatch'
| 'verification_document_address_missing'
| 'verification_document_corrupt'
| 'verification_document_country_not_supported'
| 'verification_document_directors_mismatch'
| 'verification_document_dob_mismatch'
| 'verification_document_duplicate_type'
| 'verification_document_expired'
| 'verification_document_failed_copy'
| 'verification_document_failed_greyscale'
| 'verification_document_failed_other'
| 'verification_document_failed_test_mode'
| 'verification_document_fraudulent'
| 'verification_document_id_number_mismatch'
| 'verification_document_id_number_missing'
| 'verification_document_incomplete'
| 'verification_document_invalid'
| 'verification_document_issue_or_expiry_date_missing'
| 'verification_document_manipulated'
| 'verification_document_missing_back'
| 'verification_document_missing_front'
| 'verification_document_name_mismatch'
| 'verification_document_name_missing'
| 'verification_document_nationality_mismatch'
| 'verification_document_not_readable'
| 'verification_document_not_signed'
| 'verification_document_not_uploaded'
| 'verification_document_photo_mismatch'
| 'verification_document_too_large'
| 'verification_document_type_not_supported'
| 'verification_extraneous_directors'
| 'verification_failed_address_match'
| 'verification_failed_business_iec_number'
| 'verification_failed_document_match'
| 'verification_failed_id_number_match'
| 'verification_failed_keyed_identity'
| 'verification_failed_keyed_match'
| 'verification_failed_name_match'
| 'verification_failed_other'
| 'verification_failed_representative_authority'
| 'verification_failed_residential_address'
| 'verification_failed_tax_id_match'
| 'verification_failed_tax_id_not_issued'
| 'verification_missing_directors'
| 'verification_missing_executives'
| 'verification_missing_owners'
| 'verification_requires_additional_memorandum_of_associations';
}
}
interface Requirements {
/**
* Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
*/
alternatives: Array<Requirements.Alternative> | null;
/**
* Date by which the fields in `currently_due` must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected.
*/
current_deadline: number | null;
/**
* Fields that need to be collected to keep the account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.
*/
currently_due: Array<string> | null;
/**
* If the account is disabled, this string describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). Can be `action_required.requested_capabilities`, `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.incomplete_verification`, `rejected.listed`, `rejected.other`, `rejected.terms_of_service`, `under_review`, or `other`.
*/
disabled_reason: string | null;
/**
* Fields that are `currently_due` and need to be collected again because validation or verification failed.
*/
errors: Array<Requirements.Error> | null;
/**
* Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.
*/
eventually_due: Array<string> | null;
/**
* Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account.
*/
past_due: Array<string> | null;
/**