Skip to main content

CustomerPersonEnhanced

Enhanced Customer Person model with additional attributes.

idstring

Paysafe embedded wallet internal identifier.

Possible values: <= 20 characters

titlestring

Personal title, Mr., Dr., etc.

Possible values: <= 15 characters

Example: Mr.
firstNamestringrequired

First name.

Possible values: <= 50 characters

Example: John
lastNamestringrequired

Last name.

Possible values: <= 50 characters

Example: Doe
birthDatedaterequired

Birth date in YYYY-MM-DD format.

Example: 1981-01-11
nationalityCountryCode (string)

ISO-3166 Alpha 2

Possible values: >= 2 characters and <= 2 characters

Example: GB
occupationOccupation (string)

Valid occupation:

  • ARCHITECTURE_CARTOGRAPHY_SURVEYOR - "Architecture, Cartography, Surveyor"
  • LIFE_PHYSICAL_AND_SOCIAL_SCIENCES - "Life, Physical, and Social Sciences"
  • COMMUNITY_AND_SOCIAL_SERVICES - "Community and Social Services"
  • NEWS_AND_REPORTING_SERVICES - "News and Reporting Services"
  • HEALTHCARE_SERVICES - "Healthcare Services"
  • LAW_ENFORCEMENT_AND_PUBLIC_SAFETY - "Law Enforcement and Public Safety"
  • FOOD_AND_BEVERAGE_INDUSTRY - "Food and Beverage Industry"
  • DOMESTIC_SERVICES - "Domestic Services"
  • PERSONAL_CARE_PROFESSIONAL_SERVICES - "Personal Care Professional Services"
  • SALES_AND_RELATED_OCCUPATIONS - "Sales and Related Occupations"
  • OFFICE_ADMINISTRATION_AND_SUPPORT - "Office Administration and Support"
  • FARMING_FISHING_AND_FORESTRY_SERVICES - "Farming, Fishing and Forestry Services"
  • CONSTRUCTION_AND_RELATED_SERVICES - "Construction and Related Services"
  • MANUFACTURING_SERVICES - "Manufacturing Services"
  • TRANSPORTATION_SERVICES - "Transportation Services"
  • ENTERTAINMENT_MEDIA - "Entertainment and Media"
  • UNEMPLOYED - "Unemployed"
  • STUDENT - "Student"
  • PENSIONER - "Pensioner"
  • SPORTS_INDUSTRY - "Sports Industry"
  • BETTING_INDUSTRY - "Betting Industry"
  • ART_AND_DESIGN - "Art and Design"
  • EDUCATION_AND_EDUCATIONAL_SURVICES - "Education and Educational Support Services"
  • ENGINEERING - "Engineering"
  • FINANCIAL_AND_INSURANCE_SERVICES - "Financial and Insurance Services"
  • IT_SOFTWARE_HARDWARE_AND_WEBSITE_DEVELOPMENT - "IT Software, Hardware and Website Development"
  • LEGAL_AND_COMPLIANCE_SERVICES - "Legal and Compliance Services"
  • MANAGEMENT_CONSULTING - "Management Consulting"
  • WEAPON_INDUSTRY - "Weapon Industry"
  • CHARITY_AND_NON_PROFIT_SERVICES - "Charity, Non-Profit Services"
  • FREELANCER_SELF_EMPLOYED - "Freelancer, Self-employed"
  • PUBLIC_SECTOR - "Public Sector"

Possible values: [ARCHITECTURE_CARTOGRAPHY_SURVEYOR, LIFE_PHYSICAL_AND_SOCIAL_SCIENCES, COMMUNITY_AND_SOCIAL_SERVICES, NEWS_AND_REPORTING_SERVICES, HEALTHCARE_SERVICES, LAW_ENFORCEMENT_AND_PUBLIC_SAFETY, FOOD_AND_BEVERAGE_INDUSTRY, DOMESTIC_SERVICES, PERSONAL_CARE_PROFESSIONAL_SERVICES, SALES_AND_RELATED_OCCUPATIONS, OFFICE_ADMINISTRATION_AND_SUPPORT, FARMING_FISHING_AND_FORESTRY_SERVICES, CONSTRUCTION_AND_RELATED_SERVICES, MANUFACTURING_SERVICES, TRANSPORTATION_SERVICES, ENTERTAINMENT_MEDIA, UNEMPLOYED, STUDENT, PENSIONER, SPORTS_INDUSTRY, BETTING_INDUSTRY, ART_AND_DESIGN, EDUCATION_AND_EDUCATIONAL_SURVICES, ENGINEERING, FINANCIAL_AND_INSURANCE_SERVICES, IT_SOFTWARE_HARDWARE_AND_WEBSITE_DEVELOPMENT, LEGAL_AND_COMPLIANCE_SERVICES, MANAGEMENT_CONSULTING, WEAPON_INDUSTRY, CHARITY_AND_NON_PROFIT_SERVICES, FREELANCER_SELF_EMPLOYED, PUBLIC_SECTOR]

