API Doc
Languages
Languages
  • English
  • 简体中文
Languages
Languages
  • English
  • 简体中文
  1. 11. Ekyc
  • API Signature Process
  • API General Code
  • 1. Callback
    • Merchant Subscription Event Notification - Signature Process
  • 2. Account
    • 2.1 Check Account Balance
      GET
    • 2.2 Payment Statement
      POST
    • 2.3 Payout Statement
      POST
  • 3. Payout
    • Payout Product Flow Chart
    • Open API Channel List
    • 3.1 Create Payout
      POST
    • 3.3 Payout Callback Notification
      POST
    • 3.2 Check Payout Status
      GET
  • 4. Bills Payment
    • Bills Payment Product Flow Chart
    • Bills Payment ChannelCode List
    • 4.1 Create Static Virtual Account
      POST
    • 4.2 Batch Create Static Virtual Account
      POST
    • 4.3 Update Static Virtual Account
      POST
    • 4.4 Get Virtual Account Cashier Short Url
      POST
    • 4.5 Get Virtual Account's Payments
      GET
    • 4.6 Repayment verification API
      POST
    • 4.7 Cancel Static Virtual Account
      POST
    • 4.8 Virtual Account Callback Notification
      POST
  • 5. QrCode
    • QrCode Product Flow Chart
    • QrCode ChannelCode List
    • 5.1 Create QR Code
    • 5.2 Get QR Code Detail
    • 5.3 Get QR Code Payments
    • 5.4 Cancel QR Code
    • 5.6 Update QR Code
    • 5.5 QR Code Callback Notification
  • 6. Bank Transfer
    • Bank Transfer Product Flow Chart
    • Bank Transfer ChannelCode List
    • 6.1 Batch Create Bank Transfer Account
    • 6.2 Batch Update Bank Transfer Account
    • 6.3 Bank Transfer Account Payments
    • 6.4 Bank Transfer Callback Notification
  • 7. Web payment
    • Web Payment Product Flow Chart
    • Web Payment ChannelCode List
    • 7.1 Create Web Payment
    • 7.2 Check Web Payment Status
    • 7.3 Web Payment Channels
    • 7.4 Web Payment Callback Notification
  • 8. Refund
    • Refund Support Channel List
    • 8.1 Create Refund
    • 8.2 Get Refund Payments
    • 8.3 Refund Callback Notification
  • 9. Checkout
    • 9.1 Query the channels supported by the cashier counter
    • 9.2 Create the checkout counter
    • 9.3 Check the cashier counter
    • 9.4 Close the cashier counter
    • 9.5 Checkout Payment Notification
  • 10. Direct Debit
    • Direct Debit Channel Code List
    • Authorization
      • 10.1 Create Authorization Link
      • 10.2 Check Authorization Status
      • 10.3 Cancel Authorization
      • 10.4 Authorization Notification
    • Orders
      • 10.5 Create Payment
      • 10.6 Check Payment Status
      • 10.7 Payment Notification
  • 11. Ekyc
    • Ekyc Channel Code List
    • 11.1 Ekyc Init
      POST
    • 11.2 Ekyc Check Result
      POST
    • 11.3 Ekyc Notification
      POST
  • Schemas
    • Response body
  1. 11. Ekyc

11.1 Ekyc Init

POST
/api/v1/ekyc/init

Request

Body Params application/jsonRequired

