Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Stripe Provider
  4. API Docs
  5. Person
Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi
Schema (JSON)
stripe/terraform-provider-stripe

stripe.Person

Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi
Schema (JSON)
stripe/terraform-provider-stripe

    This is an object representing a person associated with a Stripe account.

    A platform can only access a subset of data in a person for an account where account.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 or Express onboarding documentation for information about prefilling information and account onboarding steps. Learn more about handling identity verification with the API.

    Create Person Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Person(name: string, args: PersonArgs, opts?: CustomResourceOptions);
    @overload
def Person(resource_name: str,
           args: PersonArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Person(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           account: Optional[str] = None,
           additional_tos_acceptances: Optional[PersonAdditionalTosAcceptancesArgs] = None,
           address: Optional[PersonAddressArgs] = None,
           address_kana: Optional[PersonAddressKanaArgs] = None,
           address_kanji: Optional[PersonAddressKanjiArgs] = None,
           dob: Optional[PersonDobArgs] = None,
           documents: Optional[PersonDocumentsArgs] = None,
           email: Optional[str] = None,
           first_name: Optional[str] = None,
           first_name_kana: Optional[str] = None,
           first_name_kanji: Optional[str] = None,
           full_name_aliases: Optional[Sequence[str]] = None,
           gender: Optional[str] = None,
           id_number: Optional[str] = None,
           id_number_secondary: Optional[str] = None,
           last_name: Optional[str] = None,
           last_name_kana: Optional[str] = None,
           last_name_kanji: Optional[str] = None,
           maiden_name: Optional[str] = None,
           metadata: Optional[Mapping[str, str]] = None,
           nationality: Optional[str] = None,
           person_token: Optional[str] = None,
           phone: Optional[str] = None,
           political_exposure: Optional[str] = None,
           registered_address: Optional[PersonRegisteredAddressArgs] = None,
           relationship: Optional[PersonRelationshipArgs] = None,
           ssn_last4: Optional[str] = None,
           us_cfpb_data: Optional[PersonUsCfpbDataArgs] = None,
           verification: Optional[PersonVerificationArgs] = None)
    func NewPerson(ctx *Context, name string, args PersonArgs, opts ...ResourceOption) (*Person, error)
    public Person(string name, PersonArgs args, CustomResourceOptions? opts = null)
    public Person(String name, PersonArgs args)
public Person(String name, PersonArgs args, CustomResourceOptions options)

    type: stripe:Person
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "stripe_person" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args PersonArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PersonArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PersonArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PersonArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PersonArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var personResource = new Stripe.Person("personResource", new()
{
    Account = "string",
    AdditionalTosAcceptances = new Stripe.Inputs.PersonAdditionalTosAcceptancesArgs
    {
        Account = new Stripe.Inputs.PersonAdditionalTosAcceptancesAccountArgs
        {
            Date = 0.0,
            Ip = "string",
            UserAgent = "string",
        },
    },
    Address = new Stripe.Inputs.PersonAddressArgs
    {
        City = "string",
        Country = "string",
        Line1 = "string",
        Line2 = "string",
        PostalCode = "string",
        State = "string",
    },
    AddressKana = new Stripe.Inputs.PersonAddressKanaArgs
    {
        City = "string",
        Country = "string",
        Line1 = "string",
        Line2 = "string",
        PostalCode = "string",
        State = "string",
        Town = "string",
    },
    AddressKanji = new Stripe.Inputs.PersonAddressKanjiArgs
    {
        City = "string",
        Country = "string",
        Line1 = "string",
        Line2 = "string",
        PostalCode = "string",
        State = "string",
        Town = "string",
    },
    Dob = new Stripe.Inputs.PersonDobArgs
    {
        Day = 0.0,
        Month = 0.0,
        Year = 0.0,
    },
    Documents = new Stripe.Inputs.PersonDocumentsArgs
    {
        CompanyAuthorization = new Stripe.Inputs.PersonDocumentsCompanyAuthorizationArgs
        {
            Files = new[]
            {
                "string",
            },
        },
        Passport = new Stripe.Inputs.PersonDocumentsPassportArgs
        {
            Files = new[]
            {
                "string",
            },
        },
        Visa = new Stripe.Inputs.PersonDocumentsVisaArgs
        {
            Files = new[]
            {
                "string",
            },
        },
    },
    Email = "string",
    FirstName = "string",
    FirstNameKana = "string",
    FirstNameKanji = "string",
    FullNameAliases = new[]
    {
        "string",
    },
    Gender = "string",
    IdNumber = "string",
    IdNumberSecondary = "string",
    LastName = "string",
    LastNameKana = "string",
    LastNameKanji = "string",
    MaidenName = "string",
    Metadata = 
    {
        { "string", "string" },
    },
    Nationality = "string",
    PersonToken = "string",
    Phone = "string",
    PoliticalExposure = "string",
    RegisteredAddress = new Stripe.Inputs.PersonRegisteredAddressArgs
    {
        City = "string",
        Country = "string",
        Line1 = "string",
        Line2 = "string",
        PostalCode = "string",
        State = "string",
    },
    Relationship = new Stripe.Inputs.PersonRelationshipArgs
    {
        Authorizer = false,
        Director = false,
        Executive = false,
        LegalGuardian = false,
        Owner = false,
        PercentOwnership = 0.0,
        Representative = false,
        Title = "string",
    },
    SsnLast4 = "string",
    UsCfpbData = new Stripe.Inputs.PersonUsCfpbDataArgs
    {
        EthnicityDetails = new Stripe.Inputs.PersonUsCfpbDataEthnicityDetailsArgs
        {
            Ethnicities = new[]
            {
                "string",
            },
            EthnicityOther = "string",
        },
        RaceDetails = new Stripe.Inputs.PersonUsCfpbDataRaceDetailsArgs
        {
            RaceOther = "string",
            Races = new[]
            {
                "string",
            },
        },
        SelfIdentifiedGender = "string",
    },
    Verification = new Stripe.Inputs.PersonVerificationArgs
    {
        AdditionalDocument = new Stripe.Inputs.PersonVerificationAdditionalDocumentArgs
        {
            Back = "string",
            Details = "string",
            DetailsCode = "string",
            Front = "string",
        },
        Details = "string",
        DetailsCode = "string",
        Document = new Stripe.Inputs.PersonVerificationDocumentArgs
        {
            Back = "string",
            Details = "string",
            DetailsCode = "string",
            Front = "string",
        },
        Status = "string",
    },
});

    example, err := stripe.NewPerson(ctx, "personResource", &stripe.PersonArgs{
	Account: pulumi.String("string"),
	AdditionalTosAcceptances: &stripe.PersonAdditionalTosAcceptancesArgs{
		Account: &stripe.PersonAdditionalTosAcceptancesAccountArgs{
			Date:      pulumi.Float64(0),
			Ip:        pulumi.String("string"),
			UserAgent: pulumi.String("string"),
		},
	},
	Address: &stripe.PersonAddressArgs{
		City:       pulumi.String("string"),
		Country:    pulumi.String("string"),
		Line1:      pulumi.String("string"),
		Line2:      pulumi.String("string"),
		PostalCode: pulumi.String("string"),
		State:      pulumi.String("string"),
	},
	AddressKana: &stripe.PersonAddressKanaArgs{
		City:       pulumi.String("string"),
		Country:    pulumi.String("string"),
		Line1:      pulumi.String("string"),
		Line2:      pulumi.String("string"),
		PostalCode: pulumi.String("string"),
		State:      pulumi.String("string"),
		Town:       pulumi.String("string"),
	},
	AddressKanji: &stripe.PersonAddressKanjiArgs{
		City:       pulumi.String("string"),
		Country:    pulumi.String("string"),
		Line1:      pulumi.String("string"),
		Line2:      pulumi.String("string"),
		PostalCode: pulumi.String("string"),
		State:      pulumi.String("string"),
		Town:       pulumi.String("string"),
	},
	Dob: &stripe.PersonDobArgs{
		Day:   pulumi.Float64(0),
		Month: pulumi.Float64(0),
		Year:  pulumi.Float64(0),
	},
	Documents: &stripe.PersonDocumentsArgs{
		CompanyAuthorization: &stripe.PersonDocumentsCompanyAuthorizationArgs{
			Files: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		Passport: &stripe.PersonDocumentsPassportArgs{
			Files: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		Visa: &stripe.PersonDocumentsVisaArgs{
			Files: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Email:          pulumi.String("string"),
	FirstName:      pulumi.String("string"),
	FirstNameKana:  pulumi.String("string"),
	FirstNameKanji: pulumi.String("string"),
	FullNameAliases: pulumi.StringArray{
		pulumi.String("string"),
	},
	Gender:            pulumi.String("string"),
	IdNumber:          pulumi.String("string"),
	IdNumberSecondary: pulumi.String("string"),
	LastName:          pulumi.String("string"),
	LastNameKana:      pulumi.String("string"),
	LastNameKanji:     pulumi.String("string"),
	MaidenName:        pulumi.String("string"),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Nationality:       pulumi.String("string"),
	PersonToken:       pulumi.String("string"),
	Phone:             pulumi.String("string"),
	PoliticalExposure: pulumi.String("string"),
	RegisteredAddress: &stripe.PersonRegisteredAddressArgs{
		City:       pulumi.String("string"),
		Country:    pulumi.String("string"),
		Line1:      pulumi.String("string"),
		Line2:      pulumi.String("string"),
		PostalCode: pulumi.String("string"),
		State:      pulumi.String("string"),
	},
	Relationship: &stripe.PersonRelationshipArgs{
		Authorizer:       pulumi.Bool(false),
		Director:         pulumi.Bool(false),
		Executive:        pulumi.Bool(false),
		LegalGuardian:    pulumi.Bool(false),
		Owner:            pulumi.Bool(false),
		PercentOwnership: pulumi.Float64(0),
		Representative:   pulumi.Bool(false),
		Title:            pulumi.String("string"),
	},
	SsnLast4: pulumi.String("string"),
	UsCfpbData: &stripe.PersonUsCfpbDataArgs{
		EthnicityDetails: &stripe.PersonUsCfpbDataEthnicityDetailsArgs{
			Ethnicities: pulumi.StringArray{
				pulumi.String("string"),
			},
			EthnicityOther: pulumi.String("string"),
		},
		RaceDetails: &stripe.PersonUsCfpbDataRaceDetailsArgs{
			RaceOther: pulumi.String("string"),
			Races: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		SelfIdentifiedGender: pulumi.String("string"),
	},
	Verification: &stripe.PersonVerificationArgs{
		AdditionalDocument: &stripe.PersonVerificationAdditionalDocumentArgs{
			Back:        pulumi.String("string"),
			Details:     pulumi.String("string"),
			DetailsCode: pulumi.String("string"),
			Front:       pulumi.String("string"),
		},
		Details:     pulumi.String("string"),
		DetailsCode: pulumi.String("string"),
		Document: &stripe.PersonVerificationDocumentArgs{
			Back:        pulumi.String("string"),
			Details:     pulumi.String("string"),
			DetailsCode: pulumi.String("string"),
			Front:       pulumi.String("string"),
		},
		Status: pulumi.String("string"),
	},
})

    resource "stripe_person" "personResource" {
  lifecycle {
    create_before_destroy = true
  }
  account = "string"
  additional_tos_acceptances = {
    account = {
      date       = 0
      ip         = "string"
      user_agent = "string"
    }
  }
  address = {
    city        = "string"
    country     = "string"
    line1       = "string"
    line2       = "string"
    postal_code = "string"
    state       = "string"
  }
  address_kana = {
    city        = "string"
    country     = "string"
    line1       = "string"
    line2       = "string"
    postal_code = "string"
    state       = "string"
    town        = "string"
  }
  address_kanji = {
    city        = "string"
    country     = "string"
    line1       = "string"
    line2       = "string"
    postal_code = "string"
    state       = "string"
    town        = "string"
  }
  dob = {
    day   = 0
    month = 0
    year  = 0
  }
  documents = {
    company_authorization = {
      files = ["string"]
    }
    passport = {
      files = ["string"]
    }
    visa = {
      files = ["string"]
    }
  }
  email               = "string"
  first_name          = "string"
  first_name_kana     = "string"
  first_name_kanji    = "string"
  full_name_aliases   = ["string"]
  gender              = "string"
  id_number           = "string"
  id_number_secondary = "string"
  last_name           = "string"
  last_name_kana      = "string"
  last_name_kanji     = "string"
  maiden_name         = "string"
  metadata = {
    "string" = "string"
  }
  nationality        = "string"
  person_token       = "string"
  phone              = "string"
  political_exposure = "string"
  registered_address = {
    city        = "string"
    country     = "string"
    line1       = "string"
    line2       = "string"
    postal_code = "string"
    state       = "string"
  }
  relationship = {
    authorizer        = false
    director          = false
    executive         = false
    legal_guardian    = false
    owner             = false
    percent_ownership = 0
    representative    = false
    title             = "string"
  }
  ssn_last4 = "string"
  us_cfpb_data = {
    ethnicity_details = {
      ethnicities     = ["string"]
      ethnicity_other = "string"
    }
    race_details = {
      race_other = "string"
      races      = ["string"]
    }
    self_identified_gender = "string"
  }
  verification = {
    additional_document = {
      back         = "string"
      details      = "string"
      details_code = "string"
      front        = "string"
    }
    details      = "string"
    details_code = "string"
    document = {
      back         = "string"
      details      = "string"
      details_code = "string"
      front        = "string"
    }
    status = "string"
  }
}

    var personResource = new Person("personResource", PersonArgs.builder()
    .account("string")
    .additionalTosAcceptances(PersonAdditionalTosAcceptancesArgs.builder()
        .account(PersonAdditionalTosAcceptancesAccountArgs.builder()
            .date(0.0)
            .ip("string")
            .userAgent("string")
            .build())
        .build())
    .address(PersonAddressArgs.builder()
        .city("string")
        .country("string")
        .line1("string")
        .line2("string")
        .postalCode("string")
        .state("string")
        .build())
    .addressKana(PersonAddressKanaArgs.builder()
        .city("string")
        .country("string")
        .line1("string")
        .line2("string")
        .postalCode("string")
        .state("string")
        .town("string")
        .build())
    .addressKanji(PersonAddressKanjiArgs.builder()
        .city("string")
        .country("string")
        .line1("string")
        .line2("string")
        .postalCode("string")
        .state("string")
        .town("string")
        .build())
    .dob(PersonDobArgs.builder()
        .day(0.0)
        .month(0.0)
        .year(0.0)
        .build())
    .documents(PersonDocumentsArgs.builder()
        .companyAuthorization(PersonDocumentsCompanyAuthorizationArgs.builder()
            .files("string")
            .build())
        .passport(PersonDocumentsPassportArgs.builder()
            .files("string")
            .build())
        .visa(PersonDocumentsVisaArgs.builder()
            .files("string")
            .build())
        .build())
    .email("string")
    .firstName("string")
    .firstNameKana("string")
    .firstNameKanji("string")
    .fullNameAliases("string")
    .gender("string")
    .idNumber("string")
    .idNumberSecondary("string")
    .lastName("string")
    .lastNameKana("string")
    .lastNameKanji("string")
    .maidenName("string")
    .metadata(Map.of("string", "string"))
    .nationality("string")
    .personToken("string")
    .phone("string")
    .politicalExposure("string")
    .registeredAddress(PersonRegisteredAddressArgs.builder()
        .city("string")
        .country("string")
        .line1("string")
        .line2("string")
        .postalCode("string")
        .state("string")
        .build())
    .relationship(PersonRelationshipArgs.builder()
        .authorizer(false)
        .director(false)
        .executive(false)
        .legalGuardian(false)
        .owner(false)
        .percentOwnership(0.0)
        .representative(false)
        .title("string")
        .build())
    .ssnLast4("string")
    .usCfpbData(PersonUsCfpbDataArgs.builder()
        .ethnicityDetails(PersonUsCfpbDataEthnicityDetailsArgs.builder()
            .ethnicities("string")
            .ethnicityOther("string")
            .build())
        .raceDetails(PersonUsCfpbDataRaceDetailsArgs.builder()
            .raceOther("string")
            .races("string")
            .build())
        .selfIdentifiedGender("string")
        .build())
    .verification(PersonVerificationArgs.builder()
        .additionalDocument(PersonVerificationAdditionalDocumentArgs.builder()
            .back("string")
            .details("string")
            .detailsCode("string")
            .front("string")
            .build())
        .details("string")
        .detailsCode("string")
        .document(PersonVerificationDocumentArgs.builder()
            .back("string")
            .details("string")
            .detailsCode("string")
            .front("string")
            .build())
        .status("string")
        .build())
    .build());

    person_resource = stripe.Person("personResource",
    account="string",
    additional_tos_acceptances={
        "account": {
            "date": float(0),
            "ip": "string",
            "user_agent": "string",
        },
    },
    address={
        "city": "string",
        "country": "string",
        "line1": "string",
        "line2": "string",
        "postal_code": "string",
        "state": "string",
    },
    address_kana={
        "city": "string",
        "country": "string",
        "line1": "string",
        "line2": "string",
        "postal_code": "string",
        "state": "string",
        "town": "string",
    },
    address_kanji={
        "city": "string",
        "country": "string",
        "line1": "string",
        "line2": "string",
        "postal_code": "string",
        "state": "string",
        "town": "string",
    },
    dob={
        "day": float(0),
        "month": float(0),
        "year": float(0),
    },
    documents={
        "company_authorization": {
            "files": ["string"],
        },
        "passport": {
            "files": ["string"],
        },
        "visa": {
            "files": ["string"],
        },
    },
    email="string",
    first_name="string",
    first_name_kana="string",
    first_name_kanji="string",
    full_name_aliases=["string"],
    gender="string",
    id_number="string",
    id_number_secondary="string",
    last_name="string",
    last_name_kana="string",
    last_name_kanji="string",
    maiden_name="string",
    metadata={
        "string": "string",
    },
    nationality="string",
    person_token="string",
    phone="string",
    political_exposure="string",
    registered_address={
        "city": "string",
        "country": "string",
        "line1": "string",
        "line2": "string",
        "postal_code": "string",
        "state": "string",
    },
    relationship={
        "authorizer": False,
        "director": False,
        "executive": False,
        "legal_guardian": False,
        "owner": False,
        "percent_ownership": float(0),
        "representative": False,
        "title": "string",
    },
    ssn_last4="string",
    us_cfpb_data={
        "ethnicity_details": {
            "ethnicities": ["string"],
            "ethnicity_other": "string",
        },
        "race_details": {
            "race_other": "string",
            "races": ["string"],
        },
        "self_identified_gender": "string",
    },
    verification={
        "additional_document": {
            "back": "string",
            "details": "string",
            "details_code": "string",
            "front": "string",
        },
        "details": "string",
        "details_code": "string",
        "document": {
            "back": "string",
            "details": "string",
            "details_code": "string",
            "front": "string",
        },
        "status": "string",
    })

    const personResource = new stripe.Person("personResource", {
    account: "string",
    additionalTosAcceptances: {
        account: {
            date: 0,
            ip: "string",
            userAgent: "string",
        },
    },
    address: {
        city: "string",
        country: "string",
        line1: "string",
        line2: "string",
        postalCode: "string",
        state: "string",
    },
    addressKana: {
        city: "string",
        country: "string",
        line1: "string",
        line2: "string",
        postalCode: "string",
        state: "string",
        town: "string",
    },
    addressKanji: {
        city: "string",
        country: "string",
        line1: "string",
        line2: "string",
        postalCode: "string",
        state: "string",
        town: "string",
    },
    dob: {
        day: 0,
        month: 0,
        year: 0,
    },
    documents: {
        companyAuthorization: {
            files: ["string"],
        },
        passport: {
            files: ["string"],
        },
        visa: {
            files: ["string"],
        },
    },
    email: "string",
    firstName: "string",
    firstNameKana: "string",
    firstNameKanji: "string",
    fullNameAliases: ["string"],
    gender: "string",
    idNumber: "string",
    idNumberSecondary: "string",
    lastName: "string",
    lastNameKana: "string",
    lastNameKanji: "string",
    maidenName: "string",
    metadata: {
        string: "string",
    },
    nationality: "string",
    personToken: "string",
    phone: "string",
    politicalExposure: "string",
    registeredAddress: {
        city: "string",
        country: "string",
        line1: "string",
        line2: "string",
        postalCode: "string",
        state: "string",
    },
    relationship: {
        authorizer: false,
        director: false,
        executive: false,
        legalGuardian: false,
        owner: false,
        percentOwnership: 0,
        representative: false,
        title: "string",
    },
    ssnLast4: "string",
    usCfpbData: {
        ethnicityDetails: {
            ethnicities: ["string"],
            ethnicityOther: "string",
        },
        raceDetails: {
            raceOther: "string",
            races: ["string"],
        },
        selfIdentifiedGender: "string",
    },
    verification: {
        additionalDocument: {
            back: "string",
            details: "string",
            detailsCode: "string",
            front: "string",
        },
        details: "string",
        detailsCode: "string",
        document: {
            back: "string",
            details: "string",
            detailsCode: "string",
            front: "string",
        },
        status: "string",
    },
});

    type: stripe:Person
properties:
    account: string
    additionalTosAcceptances:
        account:
            date: 0
            ip: string
            userAgent: string
    address:
        city: string
        country: string
        line1: string
        line2: string
        postalCode: string
        state: string
    addressKana:
        city: string
        country: string
        line1: string
        line2: string
        postalCode: string
        state: string
        town: string
    addressKanji:
        city: string
        country: string
        line1: string
        line2: string
        postalCode: string
        state: string
        town: string
    dob:
        day: 0
        month: 0
        year: 0
    documents:
        companyAuthorization:
            files:
                - string
        passport:
            files:
                - string
        visa:
            files:
                - string
    email: string
    firstName: string
    firstNameKana: string
    firstNameKanji: string
    fullNameAliases:
        - string
    gender: string
    idNumber: string
    idNumberSecondary: string
    lastName: string
    lastNameKana: string
    lastNameKanji: string
    maidenName: string
    metadata:
        string: string
    nationality: string
    personToken: string
    phone: string
    politicalExposure: string
    registeredAddress:
        city: string
        country: string
        line1: string
        line2: string
        postalCode: string
        state: string
    relationship:
        authorizer: false
        director: false
        executive: false
        legalGuardian: false
        owner: false
        percentOwnership: 0
        representative: false
        title: string
    ssnLast4: string
    usCfpbData:
        ethnicityDetails:
            ethnicities:
                - string
            ethnicityOther: string
        raceDetails:
            raceOther: string
            races:
                - string
        selfIdentifiedGender: string
    verification:
        additionalDocument:
            back: string
            details: string
            detailsCode: string
            front: string
        details: string
        detailsCode: string
        document:
            back: string
            details: string
            detailsCode: string
            front: string
        status: string

    Person Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Person resource accepts the following input properties:

    Account string
    The account the person is associated with.
    AdditionalTosAcceptances PersonAdditionalTosAcceptances
    Address PersonAddress
    AddressKana PersonAddressKana
    The Kana variation of the person's address (Japan only).
    AddressKanji PersonAddressKanji
    The Kanji variation of the person's address (Japan only).
    Dob PersonDob
    Documents PersonDocuments
    Documents that may be submitted to satisfy various informational requests.
    Email string
    The person's email address. Also available for accounts where controller.requirement_collection is stripe.
    FirstName string
    The person's first name. Also available for accounts where controller.requirement_collection is stripe.
    FirstNameKana string
    The Kana variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    FirstNameKanji string
    The Kanji variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    FullNameAliases List<string>
    A list of alternate names or aliases that the person is known by. Also available for accounts where controller.requirement_collection is stripe.
    Gender string
    The person's gender.
    IdNumber string
    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.
    IdNumberSecondary string
    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.
    LastName string
    The person's last name. Also available for accounts where controller.requirement_collection is stripe.
    LastNameKana string
    The Kana variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    LastNameKanji string
    The Kanji variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    MaidenName string
    The person's maiden name.
    Metadata Dictionary<string, string>
    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.
    Nationality string
    The country where the person is a national.
    PersonToken string
    A person token, used to securely provide details to the person.
    Phone string
    The person's phone number.
    PoliticalExposure string
    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.
    RegisteredAddress PersonRegisteredAddress
    Relationship PersonRelationship
    SsnLast4 string
    The last four digits of the person's Social Security number (U.S. only).
    UsCfpbData PersonUsCfpbData
    Demographic data related to the person.
    Verification PersonVerification
    Account string
    The account the person is associated with.
    AdditionalTosAcceptances PersonAdditionalTosAcceptancesArgs
    Address PersonAddressArgs
    AddressKana PersonAddressKanaArgs
    The Kana variation of the person's address (Japan only).
    AddressKanji PersonAddressKanjiArgs
    The Kanji variation of the person's address (Japan only).
    Dob PersonDobArgs
    Documents PersonDocumentsArgs
    Documents that may be submitted to satisfy various informational requests.
    Email string
    The person's email address. Also available for accounts where controller.requirement_collection is stripe.
    FirstName string
    The person's first name. Also available for accounts where controller.requirement_collection is stripe.
    FirstNameKana string
    The Kana variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    FirstNameKanji string
    The Kanji variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    FullNameAliases []string
    A list of alternate names or aliases that the person is known by. Also available for accounts where controller.requirement_collection is stripe.
    Gender string
    The person's gender.
    IdNumber string
    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.
    IdNumberSecondary string
    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.
    LastName string
    The person's last name. Also available for accounts where controller.requirement_collection is stripe.
    LastNameKana string
    The Kana variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    LastNameKanji string
    The Kanji variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    MaidenName string
    The person's maiden name.
    Metadata map[string]string
    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.
    Nationality string
    The country where the person is a national.
    PersonToken string
    A person token, used to securely provide details to the person.
    Phone string
    The person's phone number.
    PoliticalExposure string
    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.
    RegisteredAddress PersonRegisteredAddressArgs
    Relationship PersonRelationshipArgs
    SsnLast4 string
    The last four digits of the person's Social Security number (U.S. only).
    UsCfpbData PersonUsCfpbDataArgs
    Demographic data related to the person.
    Verification PersonVerificationArgs
    account string
    The account the person is associated with.
    additional_tos_acceptances object
    address object
    address_kana object
    The Kana variation of the person's address (Japan only).
    address_kanji object
    The Kanji variation of the person's address (Japan only).
    dob object
    documents object
    Documents that may be submitted to satisfy various informational requests.
    email string
    The person's email address. Also available for accounts where controller.requirement_collection is stripe.
    first_name string
    The person's first name. Also available for accounts where controller.requirement_collection is stripe.
    first_name_kana string
    The Kana variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    first_name_kanji string
    The Kanji variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    full_name_aliases list(string)
    A list of alternate names or aliases that the person is known by. Also available for accounts where controller.requirement_collection is stripe.
    gender string
    The person's gender.
    id_number string
    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.
    id_number_secondary string
    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.
    last_name string
    The person's last name. Also available for accounts where controller.requirement_collection is stripe.
    last_name_kana string
    The Kana variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    last_name_kanji string
    The Kanji variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    maiden_name string
    The person's maiden name.
    metadata map(string)
    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.
    nationality string
    The country where the person is a national.
    person_token string
    A person token, used to securely provide details to the person.
    phone string
    The person's phone number.
    political_exposure string
    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 object
    relationship object
    ssn_last4 string
    The last four digits of the person's Social Security number (U.S. only).
    us_cfpb_data object
    Demographic data related to the person.
    verification object
    account String
    The account the person is associated with.
    additionalTosAcceptances PersonAdditionalTosAcceptances
    address PersonAddress
    addressKana PersonAddressKana
    The Kana variation of the person's address (Japan only).
    addressKanji PersonAddressKanji
    The Kanji variation of the person's address (Japan only).
    dob PersonDob
    documents PersonDocuments
    Documents that may be submitted to satisfy various informational requests.
    email String
    The person's email address. Also available for accounts where controller.requirement_collection is stripe.
    firstName String
    The person's first name. Also available for accounts where controller.requirement_collection is stripe.
    firstNameKana String
    The Kana variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    firstNameKanji String
    The Kanji variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    fullNameAliases List<String>
    A list of alternate names or aliases that the person is known by. Also available for accounts where controller.requirement_collection is stripe.
    gender String
    The person's gender.
    idNumber String
    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.
    idNumberSecondary String
    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.
    lastName String
    The person's last name. Also available for accounts where controller.requirement_collection is stripe.
    lastNameKana String
    The Kana variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    lastNameKanji String
    The Kanji variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    maidenName String
    The person's maiden name.
    metadata Map<String,String>
    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.
    nationality String
    The country where the person is a national.
    personToken String
    A person token, used to securely provide details to the person.
    phone String
    The person's phone number.
    politicalExposure String
    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.
    registeredAddress PersonRegisteredAddress
    relationship PersonRelationship
    ssnLast4 String
    The last four digits of the person's Social Security number (U.S. only).
    usCfpbData PersonUsCfpbData
    Demographic data related to the person.
    verification PersonVerification
    account string
    The account the person is associated with.
    additionalTosAcceptances PersonAdditionalTosAcceptances
    address PersonAddress
    addressKana PersonAddressKana
    The Kana variation of the person's address (Japan only).
    addressKanji PersonAddressKanji
    The Kanji variation of the person's address (Japan only).
    dob PersonDob
    documents PersonDocuments
    Documents that may be submitted to satisfy various informational requests.
    email string
    The person's email address. Also available for accounts where controller.requirement_collection is stripe.
    firstName string
    The person's first name. Also available for accounts where controller.requirement_collection is stripe.
    firstNameKana string
    The Kana variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    firstNameKanji string
    The Kanji variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    fullNameAliases string[]
    A list of alternate names or aliases that the person is known by. Also available for accounts where controller.requirement_collection is stripe.
    gender string
    The person's gender.
    idNumber string
    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.
    idNumberSecondary string
    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.
    lastName string
    The person's last name. Also available for accounts where controller.requirement_collection is stripe.
    lastNameKana string
    The Kana variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    lastNameKanji string
    The Kanji variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    maidenName string
    The person's maiden name.
    metadata {[key: string]: string}
    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.
    nationality string
    The country where the person is a national.
    personToken string
    A person token, used to securely provide details to the person.
    phone string
    The person's phone number.
    politicalExposure string
    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.
    registeredAddress PersonRegisteredAddress
    relationship PersonRelationship
    ssnLast4 string
    The last four digits of the person's Social Security number (U.S. only).
    usCfpbData PersonUsCfpbData
    Demographic data related to the person.
    verification PersonVerification
    account str
    The account the person is associated with.
    additional_tos_acceptances PersonAdditionalTosAcceptancesArgs
    address PersonAddressArgs
    address_kana PersonAddressKanaArgs
    The Kana variation of the person's address (Japan only).
    address_kanji PersonAddressKanjiArgs
    The Kanji variation of the person's address (Japan only).
    dob PersonDobArgs
    documents PersonDocumentsArgs
    Documents that may be submitted to satisfy various informational requests.
    email str
    The person's email address. Also available for accounts where controller.requirement_collection is stripe.
    first_name str
    The person's first name. Also available for accounts where controller.requirement_collection is stripe.
    first_name_kana str
    The Kana variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    first_name_kanji str
    The Kanji variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    full_name_aliases Sequence[str]
    A list of alternate names or aliases that the person is known by. Also available for accounts where controller.requirement_collection is stripe.
    gender str
    The person's gender.
    id_number 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.
    id_number_secondary 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.
    last_name str
    The person's last name. Also available for accounts where controller.requirement_collection is stripe.
    last_name_kana str
    The Kana variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    last_name_kanji str
    The Kanji variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    maiden_name str
    The person's maiden name.
    metadata Mapping[str, str]
    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.
    nationality str
    The country where the person is a national.
    person_token str
    A person token, used to securely provide details to the person.
    phone str
    The person's phone number.
    political_exposure str
    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 PersonRegisteredAddressArgs
    relationship PersonRelationshipArgs
    ssn_last4 str
    The last four digits of the person's Social Security number (U.S. only).
    us_cfpb_data PersonUsCfpbDataArgs
    Demographic data related to the person.
    verification PersonVerificationArgs
    account String
    The account the person is associated with.
    additionalTosAcceptances Property Map
    address Property Map
    addressKana Property Map
    The Kana variation of the person's address (Japan only).
    addressKanji Property Map
    The Kanji variation of the person's address (Japan only).
    dob Property Map
    documents Property Map
    Documents that may be submitted to satisfy various informational requests.
    email String
    The person's email address. Also available for accounts where controller.requirement_collection is stripe.
    firstName String
    The person's first name. Also available for accounts where controller.requirement_collection is stripe.
    firstNameKana String
    The Kana variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    firstNameKanji String
    The Kanji variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    fullNameAliases List<String>
    A list of alternate names or aliases that the person is known by. Also available for accounts where controller.requirement_collection is stripe.
    gender String
    The person's gender.
    idNumber String
    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.
    idNumberSecondary String
    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.
    lastName String
    The person's last name. Also available for accounts where controller.requirement_collection is stripe.
    lastNameKana String
    The Kana variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    lastNameKanji String
    The Kanji variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    maidenName String
    The person's maiden name.
    metadata Map<String>
    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.
    nationality String
    The country where the person is a national.
    personToken String
    A person token, used to securely provide details to the person.
    phone String
    The person's phone number.
    politicalExposure String
    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.
    registeredAddress Property Map
    relationship Property Map
    ssnLast4 String
    The last four digits of the person's Social Security number (U.S. only).
    usCfpbData Property Map
    Demographic data related to the person.
    verification Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Person resource produces the following output properties:

    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    FutureRequirements PersonFutureRequirements
    Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdNumberProvided bool
    Whether the person's id_number was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by ssn_last_4_provided).
    IdNumberSecondaryProvided bool
    Whether the person's id_number_secondary was provided.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Requirements PersonRequirements
    Information about the requirements for this person, including what information needs to be collected, and by when.
    SsnLast4Provided bool
    Whether the last four digits of the person's Social Security number have been provided (U.S. only).
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    FutureRequirements PersonFutureRequirements
    Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdNumberProvided bool
    Whether the person's id_number was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by ssn_last_4_provided).
    IdNumberSecondaryProvided bool
    Whether the person's id_number_secondary was provided.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Requirements PersonRequirements
    Information about the requirements for this person, including what information needs to be collected, and by when.
    SsnLast4Provided bool
    Whether the last four digits of the person's Social Security number have been provided (U.S. only).
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    future_requirements object
    Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.
    id string
    The provider-assigned unique ID for this managed resource.
    id_number_provided bool
    Whether the person's id_number was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by ssn_last_4_provided).
    id_number_secondary_provided bool
    Whether the person's id_number_secondary was provided.
    object string
    String representing the object's type. Objects of the same type share the same value.
    requirements object
    Information about the requirements for this person, including what information needs to be collected, and by when.
    ssn_last4_provided bool
    Whether the last four digits of the person's Social Security number have been provided (U.S. only).
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    futureRequirements PersonFutureRequirements
    Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.
    id String
    The provider-assigned unique ID for this managed resource.
    idNumberProvided Boolean
    Whether the person's id_number was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by ssn_last_4_provided).
    idNumberSecondaryProvided Boolean
    Whether the person's id_number_secondary was provided.
    object String
    String representing the object's type. Objects of the same type share the same value.
    requirements PersonRequirements
    Information about the requirements for this person, including what information needs to be collected, and by when.
    ssnLast4Provided Boolean
    Whether the last four digits of the person's Social Security number have been provided (U.S. only).
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    futureRequirements PersonFutureRequirements
    Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.
    id string
    The provider-assigned unique ID for this managed resource.
    idNumberProvided boolean
    Whether the person's id_number was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by ssn_last_4_provided).
    idNumberSecondaryProvided boolean
    Whether the person's id_number_secondary was provided.
    object string
    String representing the object's type. Objects of the same type share the same value.
    requirements PersonRequirements
    Information about the requirements for this person, including what information needs to be collected, and by when.
    ssnLast4Provided boolean
    Whether the last four digits of the person's Social Security number have been provided (U.S. only).
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    future_requirements PersonFutureRequirements
    Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.
    id str
    The provider-assigned unique ID for this managed resource.
    id_number_provided bool
    Whether the person's id_number was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by ssn_last_4_provided).
    id_number_secondary_provided bool
    Whether the person's id_number_secondary was provided.
    object str
    String representing the object's type. Objects of the same type share the same value.
    requirements PersonRequirements
    Information about the requirements for this person, including what information needs to be collected, and by when.
    ssn_last4_provided bool
    Whether the last four digits of the person's Social Security number have been provided (U.S. only).
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    futureRequirements Property Map
    Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.
    id String
    The provider-assigned unique ID for this managed resource.
    idNumberProvided Boolean
    Whether the person's id_number was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by ssn_last_4_provided).
    idNumberSecondaryProvided Boolean
    Whether the person's id_number_secondary was provided.
    object String
    String representing the object's type. Objects of the same type share the same value.
    requirements Property Map
    Information about the requirements for this person, including what information needs to be collected, and by when.
    ssnLast4Provided Boolean
    Whether the last four digits of the person's Social Security number have been provided (U.S. only).

    Look up Existing Person Resource

    Get an existing Person resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PersonState, opts?: CustomResourceOptions): Person
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account: Optional[str] = None,
        additional_tos_acceptances: Optional[PersonAdditionalTosAcceptancesArgs] = None,
        address: Optional[PersonAddressArgs] = None,
        address_kana: Optional[PersonAddressKanaArgs] = None,
        address_kanji: Optional[PersonAddressKanjiArgs] = None,
        created: Optional[float] = None,
        dob: Optional[PersonDobArgs] = None,
        documents: Optional[PersonDocumentsArgs] = None,
        email: Optional[str] = None,
        first_name: Optional[str] = None,
        first_name_kana: Optional[str] = None,
        first_name_kanji: Optional[str] = None,
        full_name_aliases: Optional[Sequence[str]] = None,
        future_requirements: Optional[PersonFutureRequirementsArgs] = None,
        gender: Optional[str] = None,
        id_number: Optional[str] = None,
        id_number_provided: Optional[bool] = None,
        id_number_secondary: Optional[str] = None,
        id_number_secondary_provided: Optional[bool] = None,
        last_name: Optional[str] = None,
        last_name_kana: Optional[str] = None,
        last_name_kanji: Optional[str] = None,
        maiden_name: Optional[str] = None,
        metadata: Optional[Mapping[str, str]] = None,
        nationality: Optional[str] = None,
        object: Optional[str] = None,
        person_token: Optional[str] = None,
        phone: Optional[str] = None,
        political_exposure: Optional[str] = None,
        registered_address: Optional[PersonRegisteredAddressArgs] = None,
        relationship: Optional[PersonRelationshipArgs] = None,
        requirements: Optional[PersonRequirementsArgs] = None,
        ssn_last4: Optional[str] = None,
        ssn_last4_provided: Optional[bool] = None,
        us_cfpb_data: Optional[PersonUsCfpbDataArgs] = None,
        verification: Optional[PersonVerificationArgs] = None) -> Person
    func GetPerson(ctx *Context, name string, id IDInput, state *PersonState, opts ...ResourceOption) (*Person, error)
    public static Person Get(string name, Input<string> id, PersonState? state, CustomResourceOptions? opts = null)
    public static Person get(String name, Output<String> id, PersonState state, CustomResourceOptions options)
    resources:  _:    type: stripe:Person    get:      id: ${id}
    import {
  to = stripe_person.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Account string
    The account the person is associated with.
    AdditionalTosAcceptances PersonAdditionalTosAcceptances
    Address PersonAddress
    AddressKana PersonAddressKana
    The Kana variation of the person's address (Japan only).
    AddressKanji PersonAddressKanji
    The Kanji variation of the person's address (Japan only).
    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Dob PersonDob
    Documents PersonDocuments
    Documents that may be submitted to satisfy various informational requests.
    Email string
    The person's email address. Also available for accounts where controller.requirement_collection is stripe.
    FirstName string
    The person's first name. Also available for accounts where controller.requirement_collection is stripe.
    FirstNameKana string
    The Kana variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    FirstNameKanji string
    The Kanji variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    FullNameAliases List<string>
    A list of alternate names or aliases that the person is known by. Also available for accounts where controller.requirement_collection is stripe.
    FutureRequirements PersonFutureRequirements
    Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.
    Gender string
    The person's gender.
    IdNumber string
    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.
    IdNumberProvided bool
    Whether the person's id_number was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by ssn_last_4_provided).
    IdNumberSecondary string
    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.
    IdNumberSecondaryProvided bool
    Whether the person's id_number_secondary was provided.
    LastName string
    The person's last name. Also available for accounts where controller.requirement_collection is stripe.
    LastNameKana string
    The Kana variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    LastNameKanji string
    The Kanji variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    MaidenName string
    The person's maiden name.
    Metadata Dictionary<string, string>
    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.
    Nationality string
    The country where the person is a national.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    PersonToken string
    A person token, used to securely provide details to the person.
    Phone string
    The person's phone number.
    PoliticalExposure string
    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.
    RegisteredAddress PersonRegisteredAddress
    Relationship PersonRelationship
    Requirements PersonRequirements
    Information about the requirements for this person, including what information needs to be collected, and by when.
    SsnLast4 string
    The last four digits of the person's Social Security number (U.S. only).
    SsnLast4Provided bool
    Whether the last four digits of the person's Social Security number have been provided (U.S. only).
    UsCfpbData PersonUsCfpbData
    Demographic data related to the person.
    Verification PersonVerification
    Account string
    The account the person is associated with.
    AdditionalTosAcceptances PersonAdditionalTosAcceptancesArgs
    Address PersonAddressArgs
    AddressKana PersonAddressKanaArgs
    The Kana variation of the person's address (Japan only).
    AddressKanji PersonAddressKanjiArgs
    The Kanji variation of the person's address (Japan only).
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Dob PersonDobArgs
    Documents PersonDocumentsArgs
    Documents that may be submitted to satisfy various informational requests.
    Email string
    The person's email address. Also available for accounts where controller.requirement_collection is stripe.
    FirstName string
    The person's first name. Also available for accounts where controller.requirement_collection is stripe.
    FirstNameKana string
    The Kana variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    FirstNameKanji string
    The Kanji variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    FullNameAliases []string
    A list of alternate names or aliases that the person is known by. Also available for accounts where controller.requirement_collection is stripe.
    FutureRequirements PersonFutureRequirementsArgs
    Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.
    Gender string
    The person's gender.
    IdNumber string
    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.
    IdNumberProvided bool
    Whether the person's id_number was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by ssn_last_4_provided).
    IdNumberSecondary string
    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.
    IdNumberSecondaryProvided bool
    Whether the person's id_number_secondary was provided.
    LastName string
    The person's last name. Also available for accounts where controller.requirement_collection is stripe.
    LastNameKana string
    The Kana variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    LastNameKanji string
    The Kanji variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    MaidenName string
    The person's maiden name.
    Metadata map[string]string
    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.
    Nationality string
    The country where the person is a national.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    PersonToken string
    A person token, used to securely provide details to the person.
    Phone string
    The person's phone number.
    PoliticalExposure string
    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.
    RegisteredAddress PersonRegisteredAddressArgs
    Relationship PersonRelationshipArgs
    Requirements PersonRequirementsArgs
    Information about the requirements for this person, including what information needs to be collected, and by when.
    SsnLast4 string
    The last four digits of the person's Social Security number (U.S. only).
    SsnLast4Provided bool
    Whether the last four digits of the person's Social Security number have been provided (U.S. only).
    UsCfpbData PersonUsCfpbDataArgs
    Demographic data related to the person.
    Verification PersonVerificationArgs
    account string
    The account the person is associated with.
    additional_tos_acceptances object
    address object
    address_kana object
    The Kana variation of the person's address (Japan only).
    address_kanji object
    The Kanji variation of the person's address (Japan only).
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    dob object
    documents object
    Documents that may be submitted to satisfy various informational requests.
    email string
    The person's email address. Also available for accounts where controller.requirement_collection is stripe.
    first_name string
    The person's first name. Also available for accounts where controller.requirement_collection is stripe.
    first_name_kana string
    The Kana variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    first_name_kanji string
    The Kanji variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    full_name_aliases list(string)
    A list of alternate names or aliases that the person is known by. Also available for accounts where controller.requirement_collection is stripe.
    future_requirements object
    Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.
    gender string
    The person's gender.
    id_number string
    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.
    id_number_provided bool
    Whether the person's id_number was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by ssn_last_4_provided).
    id_number_secondary string
    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.
    id_number_secondary_provided bool
    Whether the person's id_number_secondary was provided.
    last_name string
    The person's last name. Also available for accounts where controller.requirement_collection is stripe.
    last_name_kana string
    The Kana variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    last_name_kanji string
    The Kanji variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    maiden_name string
    The person's maiden name.
    metadata map(string)
    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.
    nationality string
    The country where the person is a national.
    object string
    String representing the object's type. Objects of the same type share the same value.
    person_token string
    A person token, used to securely provide details to the person.
    phone string
    The person's phone number.
    political_exposure string
    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 object
    relationship object
    requirements object
    Information about the requirements for this person, including what information needs to be collected, and by when.
    ssn_last4 string
    The last four digits of the person's Social Security number (U.S. only).
    ssn_last4_provided bool
    Whether the last four digits of the person's Social Security number have been provided (U.S. only).
    us_cfpb_data object
    Demographic data related to the person.
    verification object
    account String
    The account the person is associated with.
    additionalTosAcceptances PersonAdditionalTosAcceptances
    address PersonAddress
    addressKana PersonAddressKana
    The Kana variation of the person's address (Japan only).
    addressKanji PersonAddressKanji
    The Kanji variation of the person's address (Japan only).
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    dob PersonDob
    documents PersonDocuments
    Documents that may be submitted to satisfy various informational requests.
    email String
    The person's email address. Also available for accounts where controller.requirement_collection is stripe.
    firstName String
    The person's first name. Also available for accounts where controller.requirement_collection is stripe.
    firstNameKana String
    The Kana variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    firstNameKanji String
    The Kanji variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    fullNameAliases List<String>
    A list of alternate names or aliases that the person is known by. Also available for accounts where controller.requirement_collection is stripe.
    futureRequirements PersonFutureRequirements
    Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.
    gender String
    The person's gender.
    idNumber String
    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.
    idNumberProvided Boolean
    Whether the person's id_number was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by ssn_last_4_provided).
    idNumberSecondary String
    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.
    idNumberSecondaryProvided Boolean
    Whether the person's id_number_secondary was provided.
    lastName String
    The person's last name. Also available for accounts where controller.requirement_collection is stripe.
    lastNameKana String
    The Kana variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    lastNameKanji String
    The Kanji variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    maidenName String
    The person's maiden name.
    metadata Map<String,String>
    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.
    nationality String
    The country where the person is a national.
    object String
    String representing the object's type. Objects of the same type share the same value.
    personToken String
    A person token, used to securely provide details to the person.
    phone String
    The person's phone number.
    politicalExposure String
    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.
    registeredAddress PersonRegisteredAddress
    relationship PersonRelationship
    requirements PersonRequirements
    Information about the requirements for this person, including what information needs to be collected, and by when.
    ssnLast4 String
    The last four digits of the person's Social Security number (U.S. only).
    ssnLast4Provided Boolean
    Whether the last four digits of the person's Social Security number have been provided (U.S. only).
    usCfpbData PersonUsCfpbData
    Demographic data related to the person.
    verification PersonVerification
    account string
    The account the person is associated with.
    additionalTosAcceptances PersonAdditionalTosAcceptances
    address PersonAddress
    addressKana PersonAddressKana
    The Kana variation of the person's address (Japan only).
    addressKanji PersonAddressKanji
    The Kanji variation of the person's address (Japan only).
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    dob PersonDob
    documents PersonDocuments
    Documents that may be submitted to satisfy various informational requests.
    email string
    The person's email address. Also available for accounts where controller.requirement_collection is stripe.
    firstName string
    The person's first name. Also available for accounts where controller.requirement_collection is stripe.
    firstNameKana string
    The Kana variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    firstNameKanji string
    The Kanji variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    fullNameAliases string[]
    A list of alternate names or aliases that the person is known by. Also available for accounts where controller.requirement_collection is stripe.
    futureRequirements PersonFutureRequirements
    Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.
    gender string
    The person's gender.
    idNumber string
    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.
    idNumberProvided boolean
    Whether the person's id_number was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by ssn_last_4_provided).
    idNumberSecondary string
    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.
    idNumberSecondaryProvided boolean
    Whether the person's id_number_secondary was provided.
    lastName string
    The person's last name. Also available for accounts where controller.requirement_collection is stripe.
    lastNameKana string
    The Kana variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    lastNameKanji string
    The Kanji variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    maidenName string
    The person's maiden name.
    metadata {[key: string]: string}
    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.
    nationality string
    The country where the person is a national.
    object string
    String representing the object's type. Objects of the same type share the same value.
    personToken string
    A person token, used to securely provide details to the person.
    phone string
    The person's phone number.
    politicalExposure string
    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.
    registeredAddress PersonRegisteredAddress
    relationship PersonRelationship
    requirements PersonRequirements
    Information about the requirements for this person, including what information needs to be collected, and by when.
    ssnLast4 string
    The last four digits of the person's Social Security number (U.S. only).
    ssnLast4Provided boolean
    Whether the last four digits of the person's Social Security number have been provided (U.S. only).
    usCfpbData PersonUsCfpbData
    Demographic data related to the person.
    verification PersonVerification
    account str
    The account the person is associated with.
    additional_tos_acceptances PersonAdditionalTosAcceptancesArgs
    address PersonAddressArgs
    address_kana PersonAddressKanaArgs
    The Kana variation of the person's address (Japan only).
    address_kanji PersonAddressKanjiArgs
    The Kanji variation of the person's address (Japan only).
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    dob PersonDobArgs
    documents PersonDocumentsArgs
    Documents that may be submitted to satisfy various informational requests.
    email str
    The person's email address. Also available for accounts where controller.requirement_collection is stripe.
    first_name str
    The person's first name. Also available for accounts where controller.requirement_collection is stripe.
    first_name_kana str
    The Kana variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    first_name_kanji str
    The Kanji variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    full_name_aliases Sequence[str]
    A list of alternate names or aliases that the person is known by. Also available for accounts where controller.requirement_collection is stripe.
    future_requirements PersonFutureRequirementsArgs
    Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.
    gender str
    The person's gender.
    id_number 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.
    id_number_provided bool
    Whether the person's id_number was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by ssn_last_4_provided).
    id_number_secondary 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.
    id_number_secondary_provided bool
    Whether the person's id_number_secondary was provided.
    last_name str
    The person's last name. Also available for accounts where controller.requirement_collection is stripe.
    last_name_kana str
    The Kana variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    last_name_kanji str
    The Kanji variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    maiden_name str
    The person's maiden name.
    metadata Mapping[str, str]
    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.
    nationality str
    The country where the person is a national.
    object str
    String representing the object's type. Objects of the same type share the same value.
    person_token str
    A person token, used to securely provide details to the person.
    phone str
    The person's phone number.
    political_exposure str
    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 PersonRegisteredAddressArgs
    relationship PersonRelationshipArgs
    requirements PersonRequirementsArgs
    Information about the requirements for this person, including what information needs to be collected, and by when.
    ssn_last4 str
    The last four digits of the person's Social Security number (U.S. only).
    ssn_last4_provided bool
    Whether the last four digits of the person's Social Security number have been provided (U.S. only).
    us_cfpb_data PersonUsCfpbDataArgs
    Demographic data related to the person.
    verification PersonVerificationArgs
    account String
    The account the person is associated with.
    additionalTosAcceptances Property Map
    address Property Map
    addressKana Property Map
    The Kana variation of the person's address (Japan only).
    addressKanji Property Map
    The Kanji variation of the person's address (Japan only).
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    dob Property Map
    documents Property Map
    Documents that may be submitted to satisfy various informational requests.
    email String
    The person's email address. Also available for accounts where controller.requirement_collection is stripe.
    firstName String
    The person's first name. Also available for accounts where controller.requirement_collection is stripe.
    firstNameKana String
    The Kana variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    firstNameKanji String
    The Kanji variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    fullNameAliases List<String>
    A list of alternate names or aliases that the person is known by. Also available for accounts where controller.requirement_collection is stripe.
    futureRequirements Property Map
    Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.
    gender String
    The person's gender.
    idNumber String
    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.
    idNumberProvided Boolean
    Whether the person's id_number was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by ssn_last_4_provided).
    idNumberSecondary String
    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.
    idNumberSecondaryProvided Boolean
    Whether the person's id_number_secondary was provided.
    lastName String
    The person's last name. Also available for accounts where controller.requirement_collection is stripe.
    lastNameKana String
    The Kana variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    lastNameKanji String
    The Kanji variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.
    maidenName String
    The person's maiden name.
    metadata Map<String>
    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.
    nationality String
    The country where the person is a national.
    object String
    String representing the object's type. Objects of the same type share the same value.
    personToken String
    A person token, used to securely provide details to the person.
    phone String
    The person's phone number.
    politicalExposure String
    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.
    registeredAddress Property Map
    relationship Property Map
    requirements Property Map
    Information about the requirements for this person, including what information needs to be collected, and by when.
    ssnLast4 String
    The last four digits of the person's Social Security number (U.S. only).
    ssnLast4Provided Boolean
    Whether the last four digits of the person's Social Security number have been provided (U.S. only).
    usCfpbData Property Map
    Demographic data related to the person.
    verification Property Map

    Supporting Types

    PersonAdditionalTosAcceptances, PersonAdditionalTosAcceptancesArgs

    Account PersonAdditionalTosAcceptancesAccount
    Details on the legal guardian's acceptance of the main Stripe service agreement.
    Account PersonAdditionalTosAcceptancesAccount
    Details on the legal guardian's acceptance of the main Stripe service agreement.
    account object
    Details on the legal guardian's acceptance of the main Stripe service agreement.
    account PersonAdditionalTosAcceptancesAccount
    Details on the legal guardian's acceptance of the main Stripe service agreement.
    account PersonAdditionalTosAcceptancesAccount
    Details on the legal guardian's acceptance of the main Stripe service agreement.
    account PersonAdditionalTosAcceptancesAccount
    Details on the legal guardian's acceptance of the main Stripe service agreement.
    account Property Map
    Details on the legal guardian's acceptance of the main Stripe service agreement.

    PersonAdditionalTosAcceptancesAccount, PersonAdditionalTosAcceptancesAccountArgs

    Date double
    The Unix timestamp marking when the legal guardian accepted the service agreement.
    Ip string
    The IP address from which the legal guardian accepted the service agreement.
    UserAgent string
    The user agent of the browser from which the legal guardian accepted the service agreement.
    Date float64
    The Unix timestamp marking when the legal guardian accepted the service agreement.
    Ip string
    The IP address from which the legal guardian accepted the service agreement.
    UserAgent string
    The user agent of the browser from which the legal guardian accepted the service agreement.
    date number
    The Unix timestamp marking when the legal guardian accepted the service agreement.
    ip string
    The IP address from which the legal guardian accepted the service agreement.
    user_agent string
    The user agent of the browser from which the legal guardian accepted the service agreement.
    date Double
    The Unix timestamp marking when the legal guardian accepted the service agreement.
    ip String
    The IP address from which the legal guardian accepted the service agreement.
    userAgent String
    The user agent of the browser from which the legal guardian accepted the service agreement.
    date number
    The Unix timestamp marking when the legal guardian accepted the service agreement.
    ip string
    The IP address from which the legal guardian accepted the service agreement.
    userAgent string
    The user agent of the browser from which the legal guardian accepted the service agreement.
    date float
    The Unix timestamp marking when the legal guardian accepted the service agreement.
    ip str
    The IP address from which the legal guardian accepted the service agreement.
    user_agent str
    The user agent of the browser from which the legal guardian accepted the service agreement.
    date Number
    The Unix timestamp marking when the legal guardian accepted the service agreement.
    ip String
    The IP address from which the legal guardian accepted the service agreement.
    userAgent String
    The user agent of the browser from which the legal guardian accepted the service agreement.

    PersonAddress, PersonAddressArgs

    City string
    City, district, suburb, town, or village.
    Country string
    Two-letter country code (ISO 3166-1 alpha-2).
    Line1 string
    Address line 1, such as the street, PO Box, or company name.
    Line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    PostalCode string
    ZIP or postal code.
    State string
    State, county, province, or region (ISO 3166-2).
    City string
    City, district, suburb, town, or village.
    Country string
    Two-letter country code (ISO 3166-1 alpha-2).
    Line1 string
    Address line 1, such as the street, PO Box, or company name.
    Line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    PostalCode string
    ZIP or postal code.
    State string
    State, county, province, or region (ISO 3166-2).
    city string
    City, district, suburb, town, or village.
    country string
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 string
    Address line 1, such as the street, PO Box, or company name.
    line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    postal_code string
    ZIP or postal code.
    state string
    State, county, province, or region (ISO 3166-2).
    city String
    City, district, suburb, town, or village.
    country String
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 String
    Address line 1, such as the street, PO Box, or company name.
    line2 String
    Address line 2, such as the apartment, suite, unit, or building.
    postalCode String
    ZIP or postal code.
    state String
    State, county, province, or region (ISO 3166-2).
    city string
    City, district, suburb, town, or village.
    country string
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 string
    Address line 1, such as the street, PO Box, or company name.
    line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    postalCode string
    ZIP or postal code.
    state string
    State, county, province, or region (ISO 3166-2).
    city str
    City, district, suburb, town, or village.
    country str
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 str
    Address line 1, such as the street, PO Box, or company name.
    line2 str
    Address line 2, such as the apartment, suite, unit, or building.
    postal_code str
    ZIP or postal code.
    state str
    State, county, province, or region (ISO 3166-2).
    city String
    City, district, suburb, town, or village.
    country String
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 String
    Address line 1, such as the street, PO Box, or company name.
    line2 String
    Address line 2, such as the apartment, suite, unit, or building.
    postalCode String
    ZIP or postal code.
    state String
    State, county, province, or region (ISO 3166-2).

    PersonAddressKana, PersonAddressKanaArgs

    City string
    City/Ward.
    Country string
    Two-letter country code (ISO 3166-1 alpha-2).
    Line1 string
    Block/Building number.
    Line2 string
    Building details.
    PostalCode string
    ZIP or postal code.
    State string
    Prefecture.
    Town string
    Town/cho-me.
    City string
    City/Ward.
    Country string
    Two-letter country code (ISO 3166-1 alpha-2).
    Line1 string
    Block/Building number.
    Line2 string
    Building details.
    PostalCode string
    ZIP or postal code.
    State string
    Prefecture.
    Town string
    Town/cho-me.
    city string
    City/Ward.
    country string
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 string
    Block/Building number.
    line2 string
    Building details.
    postal_code string
    ZIP or postal code.
    state string
    Prefecture.
    town string
    Town/cho-me.
    city String
    City/Ward.
    country String
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 String
    Block/Building number.
    line2 String
    Building details.
    postalCode String
    ZIP or postal code.
    state String
    Prefecture.
    town String
    Town/cho-me.
    city string
    City/Ward.
    country string
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 string
    Block/Building number.
    line2 string
    Building details.
    postalCode string
    ZIP or postal code.
    state string
    Prefecture.
    town string
    Town/cho-me.
    city str
    City/Ward.
    country str
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 str
    Block/Building number.
    line2 str
    Building details.
    postal_code str
    ZIP or postal code.
    state str
    Prefecture.
    town str
    Town/cho-me.
    city String
    City/Ward.
    country String
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 String
    Block/Building number.
    line2 String
    Building details.
    postalCode String
    ZIP or postal code.
    state String
    Prefecture.
    town String
    Town/cho-me.

    PersonAddressKanji, PersonAddressKanjiArgs

    City string
    City/Ward.
    Country string
    Two-letter country code (ISO 3166-1 alpha-2).
    Line1 string
    Block/Building number.
    Line2 string
    Building details.
    PostalCode string
    ZIP or postal code.
    State string
    Prefecture.
    Town string
    Town/cho-me.
    City string
    City/Ward.
    Country string
    Two-letter country code (ISO 3166-1 alpha-2).
    Line1 string
    Block/Building number.
    Line2 string
    Building details.
    PostalCode string
    ZIP or postal code.
    State string
    Prefecture.
    Town string
    Town/cho-me.
    city string
    City/Ward.
    country string
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 string
    Block/Building number.
    line2 string
    Building details.
    postal_code string
    ZIP or postal code.
    state string
    Prefecture.
    town string
    Town/cho-me.
    city String
    City/Ward.
    country String
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 String
    Block/Building number.
    line2 String
    Building details.
    postalCode String
    ZIP or postal code.
    state String
    Prefecture.
    town String
    Town/cho-me.
    city string
    City/Ward.
    country string
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 string
    Block/Building number.
    line2 string
    Building details.
    postalCode string
    ZIP or postal code.
    state string
    Prefecture.
    town string
    Town/cho-me.
    city str
    City/Ward.
    country str
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 str
    Block/Building number.
    line2 str
    Building details.
    postal_code str
    ZIP or postal code.
    state str
    Prefecture.
    town str
    Town/cho-me.
    city String
    City/Ward.
    country String
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 String
    Block/Building number.
    line2 String
    Building details.
    postalCode String
    ZIP or postal code.
    state String
    Prefecture.
    town String
    Town/cho-me.

    PersonDob, PersonDobArgs

    Day double
    The day of birth, between 1 and 31.
    Month double
    The month of birth, between 1 and 12.
    Year double
    The four-digit year of birth.
    Day float64
    The day of birth, between 1 and 31.
    Month float64
    The month of birth, between 1 and 12.
    Year float64
    The four-digit year of birth.
    day number
    The day of birth, between 1 and 31.
    month number
    The month of birth, between 1 and 12.
    year number
    The four-digit year of birth.
    day Double
    The day of birth, between 1 and 31.
    month Double
    The month of birth, between 1 and 12.
    year Double
    The four-digit year of birth.
    day number
    The day of birth, between 1 and 31.
    month number
    The month of birth, between 1 and 12.
    year number
    The four-digit year of birth.
    day float
    The day of birth, between 1 and 31.
    month float
    The month of birth, between 1 and 12.
    year float
    The four-digit year of birth.
    day Number
    The day of birth, between 1 and 31.
    month Number
    The month of birth, between 1 and 12.
    year Number
    The four-digit year of birth.

    PersonDocuments, PersonDocumentsArgs

    CompanyAuthorization PersonDocumentsCompanyAuthorization
    One or more documents that demonstrate proof that this person is authorized to represent the company.
    Passport PersonDocumentsPassport
    One or more documents showing the person's passport page with photo and personal data.
    Visa PersonDocumentsVisa
    One or more documents showing the person's visa required for living in the country where they are residing.
    CompanyAuthorization PersonDocumentsCompanyAuthorization
    One or more documents that demonstrate proof that this person is authorized to represent the company.
    Passport PersonDocumentsPassport
    One or more documents showing the person's passport page with photo and personal data.
    Visa PersonDocumentsVisa
    One or more documents showing the person's visa required for living in the country where they are residing.
    company_authorization object
    One or more documents that demonstrate proof that this person is authorized to represent the company.
    passport object
    One or more documents showing the person's passport page with photo and personal data.
    visa object
    One or more documents showing the person's visa required for living in the country where they are residing.
    companyAuthorization PersonDocumentsCompanyAuthorization
    One or more documents that demonstrate proof that this person is authorized to represent the company.
    passport PersonDocumentsPassport
    One or more documents showing the person's passport page with photo and personal data.
    visa PersonDocumentsVisa
    One or more documents showing the person's visa required for living in the country where they are residing.
    companyAuthorization PersonDocumentsCompanyAuthorization
    One or more documents that demonstrate proof that this person is authorized to represent the company.
    passport PersonDocumentsPassport
    One or more documents showing the person's passport page with photo and personal data.
    visa PersonDocumentsVisa
    One or more documents showing the person's visa required for living in the country where they are residing.
    company_authorization PersonDocumentsCompanyAuthorization
    One or more documents that demonstrate proof that this person is authorized to represent the company.
    passport PersonDocumentsPassport
    One or more documents showing the person's passport page with photo and personal data.
    visa PersonDocumentsVisa
    One or more documents showing the person's visa required for living in the country where they are residing.
    companyAuthorization Property Map
    One or more documents that demonstrate proof that this person is authorized to represent the company.
    passport Property Map
    One or more documents showing the person's passport page with photo and personal data.
    visa Property Map
    One or more documents showing the person's visa required for living in the country where they are residing.

    PersonDocumentsCompanyAuthorization, PersonDocumentsCompanyAuthorizationArgs

    Files List<string>
    One or more document ids returned by a file upload with a purpose value of account_requirement.
    Files []string
    One or more document ids returned by a file upload with a purpose value of account_requirement.
    files list(string)
    One or more document ids returned by a file upload with a purpose value of account_requirement.
    files List<String>
    One or more document ids returned by a file upload with a purpose value of account_requirement.
    files string[]
    One or more document ids returned by a file upload with a purpose value of account_requirement.
    files Sequence[str]
    One or more document ids returned by a file upload with a purpose value of account_requirement.
    files List<String>
    One or more document ids returned by a file upload with a purpose value of account_requirement.

    PersonDocumentsPassport, PersonDocumentsPassportArgs

    Files List<string>
    One or more document ids returned by a file upload with a purpose value of account_requirement.
    Files []string
    One or more document ids returned by a file upload with a purpose value of account_requirement.
    files list(string)
    One or more document ids returned by a file upload with a purpose value of account_requirement.
    files List<String>
    One or more document ids returned by a file upload with a purpose value of account_requirement.
    files string[]
    One or more document ids returned by a file upload with a purpose value of account_requirement.
    files Sequence[str]
    One or more document ids returned by a file upload with a purpose value of account_requirement.
    files List<String>
    One or more document ids returned by a file upload with a purpose value of account_requirement.

    PersonDocumentsVisa, PersonDocumentsVisaArgs

    Files List<string>
    One or more document ids returned by a file upload with a purpose value of account_requirement.
    Files []string
    One or more document ids returned by a file upload with a purpose value of account_requirement.
    files list(string)
    One or more document ids returned by a file upload with a purpose value of account_requirement.
    files List<String>
    One or more document ids returned by a file upload with a purpose value of account_requirement.
    files string[]
    One or more document ids returned by a file upload with a purpose value of account_requirement.
    files Sequence[str]
    One or more document ids returned by a file upload with a purpose value of account_requirement.
    files List<String>
    One or more document ids returned by a file upload with a purpose value of account_requirement.

    PersonFutureRequirements, PersonFutureRequirementsArgs

    Alternatives List<PersonFutureRequirementsAlternative>
    Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same original_fields_due, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing original_fields_due also serves as a pathway for attempting to resolve the fields again.
    CurrentlyDues List<string>
    Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's future_requirements[current_deadline], these fields will transition to the main requirements hash, and may immediately become past_due, but the account may also be given a grace period depending on the account's enablement state prior to transition.
    Errors List<PersonFutureRequirementsError>
    Details about validation and verification failures for due requirements that must be resolved.
    EventuallyDues List<string>
    Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well, and the account's future_requirements[current_deadline] becomes set.
    PastDues List<string>
    Fields that haven't been resolved by the account's requirements.current_deadline. These fields need to be resolved to enable the person's account. future_requirements.past_due is a subset of requirements.past_due.
    PendingVerifications List<string>
    Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to eventually_due, currently_due, past_due or alternatives. Fields might appear in eventually_due, currently_due, past_due or alternatives and in pending_verification if one verification fails but another is still pending.
    Alternatives []PersonFutureRequirementsAlternative
    Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same original_fields_due, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing original_fields_due also serves as a pathway for attempting to resolve the fields again.
    CurrentlyDues []string
    Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's future_requirements[current_deadline], these fields will transition to the main requirements hash, and may immediately become past_due, but the account may also be given a grace period depending on the account's enablement state prior to transition.
    Errors []PersonFutureRequirementsError
    Details about validation and verification failures for due requirements that must be resolved.
    EventuallyDues []string
    Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well, and the account's future_requirements[current_deadline] becomes set.
    PastDues []string
    Fields that haven't been resolved by the account's requirements.current_deadline. These fields need to be resolved to enable the person's account. future_requirements.past_due is a subset of requirements.past_due.
    PendingVerifications []string
    Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to eventually_due, currently_due, past_due or alternatives. Fields might appear in eventually_due, currently_due, past_due or alternatives and in pending_verification if one verification fails but another is still pending.
    alternatives list(object)
    Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same original_fields_due, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing original_fields_due also serves as a pathway for attempting to resolve the fields again.
    currently_dues list(string)
    Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's future_requirements[current_deadline], these fields will transition to the main requirements hash, and may immediately become past_due, but the account may also be given a grace period depending on the account's enablement state prior to transition.
    errors list(object)
    Details about validation and verification failures for due requirements that must be resolved.
    eventually_dues list(string)
    Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well, and the account's future_requirements[current_deadline] becomes set.
    past_dues list(string)
    Fields that haven't been resolved by the account's requirements.current_deadline. These fields need to be resolved to enable the person's account. future_requirements.past_due is a subset of requirements.past_due.
    pending_verifications list(string)
    Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to eventually_due, currently_due, past_due or alternatives. Fields might appear in eventually_due, currently_due, past_due or alternatives and in pending_verification if one verification fails but another is still pending.
    alternatives List<PersonFutureRequirementsAlternative>
    Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same original_fields_due, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing original_fields_due also serves as a pathway for attempting to resolve the fields again.
    currentlyDues List<String>
    Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's future_requirements[current_deadline], these fields will transition to the main requirements hash, and may immediately become past_due, but the account may also be given a grace period depending on the account's enablement state prior to transition.
    errors List<PersonFutureRequirementsError>
    Details about validation and verification failures for due requirements that must be resolved.
    eventuallyDues List<String>
    Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well, and the account's future_requirements[current_deadline] becomes set.
    pastDues List<String>
    Fields that haven't been resolved by the account's requirements.current_deadline. These fields need to be resolved to enable the person's account. future_requirements.past_due is a subset of requirements.past_due.
    pendingVerifications List<String>
    Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to eventually_due, currently_due, past_due or alternatives. Fields might appear in eventually_due, currently_due, past_due or alternatives and in pending_verification if one verification fails but another is still pending.
    alternatives PersonFutureRequirementsAlternative[]
    Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same original_fields_due, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing original_fields_due also serves as a pathway for attempting to resolve the fields again.
    currentlyDues string[]
    Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's future_requirements[current_deadline], these fields will transition to the main requirements hash, and may immediately become past_due, but the account may also be given a grace period depending on the account's enablement state prior to transition.
    errors PersonFutureRequirementsError[]
    Details about validation and verification failures for due requirements that must be resolved.
    eventuallyDues string[]
    Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well, and the account's future_requirements[current_deadline] becomes set.
    pastDues string[]
    Fields that haven't been resolved by the account's requirements.current_deadline. These fields need to be resolved to enable the person's account. future_requirements.past_due is a subset of requirements.past_due.
    pendingVerifications string[]
    Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to eventually_due, currently_due, past_due or alternatives. Fields might appear in eventually_due, currently_due, past_due or alternatives and in pending_verification if one verification fails but another is still pending.
    alternatives Sequence[PersonFutureRequirementsAlternative]
    Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same original_fields_due, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing original_fields_due also serves as a pathway for attempting to resolve the fields again.
    currently_dues Sequence[str]
    Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's future_requirements[current_deadline], these fields will transition to the main requirements hash, and may immediately become past_due, but the account may also be given a grace period depending on the account's enablement state prior to transition.
    errors Sequence[PersonFutureRequirementsError]
    Details about validation and verification failures for due requirements that must be resolved.
    eventually_dues Sequence[str]
    Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well, and the account's future_requirements[current_deadline] becomes set.
    past_dues Sequence[str]
    Fields that haven't been resolved by the account's requirements.current_deadline. These fields need to be resolved to enable the person's account. future_requirements.past_due is a subset of requirements.past_due.
    pending_verifications Sequence[str]
    Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to eventually_due, currently_due, past_due or alternatives. Fields might appear in eventually_due, currently_due, past_due or alternatives and in pending_verification if one verification fails but another is still pending.
    alternatives List<Property Map>
    Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same original_fields_due, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing original_fields_due also serves as a pathway for attempting to resolve the fields again.
    currentlyDues List<String>
    Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's future_requirements[current_deadline], these fields will transition to the main requirements hash, and may immediately become past_due, but the account may also be given a grace period depending on the account's enablement state prior to transition.
    errors List<Property Map>
    Details about validation and verification failures for due requirements that must be resolved.
    eventuallyDues List<String>
    Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well, and the account's future_requirements[current_deadline] becomes set.
    pastDues List<String>
    Fields that haven't been resolved by the account's requirements.current_deadline. These fields need to be resolved to enable the person's account. future_requirements.past_due is a subset of requirements.past_due.
    pendingVerifications List<String>
    Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to eventually_due, currently_due, past_due or alternatives. Fields might appear in eventually_due, currently_due, past_due or alternatives and in pending_verification if one verification fails but another is still pending.

    PersonFutureRequirementsAlternative, PersonFutureRequirementsAlternativeArgs

    AlternativeFieldsDues List<string>
    Fields that can be provided to resolve all fields in original_fields_due.
    OriginalFieldsDues List<string>
    Fields that are due and can be resolved by providing all fields in alternative_fields_due.
    AlternativeFieldsDues []string
    Fields that can be provided to resolve all fields in original_fields_due.
    OriginalFieldsDues []string
    Fields that are due and can be resolved by providing all fields in alternative_fields_due.
    alternative_fields_dues list(string)
    Fields that can be provided to resolve all fields in original_fields_due.
    original_fields_dues list(string)
    Fields that are due and can be resolved by providing all fields in alternative_fields_due.
    alternativeFieldsDues List<String>
    Fields that can be provided to resolve all fields in original_fields_due.
    originalFieldsDues List<String>
    Fields that are due and can be resolved by providing all fields in alternative_fields_due.
    alternativeFieldsDues string[]
    Fields that can be provided to resolve all fields in original_fields_due.
    originalFieldsDues string[]
    Fields that are due and can be resolved by providing all fields in alternative_fields_due.
    alternative_fields_dues Sequence[str]
    Fields that can be provided to resolve all fields in original_fields_due.
    original_fields_dues Sequence[str]
    Fields that are due and can be resolved by providing all fields in alternative_fields_due.
    alternativeFieldsDues List<String>
    Fields that can be provided to resolve all fields in original_fields_due.
    originalFieldsDues List<String>
    Fields that are due and can be resolved by providing all fields in alternative_fields_due.

    PersonFutureRequirementsError, PersonFutureRequirementsErrorArgs

    Code string
    The code for the type of error.
    Reason string
    An informative message that indicates the error type and provides additional details about the error.
    Requirement string
    The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
    Code string
    The code for the type of error.
    Reason string
    An informative message that indicates the error type and provides additional details about the error.
    Requirement string
    The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
    code string
    The code for the type of error.
    reason string
    An informative message that indicates the error type and provides additional details about the error.
    requirement string
    The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
    code String
    The code for the type of error.
    reason String
    An informative message that indicates the error type and provides additional details about the error.
    requirement String
    The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
    code string
    The code for the type of error.
    reason string
    An informative message that indicates the error type and provides additional details about the error.
    requirement string
    The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
    code str
    The code for the type of error.
    reason str
    An informative message that indicates the error type and provides additional details about the error.
    requirement str
    The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
    code String
    The code for the type of error.
    reason String
    An informative message that indicates the error type and provides additional details about the error.
    requirement String
    The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.

    PersonRegisteredAddress, PersonRegisteredAddressArgs

    City string
    City, district, suburb, town, or village.
    Country string
    Two-letter country code (ISO 3166-1 alpha-2).
    Line1 string
    Address line 1, such as the street, PO Box, or company name.
    Line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    PostalCode string
    ZIP or postal code.
    State string
    State, county, province, or region (ISO 3166-2).
    City string
    City, district, suburb, town, or village.
    Country string
    Two-letter country code (ISO 3166-1 alpha-2).
    Line1 string
    Address line 1, such as the street, PO Box, or company name.
    Line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    PostalCode string
    ZIP or postal code.
    State string
    State, county, province, or region (ISO 3166-2).
    city string
    City, district, suburb, town, or village.
    country string
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 string
    Address line 1, such as the street, PO Box, or company name.
    line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    postal_code string
    ZIP or postal code.
    state string
    State, county, province, or region (ISO 3166-2).
    city String
    City, district, suburb, town, or village.
    country String
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 String
    Address line 1, such as the street, PO Box, or company name.
    line2 String
    Address line 2, such as the apartment, suite, unit, or building.
    postalCode String
    ZIP or postal code.
    state String
    State, county, province, or region (ISO 3166-2).
    city string
    City, district, suburb, town, or village.
    country string
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 string
    Address line 1, such as the street, PO Box, or company name.
    line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    postalCode string
    ZIP or postal code.
    state string
    State, county, province, or region (ISO 3166-2).
    city str
    City, district, suburb, town, or village.
    country str
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 str
    Address line 1, such as the street, PO Box, or company name.
    line2 str
    Address line 2, such as the apartment, suite, unit, or building.
    postal_code str
    ZIP or postal code.
    state str
    State, county, province, or region (ISO 3166-2).
    city String
    City, district, suburb, town, or village.
    country String
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 String
    Address line 1, such as the street, PO Box, or company name.
    line2 String
    Address line 2, such as the apartment, suite, unit, or building.
    postalCode String
    ZIP or postal code.
    state String
    State, county, province, or region (ISO 3166-2).

    PersonRelationship, PersonRelationshipArgs

    Authorizer bool
    Whether the person is the authorizer of the account's representative.
    Director 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 bool
    Whether the person has significant responsibility to control, manage, or direct the organization.
    LegalGuardian bool
    Whether the person is the legal guardian of the account's representative.
    Owner bool
    Whether the person is an owner of the account’s legal entity.
    PercentOwnership double
    The percent owned by the person of the account's legal entity.
    Representative 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 string
    The person's title (e.g., CEO, Support Engineer).
    Authorizer bool
    Whether the person is the authorizer of the account's representative.
    Director 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 bool
    Whether the person has significant responsibility to control, manage, or direct the organization.
    LegalGuardian bool
    Whether the person is the legal guardian of the account's representative.
    Owner bool
    Whether the person is an owner of the account’s legal entity.
    PercentOwnership float64
    The percent owned by the person of the account's legal entity.
    Representative 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 string
    The person's title (e.g., CEO, Support Engineer).
    authorizer bool
    Whether the person is the authorizer of the account's representative.
    director 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 bool
    Whether the person has significant responsibility to control, manage, or direct the organization.
    legal_guardian bool
    Whether the person is the legal guardian of the account's representative.
    owner bool
    Whether the person is an owner of the account’s legal entity.
    percent_ownership number
    The percent owned by the person of the account's legal entity.
    representative 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 string
    The person's title (e.g., CEO, Support Engineer).
    authorizer Boolean
    Whether the person is the authorizer of the account's representative.
    director Boolean
    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 Boolean
    Whether the person has significant responsibility to control, manage, or direct the organization.
    legalGuardian Boolean
    Whether the person is the legal guardian of the account's representative.
    owner Boolean
    Whether the person is an owner of the account’s legal entity.
    percentOwnership Double
    The percent owned by the person of the account's legal entity.
    representative Boolean
    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 String
    The person's title (e.g., CEO, Support Engineer).
    authorizer boolean
    Whether the person is the authorizer of the account's representative.
    director boolean
    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 boolean
    Whether the person has significant responsibility to control, manage, or direct the organization.
    legalGuardian boolean
    Whether the person is the legal guardian of the account's representative.
    owner boolean
    Whether the person is an owner of the account’s legal entity.
    percentOwnership number
    The percent owned by the person of the account's legal entity.
    representative boolean
    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 string
    The person's title (e.g., CEO, Support Engineer).
    authorizer bool
    Whether the person is the authorizer of the account's representative.
    director 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 bool
    Whether the person has significant responsibility to control, manage, or direct the organization.
    legal_guardian bool
    Whether the person is the legal guardian of the account's representative.
    owner bool
    Whether the person is an owner of the account’s legal entity.
    percent_ownership float
    The percent owned by the person of the account's legal entity.
    representative 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 str
    The person's title (e.g., CEO, Support Engineer).
    authorizer Boolean
    Whether the person is the authorizer of the account's representative.
    director Boolean
    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 Boolean
    Whether the person has significant responsibility to control, manage, or direct the organization.
    legalGuardian Boolean
    Whether the person is the legal guardian of the account's representative.
    owner Boolean
    Whether the person is an owner of the account’s legal entity.
    percentOwnership Number
    The percent owned by the person of the account's legal entity.
    representative Boolean
    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 String
    The person's title (e.g., CEO, Support Engineer).

    PersonRequirements, PersonRequirementsArgs

    Alternatives List<PersonRequirementsAlternative>
    Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same original_fields_due, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing original_fields_due also serves as a pathway for attempting to resolve the fields again.
    CurrentlyDues List<string>
    Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's current_deadline, these fields will appear in past_due as well, and the account is disabled.
    Errors List<PersonRequirementsError>
    Details about validation and verification failures for due requirements that must be resolved.
    EventuallyDues List<string>
    Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well, and the account's current_deadline becomes set.
    PastDues List<string>
    Fields that haven't been resolved by current_deadline. These fields need to be resolved to enable the person's account.
    PendingVerifications List<string>
    Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to eventually_due, currently_due, past_due or alternatives. Fields might appear in eventually_due, currently_due, past_due or alternatives and in pending_verification if one verification fails but another is still pending.
    Alternatives []PersonRequirementsAlternative
    Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same original_fields_due, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing original_fields_due also serves as a pathway for attempting to resolve the fields again.
    CurrentlyDues []string
    Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's current_deadline, these fields will appear in past_due as well, and the account is disabled.
    Errors []PersonRequirementsError
    Details about validation and verification failures for due requirements that must be resolved.
    EventuallyDues []string
    Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well, and the account's current_deadline becomes set.
    PastDues []string
    Fields that haven't been resolved by current_deadline. These fields need to be resolved to enable the person's account.
    PendingVerifications []string
    Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to eventually_due, currently_due, past_due or alternatives. Fields might appear in eventually_due, currently_due, past_due or alternatives and in pending_verification if one verification fails but another is still pending.
    alternatives list(object)
    Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same original_fields_due, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing original_fields_due also serves as a pathway for attempting to resolve the fields again.
    currently_dues list(string)
    Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's current_deadline, these fields will appear in past_due as well, and the account is disabled.
    errors list(object)
    Details about validation and verification failures for due requirements that must be resolved.
    eventually_dues list(string)
    Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well, and the account's current_deadline becomes set.
    past_dues list(string)
    Fields that haven't been resolved by current_deadline. These fields need to be resolved to enable the person's account.
    pending_verifications list(string)
    Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to eventually_due, currently_due, past_due or alternatives. Fields might appear in eventually_due, currently_due, past_due or alternatives and in pending_verification if one verification fails but another is still pending.
    alternatives List<PersonRequirementsAlternative>
    Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same original_fields_due, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing original_fields_due also serves as a pathway for attempting to resolve the fields again.
    currentlyDues List<String>
    Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's current_deadline, these fields will appear in past_due as well, and the account is disabled.
    errors List<PersonRequirementsError>
    Details about validation and verification failures for due requirements that must be resolved.
    eventuallyDues List<String>
    Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well, and the account's current_deadline becomes set.
    pastDues List<String>
    Fields that haven't been resolved by current_deadline. These fields need to be resolved to enable the person's account.
    pendingVerifications List<String>
    Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to eventually_due, currently_due, past_due or alternatives. Fields might appear in eventually_due, currently_due, past_due or alternatives and in pending_verification if one verification fails but another is still pending.
    alternatives PersonRequirementsAlternative[]
    Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same original_fields_due, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing original_fields_due also serves as a pathway for attempting to resolve the fields again.
    currentlyDues string[]
    Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's current_deadline, these fields will appear in past_due as well, and the account is disabled.
    errors PersonRequirementsError[]
    Details about validation and verification failures for due requirements that must be resolved.
    eventuallyDues string[]
    Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well, and the account's current_deadline becomes set.
    pastDues string[]
    Fields that haven't been resolved by current_deadline. These fields need to be resolved to enable the person's account.
    pendingVerifications string[]
    Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to eventually_due, currently_due, past_due or alternatives. Fields might appear in eventually_due, currently_due, past_due or alternatives and in pending_verification if one verification fails but another is still pending.
    alternatives Sequence[PersonRequirementsAlternative]
    Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same original_fields_due, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing original_fields_due also serves as a pathway for attempting to resolve the fields again.
    currently_dues Sequence[str]
    Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's current_deadline, these fields will appear in past_due as well, and the account is disabled.
    errors Sequence[PersonRequirementsError]
    Details about validation and verification failures for due requirements that must be resolved.
    eventually_dues Sequence[str]
    Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well, and the account's current_deadline becomes set.
    past_dues Sequence[str]
    Fields that haven't been resolved by current_deadline. These fields need to be resolved to enable the person's account.
    pending_verifications Sequence[str]
    Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to eventually_due, currently_due, past_due or alternatives. Fields might appear in eventually_due, currently_due, past_due or alternatives and in pending_verification if one verification fails but another is still pending.
    alternatives List<Property Map>
    Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same original_fields_due, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing original_fields_due also serves as a pathway for attempting to resolve the fields again.
    currentlyDues List<String>
    Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's current_deadline, these fields will appear in past_due as well, and the account is disabled.
    errors List<Property Map>
    Details about validation and verification failures for due requirements that must be resolved.
    eventuallyDues List<String>
    Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well, and the account's current_deadline becomes set.
    pastDues List<String>
    Fields that haven't been resolved by current_deadline. These fields need to be resolved to enable the person's account.
    pendingVerifications List<String>
    Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to eventually_due, currently_due, past_due or alternatives. Fields might appear in eventually_due, currently_due, past_due or alternatives and in pending_verification if one verification fails but another is still pending.

    PersonRequirementsAlternative, PersonRequirementsAlternativeArgs

    AlternativeFieldsDues List<string>
    Fields that can be provided to resolve all fields in original_fields_due.
    OriginalFieldsDues List<string>
    Fields that are due and can be resolved by providing all fields in alternative_fields_due.
    AlternativeFieldsDues []string
    Fields that can be provided to resolve all fields in original_fields_due.
    OriginalFieldsDues []string
    Fields that are due and can be resolved by providing all fields in alternative_fields_due.
    alternative_fields_dues list(string)
    Fields that can be provided to resolve all fields in original_fields_due.
    original_fields_dues list(string)
    Fields that are due and can be resolved by providing all fields in alternative_fields_due.
    alternativeFieldsDues List<String>
    Fields that can be provided to resolve all fields in original_fields_due.
    originalFieldsDues List<String>
    Fields that are due and can be resolved by providing all fields in alternative_fields_due.
    alternativeFieldsDues string[]
    Fields that can be provided to resolve all fields in original_fields_due.
    originalFieldsDues string[]
    Fields that are due and can be resolved by providing all fields in alternative_fields_due.
    alternative_fields_dues Sequence[str]
    Fields that can be provided to resolve all fields in original_fields_due.
    original_fields_dues Sequence[str]
    Fields that are due and can be resolved by providing all fields in alternative_fields_due.
    alternativeFieldsDues List<String>
    Fields that can be provided to resolve all fields in original_fields_due.
    originalFieldsDues List<String>
    Fields that are due and can be resolved by providing all fields in alternative_fields_due.

    PersonRequirementsError, PersonRequirementsErrorArgs

    Code string
    The code for the type of error.
    Reason string
    An informative message that indicates the error type and provides additional details about the error.
    Requirement string
    The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
    Code string
    The code for the type of error.
    Reason string
    An informative message that indicates the error type and provides additional details about the error.
    Requirement string
    The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
    code string
    The code for the type of error.
    reason string
    An informative message that indicates the error type and provides additional details about the error.
    requirement string
    The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
    code String
    The code for the type of error.
    reason String
    An informative message that indicates the error type and provides additional details about the error.
    requirement String
    The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
    code string
    The code for the type of error.
    reason string
    An informative message that indicates the error type and provides additional details about the error.
    requirement string
    The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
    code str
    The code for the type of error.
    reason str
    An informative message that indicates the error type and provides additional details about the error.
    requirement str
    The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
    code String
    The code for the type of error.
    reason String
    An informative message that indicates the error type and provides additional details about the error.
    requirement String
    The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.

    PersonUsCfpbData, PersonUsCfpbDataArgs

    EthnicityDetails PersonUsCfpbDataEthnicityDetails
    The persons ethnicity details
    RaceDetails PersonUsCfpbDataRaceDetails
    The persons race details
    SelfIdentifiedGender string
    The persons self-identified gender
    EthnicityDetails PersonUsCfpbDataEthnicityDetails
    The persons ethnicity details
    RaceDetails PersonUsCfpbDataRaceDetails
    The persons race details
    SelfIdentifiedGender string
    The persons self-identified gender
    ethnicity_details object
    The persons ethnicity details
    race_details object
    The persons race details
    self_identified_gender string
    The persons self-identified gender
    ethnicityDetails PersonUsCfpbDataEthnicityDetails
    The persons ethnicity details
    raceDetails PersonUsCfpbDataRaceDetails
    The persons race details
    selfIdentifiedGender String
    The persons self-identified gender
    ethnicityDetails PersonUsCfpbDataEthnicityDetails
    The persons ethnicity details
    raceDetails PersonUsCfpbDataRaceDetails
    The persons race details
    selfIdentifiedGender string
    The persons self-identified gender
    ethnicity_details PersonUsCfpbDataEthnicityDetails
    The persons ethnicity details
    race_details PersonUsCfpbDataRaceDetails
    The persons race details
    self_identified_gender str
    The persons self-identified gender
    ethnicityDetails Property Map
    The persons ethnicity details
    raceDetails Property Map
    The persons race details
    selfIdentifiedGender String
    The persons self-identified gender

    PersonUsCfpbDataEthnicityDetails, PersonUsCfpbDataEthnicityDetailsArgs

    Ethnicities List<string>
    The persons ethnicity
    EthnicityOther string
    Please specify your origin, when other is selected.
    Ethnicities []string
    The persons ethnicity
    EthnicityOther string
    Please specify your origin, when other is selected.
    ethnicities list(string)
    The persons ethnicity
    ethnicity_other string
    Please specify your origin, when other is selected.
    ethnicities List<String>
    The persons ethnicity
    ethnicityOther String
    Please specify your origin, when other is selected.
    ethnicities string[]
    The persons ethnicity
    ethnicityOther string
    Please specify your origin, when other is selected.
    ethnicities Sequence[str]
    The persons ethnicity
    ethnicity_other str
    Please specify your origin, when other is selected.
    ethnicities List<String>
    The persons ethnicity
    ethnicityOther String
    Please specify your origin, when other is selected.

    PersonUsCfpbDataRaceDetails, PersonUsCfpbDataRaceDetailsArgs

    RaceOther string
    Please specify your race, when other is selected.
    Races List<string>
    The persons race.
    RaceOther string
    Please specify your race, when other is selected.
    Races []string
    The persons race.
    race_other string
    Please specify your race, when other is selected.
    races list(string)
    The persons race.
    raceOther String
    Please specify your race, when other is selected.
    races List<String>
    The persons race.
    raceOther string
    Please specify your race, when other is selected.
    races string[]
    The persons race.
    race_other str
    Please specify your race, when other is selected.
    races Sequence[str]
    The persons race.
    raceOther String
    Please specify your race, when other is selected.
    races List<String>
    The persons race.

    PersonVerification, PersonVerificationArgs

    AdditionalDocument PersonVerificationAdditionalDocument
    A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
    Details string
    A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified".
    DetailsCode string
    One of document_address_mismatch, document_dob_mismatch, document_duplicate_type, document_id_number_mismatch, document_name_mismatch, document_nationality_mismatch, failed_keyed_identity, or failed_other. A machine-readable code specifying the verification state for the person.
    Document PersonVerificationDocument
    Status string
    The state of verification for the person. Possible values are unverified, pending, or verified. Please refer guide to handle verification updates.
    AdditionalDocument PersonVerificationAdditionalDocument
    A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
    Details string
    A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified".
    DetailsCode string
    One of document_address_mismatch, document_dob_mismatch, document_duplicate_type, document_id_number_mismatch, document_name_mismatch, document_nationality_mismatch, failed_keyed_identity, or failed_other. A machine-readable code specifying the verification state for the person.
    Document PersonVerificationDocument
    Status string
    The state of verification for the person. Possible values are unverified, pending, or verified. Please refer guide to handle verification updates.
    additional_document object
    A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
    details string
    A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified".
    details_code string
    One of document_address_mismatch, document_dob_mismatch, document_duplicate_type, document_id_number_mismatch, document_name_mismatch, document_nationality_mismatch, failed_keyed_identity, or failed_other. A machine-readable code specifying the verification state for the person.
    document object
    status string
    The state of verification for the person. Possible values are unverified, pending, or verified. Please refer guide to handle verification updates.
    additionalDocument PersonVerificationAdditionalDocument
    A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
    details String
    A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified".
    detailsCode String
    One of document_address_mismatch, document_dob_mismatch, document_duplicate_type, document_id_number_mismatch, document_name_mismatch, document_nationality_mismatch, failed_keyed_identity, or failed_other. A machine-readable code specifying the verification state for the person.
    document PersonVerificationDocument
    status String
    The state of verification for the person. Possible values are unverified, pending, or verified. Please refer guide to handle verification updates.
    additionalDocument PersonVerificationAdditionalDocument
    A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
    details string
    A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified".
    detailsCode string
    One of document_address_mismatch, document_dob_mismatch, document_duplicate_type, document_id_number_mismatch, document_name_mismatch, document_nationality_mismatch, failed_keyed_identity, or failed_other. A machine-readable code specifying the verification state for the person.
    document PersonVerificationDocument
    status string
    The state of verification for the person. Possible values are unverified, pending, or verified. Please refer guide to handle verification updates.
    additional_document PersonVerificationAdditionalDocument
    A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
    details str
    A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified".
    details_code str
    One of document_address_mismatch, document_dob_mismatch, document_duplicate_type, document_id_number_mismatch, document_name_mismatch, document_nationality_mismatch, failed_keyed_identity, or failed_other. A machine-readable code specifying the verification state for the person.
    document PersonVerificationDocument
    status str
    The state of verification for the person. Possible values are unverified, pending, or verified. Please refer guide to handle verification updates.
    additionalDocument Property Map
    A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
    details String
    A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified".
    detailsCode String
    One of document_address_mismatch, document_dob_mismatch, document_duplicate_type, document_id_number_mismatch, document_name_mismatch, document_nationality_mismatch, failed_keyed_identity, or failed_other. A machine-readable code specifying the verification state for the person.
    document Property Map
    status String
    The state of verification for the person. Possible values are unverified, pending, or verified. Please refer guide to handle verification updates.

    PersonVerificationAdditionalDocument, PersonVerificationAdditionalDocumentArgs

    Back string
    The back of an ID returned by a file upload with a purpose value of identity_document.
    Details string
    A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".
    DetailsCode string
    One of document_corrupt, document_country_not_supported, document_expired, document_failed_copy, document_failed_other, document_failed_test_mode, document_fraudulent, document_failed_greyscale, document_incomplete, document_invalid, document_manipulated, document_missing_back, document_missing_front, document_not_readable, document_not_uploaded, document_photo_mismatch, document_too_large, or document_type_not_supported. A machine-readable code specifying the verification state for this document.
    Front string
    The front of an ID returned by a file upload with a purpose value of identity_document.
    Back string
    The back of an ID returned by a file upload with a purpose value of identity_document.
    Details string
    A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".
    DetailsCode string
    One of document_corrupt, document_country_not_supported, document_expired, document_failed_copy, document_failed_other, document_failed_test_mode, document_fraudulent, document_failed_greyscale, document_incomplete, document_invalid, document_manipulated, document_missing_back, document_missing_front, document_not_readable, document_not_uploaded, document_photo_mismatch, document_too_large, or document_type_not_supported. A machine-readable code specifying the verification state for this document.
    Front string
    The front of an ID returned by a file upload with a purpose value of identity_document.
    back string
    The back of an ID returned by a file upload with a purpose value of identity_document.
    details string
    A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".
    details_code string
    One of document_corrupt, document_country_not_supported, document_expired, document_failed_copy, document_failed_other, document_failed_test_mode, document_fraudulent, document_failed_greyscale, document_incomplete, document_invalid, document_manipulated, document_missing_back, document_missing_front, document_not_readable, document_not_uploaded, document_photo_mismatch, document_too_large, or document_type_not_supported. A machine-readable code specifying the verification state for this document.
    front string
    The front of an ID returned by a file upload with a purpose value of identity_document.
    back String
    The back of an ID returned by a file upload with a purpose value of identity_document.
    details String
    A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".
    detailsCode String
    One of document_corrupt, document_country_not_supported, document_expired, document_failed_copy, document_failed_other, document_failed_test_mode, document_fraudulent, document_failed_greyscale, document_incomplete, document_invalid, document_manipulated, document_missing_back, document_missing_front, document_not_readable, document_not_uploaded, document_photo_mismatch, document_too_large, or document_type_not_supported. A machine-readable code specifying the verification state for this document.
    front String
    The front of an ID returned by a file upload with a purpose value of identity_document.
    back string
    The back of an ID returned by a file upload with a purpose value of identity_document.
    details string
    A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".
    detailsCode string
    One of document_corrupt, document_country_not_supported, document_expired, document_failed_copy, document_failed_other, document_failed_test_mode, document_fraudulent, document_failed_greyscale, document_incomplete, document_invalid, document_manipulated, document_missing_back, document_missing_front, document_not_readable, document_not_uploaded, document_photo_mismatch, document_too_large, or document_type_not_supported. A machine-readable code specifying the verification state for this document.
    front string
    The front of an ID returned by a file upload with a purpose value of identity_document.
    back str
    The back of an ID returned by a file upload with a purpose value of identity_document.
    details str
    A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".
    details_code str
    One of document_corrupt, document_country_not_supported, document_expired, document_failed_copy, document_failed_other, document_failed_test_mode, document_fraudulent, document_failed_greyscale, document_incomplete, document_invalid, document_manipulated, document_missing_back, document_missing_front, document_not_readable, document_not_uploaded, document_photo_mismatch, document_too_large, or document_type_not_supported. A machine-readable code specifying the verification state for this document.
    front str
    The front of an ID returned by a file upload with a purpose value of identity_document.
    back String
    The back of an ID returned by a file upload with a purpose value of identity_document.
    details String
    A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".
    detailsCode String
    One of document_corrupt, document_country_not_supported, document_expired, document_failed_copy, document_failed_other, document_failed_test_mode, document_fraudulent, document_failed_greyscale, document_incomplete, document_invalid, document_manipulated, document_missing_back, document_missing_front, document_not_readable, document_not_uploaded, document_photo_mismatch, document_too_large, or document_type_not_supported. A machine-readable code specifying the verification state for this document.
    front String
    The front of an ID returned by a file upload with a purpose value of identity_document.

    PersonVerificationDocument, PersonVerificationDocumentArgs

    Back string
    The back of an ID returned by a file upload with a purpose value of identity_document.
    Details string
    A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".
    DetailsCode string
    One of document_corrupt, document_country_not_supported, document_expired, document_failed_copy, document_failed_other, document_failed_test_mode, document_fraudulent, document_failed_greyscale, document_incomplete, document_invalid, document_manipulated, document_missing_back, document_missing_front, document_not_readable, document_not_uploaded, document_photo_mismatch, document_too_large, or document_type_not_supported. A machine-readable code specifying the verification state for this document.
    Front string
    The front of an ID returned by a file upload with a purpose value of identity_document.
    Back string
    The back of an ID returned by a file upload with a purpose value of identity_document.
    Details string
    A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".
    DetailsCode string
    One of document_corrupt, document_country_not_supported, document_expired, document_failed_copy, document_failed_other, document_failed_test_mode, document_fraudulent, document_failed_greyscale, document_incomplete, document_invalid, document_manipulated, document_missing_back, document_missing_front, document_not_readable, document_not_uploaded, document_photo_mismatch, document_too_large, or document_type_not_supported. A machine-readable code specifying the verification state for this document.
    Front string
    The front of an ID returned by a file upload with a purpose value of identity_document.
    back string
    The back of an ID returned by a file upload with a purpose value of identity_document.
    details string
    A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".
    details_code string
    One of document_corrupt, document_country_not_supported, document_expired, document_failed_copy, document_failed_other, document_failed_test_mode, document_fraudulent, document_failed_greyscale, document_incomplete, document_invalid, document_manipulated, document_missing_back, document_missing_front, document_not_readable, document_not_uploaded, document_photo_mismatch, document_too_large, or document_type_not_supported. A machine-readable code specifying the verification state for this document.
    front string
    The front of an ID returned by a file upload with a purpose value of identity_document.
    back String
    The back of an ID returned by a file upload with a purpose value of identity_document.
    details String
    A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".
    detailsCode String
    One of document_corrupt, document_country_not_supported, document_expired, document_failed_copy, document_failed_other, document_failed_test_mode, document_fraudulent, document_failed_greyscale, document_incomplete, document_invalid, document_manipulated, document_missing_back, document_missing_front, document_not_readable, document_not_uploaded, document_photo_mismatch, document_too_large, or document_type_not_supported. A machine-readable code specifying the verification state for this document.
    front String
    The front of an ID returned by a file upload with a purpose value of identity_document.
    back string
    The back of an ID returned by a file upload with a purpose value of identity_document.
    details string
    A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".
    detailsCode string
    One of document_corrupt, document_country_not_supported, document_expired, document_failed_copy, document_failed_other, document_failed_test_mode, document_fraudulent, document_failed_greyscale, document_incomplete, document_invalid, document_manipulated, document_missing_back, document_missing_front, document_not_readable, document_not_uploaded, document_photo_mismatch, document_too_large, or document_type_not_supported. A machine-readable code specifying the verification state for this document.
    front string
    The front of an ID returned by a file upload with a purpose value of identity_document.
    back str
    The back of an ID returned by a file upload with a purpose value of identity_document.
    details str
    A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".
    details_code str
    One of document_corrupt, document_country_not_supported, document_expired, document_failed_copy, document_failed_other, document_failed_test_mode, document_fraudulent, document_failed_greyscale, document_incomplete, document_invalid, document_manipulated, document_missing_back, document_missing_front, document_not_readable, document_not_uploaded, document_photo_mismatch, document_too_large, or document_type_not_supported. A machine-readable code specifying the verification state for this document.
    front str
    The front of an ID returned by a file upload with a purpose value of identity_document.
    back String
    The back of an ID returned by a file upload with a purpose value of identity_document.
    details String
    A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".
    detailsCode String
    One of document_corrupt, document_country_not_supported, document_expired, document_failed_copy, document_failed_other, document_failed_test_mode, document_fraudulent, document_failed_greyscale, document_incomplete, document_invalid, document_manipulated, document_missing_back, document_missing_front, document_not_readable, document_not_uploaded, document_photo_mismatch, document_too_large, or document_type_not_supported. A machine-readable code specifying the verification state for this document.
    front String
    The front of an ID returned by a file upload with a purpose value of identity_document.

    Package Details

    Repository
    stripe stripe/terraform-provider-stripe
    License
    Notes
    This Pulumi package is based on the stripe Terraform Provider.
    Viewing docs for Stripe 0.3.0
    published on Friday, Aug 14, 2026 by Pulumi
    Schema (JSON)
    stripe/terraform-provider-stripe

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial