Class Hyperwallet\Model\User

`extends`	`BaseModel`
`implements`	`IProgramAware`

Represents a V4 User

Hyperwallet\Model\BaseModel
- Hyperwallet\Model\User implements IProgramAware

Located at Hyperwallet/Model/User.php

Methods


					
	public
					static

FILTERS_ARRAY()


					
	public

__construct(string[] $properties = [])

Creates a instance of User

Parameters

$properties

The default properties

Overrides

Hyperwallet\Model\BaseModel::__construct()


					
	public

getToken(): string

Get the user token


					
	public

setToken(string $token): User

Set the user token


					
	public

getStatus(): string

Get the user status


					
	public

getCreatedOn(): DateTime

Get the user creation time


					
	public

getClientUserId(): string

Get the client user id


					
	public

setClientUserId(string $clientUserId): User

Set the client user id


					
	public

getProfileType(): string

Get the profile type


					
	public

setProfileType(string $profileType): User

Set the profile type


					
	public

getBusinessType(): string

Get the business type


					
	public

setBusinessType(string $businessType): User

Set the business type


					
	public

getBusinessName(): string

Get the business name


					
	public

setBusinessName(string $businessName): User

Set the business name


					
	public

getBusinessOperatingName(): string

Get the business operating name


					
	public

setBusinessOperatingName(string $businessOperatingName): User

Set the business operating name


					
	public

getBusinessRegistrationId(): string

Get the business registration id


					
	public

setBusinessRegistrationId(string $businessRegistrationId): User

Set the business registration id


					
	public

getBusinessRegistrationStateProvince(): string

Get the business registration state or province


					
	public

setBusinessRegistrationStateProvince(string $businessRegistrationStateProvince): User

Set the business registartion state or province


					
	public

getBusinessRegistrationCountry(): string

Get the business registartion country


					
	public

setBusinessRegistrationCountry(string $businessRegistrationCountry): User

Set the business registration country


					
	public

getBusinessContactRole(): string

Get the business contact role


					
	public

setBusinessContactRole(string $businessContactRole): User

Set the business contact role


					
	public

getFirstName(): string

Get the first name


					
	public

setFirstName(string $firstName): User

Set the first name


					
	public

getMiddleName(): string

Get the middle name


					
	public

setMiddleName(string $middleName): User

Set the middle name


					
	public

getLastName(): string

Get the last name


					
	public

setLastName(string $lastName): User

Set the last name


					
	public

getDateOfBirth(): DateTime|null

Get the date of birth


					
	public

setDateOfBirth(DateTime|null $dateOfBirth = null): User

Set the date of birth


					
	public

getCountryOfBirth(): string

Get the country of birth


					
	public

setCountryOfBirth(string $countryOfBirth): User

Set the country of birth


					
	public

getCountryOfNationality(): string

Get the country of nationality


					
	public

setCountryOfNationality(string $countryOfNationality): User

Set the country of nationality


					
	public

getGender(): string

Get the gender


					
	public

setGender(string $gender): User

Set the gender


					
	public

getPhoneNumber(): string

Get the phone number


					
	public

setPhoneNumber(string $phoneNumber): User

Set the phone number


					
	public

getMobileNumber(): string

Get the mobile number


					
	public

setMobileNumber(string $mobileNumber): User

Set the mobile number


					
	public

getEmail(): string

Get the email


					
	public

setEmail(string $email): User

Set the email


					
	public

getGovernmentId(): string

Get the government id


					
	public

setGovernmentId(string $governmentId): User

Set the government id


					
	public

getPassportId(): string

Get the passport id


					
	public

setPassportId(string $passportId): User

Set the passport id


					
	public

getDriversLicenseId(): string

Get the drivers license id


					
	public

setDriversLicenseId(string $driversLicenseId): User

Set the drivers license id


					
	public

getEmployerId(): string

Get the employer id


					
	public

setEmployerId(string $employerId): User

Set the employer id


					
	public

getAddressLine1(): string

Get the address line 1


					
	public

setAddressLine1(string $addressLine1): User

Set the address line 1


					
	public

getAddressLine2(): string

Get the address line 2


					
	public

setAddressLine2(string $addressLine2): User

Set the address line 2


					
	public

getCity(): string

Get the city


					
	public

setCity(string $city): User

Set the city


					
	public

getStateProvince(): string

Get the state or province


					
	public

setStateProvince(string $stateProvince): User

Set the state or province


					
	public

getCountry(): string

Get the country


					
	public

setCountry(string $country): User

Set the country


					
	public

getPostalCode(): string

Get the postal code


					
	public

setPostalCode(string $postalCode): User

Set the postal code


					
	public

getLanguage(): string

Get the user language


					
	public

setLanguage(string $language): User