Example
{
    "appId": "53cbe10f8e904f74b6eba3f8458749b6",
    "sign": "DM+8kaaJXj2vvQ4gI/Sw6rv+nePQkK+LmdllQuhaWKOcp1Y2ZlvS1uykwG+JfGpjwski2kMf3O9DdMB49q8BXIRZbK/zMAPkiZr5HOeE9WrhkMBZrIU08fNR5jxQdV3XDqrLb12EPDfeeh/YKscp3Iu5qv+O+5jImugqk2Y3onKPMDOZriKOZz/fReDxOWP4+6fLtBPz1Akwz6ZDmcZUtzo+0WcqirqCLknBufDyTvgqcEelsMlvHjpD2FpNBJcxIIQ/qAci/B9Jq1bJlZ6jwLaEgdSL9HBBkF4EWjCF+JKEL1eV9lxOK8aS37V5BPNSSOckGt7noMvTzwPn0gDACcKjAaxIykDMZboYAS3A7zC4kdtz9WU9qznvuBkXK6aXf8BKBgIHH1nCucCD2wrSf4eWw3MaeC4yCY1gf3fvIO6dEMLMMN9emJpRpjAV0E+DSCiRWxF0SqOdfcntEPtHNGGQ1daextrtaab2SqL2suHXuTgjujhjZOYqp1VcIjrYrRxAvS1ObmzCbPLt2vkkUIWnuhyUmi8uDcOR0ZJhJHVpwacMsU4Zz6yPAzsC7nkJjXq1+kr05Phj4iQ8qOB9D3Vvp5QnmTL5Ei4T3/7tc/J5DOOzCpEsniMbux43lFoqlsLsIqcZpt2jaTTakRgDO/cpWPz0DjHukqG2sfIf6Po=",
    "param": "{\"mchOrderId\": \"{{$timestamp}}\",\"channelCode\": \"REAL_ID\",\"userId\": \"U1914199652945625016\",\"sceneCode\": \"ekyc\",\"callbackUrl\": \"https://webhook.site/0ced186f-eeb6-4340-8c29-178734764f1d\",\"redirectUrl\": \"https://postman-echo.com/get\"}"
}

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/ekyc/init' \
--header 'Content-Type: application/json' \
--data '{
    "appId": "53cbe10f8e904f74b6eba3f8458749b6",
    "sign": "DM+8kaaJXj2vvQ4gI/Sw6rv+nePQkK+LmdllQuhaWKOcp1Y2ZlvS1uykwG+JfGpjwski2kMf3O9DdMB49q8BXIRZbK/zMAPkiZr5HOeE9WrhkMBZrIU08fNR5jxQdV3XDqrLb12EPDfeeh/YKscp3Iu5qv+O+5jImugqk2Y3onKPMDOZriKOZz/fReDxOWP4+6fLtBPz1Akwz6ZDmcZUtzo+0WcqirqCLknBufDyTvgqcEelsMlvHjpD2FpNBJcxIIQ/qAci/B9Jq1bJlZ6jwLaEgdSL9HBBkF4EWjCF+JKEL1eV9lxOK8aS37V5BPNSSOckGt7noMvTzwPn0gDACcKjAaxIykDMZboYAS3A7zC4kdtz9WU9qznvuBkXK6aXf8BKBgIHH1nCucCD2wrSf4eWw3MaeC4yCY1gf3fvIO6dEMLMMN9emJpRpjAV0E+DSCiRWxF0SqOdfcntEPtHNGGQ1daextrtaab2SqL2suHXuTgjujhjZOYqp1VcIjrYrRxAvS1ObmzCbPLt2vkkUIWnuhyUmi8uDcOR0ZJhJHVpwacMsU4Zz6yPAzsC7nkJjXq1+kr05Phj4iQ8qOB9D3Vvp5QnmTL5Ei4T3/7tc/J5DOOzCpEsniMbux43lFoqlsLsIqcZpt2jaTTakRgDO/cpWPz0DjHukqG2sfIf6Po=",
    "param": "{\"mchOrderId\": \"{{$timestamp}}\",\"channelCode\": \"REAL_ID\",\"userId\": \"U1914199652945625016\",\"sceneCode\": \"ekyc\",\"callbackUrl\": \"https://webhook.site/0ced186f-eeb6-4340-8c29-178734764f1d\",\"redirectUrl\": \"https://postman-echo.com/get\"}"
}'

Responses

🟢200成功
application/json
Bodyapplication/json

Example
{
    "code": 1,
    "message": "success",
    "data": {
        "mchOrderId": "1774839473",
        "businessId": "E5N8450597643943936",
        "redirectUrl": "https://webhook.site/0ced186f-eeb6-4340-8c29-178734764f"
    }
}
🟢200失败
Previous
Ekyc Channel Code List
Next
11.2 Ekyc Check Result
Built with