Appearance
Submit Kyc Requests
About 1368 wordsAbout 5 min
Event
| Event Slug | Description |
|---|---|
crm.webhooks.requests.kyc.submit | Triggers when request is subbmitted |
Data
| Key | Type | Description |
|---|---|---|
| id | string | request id |
| type | string | request type: kyc |
| status | string | request status: approved | pending |
| user_id | string | request user id |
| request_time | string | date and time of the request. UTC+0 |
| form_id | string | form id for this kyc form |
| collection_id | string | collection id for this kyc form |
| kyc_fields | array | kyc fields in the dynamic form |
| kyc_fields[].key | string | System unique key of the field |
| kyc_fields[].type | string | Type of the field |
| kyc_fields[].label | string | Label of the field |
| kyc_fields[].label.[language-code] | string | Label of the field in different languages |
| kyc_fields[].value | string/object/array | Value of the field |
| kyc_fields[].group_id | string/object/array | Group id of the field |
Example
This is an example of the full JSON payload while approving a withdrawal request on node 1
{
"source": {
"service": "requests",
"group": "crm.webhooks.groups.requests.kyc",
"event": "crm.webhooks.requests.kyc.submit"
},
"target": {
"name": "KYC"
},
"version": "1.0.0",
"data": {
"id": "omrkw7n84frk",
"type": "kyc",
"status": "submitted",
"user_id": "c8nwrb00",
"request_time": "2026-05-21 09:33:25",
"collection_id": "22b01f3e",
"kyc_fields": [
{
"key": "name",
"type": "text",
"label": {
"en-us": "Name",
"zh-cn": "名称1",
"zh-tw": "姓名",
"ja": "名前",
"kur-ckb": "ناوی سیانی",
"ar": "الإسم",
"ms": "Nama"
},
"value": "webhook6"
},
{
"key": "nationality",
"type": "country",
"label": {
"en-us": "Nationality",
"zh-cn": "国籍",
"vi": "Quốc tịch",
"zh-tw": "國籍",
"ja": "国籍",
"th": "สัญชาติ",
"id": "Kebangsaan",
"es": "Nacionalidad",
"de": "Staatsangehörigkeit",
"tr": "Milliyet",
"pt": "Nacionalidade",
"ko": "국적",
"kur-ckb": "رەگەزنامە",
"kur-kmr": "رهگهزنامه",
"ar": "الجنسية",
"ms": "Kewarganegaraan"
},
"value": "jp"
},
{
"key": "gender",
"type": "radio",
"label": {
"en-us": "Gender",
"zh-cn": "性别",
"vi": "Giới tính",
"zh-tw": "性別",
"ja": "性別",
"th": "เพศ",
"id": "Jenis kelamin",
"es": "Sexo",
"de": "Geschlecht",
"tr": "Cinsiyet",
"pt": "Gênero sexual",
"ko": "성별",
"kur-ckb": "رەگەز ",
"kur-kmr": "رهگهز",
"ar": "الجنس",
"ms": "Jantina"
},
"value": {
"label": {
"en-us": "Female",
"zh-cn": "女性",
"vi": "Nữ",
"zh-tw": "女性",
"ja": "女性",
"th": "หญิง",
"id": "Perempuan",
"es": "Mujer",
"de": "Weiblich",
"tr": "Dişi",
"pt": "Fêmea",
"ko": "여자",
"kur-ckb": "مامەڵە چاوەڕێکان",
"kur-kmr": "مامهلهيێن چاڤهرێكرى",
"ar": "مامەڵە چاوەڕێکان",
"ms": "Perempuan"
},
"key": "female"
}
},
{
"key": "date_of_birth",
"type": "date",
"label": {
"en-us": "Date of Birth",
"zh-cn": "生日",
"vi": "Ngày sinh",
"zh-tw": "生日",
"ja": "生年月日",
"th": "วันเกิด",
"id": "Tanggal lahir",
"es": "Fecha de nacimiento",
"de": "Geburtsdatum",
"tr": "Doğum tarihi",
"pt": "Data de nascimento",
"ko": "생일",
"kur-ckb": "رێکەوتی لە دایکبوون",
"kur-kmr": "رێكهفتێ ژ دايكبوونێ",
"ar": "تاريخ الميلاد",
"ms": "Tarikh Lahir"
},
"value": "2000-04-12"
},
{
"key": "phone",
"type": "phone",
"label": {
"en-us": "Phone",
"zh-cn": "手机号",
"vi": "Số điện thoại",
"zh-tw": "手機號",
"ja": "電話番号",
"th": "หมายเลขโทรศัพท์",
"id": "Nomor telepon",
"es": "Número de Teléfono",
"de": "Telefonnummer",
"tr": "Telefon numarası",
"pt": "Número de telefone",
"ko": "전화 번호",
"kur-ckb": "ژمارەی مۆبایل",
"kur-kmr": "ژمارا مۆبايلێ",
"ar": "رقم الهاتف",
"ms": "Telefon"
},
"value": {
"number": "7383774249",
"country_code": "gg"
}
},
{
"key": "identity_number",
"type": "text",
"label": {
"en-us": "Identity Card/Passport Number",
"zh-cn": "身份证/护照号码",
"vi": "Thẻ căn cước / Số hộ chiếu",
"zh-tw": "身份證/護照號碼",
"ja": "身分証明書 / パスポート番号",
"th": "หมายเลขบัตรประจำตัวประชาชน/หนังสือเดินทาง",
"id": "Kartu Identitas",
"es": "Número de Documento de Identidad/Pasaporte",
"de": "Personalausweis-/Reisepassnummer",
"tr": "Kimlik Kartı/Pasaport Numarası",
"pt": "Número do Bilhete de Identidade/Passaporte",
"ko": "신분증/여권번호",
"kur-ckb": "ژمارەی ناسنامەی نیشتمانی/پاسپۆرت",
"kur-kmr": "ژمارا ناسناما نيشتيمانى/پاسپۆرت",
"ar": "البطاقة الشخصية / جواز السفر",
"ms": "Nombor Kad Pengenalan / Pasport"
},
"value": "9384663644"
},
{
"key": "location",
"type": "location",
"label": {
"en-us": "Place of Residence",
"zh-cn": "居住地",
"vi": "Nơi cư trú",
"zh-tw": "居住地",
"ja": "居住地",
"th": "ที่อยู่อาศัย",
"id": "Tempat kediaman",
"es": "Lugar de residencia",
"de": "Ort des Wohnsitzes",
"tr": "İkamet yeri",
"pt": "Local de Residência",
"ko": "거주지",
"kur-ckb": "وڵاتی نیشتەجێ بوون",
"kur-kmr": "وهلاتێ ئاكنجيبوونێ",
"ar": "مكان الإقامة",
"ms": "Tempat Tinggal"
},
"value": {
"country": "jp",
"state": "38",
"city": "Iyo"
}
},
{
"key": "postal_code",
"type": "text",
"label": {
"en-us": "Postal code",
"zh-cn": "邮政编码",
"vi": "Mã bưu điện",
"zh-tw": "郵遞區號",
"ja": "郵便番号",
"th": "รหัสไปรษณีย์",
"id": "Kode pos",
"es": "Código postal",
"de": "Postleitzahl",
"tr": "Posta Kodu",
"pt": "Código postal",
"ko": "우편 번호",
"kur-ckb": "کۆدی پۆست",
"kur-kmr": "كۆدێ پۆستى",
"ar": "الرمز البريدي",
"ms": "Poskod"
},
"value": "9834763643"
},
{
"key": "address",
"type": "textarea",
"label": {
"en-us": "Address",
"zh-cn": "详细地址",
"vi": "Địa chỉ nhà",
"zh-tw": "地址",
"ja": "住所",
"th": "ที่อยู่อาศัย",
"id": "Alamat",
"es": "Dirección",
"de": "Anschrift",
"tr": "Adres",
"pt": "Endereço",
"ko": "주소",
"kur-ckb": "ناونیشانی ماڵ",
"kur-kmr": "ناڤ و نيشان",
"ar": "العنوان",
"ms": "Alamat"
},
"value": "日本"
},
{
"key": "ux131f97a000xfb61x0",
"type": "text",
"label": {
"en-us": "单行文本",
"zh-cn": "单行文本",
"zh-tw": "单行文本",
"vi": "单行文本",
"ko": "单行文本",
"kur-ckb": "单行文本"
},
"value": "45345"
},
{
"key": "ux131f97e5acx69b2x1",
"type": "textarea",
"label": {
"en-us": "多行文本",
"zh-cn": "多行文本",
"zh-tw": "多行文本",
"vi": "多行文本",
"ko": "多行文本",
"kur-ckb": "多行文本"
},
"value": "多行"
},
{
"key": "ux131f9a239ex2aebx2",
"type": "select",
"label": {
"en-us": "下拉单选",
"zh-cn": "下拉单选",
"zh-tw": "下拉单选",
"vi": "下拉单选",
"ko": "下拉单选",
"kur-ckb": "下拉单选"
},
"value": {
"label": {
"zh-cn": "2",
"zh-tw": "2",
"en-us": "2",
"kur-ckb": "2",
"vi": "2",
"ko": "2"
},
"key": "ux131f99eef1x4907x1"
}
},
{
"key": "ux131f9b469bx4facx3",
"type": "multiselect",
"label": {
"en-us": "下拉多选",
"zh-cn": "下拉多选",
"zh-tw": "下拉多选",
"vi": "下拉多选",
"ko": "下拉多选",
"kur-ckb": "下拉多选"
},
"value": [
{
"label": {
"zh-cn": "1",
"zh-tw": "1",
"en-us": "1",
"kur-ckb": "1",
"vi": "1",
"ko": "1"
},
"key": "ux131f9a94b4x125cfx0"
}
]
},
{
"key": "ux131f9e4254x11027x5",
"type": "radio",
"label": {
"en-us": "单选",
"zh-cn": "单选",
"zh-tw": "单选",
"vi": "单选",
"ko": "单选",
"kur-ckb": "单选"
},
"value": {
"label": {
"zh-cn": "3",
"zh-tw": "3",
"en-us": "3",
"kur-ckb": "3",
"vi": "3",
"ko": "3"
},
"key": "ux131f9e2003xf9cax2"
}
},
{
"key": "ux14a0a5175cxf26bx0",
"type": "document",
"label": {
"en-us": "身份证明文件",
"zh-cn": "身份证明文件",
"zh-tw": "身份证明文件",
"ja": "身份证明文件"
},
"value": [
{
"id": "hyl3",
"name": "fake_driving_license.png",
"url": "https://*.cloudfront.net/apps/4647b349a4e370ef34bab612dc5371d2/ux14a0a5175cxf26bx0_hyl3?response-content-disposition=filename%3D%22fake_driving_license.png%22&Expires=1779359605&Key-Pair-Id=K37NVEHESNA768&Signature=h5p0PrEpHzg0fcvbJQKlJsPPQQ%7EznM7fgzPPDDUB6ozq%7E2gBf4FIdEEGt%7EBNq28TpXKQdJs%7Ee80XHLzf0DLANAVubEYyCYw1dRrrO3RE6FNxH%7EH7%7EhTwSWfXu72TgDMaLsst0exNLbx7R6zLxOEUBjanf59TNB90a7yjmlvuo1HkxG9bFa0vZy2kOI8jlvf0Xu03DJ23E7GzFuj6TnhOzbs8qbQTercqka6maDB7cPNPlXpluSt5E5T9xvB-qtI4dfROpQY1MiVvErZeVdDdVImbfS9Cf7HB5pwvJn21LQnoAxWqxpzy6ZVQaRox608UR6y-OLNUaKjfv4rHUg8CXQ__"
}
]
},
{
"key": "ux14a0a5779exeee1x1",
"type": "document",
"label": {
"en-us": "银行卡(正面)",
"zh-cn": "银行卡(正面)",
"zh-tw": "银行卡(正面)",
"ja": "银行卡(正面)"
},
"value": [
{
"id": "rj1h",
"name": "fake_ID_card.png",
"url": "https://*.cloudfront.net/apps/4647b349a4e370ef34bab612dc5371d2/ux14a0a5779exeee1x1_rj1h?response-content-disposition=filename%3D%22fake_ID_card.png%22&Expires=1779359605&Key-Pair-Id=K37NVEHESNA768&Signature=B5Y28hTUEvwp85wZEIAKxnECcfAehHVfSb3TZ11d5d9mOfpjzbwF6NQDv7blN0OgpgSfoMzkCD%7EWJ6GfY7iCRYkouaTOJBvsCU--BDdhTHkZgbv69hUsDAY4iMWDnv0Q8V4hebt1hs-SkgnKwgPvBnT7hbY1HRfHn-18MoOxGCVt2DVPgbOWDlBfHJK0ucPjJ7blO3XFxkmz9a7BjiPCdF7mTOB0zD%7E1sj9%7E8e6SSonxg2wKUcCJmY58nX-lVTaVwxQ-6hMnPUZrdth%7EeaNIYuAuHbrBE5vmux6iJ3rcBupByuIhH80KlFwZCLplN9jUvGuRG4qT083Jc-dx327lhw__"
}
]
},
{
"key": "ux14a0a5b9ebxee22x2",
"type": "text",
"label": {
"en-us": "银行卡(背面)",
"zh-cn": "银行卡(背面)",
"zh-tw": "银行卡(背面)",
"ja": "银行卡(背面)"
},
"value": "3232322"
},
{
"key": "ux131f9f01c8xb181x0",
"type": "checkbox",
"label": {
"en-us": "多选",
"zh-cn": "多选",
"zh-tw": "多选",
"vi": "多选",
"ko": "多选",
"kur-ckb": "多选"
},
"value": [
{
"label": {
"zh-cn": "2",
"zh-tw": "22",
"en-us": "2",
"kur-ckb": "2",
"vi": "2",
"ko": "2"
},
"key": "ux131f9ec1d7xfe0ax1"
}
],
"group_key": "ux131f95a6e2x572fx3",
"group_index": 0
},
{
"key": "ux131f9f7427x5e89x1",
"type": "phone",
"label": {
"en-us": "手机号",
"zh-cn": "手机号",
"zh-tw": "手机号",
"vi": "手机号",
"ko": "手机号",
"kur-ckb": "手机号"
},
"value": {
"number": "232132",
"country_code": "im"
},
"group_key": "ux131f95a6e2x572fx3",
"group_index": 0
},
{
"key": "ux131fa08706x6649x3",
"type": "date",
"label": {
"en-us": "日期",
"zh-cn": "日期",
"zh-tw": "日期",
"vi": "日期",
"ko": "日期",
"kur-ckb": "日期"
},
"value": "2026-05-12",
"group_key": "ux131f95a6e2x572fx3",
"group_index": 0
},
{
"key": "ux131fa1586ex6f72x4",
"type": "country",
"label": {
"en-us": "国籍",
"zh-cn": "国籍",
"zh-tw": "国籍",
"vi": "国籍",
"ko": "国籍",
"kur-ckb": "国籍"
},
"value": "jp",
"group_key": "ux131f95a6e2x572fx3",
"group_index": 0
},
{
"key": "ux131fa1fb47x2365x5",
"type": "nation",
"label": {
"en-us": "国家",
"zh-cn": "国家",
"zh-tw": "国家",
"vi": "国家",
"ko": "国家",
"kur-ckb": "国家"
},
"value": "jp",
"group_key": "ux131f95a6e2x572fx3",
"group_index": 0
},
{
"key": "ux131fa24131x18433x6",
"type": "location",
"label": {
"en-us": "城市",
"zh-cn": "城市",
"zh-tw": "城市",
"vi": "城市",
"ko": "城市",
"kur-ckb": "城市"
},
"value": {
"country": "jp",
"state": "13",
"city": "Fuchū"
},
"group_key": "ux131f95a6e2x572fx3",
"group_index": 0
}
],
"form_id": "yhkgwuz3"
}
}