Set the user language


					
	public

getProgramToken(): string

Get the users program token

Implements

Hyperwallet\Model\IProgramAware::getProgramToken()


					
	public

setProgramToken(string $programToken): User

Set the users program token

Implements

Hyperwallet\Model\IProgramAware::setProgramToken()


					
	public

getVerificationStatus(): string

Get the users verification status


					
	public

setVerificationStatus(string $verificationStatus): User

Set the users verification status


					
	public

getTaxVerificationStatus(): string

Get the tax verification status


					
	public

setTaxVerificationStatus(string $taxVerificationStatus): User

Set the tax verification status


					
	public

getDocuments()


					
	public

getBusinessStakeholderVerificationStatus(): string

get Business Stakeholder verification status


					
	public

setBusinessStakeholderVerificationStatus(string $businessStakeholderVerificationStatus): User

set Business Stakeholder verification status


					
	public

getLetterOfAuthorizationStatus(): string

Get the users Letter of Authorization status


					
	public

setLetterOfAuthorizationStatus(string $letterOfAuthorizationStatus): User

Set the users Letter of Authorization status


					
	public

getGovernmentIdType(): string

get the users government Id Type


					
	public

setGovernmentIdType(string $governmentIdType): User

Set the users government Id Type


					
	public

getTimeZone(): string

get the user's time zone


					
	public

setTimeZone(string $timeZone): User

set the user's time zone


					
	public

getLinks(): array

get the HATEOS links


					
	public

setLinks(array $links): User

set the HATEOS links

Constants
`public`	`STATUS_PRE_ACTIVATED = 'PRE_ACTIVATED'`	#
`public`	`STATUS_ACTIVATED = 'ACTIVATED'`	#
`public`	`STATUS_LOCKED = 'LOCKED'`	#
`public`	`STATUS_FROZEN = 'FROZEN'`	#
`public`	`STATUS_DE_ACTIVATED = 'DE_ACTIVATED'`	#
`public`	`PROFILE_TYPE_INDIVIDUAL = 'INDIVIDUAL'`	#
`public`	`PROFILE_TYPE_BUSINESS = 'BUSINESS'`	#
`public`	`PROFILE_TYPE_UNKNOWN = 'UNKNOWN'`	#
`public`	`BUSINESS_TYPE_CORPORATION = 'CORPORATION'`	#
`public`	`BUSINESS_TYPE_PARTNERSHIP = 'PARTNERSHIP'`	#
`public`	`BUSINESS_CONTACT_ROLE_DIRECTOR = 'DIRECTOR'`	#
`public`	`BUSINESS_CONTACT_ROLE_OWNER = 'OWNER'`	#
`public`	`BUSINESS_CONTACT_ROLE_OTHER = 'OTHER'`	#
`public`	`GENDER_MALE = 'MALE'`	#
`public`	`GENDER_FEMALE = 'FEMALE'`	#
`public`	`VERIFICATION_STATUS_NOT_REQUIRED = 'NOT_REQUIRED'`	#
`public`	`VERIFICATION_STATUS_REQUIRED = 'REQUIRED'`	#
`public`	`VERIFICATION_STATUS_FAILED = 'FAILED'`	#
`public`	`VERIFICATION_STATUS_UNDER_REVIEW = 'UNDER_REVIEW'`	#
`public`	`VERIFICATION_STATUS_VERIFIED = 'VERIFIED'`	#
`public`	`VERIFICATION_STATUS_REQUESTED = 'REQUESTED'`	#
`public`	`VERIFICATION_STATUS_EXPIRED = 'EXPIRED'`	#
`public`	`VERIFICATION_STATUS_READY_FOR_REVIEW = 'READY_FOR_REVIEW'`	#
`public`	`TAX_VERIFICATION_STATUS_NOT_REQUIRED = 'NOT_REQUIRED'`	#
`public`	`TAX_VERIFICATION_STATUS_REQUIRED = 'REQUIRED'`	#
`public`	`TAX_VERIFICATION_STATUS_VERIFIED = 'VERIFIED'`	#
`public`	`TAX_VERIFICATION_STATUS_UNDER_REVIEW = 'UNDER_REVIEW'`	#
`public`	`BUSINESSS_STAKEHOLDER_VERIFICATION_STATUS_NOT_REQUIRED = 'NOT_REQUIRED'`	#
`public`	`BUSINESSS_STAKEHOLDER_VERIFICATION_STATUS_REQUIRED = 'REQUIRED'`	#
`public`	`BUSINESSS_STAKEHOLDER_VERIFICATION_STATUS_FAILED = 'FAILED'`	#
`public`	`BUSINESSS_STAKEHOLDER_VERIFICATION_STATUS_UNDER_REVIEW = 'UNDER_REVIEW'`	#
`public`	`BUSINESSS_STAKEHOLDER_VERIFICATION_STATUS_VERIFIED = 'VERIFIED'`	#
`public`	`BUSINESSS_STAKEHOLDER_VERIFICATION_STATUS_READY_FOR_REVIEW = 'READY_FOR_REVIEW'`	#
`public`	`LETTER_OF_AUTHORIZATION_STATUS_NOT_REQUIRED = 'NOT_REQUIRED'`	#
`public`	`LETTER_OF_AUTHORIZATION_STATUS_REQUIRED = 'REQUIRED'`	#
`public`	`LETTER_OF_AUTHORIZATION_STATUS_FAILED = 'FAILED'`	#
`public`	`LETTER_OF_AUTHORIZATION_STATUS_UNDER_REVIEW = 'UNDER_REVIEW'`	#
`public`	`LETTER_OF_AUTHORIZATION_STATUS_VERIFIED = 'VERIFIED'`	#
`public`	`LETTER_OF_AUTHORIZATION_STATUS_READY_FOR_REVIEW = 'READY_FOR_REVIEW'`	#
`public`	`GOVERNMENT_ID_TYPE_PASSPORT = 'PASSPORT'`	#
`public`	`GOVERNMENT_ID_TYPE_NATIONAL_ID_CARD = 'NATIONAL_ID_CARD'`	#

