| merchantUserId |
String |
Y |
Unique identifier of the user on the merchant's platform |
| merchantId |
String |
N |
Your assigned merchant ID in Paymonade |
| firstName |
String |
Y |
First name based on validated KYC information |
| middleName |
String |
N |
Middle name based on validated KYC information |
| lastName |
String |
Y |
Last name based on validated KYC information |
| dateOfBirth |
String |
Y |
Date of birth based on validated KYC information |
| gender |
Int |
Y |
Gender (0 Female, 1 Male, 2 Other) |
| nationality |
String |
Y |
Nationality (ISO 3166-1 Alpha-3 code) based on validated KYC information ( Deprecated ) |
| nationalityIso2 |
String |
Y |
Nationality (ISO 3166-1 Alpha-2 code) based on validated KYC information; Note: After completing the physical switch, please send us this iso2 |
| city |
String |
N |
City (Based on validated PoA if available. Otherwise, the manually input residential city of the user.) |
| postalCode |
String |
N |
Postal Code |
| emailAddress |
String |
Y |
Validated Email address |
| employmentStatus |
String |
N |
Employment Status |
| workIndustry |
String |
N |
Work Industry |
| workCountry |
String |
N |
Employment country (ISO 3166-1 Alpha-2 code) |
| sourceOfIncome |
String |
N |
Source of Income |
| residentCountry |
String |
N |
Resident country (ISO 3166-1 Alpha-3 code). ( Deprecated ) |
| residentCountryIso2 |
String |
Y |
Resident country (ISO 3166-1 Alpha-2 code). Based on validated PoA if available. Otherwise, the manually input residential city of the user. Note: After completing the physical switch, please send us this iso2 |
| residentialAddress |
String |
N |
Residential Address. Based on validated PoA if available. Otherwise, the manually input residential city of the user. |
| customerRiskLevel |
String |
Y |
Customer Risk level |
| customerRiskScore |
String |
Y |
Customer Risk Score |
| Selfie |
String |
Y |
User selfie download url |
| SelfieType |
String |
N |
User selfie type, SELFIE/VIDEO_SELFIE, will be set to SELFIE by default |
| idType |
String |
N |
Type of ID (see enum type definition) |
| idFront |
String |
N |
ID Front (Base64 encoded) ( Deprecated ) |
| idBack |
String |
N |
ID Back (Base64 encoded) ( Deprecated ) |
| idFrontUrl |
String |
N |
ID Front url |
| idBackUrl |
String |
N |
ID Back url |
| walletNetwork |
String |
N |
The network of the user's wallet address, mandatory for BUY_TO_WALLET/BANK_TRANSFER |
| walletAddress |
String |
N |
The user's wallet address, mandatory for BUY_TO_WALLET/BANK_TRANSFER |
| walletMemo |
String |
N |
The user's wallet memo |
| taxResidence |
String |
N |
Country where the user needs to submit tax. (ISO 3166-1 Alpha-2 code) |
| phoneNumber |
String |
N |
User’s phone number without country code |
| phoneCountryCode |
String |
N |
Country code of user’s phone number |
| language |
String |
N |
Language preference (ISO 639-2) |
| poaDocType |
String |
N |
Proof of address document type; Parameter Enumeration : 1: Utility bill (electricity, water, gas, sewerage) , 2: Internet service provider account statement , 3: Landline telephone bill \r\n (mobile bills are not acceptable) , 4: Mortgage statement , 5: Bank or Credit Card Statement , 6: Bank reference letter - stamped and/or signed , 7: Student Rental agreement from university residence or university housing/halls , 8: Letter from a university to confirm student attends and their current residential address , 9: Government issued student grants/loans or bursaries to a current residential address |
| poaDoc |
String |
N |
Validated proof of address document url (Mandatory if poaDoc is provided) |
| expMonthTurnover |
String |
N |
Expected monthly turnover in CHF, 0: less than 5000 CHF, 1: between 5000 and 30000 CHF, 2: more than 30000 CHF |
| acctPurpose |
String |
N |
Purpose of account, 0: personal use, 1: business use |
| tin |
String |
N |
Tax identification number, Mandatory if account purpose is for business use |
| birthCountry |
String |
Y |
Country of birth, (ISO 3166-1 Alpha-2 code) |
| sowDocType |
String |
N |
Source of wealth document type; Parameter Enumeration : 1: Loan proceeds , 2: Inheritance/gift/donation , 3: Retirement , 4: Salary/bonus/income , 5: Legal settlement , 6: Child/spousal support payments , 7: Investment / Dividend Income , 8: Cryptocurrency Mining/ Trading / Staking , 9: Personal Savings , 10: Passive income (rental, interest) , 11: Trust , 12: Sale of Asset |
| sowDoc |
List |
N |
List of source of wealth documents url, Mandatory if sowDoc is provided |
| sow |
List |
N |
Mandatory for Bifinity migration if the user has been triggered EDD, see definition in EddDetail |
| sofDocType |
String |
N |
Source of fund document type;Parameter Enumeration : 1: Loan proceeds , 2: Inheritance/gift/donation , 3: Retirement , 4: Salary/bonus/income , 5: Legal settlement , 6: Child/spousal support payments , 7: Investment / Dividend Income , 8: Cryptocurrency Mining/ Trading / Staking , 9: Personal Savings , 10: Passive income (rental, interest) , 11: Trust , 12: Sale of Asset |
| sofDoc |
List |
N |
List of source of fund documents url |
| sof |
List |
N |
Mandatory for Bifinity migration if the user has been triggered EDD, see definition in EddDetail |
| kycTokenType |
String |
N |
KYC token provider, such as "Sumsub" |
| kycToken |
String |
N |
User’s KYC token |
| entityTag |
String |
N |
NA |
| isFZE |
boolean |
N |
true / false |
| referenceCode |
String |
N |
Reference code of the user on the merchant's platform |
| employerName |
String |
N |
Required if nature of employment is Business Owner or Salaried Employee |
| employerAddress |
String |
N |
Required if nature of employment is Business Owner or Salaried Employee |
| employerCountry |
String |
N |
Required if nature of employment is Business Owner or Salaried Employee |
| romaTncAcceptTime |
Long |
N |
Roma T&C acceptance timestamp in milliseconds since Unix epoch (UTC), e.g. 1629384623000 |
| romaTncAcceptIP |
String |
N |
Roma T&C acceptance IP |
| isBifinity |
Boolean |
N |
true / false |