1. 2.1 Merchant Onboarding
EurewaX Open API
  • Basic Conventions
    • Global Conventions
    • Message Structure
    • Signature
    • Encryption
  • Interaction Flow
    • Business Application Flow
  • Business APIs
    • 1 Common Services
      • 1.1 Event Notifications
        • Configure NotificationURL
      • 1.2 File Service
        • Upload File
        • supplementary business Document
      • 1.3 Authentication Service
        • Get Merchant Token
    • 2 Onboarding Services
      • 2.1 Merchant Onboarding
        • Register Merchant
          POST
        • KYCApply for
          POST
        • KYBApply for
          POST
        • Query KYCReview Result
          POST
        • KYCReview ResultNotification
        • Query KYBReview Result
          POST
        • KYBReview ResultNotification
        • Get can open through Product List
          GET
    • 3 Fiat Services
      • 3.1 Collection Services
        • 3.1.1 Collection Store Management
          • Get Platform Site
          • Add Store Owner
          • Bind Store
          • Query Store Information
        • 3.1.2 VA Account Services
          • Apply for VAAccount Number
          • Download Account OpeningCertificate
          • Query VAAccount Number
          • VAAccount NumberChange Notification
        • 3.1.3 Collection Transaction Processing
          • Collection Crediting Notification
      • 3.2 Payment Services
        • 3.2.1 Payee Management
          • Add Payee
          • Delete Payee
          • Query Payee Review Result
          • Payee Review ResultNotification
        • 3.2.2 Payment Transaction Processing
          • Single Payment
          • Payment ResultNotification
        • 3.2.3 Settlement Quota Management
          • Query FX Settlement Quota
          • Upload FX Settlement Document
          • Query FX Settlement Document Review Result
          • FX Settlement Document Review ResultNotification
      • 3.3 Foreign Exchange Services
        • Query Merchant Exchange Rate
        • Merchant FX Quote
        • Real-time FX
      • 3.4 Account Services
        • 3.4.1 Account Management
          • Account Query
          • Account Authorization
          • Cancel authorization
        • 3.4.2 Account Transactions
          • Account Transfer
          • Batch Transfer
          • Funds Pooling
          • Funds PoolingResultNotification
          • Batch TransferResultNotification
          • Per-transaction TransferResultNotification
      • 3.5 Transaction Queries
        • 3.5.1 Transaction Details
          • Funds PoolingTransaction Details
          • Payment Transaction Details
          • Collection Transaction Details
          • TransferTransaction Details
          • FX Exchange Transaction Details
        • Download Transaction Certificate
        • Query Transaction Details
    • 4 Crypto Services
      • 4.1 Basic Functions
        • Query Exchange Rate
        • Query Supported of asset
      • 4.2 Account Management
        • Query Account List
      • 4.3 Collection Instrument Management
        • Query Collection Instrument
      • 4.4 Payee Management
        • Add Payee
        • Delete Payee
        • Query Payee List
        • Payee Review ResultNotification
      • 4.5 Transaction Management
        • Fiat Deposit
          • Fiat Deposit
        • Fiat Withdrawal
          • Fiat Withdrawal
        • Crypto Deposit
          • Crypto Deposit
        • Crypto Withdrawal
          • Crypto Withdrawal
        • Crypto Buy
          • Get Crypto Buy Quote
          • Buy Crypto
        • Crypto Sell
          • Get Crypto Sell Quote
          • Sell Crypto
        • Fiat convert Crypto
          • Get fiat-to-cryptoQuote
          • Fiat convert Crypto
        • Crypto convert Fiat
          • Get crypto-to-fiatQuote
          • Crypto convert Fiat
        • Deposit/WithdrawalTransaction Fee estimate
        • Query Transaction Details
        • Query Transaction record
        • Transaction ResultNotification
    • 5 VCC Services
      • 5.1 Card Application Services
        • Query Product List
        • Virtual Card Apply for
        • Query Apply for Details
        • Card Apply for ResultNotification
      • 5.2 Card Information Query Services
        • Query Card CVV
        • Query Card Information
        • Query Card Balance
      • 5.3 Card Management Services
        • Unfreeze Card
        • Activate Card
        • Cancel Card
        • Freeze Card
        • Update Card Limit
        • Update Cardholder
        • Card StatusChange Notification
      • 5.4 Card Transaction Services
        • Funds Transfer In
        • Funds Transfer Out
        • Query non-authorization Transaction Details
        • Query Transaction List
        • Query Card Funds Details
        • Card Transaction ResultNotification
        • Card 3DSVerificationNotification
    • 6 Unified Checkout
      • Create Order
      • Query Order Details
      • Payment ResultNotification
  • Integration Testing
    • Overall Flow
    • Environment Parameters
  • Appendix
    • Enum Type
    • KYCtemplate
    • KYBtemplate
  • Schemas
    • TransferOrder
  1. 2.1 Merchant Onboarding

KYCApply for

POST
/api/v1/ex/onboarding/merchant/kyc
Submit the merchant's KYC information and documents. Subsequent operations are available only after KYC approval; otherwise, business requests cannot be initiated. Upload files and image attachments through the Upload File API.

