ApiOperations
2 years ago
BillingPortal
2 years ago
Checkout
2 years ago
Exception
4 years ago
FinancialConnections
2 years ago
HttpClient
2 years ago
Identity
2 years ago
Issuing
2 years ago
Radar
2 years ago
Reporting
4 years ago
Service
2 years ago
Sigma
4 years ago
Terminal
2 years ago
TestHelpers
2 years ago
Util
2 years ago
Account.php
2 years ago
AccountLink.php
4 years ago
AlipayAccount.php
4 years ago
ApiRequestor.php
2 years ago
ApiResource.php
2 years ago
ApiResponse.php
4 years ago
ApplePayDomain.php
4 years ago
ApplicationFee.php
2 years ago
ApplicationFeeRefund.php
4 years ago
Balance.php
4 years ago
BalanceTransaction.php
4 years ago
BankAccount.php
4 years ago
BaseStripeClient.php
2 years ago
BaseStripeClientInterface.php
4 years ago
BitcoinReceiver.php
2 years ago
BitcoinTransaction.php
4 years ago
Capability.php
4 years ago
Card.php
2 years ago
CashBalance.php
2 years ago
Charge.php
2 years ago
Collection.php
2 years ago
CountrySpec.php
4 years ago
Coupon.php
2 years ago
CreditNote.php
2 years ago
CreditNoteLineItem.php
4 years ago
Customer.php
2 years ago
CustomerBalanceTransaction.php
4 years ago
Discount.php
2 years ago
Dispute.php
4 years ago
EphemeralKey.php
4 years ago
ErrorObject.php
4 years ago
Event.php
2 years ago
ExchangeRate.php
4 years ago
File.php
2 years ago
FileLink.php
4 years ago
FundingInstructions.php
2 years ago
Invoice.php
2 years ago
InvoiceItem.php
2 years ago
InvoiceLineItem.php
2 years ago
LineItem.php
4 years ago
LoginLink.php
4 years ago
Mandate.php
4 years ago
OAuth.php
4 years ago
OAuthErrorObject.php
4 years ago
Order.php
2 years ago
OrderItem.php
4 years ago
OrderReturn.php
4 years ago
PaymentIntent.php
2 years ago
PaymentLink.php
2 years ago
PaymentMethod.php
2 years ago
Payout.php
4 years ago
Person.php
2 years ago
Plan.php
2 years ago
Price.php
2 years ago
Product.php
2 years ago
PromotionCode.php
2 years ago
Quote.php
2 years ago
Recipient.php
2 years ago
RecipientTransfer.php
4 years ago
Refund.php
2 years ago
RequestTelemetry.php
4 years ago
Review.php
4 years ago
SKU.php
2 years ago
SearchResult.php
2 years ago
SetupAttempt.php
4 years ago
SetupIntent.php
2 years ago
ShippingRate.php
2 years ago
SingletonApiResource.php
2 years ago
Source.php
4 years ago
SourceTransaction.php
4 years ago
Stripe.php
2 years ago
StripeClient.php
2 years ago
StripeClientInterface.php
4 years ago
StripeObject.php
2 years ago
StripeStreamingClientInterface.php
4 years ago
Subscription.php
2 years ago
SubscriptionItem.php
2 years ago
SubscriptionSchedule.php
2 years ago
TaxCode.php
2 years ago
TaxId.php
2 years ago
TaxRate.php
4 years ago
ThreeDSecure.php
4 years ago
Token.php
4 years ago
Topup.php
4 years ago
Transfer.php
2 years ago
TransferReversal.php
4 years ago
UsageRecord.php
4 years ago
UsageRecordSummary.php
4 years ago
Webhook.php
4 years ago
WebhookEndpoint.php
4 years ago
WebhookSignature.php
4 years ago
Person.php
124 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | |
| 5 | namespace Stripe; |
| 6 | |
| 7 | /** |
| 8 | * This is an object representing a person associated with a Stripe account. |
| 9 | * |
| 10 | * A platform cannot access a Standard or Express account's persons after the |
| 11 | * account starts onboarding, such as after generating an account link for the |
| 12 | * account. See the <a |
| 13 | * href="https://stripe.com/docs/connect/standard-accounts">Standard onboarding</a> |
| 14 | * or <a href="https://stripe.com/docs/connect/express-accounts">Express onboarding |
| 15 | * documentation</a> for information about platform pre-filling and account |
| 16 | * onboarding steps. |
| 17 | * |
| 18 | * Related guide: <a |
| 19 | * href="https://stripe.com/docs/connect/identity-verification-api#person-information">Handling |
| 20 | * Identity Verification with the API</a>. |
| 21 | * |
| 22 | * @property string $id Unique identifier for the object. |
| 23 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 24 | * @property string $account The account the person is associated with. |
| 25 | * @property \Stripe\StripeObject $address |
| 26 | * @property null|\Stripe\StripeObject $address_kana The Kana variation of the person's address (Japan only). |
| 27 | * @property null|\Stripe\StripeObject $address_kanji The Kanji variation of the person's address (Japan only). |
| 28 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 29 | * @property \Stripe\StripeObject $dob |
| 30 | * @property null|string $email The person's email address. |
| 31 | * @property null|string $first_name The person's first name. |
| 32 | * @property null|string $first_name_kana The Kana variation of the person's first name (Japan only). |
| 33 | * @property null|string $first_name_kanji The Kanji variation of the person's first name (Japan only). |
| 34 | * @property string[] $full_name_aliases A list of alternate names or aliases that the person is known by. |
| 35 | * @property null|\Stripe\StripeObject $future_requirements Information about the upcoming new requirements for this person, including what information needs to be collected, and by when. |
| 36 | * @property null|string $gender The person's gender (International regulations require either "male" or "female"). |
| 37 | * @property bool $id_number_provided Whether the person's <code>id_number</code> was provided. |
| 38 | * @property null|string $last_name The person's last name. |
| 39 | * @property null|string $last_name_kana The Kana variation of the person's last name (Japan only). |
| 40 | * @property null|string $last_name_kanji The Kanji variation of the person's last name (Japan only). |
| 41 | * @property null|string $maiden_name The person's maiden name. |
| 42 | * @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format. |
| 43 | * @property null|string $nationality The country where the person is a national. |
| 44 | * @property null|string $phone The person's phone number. |
| 45 | * @property string $political_exposure 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. |
| 46 | * @property \Stripe\StripeObject $registered_address |
| 47 | * @property \Stripe\StripeObject $relationship |
| 48 | * @property null|\Stripe\StripeObject $requirements Information about the requirements for this person, including what information needs to be collected, and by when. |
| 49 | * @property bool $ssn_last_4_provided Whether the last four digits of the person's Social Security number have been provided (U.S. only). |
| 50 | * @property \Stripe\StripeObject $verification |
| 51 | */ |
| 52 | class Person extends ApiResource |
| 53 | { |
| 54 | const OBJECT_NAME = 'person'; |
| 55 | |
| 56 | use ApiOperations\Delete; |
| 57 | use ApiOperations\Update; |
| 58 | |
| 59 | const GENDER_FEMALE = 'female'; |
| 60 | const GENDER_MALE = 'male'; |
| 61 | |
| 62 | const POLITICAL_EXPOSURE_EXISTING = 'existing'; |
| 63 | const POLITICAL_EXPOSURE_NONE = 'none'; |
| 64 | |
| 65 | const VERIFICATION_STATUS_PENDING = 'pending'; |
| 66 | const VERIFICATION_STATUS_UNVERIFIED = 'unverified'; |
| 67 | const VERIFICATION_STATUS_VERIFIED = 'verified'; |
| 68 | |
| 69 | /** |
| 70 | * @return string the API URL for this Stripe account reversal |
| 71 | */ |
| 72 | public function instanceUrl() |
| 73 | { |
| 74 | $id = $this['id']; |
| 75 | $account = $this['account']; |
| 76 | if (!$id) { |
| 77 | throw new Exception\UnexpectedValueException( |
| 78 | 'Could not determine which URL to request: ' . |
| 79 | "class instance has invalid ID: {$id}", |
| 80 | null |
| 81 | ); |
| 82 | } |
| 83 | $id = Util\Util::utf8($id); |
| 84 | $account = Util\Util::utf8($account); |
| 85 | |
| 86 | $base = Account::classUrl(); |
| 87 | $accountExtn = \urlencode($account); |
| 88 | $extn = \urlencode($id); |
| 89 | |
| 90 | return "{$base}/{$accountExtn}/persons/{$extn}"; |
| 91 | } |
| 92 | |
| 93 | /** |
| 94 | * @param array|string $_id |
| 95 | * @param null|array|string $_opts |
| 96 | * |
| 97 | * @throws \Stripe\Exception\BadMethodCallException |
| 98 | */ |
| 99 | public static function retrieve($_id, $_opts = null) |
| 100 | { |
| 101 | $msg = 'Persons cannot be retrieved without an account ID. Retrieve ' . |
| 102 | "a person using `Account::retrievePerson('account_id', " . |
| 103 | "'person_id')`."; |
| 104 | |
| 105 | throw new Exception\BadMethodCallException($msg); |
| 106 | } |
| 107 | |
| 108 | /** |
| 109 | * @param string $_id |
| 110 | * @param null|array $_params |
| 111 | * @param null|array|string $_options |
| 112 | * |
| 113 | * @throws \Stripe\Exception\BadMethodCallException |
| 114 | */ |
| 115 | public static function update($_id, $_params = null, $_options = null) |
| 116 | { |
| 117 | $msg = 'Persons cannot be updated without an account ID. Update ' . |
| 118 | "a person using `Account::updatePerson('account_id', " . |
| 119 | "'person_id', \$updateParams)`."; |
| 120 | |
| 121 | throw new Exception\BadMethodCallException($msg); |
| 122 | } |
| 123 | } |
| 124 |