1. KYB Sharing V2
- Introduction: this interface can be used to share your user's KYB information to Paymonade, after receiving the KYB
information, we will move forward with the registration and KYB verification process for the user.
- Endpoint: /v2/kyc/kyb-sharing
- Method: POST
- Request
| Field Name |
Type |
Required |
Description |
| merchantUserId |
String |
Y |
Unique identifier of the user on the merchant's platform |
| email |
String |
N |
Business email address |
| basicData |
CompanyBasicData |
Y |
Company Basic Data |
| website |
String |
N |
Company Website |
| phoneNumber |
String |
N |
Company PhoneNumber |
| publicStockExchange |
Boolean |
N |
Is it a public stock exchange? |
| additionalData |
CompanyAdditionalData |
N |
Company Additional Data |
| documents |
Array of KybDocument |
N |
Company Documents |
| ibos |
Array of CompanyBasicData |
N |
Intermediate beneficial owner(non-natural persons with a minimum 25% of shares or voting rights or have other control over the company) |
| ubos |
Array of IndividualDetail |
N |
Ultimate beneficial owner(natural persons holding minimum 25% of shares or voting rights or have other control over the company) |
| directors |
Array of IndividualDetail |
N |
Management (directors/members of the governing board, third party authorized representatives) |
| authorizedTraders |
Array of IndividualDetail |
N |
Authorized traders will be obliged to undergo ID document and biometric + liveness check verification, invitation for the process in Sumsub/equivalent vendor will be sent to business email address |
| cryptoAddresses |
Array of CryptoWalletAddress |
N |
Company crypto wallet addresses |
| Field Name |
Type |
Required |
Description |
| jurisdiction |
String |
Y |
Jurisdiction |
| companyName |
String |
N |
Company Name |
| tradingName |
String |
N |
Trading Name |
| companyRegistrationNumber |
String |
Y |
Company Registration Number |
| userTier |
String |
N |
user tier |
| legalEntityType |
String |
N |
Legal Entity Type |
| dateOfIncorporation |
String |
N |
Date of incorporation |
| registeredOfficeAddress |
Array of AddressDetail |
N |
Registered office address |
| businessAddress |
Array of AddressDetail |
N |
Business address |
| businessOperationCountry |
Array of String |
N |
Locations of business operations |
| Field Name |
Type |
Required |
Description |
| country |
String |
N |
Country code in 2 letters |
| state |
String |
N |
State or province |
| city |
String |
N |
City name |
| postalCode |
String |
N |
Postal code |
| line1 |
String |
N |
Address line1 |
| line2 |
String |
N |
Address line2 |
| line3 |
String |
N |
Address line3 |
| Field Name |
Type |
Required |
Description |
| mainBusinessActivities |
Array of String |
N |
Main business activities |
| industry |
Array of String |
N |
Industry of company |
| taxId |
String |
N |
TAX ID of company |
| sourceOfFunds |
Array of String |
N |
Company’s source of funds |
| sourceOfWealth |
Array of String |
N |
Company's source of wealth (if coming from beneficial owner(s)) |
| expectedMonthlyTradingVolume |
String |
N |
Expected monthly trading volume in EUR(example:20000) |
| listed |
Boolean |
N |
True if listed in stock exchange |
| Field Name |
Type |
Required |
Description |
| docType |
String |
N |
Articles of Association/Company register/Certificate of Incorporation/Memorandum/Equivalent/Financial Statements/Financial Report /ID/Power of Attorney/Source of wealth/Source of funds |
| name |
String |
N |
File Name |
| attachmentType |
String |
N |
back / front (docType=ID); main (docType!=ID) |
| docImage |
String |
N |
Base64 encoded image, is required when docUrl is absent |
| docUrl |
String |
N |
url, is required when docImage is absent
|
| Field Name |
Type |
Required |
Description |
| email |
String |
N |
Email |
| firstName |
String |
N |
First name |
| middleName |
String |
N |
Middle name |
| lastName |
String |
N |
Last name |
| dateOfBirth |
String |
N |
Date of birth |
| countryOfBirth |
String |
N |
Country of birth |
| nationality |
String |
N |
Nationality |
| pesel |
String |
N |
For Polish citizens only |
| percentageOfOwnership |
String |
N |
Percentage of ownership |
| residentialAddress |
AddressDetail |
N |
Residential address |
| documents |
Array of KycDocument |
N |
individual's ID |
| Field Name |
Type |
Required |
Description |
| docType |
String |
N |
see KYC Document Type |
| name |
String |
N |
File Name |
| attachmentType |
String |
N |
back / front (docType=ID); main (docType!=ID) |
| docImage |
String |
N |
Base64 encoded image, is required when docUrl is absent |
| docUrl |
String |
N |
url, is required when docImage is absent |
| Field Name |
Type |
Required |
Description |
| network |
String |
N |
Crypto network |
| address |
String |
N |
Wallet address |
| cryptoCurrency |
String |
N |
USDT,USDC,EURI.... |
| tag |
String |
N |
Open network (TON) like talegram requires additional fields (also called Memo, Note, Remark, comment.....) |
| Field Name |
Type |
Description |
| status |
String |
Status data of api request results |
| msg |
String |
Error info while status is not 200 |
| data |
Object |
Response data |
| traceId |
String |
traceId |
{
"merchantUserId": "your user id",
"email": "[email protected]",
"basicData": {
"jurisdiction": "PL",
"companyName": "ABC Pte. Ltd.",
"tradingName": "ABC Tech",
"companyRegistrationNumber": "S121212AN",
"businessOperationCountry": [
"PL",
"FR",
"UK"
],
"legalEntityType": "Corporation",
"registeredOfficeAddress": [
{
"country": "PL",
"city": "Warsaw",
"state": "",
"postalCode": "121212",
"line1": "Krakowskie Przedmiescie",
"line2": "15/17 00-071",
"line3": ""
}
],
"businessAddress": [
{
"country": "FR",
"city": "Paris",
"state": "",
"postalCode": "75014",
"line1": "14 rue Delambre",
"line2": "",
"line3": ""
}
],
"dateOfIncorporation": "2001-06-01"
},
"additionalData": {
"mainBusinessActivities": [
"Facility Management",
"Crypto Trading",
"Fiat Exchange Service"
],
"industry": [
"Fintech",
"Facility Management"
],
"taxId": "PK121313",
"listed": "true",
"sourceOfFunds": [
"Business operations",
"Mortage"
],
"sourceOfWealth": [
"Business operations",
"Mortage"
],
"expectedMonthlyTradingVolume": "5000000"
},
"documents": [
{
"docType": "Incorporation Details",
"name": "aaa.pdf",
"attachmentType": "main",
"docImage": ""
}
],
"directors": [
{
"firstName": "John",
"middleName": "Joe",
"lastName": "Doe",
"dateOfBirth": "1989-01-01",
"nationality": "PL",
"countryOfBirth": "PL",
"documents": [
{
"docType": "Incorporation Details",
"name": "aaa.pdf",
"attachmentType": "main",
"docImage": ""
}
],
"pesel": "12121212"
}
],
"ibos": [
{
"jurisdiction": "PL",
"companyName": "XYZ Pte. Ltd.",
"tradingName": "XYZ Holdings",
"companyRegistrationNumber": "C989831D",
"legalEntityType": "Corporation",
"registeredOfficeAddress": [
{
"country": "PL",
"city": "Jajawice",
"state": "",
"postalCode": "01-213",
"line1": "Ul. Kurza £apa 9/13",
"line2": "",
"line3": ""
}
],
"businessAddress": [
{
"country": "PL",
"city": "Jajawice",
"state": "",
"postalCode": "01-213",
"line1": "Ul. Kurza £apa 9/13",
"line2": "",
"line3": ""
}
],
"dateOfIncorporation": "1990-02-04"
}
],
"ubos": [
{
"firstName": "Happy",
"middleName": "Mel",
"lastName": "Ng",
"dateOfBirth": "1978-03-08",
"nationality": "US",
"countryOfBirth": "CN",
"pesel": "",
"documents": [
{
"docType": "ID",
"name": "aaa.png",
"attachmentType": "front",
"docImage": ""
},
{
"docType": "ID",
"name": "aaa.png",
"attachmentType": "back",
"docImage": ""
}
],
"residentialAddress": {
"country": "CN",
"city": "Chengdu",
"state": "Sichuan",
"postalCode": "610000",
"line1": "23 Cheng Hua Road",
"line2": "#39-12",
"line3": ""
},
"percentageOfOwnership": "40%"
}
],
"authorizedTraders": [
{
"firstName": "More",
"middleName": "",
"lastName": "King",
"emailAddress": "[email protected]"
}
],
"cryptoAddress": [
{
"network": "BNB",
"address": "1Lbcfr7sAHTD9CgdQo3HTMTkV8LK4ZnX71"
}
]
}
{
"status": 200,
"msg": "OK",
"data": null,
"traceId": "77ec4eeb-86ea-42e3-97f2-e5ff1c81e7fc"
}