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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._list_object import ListObject
from stripe._person import Person
from stripe._request_options import RequestOptions
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import Dict, List, cast
from typing_extensions import Literal, NotRequired, TypedDict
class AccountPersonService(StripeService):
class CreateParams(TypedDict):
additional_tos_acceptances: NotRequired[
"AccountPersonService.CreateParamsAdditionalTosAcceptances"
]
"""
Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.
"""
address: NotRequired["AccountPersonService.CreateParamsAddress"]
"""
The person's address.
"""
address_kana: NotRequired[
"AccountPersonService.CreateParamsAddressKana"
]
"""
The Kana variation of the person's address (Japan only).
"""
address_kanji: NotRequired[
"AccountPersonService.CreateParamsAddressKanji"
]
"""
The Kanji variation of the person's address (Japan only).
"""
dob: NotRequired["Literal['']|AccountPersonService.CreateParamsDob"]
"""
The person's date of birth.
"""
documents: NotRequired["AccountPersonService.CreateParamsDocuments"]
"""
Documents that may be submitted to satisfy various informational requests.
"""
email: NotRequired[str]
"""
The person's email address.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
first_name: NotRequired[str]
"""
The person's first name.
"""
first_name_kana: NotRequired[str]
"""
The Kana variation of the person's first name (Japan only).
"""
first_name_kanji: NotRequired[str]
"""
The Kanji variation of the person's first name (Japan only).
"""
full_name_aliases: NotRequired["Literal['']|List[str]"]
"""
A list of alternate names or aliases that the person is known by.
"""
gender: NotRequired[str]
"""
The person's gender (International regulations require either "male" or "female").
"""
id_number: NotRequired[str]
"""
The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).
"""
id_number_secondary: NotRequired[str]
"""
The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).
"""
last_name: NotRequired[str]
"""
The person's last name.
"""
last_name_kana: NotRequired[str]
"""
The Kana variation of the person's last name (Japan only).
"""
last_name_kanji: NotRequired[str]
"""
The Kanji variation of the person's last name (Japan only).
"""
maiden_name: NotRequired[str]
"""
The person's maiden name.
"""
metadata: NotRequired["Literal['']|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`.
"""
nationality: NotRequired[str]
"""
The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable.
"""
person_token: NotRequired[str]
"""
A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person.
"""
phone: NotRequired[str]
"""
The person's phone number.
"""
political_exposure: NotRequired[Literal["existing", "none"]]
"""
Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
"""
registered_address: NotRequired[
"AccountPersonService.CreateParamsRegisteredAddress"
]
"""
The person's registered address.
"""
relationship: NotRequired[
"AccountPersonService.CreateParamsRelationship"
]
"""
The relationship that this person has with the account's legal entity.
"""
ssn_last_4: NotRequired[str]
"""
The last four digits of the person's Social Security number (U.S. only).
"""
verification: NotRequired[
"AccountPersonService.CreateParamsVerification"
]
"""
The person's verification status.
"""
class CreateParamsAdditionalTosAcceptances(TypedDict):
account: NotRequired[
"AccountPersonService.CreateParamsAdditionalTosAcceptancesAccount"
]
"""
Details on the legal guardian's acceptance of the main Stripe service agreement.
"""
class CreateParamsAdditionalTosAcceptancesAccount(TypedDict):
date: NotRequired[int]
"""
The Unix timestamp marking when the account representative accepted the service agreement.
"""
ip: NotRequired[str]
"""
The IP address from which the account representative accepted the service agreement.
"""
user_agent: NotRequired["Literal['']|str"]
"""
The user agent of the browser from which the account representative accepted the service agreement.
"""
class CreateParamsAddress(TypedDict):
city: NotRequired[str]
"""
City, district, suburb, town, or village.
"""
country: NotRequired[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: NotRequired[str]
"""
Address line 1 (e.g., street, PO Box, or company name).
"""
line2: NotRequired[str]
"""
Address line 2 (e.g., apartment, suite, unit, or building).
"""
postal_code: NotRequired[str]
"""
ZIP or postal code.
"""
state: NotRequired[str]
"""
State, county, province, or region.
"""
class CreateParamsAddressKana(TypedDict):
city: NotRequired[str]
"""
City or ward.
"""
country: NotRequired[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: NotRequired[str]
"""
Block or building number.
"""
line2: NotRequired[str]
"""
Building details.
"""
postal_code: NotRequired[str]
"""
Postal code.
"""
state: NotRequired[str]
"""
Prefecture.
"""
town: NotRequired[str]
"""
Town or cho-me.
"""
class CreateParamsAddressKanji(TypedDict):
city: NotRequired[str]
"""
City or ward.
"""
country: NotRequired[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: NotRequired[str]
"""
Block or building number.
"""
line2: NotRequired[str]
"""
Building details.
"""
postal_code: NotRequired[str]
"""
Postal code.
"""
state: NotRequired[str]
"""
Prefecture.
"""
town: NotRequired[str]
"""
Town or cho-me.
"""
class CreateParamsDob(TypedDict):
day: int
"""
The day of birth, between 1 and 31.
"""
month: int
"""
The month of birth, between 1 and 12.
"""
year: int
"""
The four-digit year of birth.
"""
class CreateParamsDocuments(TypedDict):
company_authorization: NotRequired[
"AccountPersonService.CreateParamsDocumentsCompanyAuthorization"
]
"""
One or more documents that demonstrate proof that this person is authorized to represent the company.
"""
passport: NotRequired[
"AccountPersonService.CreateParamsDocumentsPassport"
]
"""
One or more documents showing the person's passport page with photo and personal data.
"""
visa: NotRequired["AccountPersonService.CreateParamsDocumentsVisa"]
"""
One or more documents showing the person's visa required for living in the country where they are residing.
"""
class CreateParamsDocumentsCompanyAuthorization(TypedDict):
files: NotRequired[List[str]]
"""
One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
"""
class CreateParamsDocumentsPassport(TypedDict):
files: NotRequired[List[str]]
"""
One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
"""
class CreateParamsDocumentsVisa(TypedDict):
files: NotRequired[List[str]]
"""
One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
"""
class CreateParamsRegisteredAddress(TypedDict):
city: NotRequired[str]
"""
City, district, suburb, town, or village.
"""
country: NotRequired[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: NotRequired[str]
"""
Address line 1 (e.g., street, PO Box, or company name).
"""
line2: NotRequired[str]
"""
Address line 2 (e.g., apartment, suite, unit, or building).
"""
postal_code: NotRequired[str]
"""
ZIP or postal code.
"""
state: NotRequired[str]
"""
State, county, province, or region.
"""
class CreateParamsRelationship(TypedDict):
authorizer: NotRequired[bool]
"""
Whether the person is the authorizer of the account's representative.
"""
director: NotRequired[bool]
"""
Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
"""
executive: NotRequired[bool]
"""
Whether the person has significant responsibility to control, manage, or direct the organization.
"""
legal_guardian: NotRequired[bool]
"""
Whether the person is the legal guardian of the account's representative.
"""
owner: NotRequired[bool]
"""
Whether the person is an owner of the account's legal entity.
"""
percent_ownership: NotRequired["Literal['']|float"]
"""
The percent owned by the person of the account's legal entity.
"""
representative: NotRequired[bool]
"""
Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.
"""
title: NotRequired[str]
"""
The person's title (e.g., CEO, Support Engineer).
"""
class CreateParamsVerification(TypedDict):
additional_document: NotRequired[
"AccountPersonService.CreateParamsVerificationAdditionalDocument"
]
"""
A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
"""
document: NotRequired[
"AccountPersonService.CreateParamsVerificationDocument"
]
"""
An identifying document, either a passport or local ID card.
"""
class CreateParamsVerificationAdditionalDocument(TypedDict):
back: NotRequired[str]
"""
The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
"""
front: NotRequired[str]
"""
The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
"""
class CreateParamsVerificationDocument(TypedDict):
back: NotRequired[str]
"""
The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
"""
front: NotRequired[str]
"""
The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
"""
class DeleteParams(TypedDict):
pass
class ListParams(TypedDict):
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.
"""
relationship: NotRequired[
"AccountPersonService.ListParamsRelationship"
]
"""
Filters on the list of people returned based on the person's relationship to the account's company.
"""
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.
"""
class ListParamsRelationship(TypedDict):
authorizer: NotRequired[bool]
"""
A filter on the list of people returned based on whether these people are authorizers of the account's representative.
"""
director: NotRequired[bool]
"""
A filter on the list of people returned based on whether these people are directors of the account's company.
"""
executive: NotRequired[bool]
"""
A filter on the list of people returned based on whether these people are executives of the account's company.
"""
legal_guardian: NotRequired[bool]
"""
A filter on the list of people returned based on whether these people are legal guardians of the account's representative.
"""
owner: NotRequired[bool]
"""
A filter on the list of people returned based on whether these people are owners of the account's company.
"""
representative: NotRequired[bool]
"""
A filter on the list of people returned based on whether these people are the representative of the account's company.
"""
class RetrieveParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
class UpdateParams(TypedDict):
additional_tos_acceptances: NotRequired[
"AccountPersonService.UpdateParamsAdditionalTosAcceptances"
]
"""
Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.
"""
address: NotRequired["AccountPersonService.UpdateParamsAddress"]
"""
The person's address.
"""
address_kana: NotRequired[
"AccountPersonService.UpdateParamsAddressKana"
]
"""
The Kana variation of the person's address (Japan only).
"""
address_kanji: NotRequired[
"AccountPersonService.UpdateParamsAddressKanji"
]
"""
The Kanji variation of the person's address (Japan only).
"""
dob: NotRequired["Literal['']|AccountPersonService.UpdateParamsDob"]
"""
The person's date of birth.
"""
documents: NotRequired["AccountPersonService.UpdateParamsDocuments"]
"""
Documents that may be submitted to satisfy various informational requests.
"""
email: NotRequired[str]
"""
The person's email address.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
first_name: NotRequired[str]
"""
The person's first name.
"""
first_name_kana: NotRequired[str]
"""
The Kana variation of the person's first name (Japan only).
"""
first_name_kanji: NotRequired[str]
"""
The Kanji variation of the person's first name (Japan only).
"""
full_name_aliases: NotRequired["Literal['']|List[str]"]
"""
A list of alternate names or aliases that the person is known by.
"""
gender: NotRequired[str]
"""
The person's gender (International regulations require either "male" or "female").
"""
id_number: NotRequired[str]
"""
The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).
"""
id_number_secondary: NotRequired[str]
"""
The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).
"""
last_name: NotRequired[str]
"""
The person's last name.
"""
last_name_kana: NotRequired[str]
"""
The Kana variation of the person's last name (Japan only).
"""
last_name_kanji: NotRequired[str]
"""
The Kanji variation of the person's last name (Japan only).
"""
maiden_name: NotRequired[str]
"""
The person's maiden name.
"""
metadata: NotRequired["Literal['']|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`.
"""
nationality: NotRequired[str]
"""
The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable.
"""
person_token: NotRequired[str]
"""
A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person.
"""
phone: NotRequired[str]
"""
The person's phone number.
"""
political_exposure: NotRequired[Literal["existing", "none"]]
"""
Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
"""
registered_address: NotRequired[
"AccountPersonService.UpdateParamsRegisteredAddress"
]
"""
The person's registered address.
"""
relationship: NotRequired[
"AccountPersonService.UpdateParamsRelationship"
]
"""
The relationship that this person has with the account's legal entity.
"""
ssn_last_4: NotRequired[str]
"""
The last four digits of the person's Social Security number (U.S. only).
"""
verification: NotRequired[
"AccountPersonService.UpdateParamsVerification"
]
"""
The person's verification status.
"""
class UpdateParamsAdditionalTosAcceptances(TypedDict):
account: NotRequired[
"AccountPersonService.UpdateParamsAdditionalTosAcceptancesAccount"
]
"""
Details on the legal guardian's acceptance of the main Stripe service agreement.
"""
class UpdateParamsAdditionalTosAcceptancesAccount(TypedDict):
date: NotRequired[int]
"""
The Unix timestamp marking when the account representative accepted the service agreement.
"""
ip: NotRequired[str]
"""
The IP address from which the account representative accepted the service agreement.
"""
user_agent: NotRequired["Literal['']|str"]
"""
The user agent of the browser from which the account representative accepted the service agreement.
"""
class UpdateParamsAddress(TypedDict):
city: NotRequired[str]
"""
City, district, suburb, town, or village.
"""
country: NotRequired[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: NotRequired[str]
"""
Address line 1 (e.g., street, PO Box, or company name).
"""
line2: NotRequired[str]
"""
Address line 2 (e.g., apartment, suite, unit, or building).
"""
postal_code: NotRequired[str]
"""
ZIP or postal code.
"""
state: NotRequired[str]
"""
State, county, province, or region.
"""
class UpdateParamsAddressKana(TypedDict):
city: NotRequired[str]
"""
City or ward.
"""
country: NotRequired[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: NotRequired[str]
"""
Block or building number.
"""
line2: NotRequired[str]
"""
Building details.
"""
postal_code: NotRequired[str]
"""
Postal code.
"""
state: NotRequired[str]
"""
Prefecture.
"""
town: NotRequired[str]
"""
Town or cho-me.
"""
class UpdateParamsAddressKanji(TypedDict):
city: NotRequired[str]
"""
City or ward.
"""
country: NotRequired[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: NotRequired[str]
"""
Block or building number.
"""
line2: NotRequired[str]
"""
Building details.
"""
postal_code: NotRequired[str]
"""
Postal code.
"""
state: NotRequired[str]
"""
Prefecture.
"""
town: NotRequired[str]
"""
Town or cho-me.
"""
class UpdateParamsDob(TypedDict):
day: int
"""
The day of birth, between 1 and 31.
"""
month: int
"""
The month of birth, between 1 and 12.
"""
year: int
"""
The four-digit year of birth.
"""
class UpdateParamsDocuments(TypedDict):
company_authorization: NotRequired[
"AccountPersonService.UpdateParamsDocumentsCompanyAuthorization"
]
"""
One or more documents that demonstrate proof that this person is authorized to represent the company.
"""
passport: NotRequired[
"AccountPersonService.UpdateParamsDocumentsPassport"
]
"""
One or more documents showing the person's passport page with photo and personal data.
"""
visa: NotRequired["AccountPersonService.UpdateParamsDocumentsVisa"]
"""
One or more documents showing the person's visa required for living in the country where they are residing.
"""
class UpdateParamsDocumentsCompanyAuthorization(TypedDict):
files: NotRequired[List[str]]
"""
One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
"""
class UpdateParamsDocumentsPassport(TypedDict):
files: NotRequired[List[str]]
"""
One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
"""
class UpdateParamsDocumentsVisa(TypedDict):
files: NotRequired[List[str]]
"""
One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
"""
class UpdateParamsRegisteredAddress(TypedDict):
city: NotRequired[str]
"""
City, district, suburb, town, or village.
"""
country: NotRequired[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: NotRequired[str]
"""
Address line 1 (e.g., street, PO Box, or company name).
"""
line2: NotRequired[str]
"""
Address line 2 (e.g., apartment, suite, unit, or building).
"""
postal_code: NotRequired[str]
"""
ZIP or postal code.
"""
state: NotRequired[str]
"""
State, county, province, or region.
"""
class UpdateParamsRelationship(TypedDict):
authorizer: NotRequired[bool]
"""
Whether the person is the authorizer of the account's representative.
"""
director: NotRequired[bool]
"""
Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
"""
executive: NotRequired[bool]
"""
Whether the person has significant responsibility to control, manage, or direct the organization.
"""
legal_guardian: NotRequired[bool]
"""
Whether the person is the legal guardian of the account's representative.
"""
owner: NotRequired[bool]
"""
Whether the person is an owner of the account's legal entity.
"""
percent_ownership: NotRequired["Literal['']|float"]
"""
The percent owned by the person of the account's legal entity.
"""
representative: NotRequired[bool]
"""
Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.
"""
title: NotRequired[str]
"""
The person's title (e.g., CEO, Support Engineer).
"""
class UpdateParamsVerification(TypedDict):
additional_document: NotRequired[
"AccountPersonService.UpdateParamsVerificationAdditionalDocument"
]
"""
A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
"""
document: NotRequired[
"AccountPersonService.UpdateParamsVerificationDocument"
]
"""
An identifying document, either a passport or local ID card.
"""
class UpdateParamsVerificationAdditionalDocument(TypedDict):
back: NotRequired[str]
"""
The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
"""
front: NotRequired[str]
"""
The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
"""
class UpdateParamsVerificationDocument(TypedDict):
back: NotRequired[str]
"""
The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
"""
front: NotRequired[str]
"""
The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
"""
def delete(
self,
account: str,
person: str,
params: "AccountPersonService.DeleteParams" = {},
options: RequestOptions = {},
) -> Person:
"""
Deletes an existing person's relationship to the account's legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
"""
return cast(
Person,
self._request(
"delete",
"/v1/accounts/{account}/persons/{person}".format(
account=sanitize_id(account),
person=sanitize_id(person),
),
base_address="api",
params=params,
options=options,
),
)
async def delete_async(
self,
account: str,
person: str,
params: "AccountPersonService.DeleteParams" = {},
options: RequestOptions = {},
) -> Person:
"""
Deletes an existing person's relationship to the account's legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
"""
return cast(
Person,
await self._request_async(
"delete",
"/v1/accounts/{account}/persons/{person}".format(
account=sanitize_id(account),
person=sanitize_id(person),
),
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
account: str,
person: str,
params: "AccountPersonService.RetrieveParams" = {},
options: RequestOptions = {},
) -> Person:
"""
Retrieves an existing person.
"""
return cast(
Person,
self._request(
"get",
"/v1/accounts/{account}/persons/{person}".format(
account=sanitize_id(account),
person=sanitize_id(person),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
account: str,
person: str,
params: "AccountPersonService.RetrieveParams" = {},
options: RequestOptions = {},
) -> Person:
"""
Retrieves an existing person.
"""
return cast(
Person,
await self._request_async(
"get",
"/v1/accounts/{account}/persons/{person}".format(
account=sanitize_id(account),
person=sanitize_id(person),
),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
account: str,
person: str,
params: "AccountPersonService.UpdateParams" = {},
options: RequestOptions = {},
) -> Person:
"""
Updates an existing person.
"""
return cast(
Person,
self._request(
"post",
"/v1/accounts/{account}/persons/{person}".format(
account=sanitize_id(account),
person=sanitize_id(person),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
account: str,
person: str,
params: "AccountPersonService.UpdateParams" = {},
options: RequestOptions = {},
) -> Person:
"""
Updates an existing person.
"""
return cast(
Person,
await self._request_async(
"post",
"/v1/accounts/{account}/persons/{person}".format(
account=sanitize_id(account),
person=sanitize_id(person),
),
base_address="api",
params=params,
options=options,
),
)
def list(
self,
account: str,
params: "AccountPersonService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[Person]:
"""
Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
"""
return cast(
ListObject[Person],
self._request(
"get",
"/v1/accounts/{account}/persons".format(
account=sanitize_id(account),
),
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
account: str,
params: "AccountPersonService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[Person]:
"""
Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
"""
return cast(
ListObject[Person],
await self._request_async(
"get",
"/v1/accounts/{account}/persons".format(
account=sanitize_id(account),
),
base_address="api",
params=params,
options=options,
),
)
def create(
self,
account: str,
params: "AccountPersonService.CreateParams" = {},
options: RequestOptions = {},
) -> Person:
"""
Creates a new person.
"""
return cast(
Person,
self._request(
"post",
"/v1/accounts/{account}/persons".format(
account=sanitize_id(account),
),
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
account: str,
params: "AccountPersonService.CreateParams" = {},
options: RequestOptions = {},
) -> Person:
"""
Creates a new person.
"""
return cast(
Person,
await self._request_async(
"post",
"/v1/accounts/{account}/persons".format(
account=sanitize_id(account),
),
base_address="api",
params=params,
options=options,
),
)
|