Example: ARCHITECTURE_CARTOGRAPHY_SURVEYOR
vulnerabilitiesVulnerability (string)[]

List of vulnerabilities.

Possible values: [CARING_RESPONSIBILITIES, FINANCE_MISMANAGEMENT, FRAUDULENT_LOCATION, GAMBLING_ADDICTION, LOW_MENTAL_CAPACITY, PHYSICAL_DISABILITY, POOR_DIGITAL_SKILLS, POOR_LANGUAGE_SKILLS, POOR_LITERACY]

Example: ["PHYSICAL_DISABILITY","LOW_MENTAL_CAPACITY"]
additionalAttributes object

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

property name*string
userCategorystring

The user category

Possible values: <= 50 characters

serviceLevelint32

Service level of the customer.

Possible values: <= 5

Example: 0
externalIdExternalId (string)

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

Possible values: non-empty and <= 40 characters

Example: a2322550-af91-417f-867e-681efad44b9d
address object

Address of the customer.

countryCodeCountryCode (string)required

ISO-3166 Alpha 2

Possible values: >= 2 characters and <= 2 characters

Example: GB
stateProvincestring

US state postal abbreviation. Not used for non-US territories.

Possible values: <= 2 characters

citystringrequired

City.

Possible values: <= 50 characters

Example: London
postalCodestringrequired

Postal code.

Possible values: non-empty and <= 50 characters

Example: E1 6AN
address1stringrequired

The first line of the address.

Possible values: <= 200 characters

Example: 12 Brushfield Street
address2string

The second line of the address.

Possible values: <= 200 characters

contactInfo object

Represents contact information.

mobilestring

Mobile number.

Possible values: <= 50 characters

emailemail

Email.

Possible values: >= 6 characters and <= 100 characters

typestring

Type of the customer.

restrictions object[]