Request

Header Params

Body Params application/json

Example
{
    "merchantNo": "26012119710608",
    "bizOrderNo": "3bbb8881227",
    "bizType": "B2B",
    "kycData": 
    {
    "entityLegalDtos": {
        "director1": [
            {
                "meterialName": "Please select your role",
                "meterialValue": "director",
                "meterialCode": "legalType"
            },
            {
                "meterialName": "ID Document issued Country or region",
                "meterialValue": "CN",
                "meterialCode": "country"
            },
            {
                "meterialName": "ID Document Type",
                "meterialValue": "idCard",
                "meterialCode": "certType"
            },
            {
                "meterialName": "VerificationMethod",
                "meterialValue": "idCardHoldAuth",
                "meterialCode": "certificationType"
            },
            {
                "meterialName": "National ID Cardfront photo",
                "meterialValue": "",
                "meterialCode": "id_card_front",
                "kycEntityAttachmentDto": [
                    {
                        "fileName": "zhang_san_front.jpg",
                        "type": "id_card_front",
                        "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                        "isMerchantOriginal": "Y",
                        "name": "National ID Cardfront photo",
                        "location": "/unified/account/createAccount",
                        "category": "legal"
                    }
                ]
            },
            {
                "meterialName": "National ID Cardback photo",
                "meterialValue": "",
                "meterialCode": "id_card_back",
                "kycEntityAttachmentDto": [
                    {
                        "fileName": "zhang_san_back.jpg",
                        "type": "id_card_back",
                        "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                        "isMerchantOriginal": "Y",
                        "name": "National ID Cardback photo",
                        "location": "/unified/account/createAccount",
                        "category": "legal"
                    }
                ]
            },
            {
                "meterialName": "National ID CardNumber",
                "meterialValue": "110101199022026434",
                "meterialCode": "idCardNo"
            },
            {
                "meterialName": "Family NameGiven Name",
                "meterialValue": "Zhang San11",
                "meterialCode": "fullName"
            },
            {
                "meterialName": "Date of BirthDate",
                "meterialValue": "1990-01-01",
                "meterialCode": "birthday"
            },
            {
                "meterialName": "ID Document Validity PeriodStart Time",
                "meterialValue": "2015-01-01",
                "meterialCode": "certExpirationBegin"
            },
            {
                "meterialName": "ID Document Validity PeriodEnd Time",
                "meterialValue": "2035-01-01",
                "meterialCode": "certExpirationEnd"
            },
            {
                "meterialName": "photo of the director holding the ID document",
                "meterialValue": "",
                "meterialCode": "directorHandheldPhoto",
                "kycEntityAttachmentDto": [
                    {
                        "fileName": "zhang_san_hold.jpg",
                        "type": "directorHandheldPhoto",
                        "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                        "isMerchantOriginal": "Y",
                        "name": "photo of the director holding the ID document",
                        "location": "/unified/account/createAccount",
                        "category": "legal"
                    }
                ]
            },
	    {
                "display": "IMAGES",
                "meterialCode": "addressCertificate",
                "meterialName": "Addressproof(the last three months), that is, Bank statement, utility bill, or any government-issued letter",
                "kycEntityAttachmentDto": [
                    {
                        "location": "/unified/account/createAccount",
                        "fileName": "f6784d63654ddbf8f975aa02f2718c1b.jpg",
                        "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                        "previewUrl": "",
                        "name": "f6784d63654ddbf8f975aa02f2718c1b.jpg",
                        "isMerchantOriginal": "Y",
                        "type": "addressCertificate"
                    }
                ]
            },
            {
                "meterialName": "Director Residential Address",
                "meterialValue": "Beijing CityChaoyang District, Wangjing Street  1  Number",
                "meterialCode": "detailAddress"
            },
            {
                "display": "TEXT",
                "meterialCode": "Nationality",
                "meterialName": "Nationality",
                "meterialValue": "China"
            },
            {
                "meterialName": "at the same time YesUltimate Beneficial Owner",
                "meterialValue": "N",
                "meterialCode": "sameAsUbo"
            }
        ],
        "UBO1": [
            {
                "meterialName": "ID Document issued Country or region",
                "meterialValue": "CN",
                "meterialCode": "country"
            },
            {
                "meterialName": "ID Document Type",
                "meterialValue": "idCard",
                "meterialCode": "certType"
            },
            {
                "meterialName": "National ID Cardfront photo",
                "meterialValue": "",
                "meterialCode": "id_card_front",
                "kycEntityAttachmentDto": [
                    {
                        "fileName": "wang_wu_front.jpg",
                        "type": "id_card_front",
                        "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                        "isMerchantOriginal": "Y",
                        "name": "National ID Cardfront photo",
                        "location": "/unified/account/createAccount",
                        "category": "legal"
                    }
                ]
            },
            {
                "meterialName": "National ID Cardback photo",
                "meterialValue": "",
                "meterialCode": "id_card_back",
                "kycEntityAttachmentDto": [
                    {
                        "fileName": "wang_wu_back.jpg",
                        "type": "id_card_back",
                        "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                        "isMerchantOriginal": "Y",
                        "name": "National ID Cardback photo",
                        "location": "/unified/account/createAccount",
                        "category": "legal"
                    }
                ]
            }, 
	    {
                "meterialName": "photo of the beneficiary holding the ID document",
                "meterialValue": "",
                "meterialCode": "directorHandheldPhoto",
                "kycEntityAttachmentDto": [
                    {
                        "fileName": "zhang_san_hold.jpg",
                        "type": "directorHandheldPhoto",
                        "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                        "isMerchantOriginal": "Y",
                        "name": "photo of the beneficiary holding the ID document",
                        "location": "/unified/account/createAccount",
                        "category": "legal"
                    }
                ]
            },
	    {
                "display": "IMAGES",
                "meterialCode": "addressCertificate",
                "meterialName": "Addressproof(the last three months), that is, Bank statement, utility bill, or any government-issued letter",
                "kycEntityAttachmentDto": [
                    {
                        "location": "/unified/account/createAccount",
                        "fileName": "f6784d63654ddbf8f975aa02f2718c1b.jpg",
                        "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                        "previewUrl": "",
                        "name": "f6784d63654ddbf8f975aa02f2718c1b.jpg",
                        "isMerchantOriginal": "Y",
                        "type": "addressCertificate"
                    }
                ]
            },
            {
                "meterialName": "National ID CardNumber",
                "meterialValue": "310101199313035456",
                "meterialCode": "idCardNo"
            },
            {
                "meterialName": "Family NameGiven Name",
                "meterialValue": "Wang Wu",
                "meterialCode": "fullName"
            },
            {
                "meterialName": "Date of BirthDate",
                "meterialValue": "1990-01-01",
                "meterialCode": "birthday"
            },
            {
                "meterialName": "ID Document Validity PeriodStart Time",
                "meterialValue": "2015-01-01",
                "meterialCode": "certExpirationBegin"
            },
            {
                "meterialName": "ID Document Validity PeriodEnd Time",
                "meterialValue": "2035-01-01",
                "meterialCode": "certExpirationEnd"
            },
	    {
                "meterialName": "Residential Address",
                "meterialValue": "Beijing CityChaoyang District, Wangjing Street  1  Number",
                "meterialCode": "detailAddress"
            },
            {
                "display": "TEXT",
                "meterialCode": "Nationality",
                "meterialName": "Nationality",
                "meterialValue": "China"
            }
        ]
    },
    "entityDynamicDtoList": [
        {
            "meterialName": "Entity Country/Region",
            "meterialValue": "HK",
            "meterialCode": "countryCode"
        },
        {
            "meterialName": "Entity Type",
            "meterialValue": "enterprise",
            "meterialCode": "entityType"
        },
        {
            "meterialName": "CompanyRegister certificate",
            "meterialValue": "",
            "meterialCode": "incorporation_certificate",
            "kycEntityAttachmentDto": [
                {
                    "fileName": "inc.png",
                    "type": "incorporation_certificate",
                    "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                    "isMerchantOriginal": "Y",
                    "name": "CompanyRegister certificate",
                    "location": "/unified/account/createAccount",
                    "category": "entity"
                }
            ]
        },
        {
            "meterialName": "Business Registration Certificate",
            "meterialValue": "",
            "meterialCode": "business_register_certificate",
            "kycEntityAttachmentDto": [
                {
                    "fileName": "br.png",
                    "type": "business_register_certificate",
                    "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                    "isMerchantOriginal": "Y",
                    "name": "Business Registration Certificate",
                    "location": "/unified/account/createAccount",
                    "category": "entity"
                }
            ]
        },
        {
            "meterialName": "Incorporation Form (NNC1)",
            "meterialValue": "",
            "meterialCode": "NNC1",
            "kycEntityAttachmentDto": [
                {
                    "fileName": "nnc1.png",
                    "type": "NNC1",
                    "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                    "isMerchantOriginal": "Y",
                    "name": "Incorporation Form (NNC1)",
                    "location": "/unified/account/createAccount",
                    "category": "entity"
                }
            ]
        },
        {
            "meterialName": "Annual Return (NAR1)",
            "meterialValue": "",
            "meterialCode": "NAR1",
            "kycEntityAttachmentDto": [
                {
                    "fileName": "nar1.png",
                    "type": "NAR1",
                    "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                    "isMerchantOriginal": "Y",
                    "name": "Annual Return (NAR1)",
                    "location": "/unified/account/createAccount",
                    "category": "entity"
                }
            ]
        },
        {
            "meterialName": "ID Document Number",
            "meterialValue": "12345665673000121",
            "meterialCode": "certificateNumber"
        },
        {
            "meterialName": "Enterprise Name",
            "meterialValue": "BB Tech",
            "meterialCode": "companyName"
        },
        {
            "meterialName": "EnterpriseEnglish Name",
            "meterialValue": "BB & Partners (UK) Ltd.",
            "meterialCode": "companyNameEn"
        },
        {
            "meterialName": "EnterpriseBusiness Address",
            "meterialValue": "Hong Kong  in Central Queen's after Road  in  99  Number",
            "meterialCode": "businessAddress"
        },
	{
            "meterialName": "EnterpriseRegister Date",
            "meterialValue": "2025-01-01",
            "meterialCode": "registrationDate"
        },
        {
            "meterialName": "EnterpriseNumber of Employees",
            "meterialValue": "50-100 people",
            "meterialCode": "enterpriseScale"
        },
        {
            "meterialName": "Company Revenue Source  (used to sustain company operationsFunds Source channel and Method)",
            "meterialValue": "Operating Revenue",
            "meterialCode": "sourceFunds"
        },
        {
            "meterialName": "Company Revenue Source DetailsDescription",
            "meterialValue": "Primary Funds Source is software subscriptions and Technical Servicesfee",
            "meterialCode": "description_sourceFunds"
        }
    ],
      "entitykybDtos": [
        {
            "display": "select",
            "displayOrder": 0,
            "explainText": "",
            "imgExplainUrl": "",
            "materialGroup": "",
            "meterialCode": "b2bMcc",
            "meterialId": "",
            "meterialName": "Business Domain",
            "meterialValue": "goods",
            "mpDisplay": "Y",
            "mpRequired": "Y",
            "nextMeterialCode": "",
            "noInputText": "",
            "opDisplay": "N",
            "opRequired": "N"
        },
	{
            "display": "select",
            "displayOrder": 0,
            "explainText": "",
            "imgExplainUrl": "",
            "materialGroup": "",
            "meterialCode": "industry",
            "meterialId": "",
            "meterialName": "industryType",
            "meterialValue": "Education",
            "mpDisplay": "Y",
            "mpRequired": "Y",
            "nextMeterialCode": "",
            "noInputText": "",
            "opDisplay": "N",
            "opRequired": "N"
        },
        {
            "display": "select",
            "displayOrder": 1,
            "explainText": "",
            "imgExplainUrl": "",
            "materialGroup": "",
            "meterialCode": "hasSite",
            "meterialId": "",
            "meterialName": "Whether has official website",
            "meterialValue": "",
            "mpDisplay": "Y",
            "mpRequired": "Y",
            "nextMeterialCode": "",
            "noInputText": "",
            "opDisplay": "N",
            "opRequired": "N"
        },
        {
            "display": "select",
            "displayOrder": 2,
            "explainText": "",
            "imgExplainUrl": "",
            "materialGroup": "",
            "meterialCode": "siteType",
            "meterialId": "",
            "meterialName": "network siteType",
            "meterialValue": "",
            "mpDisplay": "Y",
            "mpRequired": "Y",
            "nextMeterialCode": "",
            "noInputText": "",
            "opDisplay": "N",
            "opRequired": "N"
        },
        {
            "cascadeCategoryKey": "",
            "display": "TEXT",
            "displayOrder": 3,
            "explainText": "",
            "imgExplainUrl": "",
            "materialGroup": "",
            "meterialCode": "storeUrl",
            "meterialId": "",
            "meterialName": "Store URL",
            "meterialValue": "https://bbss.com",
            "mpDisplay": "Y",
            "mpRequired": "Y",
            "nextMeterialCode": "",
            "noInputText": "",
            "opDisplay": "N",
            "opRequired": "N"
        },
        {
            "display": "multi select",
            "displayOrder": 2,
            "explainText": "",
            "imgExplainUrl": "",
            "materialGroup": "",
            "meterialCode": "relateCountries",
            "meterialId": "",
            "meterialName": "Related Country",
            "meterialValue": "",
            "mpDisplay": "Y",
            "mpRequired": "Y",
            "nextMeterialCode": "",
            "noInputText": "",
            "opDisplay": "N",
            "opRequired": "N"
        },
        {
            "cascadeCategoryKey": "",
            "display": "TEXT",
            "displayOrder": 4,
            "explainText": "",
            "imgExplainUrl": "",
            "materialGroup": "",
            "meterialCode": "exportTypeDesc",
            "meterialId": "",
            "meterialName": "Related Product productcategory",
            "meterialValue": "Asada when code",
            "mpDisplay": "Y",
            "mpRequired": "Y",
            "nextMeterialCode": "",
            "noInputText": "",
            "opDisplay": "N",
            "opRequired": "N"
        },
        {
            "display": "select",
            "displayOrder": 5,
            "explainText": "",
            "imgExplainUrl": "",
            "materialGroup": "",
            "meterialCode": "expectAmount",
            "meterialId": "",
            "meterialName": "Estimated in iPayLinks of monthTransaction amount (US Dollar)",
            "meterialValue": "100000",
            "mpDisplay": "Y",
            "mpRequired": "Y",
            "nextMeterialCode": "",
            "noInputText": "",
            "opDisplay": "N",
            "opRequired": "N"
        },
        {
            "display": "select",
            "displayOrder": 6,
            "explainText": "",
            "imgExplainUrl": "",
            "materialGroup": "",
            "meterialCode": "monthExpectedTranNum",
            "meterialId": "",
            "meterialName": "Estimated in iPayLinks of monthTransaction transactiondigit",
            "meterialValue": "111",
            "mpDisplay": "Y",
            "mpRequired": "Y",
            "nextMeterialCode": "",
            "noInputText": "",
            "opDisplay": "N",
            "opRequired": "N"
        },
        {
            "cascadeCategoryKey": "",
            "display": "attachmentMix",
            "displayOrder": 7,
            "explainText": "",
            "imgExplainUrl": "",
            "kycEntityAttachmentDto": [
                {
                    "category": "kyb",
                    "fileName": "",
                    "isMerchantOriginal": "Y",
                    "location": "",
                    "name": "additional documents",
                    "previewUrl": "",
                    "type": "additionalInformation",
                    "url": ""
                }
            ],
            "materialGroup": "",
            "meterialCode": "additionalInformation",
            "meterialId": "",
            "meterialName": "additional documents",
            "meterialValue": "",
            "mpDisplay": "Y",
            "mpRequired": "N",
            "nextMeterialCode": "",
            "noInputText": "",
            "opDisplay": "N",
            "opRequired": "N"
        }
    ],
    "fundInInfos":[
	{
	    "meterialCode": "sourceOfFunds",
            "meterialName": "Funds Source ",
            "meterialValue": "otc"
	},
	{
	    "meterialCode": "sourceOfFundsProof",
            "meterialName": "Funds Source proof",
            "meterialValue": "",
	    "kycEntityAttachmentDto": [
                {
                    "fileName": "ceshi.jpg",
                    "location": "",
                    "name": "Funds Source proof",
                    "previewUrl": "",
                    "type": "sourceOfFundsProof",
                    "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3"
                }
            ]
	},
	{
	    "meterialCode": "purposeOfFunds",
            "meterialName": "Funds Purpose",
            "meterialValue": "SupplierPayment"
	},
	{
	"meterialCode": "purposeOfFundsProof",
            "meterialName": "Funds Purposeproof",
            "meterialValue": "",
	    "kycEntityAttachmentDto": [
                {
                    "category": "kyb",
                    "fileName": "ceshi1.jpg",
                    "location": "",
                    "name": "Funds Purposeproof",
                    "previewUrl": "",
                    "type": "purposeOfFundsProof",
                    "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3"
                }
            ]
	}
    ]
}
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/ex/onboarding/merchant/kyc' \
--header 'x-app-id;' \
--header 'x-request-id;' \
--header 'x-signature;' \
--header 'Content-Type: application/json' \
--data '{
    "merchantNo": "26012119710608",
    "bizOrderNo": "3bbb8881227",
    "bizType": "B2B",
    "kycData": 
    {
    "entityLegalDtos": {
        "director1": [
            {
                "meterialName": "Please select your role",
                "meterialValue": "director",
                "meterialCode": "legalType"
            },
            {
                "meterialName": "ID Document issued Country or region",
                "meterialValue": "CN",
                "meterialCode": "country"
            },
            {
                "meterialName": "ID Document Type",
                "meterialValue": "idCard",
                "meterialCode": "certType"
            },
            {
                "meterialName": "VerificationMethod",
                "meterialValue": "idCardHoldAuth",
                "meterialCode": "certificationType"
            },
            {
                "meterialName": "National ID Cardfront photo",
                "meterialValue": "",
                "meterialCode": "id_card_front",
                "kycEntityAttachmentDto": [
                    {
                        "fileName": "zhang_san_front.jpg",
                        "type": "id_card_front",
                        "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                        "isMerchantOriginal": "Y",
                        "name": "National ID Cardfront photo",
                        "location": "/unified/account/createAccount",
                        "category": "legal"
                    }
                ]
            },
            {
                "meterialName": "National ID Cardback photo",
                "meterialValue": "",
                "meterialCode": "id_card_back",
                "kycEntityAttachmentDto": [
                    {
                        "fileName": "zhang_san_back.jpg",
                        "type": "id_card_back",
                        "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                        "isMerchantOriginal": "Y",
                        "name": "National ID Cardback photo",
                        "location": "/unified/account/createAccount",
                        "category": "legal"
                    }
                ]
            },
            {
                "meterialName": "National ID CardNumber",
                "meterialValue": "110101199022026434",
                "meterialCode": "idCardNo"
            },
            {
                "meterialName": "Family NameGiven Name",
                "meterialValue": "Zhang San11",
                "meterialCode": "fullName"
            },
            {
                "meterialName": "Date of BirthDate",
                "meterialValue": "1990-01-01",
                "meterialCode": "birthday"
            },
            {
                "meterialName": "ID Document Validity PeriodStart Time",
                "meterialValue": "2015-01-01",
                "meterialCode": "certExpirationBegin"
            },
            {
                "meterialName": "ID Document Validity PeriodEnd Time",
                "meterialValue": "2035-01-01",
                "meterialCode": "certExpirationEnd"
            },
            {
                "meterialName": "photo of the director holding the ID document",
                "meterialValue": "",
                "meterialCode": "directorHandheldPhoto",
                "kycEntityAttachmentDto": [
                    {
                        "fileName": "zhang_san_hold.jpg",
                        "type": "directorHandheldPhoto",
                        "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                        "isMerchantOriginal": "Y",
                        "name": "photo of the director holding the ID document",
                        "location": "/unified/account/createAccount",
                        "category": "legal"
                    }
                ]
            },
	    {
                "display": "IMAGES",
                "meterialCode": "addressCertificate",
                "meterialName": "Addressproof(the last three months), that is, Bank statement, utility bill, or any government-issued letter",
                "kycEntityAttachmentDto": [
                    {
                        "location": "/unified/account/createAccount",
                        "fileName": "f6784d63654ddbf8f975aa02f2718c1b.jpg",
                        "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                        "previewUrl": "",
                        "name": "f6784d63654ddbf8f975aa02f2718c1b.jpg",
                        "isMerchantOriginal": "Y",
                        "type": "addressCertificate"
                    }
                ]
            },
            {
                "meterialName": "Director Residential Address",
                "meterialValue": "Beijing CityChaoyang District, Wangjing Street  1  Number",
                "meterialCode": "detailAddress"
            },
            {
                "display": "TEXT",
                "meterialCode": "Nationality",
                "meterialName": "Nationality",
                "meterialValue": "China"
            },
            {
                "meterialName": "at the same time YesUltimate Beneficial Owner",
                "meterialValue": "N",
                "meterialCode": "sameAsUbo"
            }
        ],
        "UBO1": [
            {
                "meterialName": "ID Document issued Country or region",
                "meterialValue": "CN",
                "meterialCode": "country"
            },
            {
                "meterialName": "ID Document Type",
                "meterialValue": "idCard",
                "meterialCode": "certType"
            },
            {
                "meterialName": "National ID Cardfront photo",
                "meterialValue": "",
                "meterialCode": "id_card_front",
                "kycEntityAttachmentDto": [
                    {
                        "fileName": "wang_wu_front.jpg",
                        "type": "id_card_front",
                        "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                        "isMerchantOriginal": "Y",
                        "name": "National ID Cardfront photo",
                        "location": "/unified/account/createAccount",
                        "category": "legal"
                    }
                ]
            },
            {
                "meterialName": "National ID Cardback photo",
                "meterialValue": "",
                "meterialCode": "id_card_back",
                "kycEntityAttachmentDto": [
                    {
                        "fileName": "wang_wu_back.jpg",
                        "type": "id_card_back",
                        "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                        "isMerchantOriginal": "Y",
                        "name": "National ID Cardback photo",
                        "location": "/unified/account/createAccount",
                        "category": "legal"
                    }
                ]
            }, 
	    {
                "meterialName": "photo of the beneficiary holding the ID document",
                "meterialValue": "",
                "meterialCode": "directorHandheldPhoto",
                "kycEntityAttachmentDto": [
                    {
                        "fileName": "zhang_san_hold.jpg",
                        "type": "directorHandheldPhoto",
                        "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                        "isMerchantOriginal": "Y",
                        "name": "photo of the beneficiary holding the ID document",
                        "location": "/unified/account/createAccount",
                        "category": "legal"
                    }
                ]
            },
	    {
                "display": "IMAGES",
                "meterialCode": "addressCertificate",
                "meterialName": "Addressproof(the last three months), that is, Bank statement, utility bill, or any government-issued letter",
                "kycEntityAttachmentDto": [
                    {
                        "location": "/unified/account/createAccount",
                        "fileName": "f6784d63654ddbf8f975aa02f2718c1b.jpg",
                        "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                        "previewUrl": "",
                        "name": "f6784d63654ddbf8f975aa02f2718c1b.jpg",
                        "isMerchantOriginal": "Y",
                        "type": "addressCertificate"
                    }
                ]
            },
            {
                "meterialName": "National ID CardNumber",
                "meterialValue": "310101199313035456",
                "meterialCode": "idCardNo"
            },
            {
                "meterialName": "Family NameGiven Name",
                "meterialValue": "Wang Wu",
                "meterialCode": "fullName"
            },
            {
                "meterialName": "Date of BirthDate",
                "meterialValue": "1990-01-01",
                "meterialCode": "birthday"
            },
            {
                "meterialName": "ID Document Validity PeriodStart Time",
                "meterialValue": "2015-01-01",
                "meterialCode": "certExpirationBegin"
            },
            {
                "meterialName": "ID Document Validity PeriodEnd Time",
                "meterialValue": "2035-01-01",
                "meterialCode": "certExpirationEnd"
            },
	    {
                "meterialName": "Residential Address",
                "meterialValue": "Beijing CityChaoyang District, Wangjing Street  1  Number",
                "meterialCode": "detailAddress"
            },
            {
                "display": "TEXT",
                "meterialCode": "Nationality",
                "meterialName": "Nationality",
                "meterialValue": "China"
            }
        ]
    },
    "entityDynamicDtoList": [
        {
            "meterialName": "Entity Country/Region",
            "meterialValue": "HK",
            "meterialCode": "countryCode"
        },
        {
            "meterialName": "Entity Type",
            "meterialValue": "enterprise",
            "meterialCode": "entityType"
        },
        {
            "meterialName": "CompanyRegister certificate",
            "meterialValue": "",
            "meterialCode": "incorporation_certificate",
            "kycEntityAttachmentDto": [
                {
                    "fileName": "inc.png",
                    "type": "incorporation_certificate",
                    "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                    "isMerchantOriginal": "Y",
                    "name": "CompanyRegister certificate",
                    "location": "/unified/account/createAccount",
                    "category": "entity"
                }
            ]
        },
        {
            "meterialName": "Business Registration Certificate",
            "meterialValue": "",
            "meterialCode": "business_register_certificate",
            "kycEntityAttachmentDto": [
                {
                    "fileName": "br.png",
                    "type": "business_register_certificate",
                    "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                    "isMerchantOriginal": "Y",
                    "name": "Business Registration Certificate",
                    "location": "/unified/account/createAccount",
                    "category": "entity"
                }
            ]
        },
        {
            "meterialName": "Incorporation Form (NNC1)",
            "meterialValue": "",
            "meterialCode": "NNC1",
            "kycEntityAttachmentDto": [
                {
                    "fileName": "nnc1.png",
                    "type": "NNC1",
                    "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                    "isMerchantOriginal": "Y",
                    "name": "Incorporation Form (NNC1)",
                    "location": "/unified/account/createAccount",
                    "category": "entity"
                }
            ]
        },
        {
            "meterialName": "Annual Return (NAR1)",
            "meterialValue": "",
            "meterialCode": "NAR1",
            "kycEntityAttachmentDto": [
                {
                    "fileName": "nar1.png",
                    "type": "NAR1",
                    "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3",
                    "isMerchantOriginal": "Y",
                    "name": "Annual Return (NAR1)",
                    "location": "/unified/account/createAccount",
                    "category": "entity"
                }
            ]
        },
        {
            "meterialName": "ID Document Number",
            "meterialValue": "12345665673000121",
            "meterialCode": "certificateNumber"
        },
        {
            "meterialName": "Enterprise Name",
            "meterialValue": "BB Tech",
            "meterialCode": "companyName"
        },
        {
            "meterialName": "EnterpriseEnglish Name",
            "meterialValue": "BB & Partners (UK) Ltd.",
            "meterialCode": "companyNameEn"
        },
        {
            "meterialName": "EnterpriseBusiness Address",
            "meterialValue": "Hong Kong  in Central Queen'\''s after Road  in  99  Number",
            "meterialCode": "businessAddress"
        },
	{
            "meterialName": "EnterpriseRegister Date",
            "meterialValue": "2025-01-01",
            "meterialCode": "registrationDate"
        },
        {
            "meterialName": "EnterpriseNumber of Employees",
            "meterialValue": "50-100 people",
            "meterialCode": "enterpriseScale"
        },
        {
            "meterialName": "Company Revenue Source  (used to sustain company operationsFunds Source channel and Method)",
            "meterialValue": "Operating Revenue",
            "meterialCode": "sourceFunds"
        },
        {
            "meterialName": "Company Revenue Source DetailsDescription",
            "meterialValue": "Primary Funds Source is software subscriptions and Technical Servicesfee",
            "meterialCode": "description_sourceFunds"
        }
    ],
      "entitykybDtos": [
        {
            "display": "select",
            "displayOrder": 0,
            "explainText": "",
            "imgExplainUrl": "",
            "materialGroup": "",
            "meterialCode": "b2bMcc",
            "meterialId": "",
            "meterialName": "Business Domain",
            "meterialValue": "goods",
            "mpDisplay": "Y",
            "mpRequired": "Y",
            "nextMeterialCode": "",
            "noInputText": "",
            "opDisplay": "N",
            "opRequired": "N"
        },
	{
            "display": "select",
            "displayOrder": 0,
            "explainText": "",
            "imgExplainUrl": "",
            "materialGroup": "",
            "meterialCode": "industry",
            "meterialId": "",
            "meterialName": "industryType",
            "meterialValue": "Education",
            "mpDisplay": "Y",
            "mpRequired": "Y",
            "nextMeterialCode": "",
            "noInputText": "",
            "opDisplay": "N",
            "opRequired": "N"
        },
        {
            "display": "select",
            "displayOrder": 1,
            "explainText": "",
            "imgExplainUrl": "",
            "materialGroup": "",
            "meterialCode": "hasSite",
            "meterialId": "",
            "meterialName": "Whether has official website",
            "meterialValue": "",
            "mpDisplay": "Y",
            "mpRequired": "Y",
            "nextMeterialCode": "",
            "noInputText": "",
            "opDisplay": "N",
            "opRequired": "N"
        },
        {
            "display": "select",
            "displayOrder": 2,
            "explainText": "",
            "imgExplainUrl": "",
            "materialGroup": "",
            "meterialCode": "siteType",
            "meterialId": "",
            "meterialName": "network siteType",
            "meterialValue": "",
            "mpDisplay": "Y",
            "mpRequired": "Y",
            "nextMeterialCode": "",
            "noInputText": "",
            "opDisplay": "N",
            "opRequired": "N"
        },
        {
            "cascadeCategoryKey": "",
            "display": "TEXT",
            "displayOrder": 3,
            "explainText": "",
            "imgExplainUrl": "",
            "materialGroup": "",
            "meterialCode": "storeUrl",
            "meterialId": "",
            "meterialName": "Store URL",
            "meterialValue": "https://bbss.com",
            "mpDisplay": "Y",
            "mpRequired": "Y",
            "nextMeterialCode": "",
            "noInputText": "",
            "opDisplay": "N",
            "opRequired": "N"
        },
        {
            "display": "multi select",
            "displayOrder": 2,
            "explainText": "",
            "imgExplainUrl": "",
            "materialGroup": "",
            "meterialCode": "relateCountries",
            "meterialId": "",
            "meterialName": "Related Country",
            "meterialValue": "",
            "mpDisplay": "Y",
            "mpRequired": "Y",
            "nextMeterialCode": "",
            "noInputText": "",
            "opDisplay": "N",
            "opRequired": "N"
        },
        {
            "cascadeCategoryKey": "",
            "display": "TEXT",
            "displayOrder": 4,
            "explainText": "",
            "imgExplainUrl": "",
            "materialGroup": "",
            "meterialCode": "exportTypeDesc",
            "meterialId": "",
            "meterialName": "Related Product productcategory",
            "meterialValue": "Asada when code",
            "mpDisplay": "Y",
            "mpRequired": "Y",
            "nextMeterialCode": "",
            "noInputText": "",
            "opDisplay": "N",
            "opRequired": "N"
        },
        {
            "display": "select",
            "displayOrder": 5,
            "explainText": "",
            "imgExplainUrl": "",
            "materialGroup": "",
            "meterialCode": "expectAmount",
            "meterialId": "",
            "meterialName": "Estimated in iPayLinks of monthTransaction amount (US Dollar)",
            "meterialValue": "100000",
            "mpDisplay": "Y",
            "mpRequired": "Y",
            "nextMeterialCode": "",
            "noInputText": "",
            "opDisplay": "N",
            "opRequired": "N"
        },
        {
            "display": "select",
            "displayOrder": 6,
            "explainText": "",
            "imgExplainUrl": "",
            "materialGroup": "",
            "meterialCode": "monthExpectedTranNum",
            "meterialId": "",
            "meterialName": "Estimated in iPayLinks of monthTransaction transactiondigit",
            "meterialValue": "111",
            "mpDisplay": "Y",
            "mpRequired": "Y",
            "nextMeterialCode": "",
            "noInputText": "",
            "opDisplay": "N",
            "opRequired": "N"
        },
        {
            "cascadeCategoryKey": "",
            "display": "attachmentMix",
            "displayOrder": 7,
            "explainText": "",
            "imgExplainUrl": "",
            "kycEntityAttachmentDto": [
                {
                    "category": "kyb",
                    "fileName": "",
                    "isMerchantOriginal": "Y",
                    "location": "",
                    "name": "additional documents",
                    "previewUrl": "",
                    "type": "additionalInformation",
                    "url": ""
                }
            ],
            "materialGroup": "",
            "meterialCode": "additionalInformation",
            "meterialId": "",
            "meterialName": "additional documents",
            "meterialValue": "",
            "mpDisplay": "Y",
            "mpRequired": "N",
            "nextMeterialCode": "",
            "noInputText": "",
            "opDisplay": "N",
            "opRequired": "N"
        }
    ],
    "fundInInfos":[
	{
	    "meterialCode": "sourceOfFunds",
            "meterialName": "Funds Source ",
            "meterialValue": "otc"
	},
	{
	    "meterialCode": "sourceOfFundsProof",
            "meterialName": "Funds Source proof",
            "meterialValue": "",
	    "kycEntityAttachmentDto": [
                {
                    "fileName": "ceshi.jpg",
                    "location": "",
                    "name": "Funds Source proof",
                    "previewUrl": "",
                    "type": "sourceOfFundsProof",
                    "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3"
                }
            ]
	},
	{
	    "meterialCode": "purposeOfFunds",
            "meterialName": "Funds Purpose",
            "meterialValue": "SupplierPayment"
	},
	{
	"meterialCode": "purposeOfFundsProof",
            "meterialName": "Funds Purposeproof",
            "meterialValue": "",
	    "kycEntityAttachmentDto": [
                {
                    "category": "kyb",
                    "fileName": "ceshi1.jpg",
                    "location": "",
                    "name": "Funds Purposeproof",
                    "previewUrl": "",
                    "type": "purposeOfFundsProof",
                    "url": "http://filesystem.ipaylinks.com?bucket=noprod-s3-private&endpoint=cn-north-1&fileLocation=unified-filesystem/openapi/0/2025-10-20/7c7b9d14af4049b28229f4252af6a8ad/QQscreenshot20250910105453.png&objectType=s3"
                }
            ]
	}
    ]
}
}'

Responses

🟢200Success
application/json
Bodyapplication/json

Example
{
    "code": "string",
    "message": "string",
    "data": {
        "status": "string",
        "completeTime": "20230101120000",
        "failReason": "string"
    }
}
Modified at 2026-08-08 08:08:06
Previous
Register Merchant
Next
KYBApply for
Built with