Interface CustomerPersonRequest

Represents the customer information used in the onboarding process.

interface CustomerPersonRequest {
    additionalAttributes?: Record<string, string>;
    address: Address;
    birthDate: string;
    currencyCode: string;
    customerCredentials: CustomerCredentials;
    customerIdentifiers: CustomerIdentifiersOnboarding;
    deviceInfo: DeviceInfo;
    firstName: string;
    isPoliticallyExposed?: boolean;
    lastName: string;
    nationality?: string;
    occupation?: Occupation;
    preferences?: Preferences;
    termsAndConditions: boolean;
    title?: string;
    vulnerabilities?: Vulnerability[];
}

Properties

additionalAttributes? address birthDate currencyCode customerCredentials customerIdentifiers deviceInfo firstName isPoliticallyExposed? lastName nationality? occupation? preferences? termsAndConditions title? vulnerabilities?

Properties

Optional additionalAttributes

additionalAttributes?: Record<string, string>

List of additional attributes not covered in standard list. Specifics need to be aligned during integration with Paysafe.

address

address: Address

The 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"

currencyCode

currencyCode: string

Currency alphabetic code as specified by ISO 4217.

Example

"EUR"

customerCredentials

customerCredentials: CustomerCredentials

Credentials used for recovery or customer onboarding.

customerIdentifiers

customerIdentifiers: CustomerIdentifiersOnboarding

Customer identifiers used in onboarding process.

deviceInfo

deviceInfo: DeviceInfo

Provides information about the device that the end-customer uses to access the service.

firstName

firstName: string

The first name of the customer.

Optional isPoliticallyExposed

isPoliticallyExposed?: boolean

Identifies whether the customer is a Politically Exposed Person (PEP).

lastName

lastName: string

The last name of the customer.

Optional nationality

nationality?: string

The nationality of the customer in ISO-3166 Alpha 2 format.

Example

"GB"

Optional occupation

occupation?: Occupation

The occupation of the customer.

Optional preferences

preferences?: Preferences

User-defined preferences related to data consent and marketing communication.

termsAndConditions

termsAndConditions: boolean

A boolean indicating whether the customer has accepted the terms and conditions.

Optional title

title?: string

Personal title.

Example

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

Optional vulnerabilities

vulnerabilities?: Vulnerability[]

A list of vulnerabilities associated with the customer.

Settings

Member Visibility

Theme

On This Page

additionalAttributesaddressbirthDatecurrencyCodecustomerCredentialscustomerIdentifiersdeviceInfofirstNameisPoliticallyExposedlastNamenationalityoccupationpreferencestermsAndConditionstitlevulnerabilities