🚀 API Endpoints
🔍 KYC Management
Identity verification and compliance check endpoints. 5 endpoints available.
🎯 Quick Stats
- Total Endpoints: 5
- Base URL:
https://api.market.decenctype.com - Authentication: Bearer Token / API Key
📊 Methods
- 📝 POST: 1 endpoints
- 🔍 GET: 4 endpoints
🔐 Authentication
All endpoints in this section use the same authentication methods. Choose one:
🔑 Bearer Token (Recommended)
For user session authentication
Add to request headers:
Authorization: Bearer YOUR_TOKEN🔧 API Key
For server-side authentication
Add to request headers:
X-API-KEY: YOUR_API_KEY⚠️ Important: Do not use both authentication methods simultaneously in the same request.
🔗 Endpoints Overview
| Method | Endpoint | Description |
|---|---|---|
📝 POST | /kyc-usage/track/{kycOrderId} | 记录KYC的使用情况 |
🔍 GET | /kyc-usage/check/{kycOrderId} | 检查KYC对于特定issuer和channel的使用次数是否已达上限 |
🔍 GET | /kyc-usage/history/{kycOrderId} | 获取KYC的使用记录 |
🔍 GET | /kyc-usage/available | 获取对特定发卡机构和渠道可用的KYC列表 |
🔍 GET | /kyc-usage/summary/{kycOrderId} | 获取KYC使用情况汇总 |
📖 Detailed Documentation
记录KYC的使用情况
POST
/kyc-usage/track/{kycOrderId}Full URL
https://api.market.decenctype.com/kyc-usage/track/{kycOrderId}🎯 Path Parameters
kycOrderId(string) - ✅ Required: KYC订单ID
📋 Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
issuerId | string | ✅ | 发卡机构ID |
channelId | string | ✅ | 渠道ID |
cardOrderId | string | ✅ | 关联的卡片订单ID |
remark | string | ❌ | 备注 |
Description: 记录KYC的使用情况
Operation ID: trackKycUsage
Response Status:
- ✅ 201: KYC使用记录已创建
📝 Example Request
curl -X POST "https://api.market.decenctype.com/kyc-usage/track/example-id" \\
-H "Authorization: Bearer YOUR_TOKEN" \\
-H "Content-Type: application/json"检查KYC对于特定issuer和channel的使用次数是否已达上限
GET
/kyc-usage/check/{kycOrderId}Full URL
https://api.market.decenctype.com/kyc-usage/check/{kycOrderId}🎯 Path Parameters
kycOrderId(string) - ✅ Required: KYC订单ID
📋 Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
issuerId | string | ✅ | 发卡机构ID |
channelId | string | ✅ | 渠道ID |
Description: 检查KYC对于特定issuer和channel的使用次数是否已达上限
Operation ID: checkKycUsageAvailability
Response Status:
- ✅ 200: KYC使用情况
📝 Example Request
curl -X GET "https://api.market.decenctype.com/kyc-usage/check/example-id" \\
-H "Authorization: Bearer YOUR_TOKEN" \\
-H "Content-Type: application/json"获取KYC的使用记录
GET
/kyc-usage/history/{kycOrderId}Full URL
https://api.market.decenctype.com/kyc-usage/history/{kycOrderId}🎯 Path Parameters
kycOrderId(string) - ✅ Required: KYC订单ID
Description: 获取KYC的使用记录
Operation ID: getKycUsageHistory
Response Status:
- ✅ 200: KYC使用记录列表
📝 Example Request
curl -X GET "https://api.market.decenctype.com/kyc-usage/history/example-id" \\
-H "Authorization: Bearer YOUR_TOKEN" \\
-H "Content-Type: application/json"获取对特定发卡机构和渠道可用的KYC列表
GET
/kyc-usage/availableFull URL
https://api.market.decenctype.com/kyc-usage/available📋 Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
sortField | string | ❌ | 排序字段 |
sort | string | ❌ | 排序方式 |
page | number | ❌ | 页码（从1开始） |
pageSize | number | ❌ | 每页条数 |
issuerId | string | ✅ | 发卡机构ID |
channelId | string | ✅ | 渠道ID |
excludeIds | string | ❌ | 需要排除的 KYC 订单 ID 列表 |
randomOrder | boolean | ❌ | 是否随机返回 KYC 订单 |
Description: 获取对特定发卡机构和渠道可用的KYC列表
Operation ID: getAvailableKycs
Response Status:
- ✅ 200: 可用的KYC列表
📋 Response Examples
response.json
1{2 "items": [3 {4 "orderId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",5 "status": "pending",6 "firstName": "John",7 "lastName": "Doe",8 "addressCountry": "US",9 "addressCity": "Los Angeles",10 "addressLine1": "123 Main Street",11 "addressPostalCode": "90001",12 "dob": "1990-01-01",13 "dialCode": "1",14 "phoneNumber": "1234567890",15 "documentType": "passport",16 "documentNumber": "P12345678",17 "type": "user",18 "channelCode": "common",19 "user": "example-user"20 }21 ],22 "meta": "example-meta"23}📝 Example Request
curl -X GET "https://api.market.decenctype.com/kyc-usage/available" \\
-H "Authorization: Bearer YOUR_TOKEN" \\
-H "Content-Type: application/json"获取KYC使用情况汇总
GET
/kyc-usage/summary/{kycOrderId}Full URL
https://api.market.decenctype.com/kyc-usage/summary/{kycOrderId}🎯 Path Parameters
kycOrderId(string) - ✅ Required: KYC订单ID
Description: 获取KYC使用情况汇总
Operation ID: getKycUsageSummary
Response Status:
- ✅ 200: KYC使用情况汇总
📝 Example Request
curl -X GET "https://api.market.decenctype.com/kyc-usage/summary/example-id" \\
-H "Authorization: Bearer YOUR_TOKEN" \\
-H "Content-Type: application/json"