PersonTokenParams

data class PersonTokenParams(address: Address?, addressKana: AddressJapanParams?, addressKanji: AddressJapanParams?, dateOfBirth: DateOfBirth?, email: String?, firstName: String?, firstNameKana: String?, firstNameKanji: String?, gender: String?, idNumber: String?, lastName: String?, lastNameKana: String?, lastNameKanji: String?, maidenName: String?, metadata: Map<String, String>?, phone: String?, relationship: PersonTokenParams.Relationship?, ssnLast4: String?, verification: PersonTokenParams.Verification?) : TokenParams

Creates a single-use token that represents the details for a person. Use this when creating or updating persons associated with a Connect account. See the documentation to learn more.

See Create a person token

Constructors

Link copied to clipboard
fun PersonTokenParams(address: Address? = null, addressKana: AddressJapanParams? = null, addressKanji: AddressJapanParams? = null, dateOfBirth: DateOfBirth? = null, email: String? = null, firstName: String? = null, firstNameKana: String? = null, firstNameKanji: String? = null, gender: String? = null, idNumber: String? = null, lastName: String? = null, lastNameKana: String? = null, lastNameKanji: String? = null, maidenName: String? = null, metadata: Map<String, String>? = null, phone: String? = null, relationship: PersonTokenParams.Relationship? = null, ssnLast4: String? = null, verification: PersonTokenParams.Verification? = null)

Types

Link copied to clipboard
class Builder : ObjectBuilder<PersonTokenParams>
Link copied to clipboard
data class Document @JvmOverloads constructor(front: String?, back: String?) : StripeParamsModel, Parcelable
Link copied to clipboard
data class Relationship(director: Boolean?, executive: Boolean?, owner: Boolean?, percentOwnership: Int?, representative: Boolean?, title: String?) : StripeParamsModel, Parcelable

The relationship that this person has with the account’s legal entity.

Link copied to clipboard
data class Verification @JvmOverloads constructor(document: PersonTokenParams.Document?, additionalDocument: PersonTokenParams.Document?) : StripeParamsModel, Parcelable

The person’s verification status.

Functions

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
open override fun toParamMap(): Map<String, Any>
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

Link copied to clipboard
val address: Address? = null

The person’s address.

Link copied to clipboard
val addressKana: AddressJapanParams? = null

The Kana variation of the person’s address (Japan only).

Link copied to clipboard
val addressKanji: AddressJapanParams? = null

The Kanji variation of the person’s address (Japan only).

Link copied to clipboard
val dateOfBirth: DateOfBirth? = null

The person’s date of birth.

Link copied to clipboard
val email: String? = null

The person’s email address.

Link copied to clipboard
val firstName: String? = null

The person’s first name.

Link copied to clipboard
val firstNameKana: String? = null

The Kana variation of the person’s first name (Japan only).

Link copied to clipboard
val firstNameKanji: String? = null

The Kanji variation of the person’s first name (Japan only).

Link copied to clipboard
val gender: String? = null

The person’s gender (International regulations require either “male” or “female”).

Link copied to clipboard
val idNumber: String? = null

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.

Link copied to clipboard
val lastName: String? = null

The person’s last name.

Link copied to clipboard
val lastNameKana: String? = null

The Kana variation of the person’s last name (Japan only).

Link copied to clipboard
val lastNameKanji: String? = null

The Kanji variation of the person’s last name (Japan only).

Link copied to clipboard
val maidenName: String? = null

The person’s maiden name.

Link copied to clipboard
val metadata: Map<String, String>? = null

Set of key-value pairs 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.

Link copied to clipboard
val phone: String? = null

The person’s phone number.

Link copied to clipboard
val relationship: PersonTokenParams.Relationship? = null

The relationship that this person has with the account’s legal entity.

Link copied to clipboard
val ssnLast4: String? = null

The last 4 digits of the person’s social security number.

Link copied to clipboard
open override val typeDataParams: Map<String, Any>
Link copied to clipboard
val verification: PersonTokenParams.Verification? = null

The person’s verification status.