CustomerPerson
Possible values: <= 20 characters
10040500
Customer identifier used in Partner system.
Possible values: non-empty
and <= 40 characters
af5c8b52-0afd-4799-85ab-fe659a076932
Type of Customer
Possible values: [LEGAL_ENTITY
, PERSON
]
PERSON
PERSON
Primary email address
Possible values: <= 150 characters
john.smith@mail.com
Mobile number
Possible values: <= 50 characters
+12025550120
IPv4 address from which the customer has registered.
Date of registration at the Merchant system
restrictions object[]
Restriction name
Note! The model is deprecated.
Possible values: [ALL_TRANSACTIONS
, OUTGOING_TRANSACTIONS
, INCOMING_TRANSACTIONS
, SEND_MONEY
, CARD_DEPOSITS
, DEPOSITS
, OUTGOING_TRANSACTIONS_AND_CARD_DEPOSITS
, INCOMING_TRANSACTIONS_AND_SEND_MONEY
, BANK_WITHDRAWALS
, WITHDRAWALS
, DEPOSITS_AND_WITHDRAWALS
, INCOMING_TRANSACTIONS_AND_TRANSFERS
, OTHER
]
ALL_TRANSACTIONS
Reason for restricting
Note! The model is deprecated.
Possible values: [ACCOUNT_TAKEOVER_RECEIVER
, ACCOUNT_TAKEOVER_VICTIM
, AUP_VIOLATION
, BLACKLIST
, CHARGEBACK_RECEIVED
, CLOSE_ACCOUNT
, COLLECTIONS_CASE
, COMPLIANCE
, COMPLIANCE_EDD_RESTRICTED
, COMPLIANCE_LIMITS
, COMPLIANCE_PEP
, COMPLIANCE_SANCTIONS
, CONFIRMED_FRAUD
, CUSTOMER_REQUESTED_CLOSURE
, CUSTOMER_REQUESTED_CLOSURE_GAMBLING_PROBLEM
, DEBT_COLLECTION_AGENCY
, DUPLICATE_ACCOUNT_MANUAL
, DUPLICATE_ACCOUNT_SIGNUP
, EDD_TRANSACTION_CHECK
, EXTERNAL_NOTIFICATION
, FRAUD_ACCOUNT_CLOSURE
, INACTIVE_ACCOUNT
, KYC
, KYC_LIMITS
, LIMITS_EXCEEDED
, MERCHANT_REQUEST
, MLRO_LOCK
, NO_SERVICE_COUNTRY
, PAID_TO_DEBT_COLLECTOR
, PURCHASED_ID
, REGULATORY_LOCK
, REPORTED_FRAUD_ISSUER
, REQUEST_CERTIFIED_DOCS
, RETRIEVAL_REQUEST_RECEIVED
, RISK_ENGINE
, SCA
, SUSPECTED_FRAUD
, SUSPECTED_MONEY_LAUNDERING
, T_C_ABUSE
, TERMINATED
, UNDER_18
, UNDER_INVESTIGATION
, WALLET_RECOVERY_PROCEDURE
, OTHER
]
Actions to be completed in order to resolve
Possible values: [ADDRESS_REVERIFICATION
, CONTACT_INVESTIGATIONS_TEAM
, EDD_CASE_REQUIRED
, EDD_CONFIRMATION_REQUIRED
, EXPLANATION_OF_ACTIVITY
, KYC_DOCS_ONLY
, KYC_VERIFICATION
, MANUAL_REVIEW
, PEP_DECLARATION
, PEP_DECLARATION_OCCUPATION_SPOUSE
, PEP_SANCTIONS_ALL_QUESTIONS
, PEP_SANCTIONS_OCCUPATION_SPOUSE
, SUBMIT_AD
, SUBMIT_AD_BANK_STATEMENT
, SUBMIT_AD_COUNCIL_BILL
, SUBMIT_AD_COURT_DOCUMENT
, SUBMIT_AD_CREDIT_CARD_STATEMENT
, SUBMIT_AD_LEASE_TENANT_CONTRACT
, SUBMIT_AD_OTHER
, SUBMIT_AD_PENSION_DOCUMENT
, SUBMIT_AD_SCHOOL_ENROLLMENT_LETTER
, SUBMIT_AD_TAX_RETURN_FORM
, SUBMIT_AD_UTILITY_BILL
, SUBMIT_HOLDING_ID
, SUBMIT_ID
, SUBMIT_ID_DRIVER_LICENSE
, SUBMIT_ID_FACE_VERIFICATION
, SUBMIT_ID_IDENTITY_CARD
, SUBMIT_ID_PASSPORT
, SUBMIT_ID_RESIDENCE_PERMIT
, WAITING_FOR_DOCUMENTS
, WAIT
, NATIONALITY
, OTHER
]
Restriction id
accounts object[]
Accounts associated with this customer.
Account id.
Possible values: <= 20 characters
Possible values: <= 20 characters
5435323362
Possible values: <= 40 characters
Currency alphabetic code as specified by ISO 4217
Possible values: >= 3 characters
and <= 3 characters
EUR
Amount in minor units
Amount in minor units
IBAN associated with this account.
Possible values: <= 20 characters
DKK account number.
Possible values: <= 40 characters
DKK bank code.
Possible values: <= 20 characters
2019-08-24T14:15:22Z
First name. Only latin characters, spaces, single quotes, and hyphens are allowed.
Possible values: <= 50 characters
Last name. Only latin characters, spaces, single quotes, and hyphens are allowed.
Possible values: <= 50 characters
Personal title, Mr., Dr., etc.
Possible values: <= 15 characters
Address line 1.
Possible values: <= 200 characters
Address line 2.
Possible values: <= 200 characters
City of residence.
Possible values: <= 100 characters
Postal code.
Possible values: <= 30 characters
US state postal abbreviation. Not used for non US territories.
Possible values: <= 2 characters
ISO-3166 Alpha 2
Possible values: >= 2 characters
and <= 2 characters
GB
Birth date in YYYY-MM-DD format.
ISO-3166 Alpha 2
Possible values: >= 2 characters
and <= 2 characters
GB
kyc object
KYC Status enumeration
Possible values: [COMPLETED
, IN_PROGRESS
, NOT_COMPLETED
]
idVerification object
Possible values: [COMPLETED
, NOT_COMPLETED
, IN_PROGRESS
]
Name of the vendor that performed the electronic verification
Possible values: <= 50 characters
addressVerification object
Possible values: [COMPLETED
, NOT_COMPLETED
, IN_PROGRESS
]
Name of the vendor that performed the electronic verification
Possible values: <= 50 characters
faceMatch object
Possible values: [COMPLETED
, NOT_COMPLETED
, IN_PROGRESS
]
Name of the vendor that performed the electronic verification
Possible values: <= 50 characters
EDD object
Possible values: [COMPLETED
, NOT_COMPLETED
, IN_PROGRESS
]
Name of the vendor that performed the electronic verification
Possible values: <= 50 characters
Possible values: [BANK_STATEMENT
, CREDIT_CARD_STATEMENT
, UTILITY_BILL
, CREDIT_CARD
, PHONE_BILL
, TAX_RETURN
, COUNCIL_BILL
, SCHOOL_ENROLLMENT_LETTER
, COURT_DOCUMENT
, PENSION_DOCUMENT
, LEASE_TENANT_CONTRACT
, OTHER_AV_DOCUMENT
, CUSTOM_AV_DOCUMENT
]
pep object
Possible values: [NO_MATCH
, MATCH
, NOT_SCREENED
, RESOLVED
, DISMISSED
, IN_PROGRESS
]
sanctions object
Possible values: [NO_MATCH
, MATCH
, NOT_SCREENED
, RESOLVED
, DISMISSED
, IN_PROGRESS
]
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
]
ARCHITECTURE_CARTOGRAPHY_SURVEYOR
List of vulnerabilities
Possible values: [PHYSICAL_DISABILITY
, LOW_MENTAL_CAPACITY
, GAMBLING_ADDICTION
, FINANCE_MISMANAGEMENT
, POOR_LITERACY
, POOR_LANGUAGE_SKILLS
, POOR_DIGITAL_SKILLS
, CARING_RESPONSIBILITIES
, FRAUDULENT_LOCATION
]
additionalAttributes object
List of additional attributes not covered in standard list. Specifics need to be aligned during integration with Paysafe.
{
"id": "10040500",
"externalId": "af5c8b52-0afd-4799-85ab-fe659a076932",
"type": "PERSON",
"email": "john.smith@mail.com",
"mobile": "+12025550120",
"registrationIp": "198.51.100.42",
"registrationDate": "2024-07-29T15:51:28.071Z",
"restrictions": [
{
"name": "ALL_TRANSACTIONS",
"reason": "ACCOUNT_TAKEOVER_RECEIVER",
"requiredActions": [
"ADDRESS_REVERIFICATION"
],
"lastChangeDate": "2021-07-15T17:54:12Z",
"id": "string",
"activationTime": "2021-07-15T17:54:12Z",
"dueDate": "2021-07-15T17:54:12Z"
}
],
"accounts": [
{
"id": "string",
"customerId": "5435323362",
"externalId": "string",
"currencyCode": "EUR",
"totalBalance": 0,
"availableBalance": 0,
"iban": "string",
"bic": "string",
"accountNumber": "string",
"bankCode": "string",
"creationTime": "2019-08-24T14:15:22Z",
"hasIban": true
}
],
"firstName": "string",
"lastName": "string",
"title": "string",
"address1": "string",
"address2": "string",
"city": "string",
"zip": "string",
"state": "string",
"countryCode": "GB",
"birthDate": "2024-07-29",
"nationality": "GB",
"kyc": {
"status": "COMPLETED",
"idVerification": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"addressVerification": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"faceMatch": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"EDD": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"addressVerificationDocumentsReceived": [
"BANK_STATEMENT"
],
"pep": {
"status": "NO_MATCH",
"lastScreenDate": "2024-07-29T15:51:28.071Z",
"reason": "string"
},
"sanctions": {
"status": "NO_MATCH",
"lastScreenDate": "2024-07-29T15:51:28.071Z",
"reason": "string"
}
},
"occupation": "ARCHITECTURE_CARTOGRAPHY_SURVEYOR",
"vulnerabilities": [
"PHYSICAL_DISABILITY"
],
"additionalAttributes": {}
}