Properties
`public`	`string`	`$token` The user token The user token	#
`public`	`string`	`$status` The user status The user status	#
`public`	`string`	`$verificationStatus` The status of user verification The status of user verification	#
`public`	`string`	`$taxVerificationStatus` The status of tax verification The status of tax verification	#
`public`	`string`	`$businessStakeholderVerificationStatus` The status of Business Stakeholder verification The status of Business Stakeholder verification	#
`public`	`string`	`$letterOfAuthorizationStatus` The status of Letter of Authorization verification The status of Letter of Authorization verification	#
`public`	`DateTime`	`$createdOn` The user creation date The user creation date	#
`public`	`string`	`$clientUserId` The client user id The client user id	#
`public`	`string`	`$profileType` The profile type The profile type	#
`public`	`string`	`$businessType` The business type The business type	#
`public`	`string`	`$businessName` The business name The business name	#
`public`	`string`	`$businessOperatingName` The business operating name The business operating name	#
`public`	`string`	`$businessRegistrationId` The business registration id The business registration id	#
`public`	`string`	`$businessRegistrationCountry` The business registration country The business registration country	#
`public`	`string`	`$businessRegistrationStateProvince` The business registration state or province The business registration state or province	#
`public`	`string`	`$businessContactRole` The business contact role The business contact role	#
`public`	`string`	`$firstName` The first name The first name	#
`public`	`string`	`$middleName` The middle name The middle name	#
`public`	`string`	`$lastName` The last name The last name	#
`public`	`DateTime`	`$dateOfBirth` The date of birth The date of birth	#
`public`	`string`	`$countryOfBirth` The country of birth The country of birth	#
`public`	`string`	`$countryOfNationality` The country of nationality The country of nationality	#
`public`	`string`	`$gender` The gender The gender	#
`public`	`string`	`$phoneNumber` The phone number The phone number	#
`public`	`string`	`$mobileNumber` The mobile number The mobile number	#
`public`	`string`	`$email` The email The email	#
`public`	`string`	`$governmentId` The goverment id The goverment id	#
`public`	`string`	`$governmentIdType` The status of Letter of Authorization verification The status of Letter of Authorization verification	#
`public`	`string`	`$passportId` The passport id The passport id	#
`public`	`string`	`$driversLicenseId` The drivers license id The drivers license id	#
`public`	`string`	`$employerId` The employer id The employer id	#
`public`	`string`	`$addressLine1` The address line 1 The address line 1	#
`public`	`string`	`$addressLine2` The address line 2 The address line 2	#
`public`	`string`	`$city` The city The city	#
`public`	`string`	`$stateProvince` The state or province The state or province	#
`public`	`string`	`$postalCode` The postal code The postal code	#
`public`	`string`	`$country` The country The country	#
`public`	`string`	`$language` The user language The user language	#
`public`	`string`	`$programToken` The users program token The users program token	#
`public`	`string`	`$timeZone` The users program token The users program token	#
`public`	`HyperwalletVerificationDocumentCollection`	`$documents` The array of documents of type HyperwalletVerificationDocument returned for document upload The array of documents of type HyperwalletVerificationDocument returned for document upload	#
`public`	`array`	`$links` The array of HATEOS links The array of HATEOS links	#

Namespaces

Classes

Interfaces

Class Hyperwallet\Model\User

Parameters

Overrides

Implements

Implements