Home
HomeGuidesAPI Reference
HomeLog In
API Reference

Calling the KYC Connect API

KYC Connect API Process

KYC Connect provides three different API calling processes to meet the needs of different user types and platforms:

Individual User KYC API Process

  1. Submit Personal Information - Call /kyc/individual/pi API and submit all required user information
  2. Upload Files - Call /kyc/individual/file API and send all user files previously uploaded to your platform
  3. Get Questionnaire - Call GET /kyc/individual/qa to retrieve questionnaire questions
  4. Submit Questionnaire Answers - Call POST /kyc/individual/qa to save questionnaire answers
  5. Submit KYC Application - Call /kyc/individual/submit API to submit the KYC application

After submission, you can call /kyc-status to check the user's KYC status.

Institutional User KYC API Process

  1. User Registration - Call /kyc/email to register the user (users can skip the KYC process if previously approved)
  2. Fill Company Information - Call /kyc/company/* APIs to complete all user information
  3. Submit Files - Call /kyc/company/file API to submit all user files
  4. Submit Application - Call /kyc/company/submit API to submit the KYC application

After submission, you can call /kyc-status to check the user's KYC status.

Hybrid KYC API Process (Individual Users)

  1. Submit Personal Information - Call /kyc/individual/pi API and submit all required user information
  2. Get Questionnaire - Call GET /kyc/individual/qa to retrieve questionnaire questions
  3. Submit Questionnaire Answers - Call POST /kyc/individual/qa to save questionnaire answers
  4. ID Verification - Call POST /kyc/individual/id to get the ID verification link, display the UI as iframe in front-end
    • Wait for ID verification result webhook in back-end:
      • If status is "Completed", call /kyc/individual/submit API to submit the KYC application
      • If other status, return to step 4 when user reloads your page. ID verification step is required to finish the KYC application

After submission, you can call /kyc-status to check the user's KYC status, or wait for the KYC status webhook.

Technical Features

  • Flexible Integration Options - Provides standard, institutional, and hybrid processes
  • Webhook Support - Real-time status update notifications
  • iframe Integration - Seamless front-end user experience
  • Status Tracking - Complete application status monitoring

This comprehensive API process design ensures that different types of users receive the most suitable KYC experience, while providing partner platforms with flexible technical integration options.


KYC Connect API流程详解

KYC Connect提供三种不同的API调用流程，以满足不同类型用户和平台需求：

个人用户KYC API流程

  1. 提交个人信息 - 调用 /kyc/individual/pi API，提交所需的用户信息
  2. 上传文件 - 调用 /kyc/individual/file API，发送用户之前上传到您平台的所有文件
  3. 获取问卷 - 调用 GET /kyc/individual/qa 获取问卷调查问题
  4. 提交问卷答案 - 调用 POST /kyc/individual/qa 保存问卷调查答案
  5. 提交KYC申请 - 调用 /kyc/individual/submit 提交KYC申请

提交后可通过 /kyc-status 检查用户KYC状态。

机构用户KYC API流程

  1. 用户注册 - 调用 /kyc/email 注册用户（如用户之前已获批准，可跳过KYC流程）
  2. 填写公司信息 - 调用 /kyc/company/* 相关APIs填写所有用户信息
  3. 提交文件 - 调用 /kyc/company/file 提交（上传）所有用户文件
  4. 提交申请 - 调用 /kyc/company/submit 提交KYC申请

提交后可通过 /kyc-status 检查用户KYC状态。

混合KYC API流程（个人用户）

  1. 提交个人信息 - 调用 /kyc/individual/pi API，提交所需的用户信息
  2. 获取问卷 - 调用 GET /kyc/individual/qa 获取问卷调查问题
  3. 提交问卷答案 - 调用 POST /kyc/individual/qa 保存问卷调查答案
  4. 身份验证 - 调用 POST /kyc/individual/id 获取身份验证链接，在前端以iframe形式显示UI

后端等待身份验证结果webhook：

如果状态为"已完成"，调用 /kyc/individual/submit 提交KYC申请
如果是其他状态，用户重新加载页面时返回步骤4。身份验证步骤是完成KYC申请的必要步骤

提交后可通过 /kyc-status 检查用户KYC状态，或等待KYC状态webhook通知。

技术特点

  • 灵活的集成方式 - 提供标准、机构和混合三种流程
  • Webhook支持 - 实时状态更新通知
  • iframe集成 - 无缝的前端用户体验 （如需）
  • 状态追踪 - 完整的申请状态监控

这套完整的API流程设计确保了不同类型用户都能获得最适合的KYC体验，同时为合作平台提供了灵活的技术集成选择。

Updated about 1 year ago

Updated about 1 year ago