Restrictions placed on the customer.

  • Array [
    • nameRestrictionName (string)required

    Represents the name of a restriction applied to a customer wallet.

    • ALL_TRANSACTIONS - Block all types of transactions.
    • OUTGOING_TRANSACTIONS - Block withdrawals and send money transactions.
    • INCOMING_TRANSACTIONS - Block all types of bank ( ACH, bankwire) and card deposits, including EFT deposits; received money from other customers and merchants; sell crypto and stocks.
    • SEND_MONEY - Block all send money transactions to other customers and merchants.
    • INCOMING_TRANSACTIONS_AND_SEND_MONEY - Block all types of bank ( ACH, bankwire) and card deposits, including EFT deposits; received money from other customers and merchants; sell crypto and stocks. Block all send money transactions to other customers and merchants.
    • CARD_DEPOSITS - Block all deposit made by card.
    • CARD_AND_ACH_DEPOSITS - Block all deposit made by card and ACH bank deposits.
    • DEPOSITS - Block all types of bank ( ACH, bankwire) and card deposits, including EFT deposits.
    • OUTGOING_TRANSACTIONS_AND_CARD_DEPOSITS - Block withdrawals and send money transactions and all card deposits.
    • OUTGOING_TRANSACTIONS_AND_ACH_DEPOSITS - Block all types of withdrawals (including ATM and POS trn with prepaid card) and ACH deposits.
    • DEPOSITS_AND_WITHDRAWALS - Bocks all withdrawals and deposits.
    • CRYPTO_TRANSACTIONS - Block all crypto trn including buy and sell, received and send crypto.
    • LOGIN - Block access to account login, preventing the user from signing in to view or manage their account.
    • OTHER - Other restrictions.

    Possible values: [ALL_TRANSACTIONS, CARD_AND_ACH_DEPOSITS, CARD_DEPOSITS, CRYPTO_TRANSACTIONS, DEPOSITS, DEPOSITS_AND_WITHDRAWALS, INCOMING_TRANSACTIONS, INCOMING_TRANSACTIONS_AND_SEND_MONEY, LOGIN, OTHER, OUTGOING_TRANSACTIONS, OUTGOING_TRANSACTIONS_AND_ACH_DEPOSITS, OUTGOING_TRANSACTIONS_AND_CARD_DEPOSITS, SEND_MONEY]

    Example: ALL_TRANSACTIONS
    requiredActionsRequiredAction (string)[]

    Actions to be completed in order to resolve

    Possible values: [BANK_ACCOUNT_VERIFICATION, COMPLETE_ONBOARDING, CONTACT_CUSTOMER_SERVICE, KYC_VERIFICATION, OTHER, PEP_DECLARATION, WAIT]

    Example: ["CONTACT_CUSTOMER_SERVICE","KYC_VERIFICATION"]
    lastChangeDatedate-time

    Represents RFC 3339, section 5.6 date-time.

    Example: 2021-07-15T17:54:12Z
    idstringrequired

    Restriction id

    Possible values: <= 36 characters

    Example: 084666a4-cd47-40c1-afe2-4a575e341d59
    activationTimedate-time

    Represents RFC 3339, section 5.6 date-time.

    Example: 2021-07-15T17:54:12Z
    dueDatedate-time

    Represents RFC 3339, section 5.6 date-time.

    Example: 2021-07-15T17:54:12Z
    reasonRestrictionReason (string)required

    Reason for placing the restriction.

    • RISK_CONTROLS - The reason for setting up the restriction requires additional risk checks to the end-customer's account.
    • COMPLIANCE - The reason for setting up the restriction is related to the customer's due diligence and requires an additional compliance check of the end-customer's account.
    • CLOSE_ACCOUNT - Account closure.
    • DUPLICATE_ACCOUNT - The reason for setting up the restriction shows that the same person already exists as the account owner.
    • KYC - The reason for setting up the restriction is related to the customer's KYC verification and requires KYC document submissions.
    • NO_SERVICE_COUNTRY - No service country.
    • PREPAID_CARD_CHARGEBACK - Pre-paid card chargeback.
    • T_C_ABUSE - Terms & Conditions Abuse
    • TERMINATED - Account terminated.
    • UNDER_18 - Customer under 18.
    • MERCHANT_REQUEST - Merchant placed the restriction.
    • CONFIRM_TXN_ACTIVITY - Contact customer to confirm pre-paid card transactional activities.
    • SCA - Customer should perform some action related to SCA.
    • OTHER - Other reason.

    Possible values: [RISK_CONTROLS, COMPLIANCE, CLOSE_ACCOUNT, DUPLICATE_ACCOUNT, KYC, NO_SERVICE_COUNTRY, PREPAID_CARD_CHARGEBACK, T_C_ABUSE, TERMINATED, UNDER_18, OTHER, CONFIRM_TXN_ACTIVITY, MERCHANT_REQUEST, SCA]

    creationTimedate-time

    Represents RFC 3339, section 5.6 date-time.

    Example: 2021-07-15T17:54:12Z
  • ]
    • accounts object[]

    Accounts associated with this customer.

  • Array [
    • currencyCodeCurrency (string)required

    Currency alphabetic code as specified by ISO 4217

    Possible values: >= 3 characters and <= 3 characters

    Example: EUR
    idstring

    Account id.

    Possible values: <= 20 characters

    Example: 5029090724
    customerIdstring

    Paysafe embedded wallet internal customer identifier.

    Possible values: <= 20 characters

    Example: 123456789
    externalIdExternalId (string)

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

    Possible values: non-empty and <= 40 characters

    Example: a2322550-af91-417f-867e-681efad44b9d
    totalBalanceint64

    Amount in minor units

    Example: 0
    availableBalanceint64

    Amount in minor units

    Example: 0
    instruments object[]deprecated

    **Deprecated! Use virtualInstrument property instead. **

    List of payment instruments associated with this account, provided by Paysafe. This list might include virtual bank accounts or pre-paid cards funded by the account

  • Array [
    • idstring

    The instrument id

    customerIdstring

    The customer to which this instrument belongs.

    Example: 5435323362
    instrumentTypeInstrumentType (string)required

    Represents the type of the instrument.

    | Value | Description| |---|---| | SEPA_BANK_ACCOUNT| SEPA Bank account | | UK_BANK_ACCOUNT | UK Bank account | | US_BANK_ACCOUNT | US Bank account | | CCI_BANK_ACCOUNT | CCI Bank account | | CARD | Card |

    Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT, CCI_BANK_ACCOUNT, CARD]

    Example: CARD
    externallyVerifiedboolean

    Is the instrument externally verified.

    Default value: false
    statusstring

    The instrument status.

    Possible values: [VERIFIED, UNVERIFIED, VERIFICATION_REQUIRED, REJECTED]

    creationTimedate-time

    Represents RFC 3339, section 5.6 date-time.

    Example: 2021-07-15T17:54:12Z
  • ]
    • virtualInstruments object[]

    List of virtual payment instruments liked to this balance account.

  • Array [
    • idstringrequired

    Virtual instrument unique identifier.

    Possible values: <= 50 characters

    Example: acde070d-8c4c-4f0d-9d8a-162843c10333
    instrumentTypeVirtualInstrumentType (string)required

    Virtual payment instrument type.

    Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT]

    Example: US_BANK_ACCOUNT
  • ]
    • creationTimedate-time

    Instrument creation time.

    Example: 2019-08-24T14:15:22Z
  • ]
    • incompleteAttributesIncompleteAttribute (string)[]

    List of not completed attributes required for full customer onboarding.

    Possible values: [NATIONALITY, OCCUPATION]

    preferences object

    User-defined preferences related to data consent and marketing communication

    marketing object

    Preferences related to the user's choice to receive marketing communications through various channels, including push notifications, emails, SMS, social media, targeted ads, and third-party marketing.

    receivePushNotificationsboolean

    User preference to receive marketing-related push notifications.

    receiveMarketingEmailsboolean

    User preference to receive promotional emails.

    receiveMarketingSmsboolean

    User preference to receive marketing messages via SMS.

    receiveSocialAdsboolean

    User preference to receive advertisements through social media platforms.

    receiveTargetedAdsboolean

    User preference to receive advertisements that are targeted based on user data.

    receiveThirdPartyAdsboolean

    User preference to receive marketing content from third-party partners.

    data object

    Preferences related to the user's consent for various types of data usage, including targeted advertising, analytics, and performance tracking.

    consentForTargetedAdsboolean

    User consent to use their data for targeted advertising purposes.

    consentForAnalyticsboolean

    User consent to collect and use data for analytics and insights.

    consentForPerformanceTrackingboolean

    User consent to track data for enhancing app or service performance.

    registrationIpipv4

    IPv4 address from which the customer has registered.

    registrationDatedate-time

    Date of registration at the Merchant system

    kycInfo object

    Contains information about the customer's KYC verification.

    documentTypestring

    Document type

    Example: NATIONAL_ID
    documentNumberstring

    Document number

    Example: 123456789
    CustomerPersonEnhanced
    {
      "id": "string",
      "title": "Mr.",
      "firstName": "John",
      "lastName": "Doe",
      "birthDate": "1981-01-11",
      "nationality": "GB",
      "occupation": "ARCHITECTURE_CARTOGRAPHY_SURVEYOR",
      "vulnerabilities": [
        "PHYSICAL_DISABILITY",
        "LOW_MENTAL_CAPACITY"
      ],
      "additionalAttributes": {},
      "userCategory": "string",
      "serviceLevel": 0,
      "externalId": "a2322550-af91-417f-867e-681efad44b9d",
      "address": {
        "countryCode": "GB",
        "stateProvince": "string",
        "city": "London",
        "postalCode": "E1 6AN",
        "address1": "12 Brushfield Street",
        "address2": "string"
      },
      "contactInfo": {
        "mobile": "string",
        "email": "user@example.com"
      },
      "type": "string",
      "restrictions": [
        {
          "name": "ALL_TRANSACTIONS",
          "requiredActions": [
            "CONTACT_CUSTOMER_SERVICE",
            "KYC_VERIFICATION"
          ],
          "lastChangeDate": "2021-07-15T17:54:12Z",
          "id": "084666a4-cd47-40c1-afe2-4a575e341d59",
          "activationTime": "2021-07-15T17:54:12Z",
          "dueDate": "2021-07-15T17:54:12Z",
          "reason": "RISK_CONTROLS",
          "creationTime": "2021-07-15T17:54:12Z"
        }
      ],
      "accounts": [
        {
          "currencyCode": "EUR",
          "id": "5029090724",
          "customerId": "123456789",
          "externalId": "a2322550-af91-417f-867e-681efad44b9d",
          "totalBalance": 0,
          "availableBalance": 0,
          "virtualInstruments": [
            {
              "id": "acde070d-8c4c-4f0d-9d8a-162843c10333",
              "instrumentType": "US_BANK_ACCOUNT"
            }
          ],
          "creationTime": "2019-08-24T14:15:22Z"
        }
      ],
      "incompleteAttributes": [
        "OCCUPATION"
      ],
      "preferences": {
        "marketing": {
          "receivePushNotifications": true,
          "receiveMarketingEmails": true,
          "receiveMarketingSms": true,
          "receiveSocialAds": true,
          "receiveTargetedAds": true,
          "receiveThirdPartyAds": true
        },
        "data": {
          "consentForTargetedAds": true,
          "consentForAnalytics": true,
          "consentForPerformanceTracking": true
        }
      },
      "registrationIp": "198.51.100.42",
      "registrationDate": "2024-07-29T15:51:28.071Z",
      "kycInfo": {
        "documentType": "NATIONAL_ID",
        "documentNumber": "123456789"
      }
    }