Interface Tenant

export Tenant

interface Tenant {
    account_id?: null | string;
    address?: AddressDeets;
    business_details?: IUserBusinessDeets;
    business_name?: null | string;
    capabilities?: TenantCapabilities;
    country_code?: null | string;
    dob?: null | string;
    email_address?: null | string;
    entity_type?: EntityType;
    federal_tax_id?: null | string;
    first_name?: null | string;
    id?: null | string;
    individual_details?: IUserIndividualDeets;
    is_new?: boolean;
    last_name?: null | string;
    phone?: null | string;
    provider_accounts?: null | ProviderAccount[];
    status?: TenantStatus;
    verification?: UserStatusVerification;
}

Properties

account_id? address? business_details? business_name? capabilities? country_code? dob? email_address? entity_type? federal_tax_id? first_name? id? individual_details? is_new? last_name? phone? provider_accounts? status? verification?

Properties

Optionalaccount_id

account_id?: null | string

Optionaladdress

address?: AddressDeets

Optionalbusiness_details

business_details?: IUserBusinessDeets

Optionalbusiness_name

business_name?: null | string

Business Name

Optionalcapabilities

capabilities?: TenantCapabilities

Optionalcountry_code

country_code?: null | string

Country code

Optionaldob

dob?: null | string

The birthdate of the account holder

Optionalemail_address

email_address?: null | string

Optionalentity_type

entity_type?: EntityType

Optionalfederal_tax_id

federal_tax_id?: null | string

Federal Tax Identifier / SSN of the account holder

Optionalfirst_name

first_name?: null | string

First name of the account holder

Optionalid

id?: null | string

Tenant User ID

Optionalindividual_details

individual_details?: IUserIndividualDeets

Optionalis_new

is_new?: boolean

True if the account was created

Optionallast_name

last_name?: null | string

Last name of the account holder

Optionalphone

phone?: null | string

Phone number of the account holder

Optionalprovider_accounts

provider_accounts?: null | ProviderAccount[]

Returns the external accounts that the tenant is linked to.

Optionalstatus

status?: TenantStatus

Optionalverification

verification?: UserStatusVerification

Settings

Member Visibility

On This Page

Properties