Skip to main content

Person

Information related to a person.

idstring

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)[]

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

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
Person
{
  "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
}