Interface CustomerInfo

Represents customer information.

interface CustomerInfo {
    accounts?: Account[];
    additionalAttributes?: Record<string, string>;
    address?: Address;
    birthDate: string;
    contactInfo?: ContactInformation;
    externalId?: string;
    firstName: string;
    id?: string;
    incompleteAttributes?: IncompleteAttribute[];
    lastName: string;
    nationality?: string;
    occupation?: string;
    preferences?: Preferences;
    restrictions?: Restriction[];
    title?: string;
    type?: string;
    userCategory?: string;
    vulnerabilities?: Vulnerability[];
}

Properties

accounts? additionalAttributes? address? birthDate contactInfo? externalId? firstName id? incompleteAttributes? lastName nationality? occupation? preferences? restrictions? title? type? userCategory? vulnerabilities?

Properties

Optional accounts

accounts?: Account[]

Accounts associated with this customer.

Optional additionalAttributes

additionalAttributes?: Record<string, string>

Additional attributes associated with this customer.

Optional address

address?: Address

Address of the customer.

birthDate

birthDate: string

Date of birth.

Format should be ISO 8601 in UTC. Represents RFC 3339, section 5.6 date-time.

Example

"2024-05-23"

Optional contactInfo

contactInfo?: ContactInformation

Contact information.

Optional externalId

externalId?: string

External identifier in merchant system. Must be passed during onboarding.

firstName

firstName: string

First name.

Optional id

id?: string

Paysafe embedded wallet internal identifier.

Optional incompleteAttributes

incompleteAttributes?: IncompleteAttribute[]

Incomplete attributes associated with this customer.

lastName

lastName: string

Last name.

Optional nationality

nationality?: string

Nationality. Represents ISO-3166 Alpha 2 country code.

Example

"GB"

Optional occupation

occupation?: string

Occupation.

Optional preferences

preferences?: Preferences

Preferences associated with this customer.

Optional restrictions

restrictions?: Restriction[]

Restrictions placed on the customer.

Optional title

title?: string

Personal title.

Example

"Mr.", "Ms" "Dr."

Optional type

type?: string

Type of the customer.

Optional userCategory

userCategory?: string

User category associated with this customer.

Optional vulnerabilities

vulnerabilities?: Vulnerability[]

Vulnerabilities associated with this customer.

Settings

Member Visibility

Theme

On This Page

accountsadditionalAttributesaddressbirthDatecontactInfoexternalIdfirstNameidincompleteAttributeslastNamenationalityoccupationpreferencesrestrictionstitletypeuserCategoryvulnerabilities