Appearance
Get User Kyc Form
About 193 wordsLess than 1 minute
GET /public/v1/form/kyc/register
Query Parameters
| Key | Type | Required | Rule | Description |
|---|---|---|---|---|
| collection_id | string | Mandatory | length 8 | kyc form's collection id |
Expected HTTP status code
- 200
Response
| Name | Type | Description |
|---|---|---|
| id | string | form id |
| type | string | the type of registration form |
| groups | array | the information groups of registration form |
| groups[].key | string | the key of groups |
| groups[].label | map | the label of groups , key is language code like 'en-us', 'zh-cn' etc |
| groups[].fields | array | the fields of information groups |
| groups[].fields[].key | string | the key of fields |
| groups[].fields[].label | string | the label of groups , key is language code like 'en-us', 'zh-cn' etc |
| groups[].fields[].required | number | the field is required ro not |
| groups[].fields[].type | number | the type of fields |
| groups[].fields[].options | number | the value of fields , when the type is select,multiselect,radio or checkbox |
| groups[].fields[].disabled | number | the field is disabled or not |
| groups[].fields[].readonly | number | the field is readonly or not |
| groups[].fields[].docs | array | the files need to read |
| groups[].fields[].docs[].doc_url | string | the url of file |