Get KYC Config
- GET /v3/b2b/kyc/config
Get the KYC config to be submitted
Request Sample
curl --location --request GET 'https://test2-business-cgi.pingpongx.com/v3/b2b/kyc/config?subject_type=CORPORATION&open_id=8814a567530845629442ff4bbb903f6a' \
--header 'Content-Type: application/json' \
--header 'timestamp: 1637564397860' \
--header 'sign: 4a70672b69b59d24d1ef05b716b1fc1d89e3e87e2b4921cb5847b6230e91c472' \
--header 'app_id: 80242303107221' \
--header 'Authorization: Bearer 75efb5bfed7644d38f713367e2787ebe1bb012fef2d048a9b12aa86c7ca07565'
Request Schema
| Parameter | Type | Required | Description |
|---|---|---|---|
| subject_type | String | M | Subjec type(eg:INDIVIDUAL_OR_SOLE_PROPRIETORSHIP,PARTNERSHIP,CORPORATION,LIMITED_LIABILITY_COMPANY) |
| open_id | String | M | User ID in PingPong |
Response Sample
{
"code": 0,
"success": true,
"message": "OK",
"data": [
{
"module": "business-info",
"name": "Business Information",
"materials": [
{
"material": "name",
"name": "Business full name",
"options": [],
"required": true,
"material_type": "TEXT"
},
{
"material": "category",
"name": "Sales category",
"options": [
{
"value": "Baby products",
"name": "Baby products",
"default_option": false,
"relate_materials": [
{
"material": "businessUrl_1",
"name": "Business URL (Optional)",
"options": [],
"required": false,
"material_type": "TEXT"
}
]
},
{
"value": "Beauty and fragrances",
"name": "Beauty and fragrances",
"default_option": false,
"relate_materials": [
{
"material": "businessUrl_1",
"name": "Business URL (Optional)",
"options": [],
"required": false,
"material_type": "TEXT"
}
]
}
],
"required": true,
"material_type": "TEXT"
},
{
"material": "zipcode",
"name": "Postal / ZIP Code",
"options": [],
"required": true,
"material_type": "TEXT"
}
]
},
{
"module": "ubo-person-info",
"name": "UBO",
"materials": [
{
"material": "country",
"name": "Country",
"options": [
{
"value": "Afghanistan",
"name": "Afghanistan",
"default_option": false,
"relate_materials": [
{
"material": "specifiedCity",
"name": "City",
"options": [],
"required": true,
"material_type": "TEXT"
}
]
},
{
"value": "Aland Islands",
"name": "Aland Islands",
"default_option": false,
"relate_materials": [
{
"material": "specifiedCity",
"name": "City",
"options": [],
"required": true,
"material_type": "TEXT"
}
]
}
],
"required": true,
"material_type": "TEXT"
},
{
"material": "nationality",
"name": "Nationality",
"options": [
{
"value": "Afghanistan",
"name": "Afghanistan",
"default_option": false,
"relate_materials": []
},
{
"value": "Aland Islands",
"name": "Aland Islands",
"default_option": false,
"relate_materials": []
},
],
"required": true,
"material_type": "TEXT"
},
{
"material": "idType",
"name": "ID type",
"options": [
{
"value": "drivingLicense",
"name": "Driving license",
"default_option": true,
"relate_materials": [
{
"material": "drivingLicenseNo",
"name": "Driving license number",
"options": [],
"required": true,
"material_type": "TEXT"
},
{
"material": "drivingLicense",
"name": "Image of driving license",
"options": [],
"required": true,
"material_type": "FILE"
}
]
},
{
"value": "nationalId",
"name": "National ID",
"default_option": false,
"relate_materials": [
{
"material": "nationalIdNo",
"name": "National ID number",
"options": [],
"required": true,
"material_type": "TEXT"
},
{
"material": "nationalId",
"name": "Image of national ID",
"options": [],
"required": true,
"material_type": "FILE"
}
]
},
{
"value": "passport",
"name": "Passport",
"default_option": false,
"relate_materials": [
{
"material": "passportNo",
"name": "Passport number",
"options": [],
"required": true,
"material_type": "TEXT"
},
{
"material": "passport",
"name": "Image of passport",
"options": [],
"required": true,
"material_type": "FILE"
}
]
}
],
"required": true,
"material_type": "TEXT"
},
{
"material": "address",
"name": "Address line 1",
"options": [],
"required": true,
"material_type": "TEXT"
}
]
},
{
"module": "control-person-info",
"name": "Control Person Information",
"materials": [
{
"material": "firstName",
"name": "First Name",
"options": [],
"required": true,
"material_type": "TEXT"
},
{
"material": "lastName",
"name": "Last Name",
"options": [],
"required": true,
"material_type": "TEXT"
},
{
"material": "birth",
"name": "Date of birth",
"options": [],
"required": true,
"material_type": "TEXT"
},
{
"material": "country",
"name": "Country",
"options": [
{
"value": "Afghanistan",
"name": "Afghanistan",
"default_option": false,
"relate_materials": [
{
"material": "specifiedCity",
"name": "City",
"options": [],
"required": true,
"material_type": "TEXT"
}
]
},
{
"value": "Aland Islands",
"name": "Aland Islands",
"default_option": false,
"relate_materials": [
{
"material": "specifiedCity",
"name": "City",
"options": [],
"required": true,
"material_type": "TEXT"
}
]
}
],
"required": true,
"material_type": "TEXT"
},
{
"material": "idType",
"name": "ID type",
"options": [
{
"value": "drivingLicense",
"name": "Driving license",
"default_option": true,
"relate_materials": [
{
"material": "drivingLicenseNo",
"name": "Driving license number",
"options": [],
"required": true,
"material_type": "TEXT"
},
{
"material": "drivingLicense",
"name": "Image of driving license",
"options": [],
"required": true,
"material_type": "FILE"
}
]
},
],
"required": true,
"material_type": "TEXT"
},
{
"material": "address",
"name": "Address line 1",
"options": [],
"required": true,
"material_type": "TEXT"
},
{
"material": "otherAddress",
"name": "Address Line 2（Optional）",
"options": [],
"required": false,
"material_type": "TEXT"
},
{
"material": "postTown",
"name": "City / Post Town",
"options": [],
"required": true,
"material_type": "TEXT"
},
{
"material": "state",
"name": "State / Province / Territory",
"options": [],
"required": true,
"material_type": "TEXT"
},
{
"material": "zipcode",
"name": "Postal / ZIP Code",
"options": [],
"required": true,
"material_type": "TEXT"
}
]
},
{
"module": "contact-person-info",
"name": "Contact Person Information",
"materials": [
{
"material": "contactPhone",
"name": "Phone",
"options": [],
"required": true,
"material_type": "TEXT"
},
{
"material": "idType",
"name": "ID type",
"options": [
{
"value": "drivingLicense",
"name": "Driving license",
"default_option": true,
"relate_materials": [
{
"material": "drivingLicenseNo",
"name": "Driving license number",
"options": [],
"required": true,
"material_type": "TEXT"
},
{
"material": "drivingLicense",
"name": "Image of driving license",
"options": [],
"required": true,
"material_type": "FILE"
}
]
}
],
"required": true,
"material_type": "TEXT"
}
]
}
]
}
Response Schema
| Parameter | Type | Description |
|---|---|---|
| data | List | List of ModuleConfig |
ModuleConfig
| Parameter | Type | Description |
|---|---|---|
| module | String | Module |
| name | String | Module name |
| materials | List | List of MaterialConfig |
MaterialConfig
| Parameter | Type | Description |
|---|---|---|
| material | String | Material |
| name | String | Material name |
| required | Bool | Required or not (eg: true, false) |
| material_type | String | Material type (eg: TEXT, FILE) |
| options | List | List of OptionConfig |
OptionConfig
| Parameter | Type | Description |
|---|---|---|
| value | String | Option value |
| name | String | Option name |
| default_option | Bool | Default or not (eg: true, false) |
| relate_materials | List | List of materials |