创建个人信息
创建人员的个人信息。
Error: 接口已升级,推荐使用:创建个人信息
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/corehr/v1/persons |
| HTTP Method | POST |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | corehr:corehr 更新核心人事信息 corehr:person:write 读写员工的个人信息 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
client_token | string | 否 | 根据client_token是否一致来判断是否为同一请求 示例值:12454646 |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
name_list | person_name\[\] | 是 | 姓名 |
└ local_primary | string | 否 | 姓 - 本地文字 示例值:"黄" |
└ local_first_name | string | 否 | 名 - 本地文字 示例值:"四" |
└ country_region_id | string | 是 | 国家 / 地区 示例值:"6862995757234914824" |
└ name_type | enum | 是 | 姓名类型,枚举值可通过文档【飞书人事枚举常量】姓名类型(name_type)枚举定义部分获得 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ local_first_name_2 | string | 否 | 名 - 第二本地文字 示例值:"五" |
└ local_primary_2 | string | 否 | 姓 - 第二本地文字 示例值:"王" |
└ additional_name_type | enum | 否 | 补充姓名类型,比如emergency_contact_name(紧急联系人姓名) |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ first_name | string | 否 | 名 示例值:"帅" |
└ full_name | string | 否 | 全名 示例值:"刘梓新" |
└ hereditary | string | 否 | 姓氏称谓 示例值:"王" |
└ custom_name | string | 否 | 自定义姓名 示例值:"刘梓新" |
└ custom_local_name | string | 否 | 本地文字的自定义姓名 示例值:"刘梓新" |
└ middle_name | string | 否 | 中间名 示例值:"大" |
└ name_primary | string | 否 | 姓 示例值:"王" |
└ secondary | string | 否 | 第二姓氏 示例值:"王" |
└ social | enum | 否 | 尊称 示例值:刘梓新 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ tertiary | string | 否 | 婚后姓氏 示例值:"王" |
└ title | enum | 否 | 头衔,比如 Mr. Miss. Mrs. Prof. Dr. 示例值:王 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ local_middle_name | string | 否 | 本地中间名 示例值:"大" |
└ local_secondary | string | 否 | 第二姓氏 - 本地文字 示例值:"王" |
└ custom_fields | object_field_data\[\] | 否 | 自定义字段 |
└ field_name | string | 是 | 字段名 示例值:"name" |
└ value | string | 是 | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") 示例值:""Sandy"" |
gender | enum | 否 | 性别,枚举值可通过文档【飞书人事枚举常量】性别(gender)枚举定义部分获得 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
date_of_birth | string | 否 | 出生日期 示例值:"2020-01-01" |
nationality_id | string | 否 | 国籍id 示例值:"123456789" |
race | enum | 否 | 民族 / 种族,枚举值可通过文档【飞书人事枚举常量】民族(race)枚举定义部分获得 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
marital_status | enum | 否 | 婚姻状况,枚举值可通过文档【飞书人事枚举常量】婚姻状况(marital_status)枚举定义部分获得 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
phone_list | phone\[\] | 否 | 电话列表,只有当满足下面所有条件时,电话在个人信息页才可见: - 电话号码不为空 - is_primary = "true" - phone_usage = "home" |
└ international_area_code | enum | 否 | 国家区号 常见如:86_china(中国)、852_hong_kong(中国香港)、886_taiwan(中国台湾)、853_macao(中国澳门)、1_united_states_of_america(美利坚合众国)、7_russian_federation(俄罗斯联邦)、44_united_kingdom(英国)、81_japan(日本)、82_korea_republic_of(大韩民国)、91_india(印度) |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ phone_number | string | 是 | 电话号码 示例值:"010-12345678" |
└ device_type | enum | 否 | 设备类型,枚举值可通过文档【飞书人事枚举常量】设备类型(device_type)枚举定义部分获得 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ phone_usage | enum | 否 | 电话用途,枚举值可通过文档【飞书人事枚举常量】电话用途(phone_usage)枚举定义部分获得 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ is_primary | boolean | 否 | 是否为主要电话 示例值:true |
└ is_public | boolean | 否 | 是否为公开电话 示例值:true |
└ custom_fields | object_field_data\[\] | 否 | 自定义字段 |
└ field_name | string | 是 | 字段名 示例值:"name" |
└ value | string | 是 | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") 示例值:""Sandy"" |
address_list | address\[\] | 否 | 地址列表 |
└ country_region_id | string | 是 | 国家 / 地区 示例值:"6862995757234914824" |
└ region_id | string | 否 | 主要行政区 示例值:"6863326815667095047" |
└ city_id | string | 否 | 城市 示例值:"6863333254578046471" |
└ distinct_id | string | 否 | 区/县 示例值:"6863333516579440141" |
└ local_address_line1 | string | 否 | 地址行 1(非拉丁语系的本地文字) 示例值:"丹佛测试地址-纽埃时区" |
└ local_address_line2 | string | 否 | 地址行 2(非拉丁语系的本地文字) 示例值:"PoewH" |
└ local_address_line3 | string | 否 | 地址行 3(非拉丁语系的本地文字) 示例值:"PoewH" |
└ local_address_line4 | string | 否 | 地址行 4(非拉丁语系的本地文字) 示例值:"jmwJc" |
└ local_address_line5 | string | 否 | 地址行 5(非拉丁语系的本地文字) 示例值:"jmwJc" |
└ local_address_line6 | string | 否 | 地址行 6(非拉丁语系的本地文字) 示例值:"jmwJc" |
└ local_address_line7 | string | 否 | 地址行 7(非拉丁语系的本地文字) 示例值:"jmwJc" |
└ local_address_line8 | string | 否 | 地址行 8(非拉丁语系的本地文字) 示例值:"rafSu" |
└ local_address_line9 | string | 否 | 地址行 9(非拉丁语系的本地文字) 示例值:"McPRG" |
└ postal_code | string | 否 | 邮政编码 示例值:"611530" |
└ custom_fields | object_field_data\[\] | 否 | 自定义字段 |
└ field_name | string | 是 | 字段名 示例值:"name" |
└ value | string | 是 | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") 示例值:""Sandy"" |
email_list | email\[\] | 否 | 邮箱列表 |
└ email | string | 是 | 邮箱号 示例值:"12456@test.com" |
└ custom_fields | object_field_data\[\] | 否 | 自定义字段 |
└ field_name | string | 是 | 字段名 示例值:"name" |
└ value | string | 是 | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") 示例值:""Sandy"" |
work_experience_list | work_experience\[\] | 否 | 工作履历列表 |
└ company_organization | i18n\[\] | 否 | 公司 / 组织 |
└ lang | string | 是 | 名称信息的语言 示例值:"zh-CN" |
└ value | string | 是 | 名称信息的内容 示例值:"张三" |
└ department | i18n\[\] | 否 | 部门 |
└ lang | string | 是 | 名称信息的语言 示例值:"zh-CN" |
└ value | string | 是 | 名称信息的内容 示例值:"张三" |
└ job | i18n\[\] | 否 | 岗位 |
└ lang | string | 是 | 名称信息的语言 示例值:"zh-CN" |
└ value | string | 是 | 名称信息的内容 示例值:"张三" |
└ description | i18n\[\] | 否 | 工作描述 |
└ lang | string | 是 | 名称信息的语言 示例值:"zh-CN" |
└ value | string | 是 | 名称信息的内容 示例值:"张三" |
└ start_date | string | 否 | 开始日期 示例值:"2020-01-01" |
└ end_date | string | 否 | 结束日期 示例值:"2020-01-01" |
└ custom_fields | object_field_data\[\] | 否 | 自定义字段 |
└ field_name | string | 是 | 字段名 示例值:"name" |
└ value | string | 是 | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") 示例值:""Sandy"" |
education_list | education\[\] | 否 | 教育经历列表 |
└ school | i18n\[\] | 是 | 学校 |
└ lang | string | 是 | 名称信息的语言 示例值:"zh-CN" |
└ value | string | 是 | 名称信息的内容 示例值:"张三" |
└ level_of_education | enum | 否 | 学历,枚举值可通过文档【飞书人事枚举常量】学历(level_of_education)枚举定义获得 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ start_date | string | 否 | 开始日期 示例值:"2011-09-01" |
└ end_date | string | 否 | 结束日期 示例值:"2015-06-30" |
└ field_of_study | i18n\[\] | 否 | 专业 |
└ lang | string | 是 | 名称信息的语言 示例值:"zh-CN" |
└ value | string | 是 | 名称信息的内容 示例值:"张三" |
└ degree | enum | 否 | 学位,枚举值可通过文档【飞书人事枚举常量】学位(degree)枚举定义获得 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ school_name | enum | 否 | 学校名称 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ field_of_study_name | enum | 否 | 专业名称 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ country_region_id | string | 否 | 国家地区ID 示例值:"1" |
└ expected_end_date | string | 否 | 预期结束日期 示例值:"2011-09-01" |
└ custom_fields | object_field_data\[\] | 否 | 自定义字段 |
└ field_name | string | 是 | 字段名 示例值:"name" |
└ value | string | 是 | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") 示例值:""Sandy"" |
bank_account_list | bank_account\[\] | 否 | 银行账号 |
└ bank_name | string | 否 | 银行名称,如果已经填入银行枚举,该字段可为空。如果要填写数据不在系统提供的枚举范围内,该字段存储自定义银行名称 示例值:"中国农业银行" |
└ bank_account_number | string | 是 | 银行账号 示例值:"6231200000001223" |
└ account_holder | string | 是 | 开户人姓名 示例值:"孟十五" |
└ bank | enum | 否 | 银行枚举,常见的银行枚举如:bank-5(交通银行)、bank-6(中国银行)、bank-7(中国建设银行)、bank-8(中国农业银行)、bank-9(中国工商银行)、bank-10(中国邮政储蓄银行)、bank-11(中国光大银行)、bank-12(中国民生银行)、bank-13(招商银行)、bank-14(中信银行)、bank-15(华夏银行) |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ branch_name | string | 否 | 支行名称 示例值:"中国农业银行支行" |
└ custom_fields | object_field_data\[\] | 否 | 自定义字段 |
└ field_name | string | 是 | 字段名 示例值:"name" |
└ value | string | 是 | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") 示例值:""Sandy"" |
└ country_region_id | string | 否 | 国家/地区id,详细信息可通过【查询国家/地区信息】接口查询获得 示例值:"12" |
└ bank_account_usage | enum\[\] | 否 | 银行卡用途,枚举值可通过文档【飞书人事枚举常量】银行卡用途(bank_account_usage)枚举定义部分获得 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ bank_account_type | enum | 否 | 银行卡类型,枚举值可通过文档【飞书人事枚举常量】银行卡类型(bank_account_type)枚举定义部分获得 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ currency_id | string | 否 | 货币id 示例值:"12QueryCountryRegionSubdivisionDataReq" |
national_id_list | national_id\[\] | 否 | 证件号码 |
└ national_id_type_id | string | 是 | 国家证件类型,枚举值可通过【批量查询国家证件类型】接口获取 示例值:"6863330041896371725" |
└ national_id_number | string | 是 | 证件号码 示例值:"1231131333" |
└ issue_date | string | 否 | 证件签发日期 示例值:"2020-04-01" |
└ expiration_date | string | 否 | 证件到期日期 示例值:"2020-05-21" |
└ country_region_id | string | 是 | 国家 / 地区 示例值:"6862995757234914824" |
└ issued_by | string | 否 | 证件签发机构 示例值:"北京市公安局" |
└ custom_fields | object_field_data\[\] | 否 | 自定义字段 |
└ field_name | string | 是 | 字段名 示例值:"name" |
└ value | string | 是 | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") 示例值:""Sandy"" |
dependent_list | dependent\[\] | 否 | 亲属列表 |
└ name | person_name | 否 | 亲属姓名 |
└ local_primary | string | 否 | 姓 - 本地文字 示例值:"黄" |
└ local_first_name | string | 否 | 名 - 本地文字 示例值:"四" |
└ country_region_id | string | 是 | 国家 / 地区 示例值:"6862995757234914824" |
└ name_type | enum | 是 | 姓名类型,枚举值可通过文档【飞书人事枚举常量】姓名类型(name_type)枚举定义部分获得 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ local_first_name_2 | string | 否 | 名 - 第二本地文字 示例值:"五" |
└ local_primary_2 | string | 否 | 姓 - 第二本地文字 示例值:"王" |
└ additional_name_type | enum | 否 | 补充姓名类型,比如emergency_contact_name(紧急联系人姓名) |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ first_name | string | 否 | 名 示例值:"帅" |
└ full_name | string | 否 | 全名 示例值:"刘梓新" |
└ hereditary | string | 否 | 姓氏称谓 示例值:"王" |
└ custom_name | string | 否 | 自定义姓名 示例值:"刘梓新" |
└ custom_local_name | string | 否 | 本地文字的自定义姓名 示例值:"刘梓新" |
└ middle_name | string | 否 | 中间名 示例值:"大" |
└ name_primary | string | 否 | 姓 示例值:"王" |
└ secondary | string | 否 | 第二姓氏 示例值:"王" |
└ social | enum | 否 | 尊称 示例值:刘梓新 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ tertiary | string | 否 | 婚后姓氏 示例值:"王" |
└ title | enum | 否 | 头衔,比如 Mr. Miss. Mrs. Prof. Dr. 示例值:王 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ local_middle_name | string | 否 | 本地中间名 示例值:"大" |
└ local_secondary | string | 否 | 第二姓氏 - 本地文字 示例值:"王" |
└ custom_fields | object_field_data\[\] | 否 | 自定义字段 |
└ field_name | string | 是 | 字段名 示例值:"name" |
└ value | string | 是 | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") 示例值:""Sandy"" |
└ relationship | enum | 是 | 亲属关系,枚举值可通过文档【飞书人事枚举常量】亲属关系(relationship)枚举定义获得 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ gender | enum | 否 | 亲属性别,枚举值可通过文档【飞书人事枚举常量】性别(gender)枚举定义部分获得 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ date_of_birth | string | 否 | 生日 示例值:"2020-01-01" |
└ nationality_id | string | 否 | 国籍 示例值:"7075702734054164011" |
└ national_id_list | national_id\[\] | 否 | 证件号码 |
└ national_id_type_id | string | 是 | 国家证件类型,枚举值可通过【批量查询国家证件类型】接口获取 示例值:"6863330041896371725" |
└ national_id_number | string | 是 | 证件号码 示例值:"1231131333" |
└ issue_date | string | 否 | 证件签发日期 示例值:"2020-04-01" |
└ expiration_date | string | 否 | 证件到期日期 示例值:"2020-05-21" |
└ country_region_id | string | 是 | 国家 / 地区 示例值:"6862995757234914824" |
└ issued_by | string | 否 | 证件签发机构 示例值:"北京市公安局" |
└ custom_fields | object_field_data\[\] | 否 | 自定义字段 |
└ field_name | string | 是 | 字段名 示例值:"name" |
└ value | string | 是 | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") 示例值:""Sandy"" |
└ spouses_working_status | enum | 否 | 配偶工作状态,比如working(在岗)、not_working(不在岗) |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ is_this_person_covered_by_health_insurance | boolean | 否 | 包含家属医疗保险 示例值:true |
└ is_this_person_allowed_for_tax_deduction | boolean | 否 | 允许家属抵扣税款 示例值:false |
└ custom_fields | object_field_data\[\] | 否 | 自定义字段 |
└ field_name | string | 是 | 字段名 示例值:"name" |
└ value | string | 是 | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") 示例值:""Sandy"" |
└ dependent_name | string | 否 | 家庭成员姓名 示例值:"张三" |
└ employer | string | 否 | 工作单位 示例值:"海淀区交警大队" |
└ job | string | 否 | 岗位 示例值:"保安" |
└ phone | phone | 否 | 电话 |
└ international_area_code | enum | 否 | 国家区号 常见如:86_china(中国)、852_hong_kong(中国香港)、886_taiwan(中国台湾)、853_macao(中国澳门)、1_united_states_of_america(美利坚合众国)、7_russian_federation(俄罗斯联邦)、44_united_kingdom(英国)、81_japan(日本)、82_korea_republic_of(大韩民国)、91_india(印度) |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ phone_number | string | 是 | 电话号码 示例值:"010-12345678" |
└ custom_fields | object_field_data\[\] | 否 | 自定义字段 |
└ field_name | string | 是 | 字段名 示例值:"name" |
└ value | string | 是 | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") 示例值:""Sandy"" |
└ address | address | 否 | 联系地址 |
└ id | string | 否 | 地址ID 示例值:"6989822217869624863" |
└ country_region_id | string | 是 | 国家 / 地区 示例值:"6862995757234914824" |
└ region_id | string | 否 | 主要行政区 示例值:"6863326815667095047" |
└ city_id | string | 否 | 城市 示例值:"6863333254578046471" |
└ distinct_id | string | 否 | 区/县 示例值:"6863333516579440141" |
└ local_address_line1 | string | 否 | 地址行 1(非拉丁语系的本地文字) 示例值:"丹佛测试地址-纽埃时区" |
└ local_address_line2 | string | 否 | 地址行 2(非拉丁语系的本地文字) 示例值:"PoewH" |
└ local_address_line3 | string | 否 | 地址行 1(非拉丁语系的本地文字) 示例值:"丹佛测试地址-纽埃时区" |
└ local_address_line4 | string | 否 | 地址行 2(非拉丁语系的本地文字) 示例值:"PoewH" |
└ local_address_line5 | string | 否 | 地址行 3(非拉丁语系的本地文字) 示例值:"PoewH" |
└ local_address_line6 | string | 否 | 地址行 4(非拉丁语系的本地文字) 示例值:"jmwJc" |
└ local_address_line7 | string | 否 | 地址行 5(非拉丁语系的本地文字) 示例值:"jmwJc" |
└ local_address_line8 | string | 否 | 地址行 6(非拉丁语系的本地文字) 示例值:"jmwJc" |
└ local_address_line9 | string | 否 | 地址行 7(非拉丁语系的本地文字) 示例值:"jmwJc" |
└ postal_code | string | 否 | 地址行 8(非拉丁语系的本地文字) 示例值:"rafSu" |
└ custom_fields | object_field_data\[\] | 否 | 地址行 9(非拉丁语系的本地文字) 示例值:McPRG |
└ field_name | string | 是 | 字段名 示例值:"name" |
└ value | string | 是 | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(123, 123.23, true, ["id1","id2], 2006-01-02 15:04:05]) 示例值:"Sandy" |
└ birth_certificate_of_child | file\[\] | 否 | 出生证明 |
└ id | string | 否 | 上传文件ID 示例值:"150018109586e8ea745e47ae8feb3722dbe1d03a181336393633393133303431393831343930373235150200" |
emergency_contact_list | emergency_contact\[\] | 否 | 紧急联系人列表 |
└ name | person_name | 否 | 紧急联系人姓名 |
└ local_primary | string | 否 | 姓 - 本地文字 示例值:"黄" |
└ local_first_name | string | 否 | 名 - 本地文字 示例值:"四" |
└ country_region_id | string | 是 | 国家 / 地区 示例值:"6862995757234914824" |
└ name_type | enum | 是 | 姓名类型,枚举值可通过文档【飞书人事枚举常量】姓名类型(name_type)枚举定义部分获得 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ local_first_name_2 | string | 否 | 名 - 第二本地文字 示例值:"五" |
└ local_primary_2 | string | 否 | 姓 - 第二本地文字 示例值:"王" |
└ additional_name_type | enum | 否 | 补充姓名类型,比如emergency_contact_name(紧急联系人姓名) |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ first_name | string | 否 | 名 示例值:"帅" |
└ full_name | string | 否 | 全名 示例值:"刘梓新" |
└ hereditary | string | 否 | 姓氏称谓 示例值:"王" |
└ custom_name | string | 否 | 自定义姓名 示例值:"刘梓新" |
└ custom_local_name | string | 否 | 本地文字的自定义姓名 示例值:"刘梓新" |
└ middle_name | string | 否 | 中间名 示例值:"大" |
└ name_primary | string | 否 | 姓 示例值:"王" |
└ secondary | string | 否 | 第二姓氏 示例值:"王" |
└ social | enum | 否 | 尊称 示例值:刘梓新 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ tertiary | string | 否 | 婚后姓氏 示例值:"王" |
└ title | enum | 否 | 头衔,比如 Mr. Miss. Mrs. Prof. Dr. 示例值:王 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ local_middle_name | string | 否 | 本地中间名 示例值:"大" |
└ local_secondary | string | 否 | 第二姓氏 - 本地文字 示例值:"王" |
└ custom_fields | object_field_data\[\] | 否 | 自定义字段 |
└ field_name | string | 是 | 字段名 示例值:"name" |
└ value | string | 是 | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") 示例值:""Sandy"" |
└ relationship | enum | 否 | 紧急联系人与本人亲属关系,枚举值可通过文档【飞书人事枚举常量】亲属关系(relationship)枚举定义获得 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ phone_ist | phone\[\] | 否 | 紧急联系人电话 |
└ international_area_code | enum | 否 | 国家区号 常见如:86_china(中国)、852_hong_kong(中国香港)、886_taiwan(中国台湾)、853_macao(中国澳门)、1_united_states_of_america(美利坚合众国)、7_russian_federation(俄罗斯联邦)、44_united_kingdom(英国)、81_japan(日本)、82_korea_republic_of(大韩民国)、91_india(印度) |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ phone_number | string | 是 | 电话号码 示例值:"010-12345678" |
└ custom_fields | object_field_data\[\] | 否 | 自定义字段 |
└ field_name | string | 是 | 字段名 示例值:"name" |
└ value | string | 是 | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") 示例值:""Sandy"" |
└ custom_fields | object_field_data\[\] | 否 | 自定义字段 |
└ field_name | string | 是 | 字段名 示例值:"name" |
└ value | string | 是 | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") 示例值:""Sandy"" |
└ legal_name | string | 否 | 法定姓名 示例值:"张三" |
date_entered_workforce | string | 否 | 参加工作日期 示例值:"2020-10-01" |
profile_image_id | string | 否 | 头像资源的 ID 示例值:"dfysuc8x76dsfsw" |
custom_fields | object_field_data\[\] | 否 | 自定义字段 |
└ field_name | string | 是 | 字段名 示例值:"name" |
└ value | string | 是 | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") 示例值:""Sandy"" |
resident_tax_id_list | string\[\] | 否 | 纳税身份信息 示例值:["123456"] |
age | int | 否 | 年龄 示例值:25 |
personal_profile | personal_profile\[\] | 否 | 个人资料 |
└ personal_profile_type | enum | 否 | 个人资料类型,比如 银行储蓄卡复印件、证件照、个人信息采集表、生活照 |
└ enum_name | string | 是 | 枚举值 示例值:"type_1" |
└ files | file\[\] | 否 | 上传文件列表 |
└ id | string | 否 | 上传文件ID 示例值:"150018109586e8ea745e47ae8feb3722dbe1d03a181336393633393133303431393831343930373235150200" |
请求体示例
json
{
"name_list": [
{
"local_primary": "黄",
"local_first_name": "四",
"country_region_id": "6862995757234914824",
"name_type": {
"enum_name": "type_1"
},
"local_first_name_2": "五",
"local_primary_2": "王",
"additional_name_type": {
"enum_name": "type_1"
},
"first_name": "帅",
"full_name": "刘梓新",
"hereditary": "王",
"custom_name": "刘梓新",
"custom_local_name": "刘梓新",
"middle_name": "大",
"name_primary": "王",
"secondary": "王",
"social": {
"enum_name": "type_1"
},
"tertiary": "王",
"title": {
"enum_name": "type_1"
},
"local_middle_name": "大",
"local_secondary": "王",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
}
],
"gender": {
"enum_name": "type_1"
},
"date_of_birth": "2020-01-01",
"nationality_id": "123456789",
"race": {
"enum_name": "type_1"
},
"marital_status": {
"enum_name": "type_1"
},
"phone_list": [
{
"international_area_code": {
"enum_name": "type_1"
},
"phone_number": "010-12345678",
"device_type": {
"enum_name": "type_1"
},
"phone_usage": {
"enum_name": "type_1"
},
"is_primary": true,
"is_public": true,
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
}
],
"address_list": [
{
"country_region_id": "6862995757234914824",
"region_id": "6863326815667095047",
"city_id": "6863333254578046471",
"distinct_id": "6863333516579440141",
"local_address_line1": "丹佛测试地址-纽埃时区",
"local_address_line2": "PoewH",
"local_address_line3": "PoewH",
"local_address_line4": "jmwJc",
"local_address_line5": "jmwJc",
"local_address_line6": "jmwJc",
"local_address_line7": "jmwJc",
"local_address_line8": "rafSu",
"local_address_line9": "McPRG",
"postal_code": "611530",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
}
],
"email_list": [
{
"email": "12456@test.com",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
}
],
"work_experience_list": [
{
"company_organization": [
{
"lang": "zh-CN",
"value": "张三"
}
],
"department": [
{
"lang": "zh-CN",
"value": "张三"
}
],
"job": [
{
"lang": "zh-CN",
"value": "张三"
}
],
"description": [
{
"lang": "zh-CN",
"value": "张三"
}
],
"start_date": "2020-01-01",
"end_date": "2020-01-01",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
}
],
"education_list": [
{
"school": [
{
"lang": "zh-CN",
"value": "张三"
}
],
"level_of_education": {
"enum_name": "type_1"
},
"start_date": "2011-09-01",
"end_date": "2015-06-30",
"field_of_study": [
{
"lang": "zh-CN",
"value": "张三"
}
],
"degree": {
"enum_name": "type_1"
},
"school_name": {
"enum_name": "type_1"
},
"field_of_study_name": {
"enum_name": "type_1"
},
"country_region_id": "1",
"expected_end_date": "2011-09-01",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
}
],
"bank_account_list": [
{
"bank_name": "中国农业银行",
"bank_account_number": "6231200000001223",
"account_holder": "孟十五",
"bank": {
"enum_name": "type_1"
},
"branch_name": "中国农业银行支行",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
],
"country_region_id": "12",
"bank_account_usage": [
{
"enum_name": "type_1"
}
],
"bank_account_type": {
"enum_name": "type_1"
},
"currency_id": "12QueryCountryRegionSubdivisionDataReq"
}
],
"national_id_list": [
{
"national_id_type_id": "6863330041896371725",
"national_id_number": "1231131333",
"issue_date": "2020-04-01",
"expiration_date": "2020-05-21",
"country_region_id": "6862995757234914824",
"issued_by": "北京市公安局",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
}
],
"dependent_list": [
{
"name": {
"local_primary": "黄",
"local_first_name": "四",
"country_region_id": "6862995757234914824",
"name_type": {
"enum_name": "type_1"
},
"local_first_name_2": "五",
"local_primary_2": "王",
"additional_name_type": {
"enum_name": "type_1"
},
"first_name": "帅",
"full_name": "刘梓新",
"hereditary": "王",
"custom_name": "刘梓新",
"custom_local_name": "刘梓新",
"middle_name": "大",
"name_primary": "王",
"secondary": "王",
"social": {
"enum_name": "type_1"
},
"tertiary": "王",
"title": {
"enum_name": "type_1"
},
"local_middle_name": "大",
"local_secondary": "王",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
},
"relationship": {
"enum_name": "type_1"
},
"gender": {
"enum_name": "type_1"
},
"date_of_birth": "2020-01-01",
"nationality_id": "7075702734054164011",
"national_id_list": [
{
"national_id_type_id": "6863330041896371725",
"national_id_number": "1231131333",
"issue_date": "2020-04-01",
"expiration_date": "2020-05-21",
"country_region_id": "6862995757234914824",
"issued_by": "北京市公安局",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
}
],
"spouses_working_status": {
"enum_name": "type_1"
},
"is_this_person_covered_by_health_insurance": true,
"is_this_person_allowed_for_tax_deduction": false,
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
],
"dependent_name": "张三",
"employer": "海淀区交警大队",
"job": "保安",
"phone": {
"international_area_code": {
"enum_name": "type_1"
},
"phone_number": "010-12345678",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
},
"address": {
"id": "6989822217869624863",
"country_region_id": "6862995757234914824",
"region_id": "6863326815667095047",
"city_id": "6863333254578046471",
"distinct_id": "6863333516579440141",
"local_address_line1": "丹佛测试地址-纽埃时区",
"local_address_line2": "PoewH",
"local_address_line3": "丹佛测试地址-纽埃时区",
"local_address_line4": "PoewH",
"local_address_line5": "PoewH",
"local_address_line6": "jmwJc",
"local_address_line7": "jmwJc",
"local_address_line8": "jmwJc",
"local_address_line9": "jmwJc",
"postal_code": "rafSu",
"custom_fields": [
{
"field_name": "name",
"value": "Sandy"
}
]
},
"birth_certificate_of_child": [
{
"id": "150018109586e8ea745e47ae8feb3722dbe1d03a181336393633393133303431393831343930373235150200"
}
]
}
],
"emergency_contact_list": [
{
"name": {
"local_primary": "黄",
"local_first_name": "四",
"country_region_id": "6862995757234914824",
"name_type": {
"enum_name": "type_1"
},
"local_first_name_2": "五",
"local_primary_2": "王",
"additional_name_type": {
"enum_name": "type_1"
},
"first_name": "帅",
"full_name": "刘梓新",
"hereditary": "王",
"custom_name": "刘梓新",
"custom_local_name": "刘梓新",
"middle_name": "大",
"name_primary": "王",
"secondary": "王",
"social": {
"enum_name": "type_1"
},
"tertiary": "王",
"title": {
"enum_name": "type_1"
},
"local_middle_name": "大",
"local_secondary": "王",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
},
"relationship": {
"enum_name": "type_1"
},
"phone_ist": [
{
"international_area_code": {
"enum_name": "type_1"
},
"phone_number": "010-12345678",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
}
],
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
],
"legal_name": "张三"
}
],
"date_entered_workforce": "2020-10-01",
"profile_image_id": "dfysuc8x76dsfsw",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
],
"resident_tax_id_list": [
"123456"
],
"age": 25,
"personal_profile": [
{
"personal_profile_type": {
"enum_name": "type_1"
},
"files": [
{
"id": "150018109586e8ea745e47ae8feb3722dbe1d03a181336393633393133303431393831343930373235150200"
}
]
}
]
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ person | person | 创建成功返回Person信息 |
└ phone_number | string | 个人手机号 |
└ legal_name | string | 法定姓名 |
└ preferred_name | string | 常用名 展示中英文混合名,示例值:张三(Zhang San) |
└ id | string | Person ID |
└ name_list | person_name\[\] | 姓名 |
└ local_primary | string | 姓 - 本地文字 |
└ local_first_name | string | 名 - 本地文字 |
└ country_region_id | string | 国家 / 地区 |
└ name_type | enum | 姓名类型,枚举值可通过文档【飞书人事枚举常量】姓名类型(name_type)枚举定义部分获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ local_first_name_2 | string | 名 - 第二本地文字 |
└ local_primary_2 | string | 姓 - 第二本地文字 |
└ additional_name_type | enum | 补充姓名类型,比如emergency_contact_name(紧急联系人姓名) |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ first_name | string | 名 |
└ full_name | string | 全名 |
└ hereditary | string | 姓氏称谓 |
└ middle_name | string | 中间名 |
└ name_primary | string | 姓 |
└ secondary | string | 第二姓氏 |
└ social | enum | 尊称 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ tertiary | string | 婚后姓氏 |
└ title | enum | 头衔,比如 Mr. Miss. Mrs. Prof. Dr. |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ local_middle_name | string | 本地中间名 |
└ local_secondary | string | 第二姓氏 - 本地文字 |
└ display_name_local_and_western_script | string | 展示姓名(本地和西方文字),按照如下规则自动计算得到 - 中国(包括中国香港、中国澳门、中国台湾)姓名,默认取 custom_local_name 字段的值,如果为空则取 custom_name 的值 - 非中国姓名,根据该国家/地区的规则自动将 local_primary、local_first_name、name_primary、first_name 等字段拼接在一起 |
└ display_name_local_script | string | 展示姓名(本地文字),按照如下规则自动计算得到 - 中国(包括中国香港、中国澳门、中国台湾)姓名,默认取 custom_local_name 字段的值 - 非中国姓名,根据该国家/地区的规则自动将 local_primary、local_first_name 等字段拼接在一起 |
└ display_name_western_script | string | 展示姓名(西方文字),按照如下规则自动计算得到 - 中国(包括中国香港、中国澳门、中国台湾)姓名,默认取 custom_name 字段的值 - 非中国姓名,根据该国家/地区的规则自动将 name_primary、first_name 等字段拼接在一起 |
└ custom_fields | object_field_data\[\] | 自定义字段 |
└ field_name | string | 字段名 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") |
└ gender | enum | 性别,枚举值可通过文档【飞书人事枚举常量】性别(gender)枚举定义部分获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ date_of_birth | string | 出生日期 |
└ nationality_id | string | 国籍id |
└ race | enum | 民族 / 种族,枚举值可通过文档【飞书人事枚举常量】民族(race)枚举定义部分获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ marital_status | enum | 婚姻状况,枚举值可通过文档【飞书人事枚举常量】婚姻状况(marital_status)枚举定义部分获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ phone_list | phone\[\] | 电话列表,只有当满足下面所有条件时,电话在个人信息页才可见: - 电话号码不为空 - is_primary = "true" - phone_usage = "home" |
└ international_area_code | enum | 国家区号 常见如:86_china(中国)、852_hong_kong(中国香港)、886_taiwan(中国台湾)、853_macao(中国澳门)、1_united_states_of_america(美利坚合众国)、7_russian_federation(俄罗斯联邦)、44_united_kingdom(英国)、81_japan(日本)、82_korea_republic_of(大韩民国)、91_india(印度) |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ phone_number | string | 电话号码 |
└ formatted_phone_number | string | 完整电话号码 |
└ device_type | enum | 设备类型,枚举值可通过文档【飞书人事枚举常量】设备类型(device_type)枚举定义部分获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ phone_usage | enum | 电话用途,枚举值可通过文档【飞书人事枚举常量】电话用途(phone_usage)枚举定义部分获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ is_primary | boolean | 是否为主要电话 |
└ is_public | boolean | 是否为公开电话 |
└ custom_fields | object_field_data\[\] | 自定义字段 |
└ field_name | string | 字段名 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") |
└ address_list | address\[\] | 地址列表 |
└ full_address_local_script | string | 完整地址(本地文字) |
└ full_address_western_script | string | 完整地址(西方文字) |
└ id | string | 地址ID |
└ country_region_id | string | 国家 / 地区 |
└ region_id | string | 主要行政区 |
└ city_id | string | 城市 |
└ distinct_id | string | 区/县 |
└ local_address_line1 | string | 地址行 1(非拉丁语系的本地文字) |
└ local_address_line2 | string | 地址行 2(非拉丁语系的本地文字) |
└ local_address_line3 | string | 地址行 3(非拉丁语系的本地文字) |
└ local_address_line4 | string | 地址行 4(非拉丁语系的本地文字) |
└ local_address_line5 | string | 地址行 5(非拉丁语系的本地文字) |
└ local_address_line6 | string | 地址行 6(非拉丁语系的本地文字) |
└ local_address_line7 | string | 地址行 7(非拉丁语系的本地文字) |
└ local_address_line8 | string | 地址行 8(非拉丁语系的本地文字) |
└ local_address_line9 | string | 地址行 9(非拉丁语系的本地文字) |
└ postal_code | string | 邮政编码 |
└ custom_fields | object_field_data\[\] | 自定义字段 |
└ field_name | string | 字段名 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") |
└ email_list | email\[\] | 邮箱列表 |
└ email | string | 邮箱号 |
└ custom_fields | object_field_data\[\] | 自定义字段 |
└ field_name | string | 字段名 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") |
└ work_experience_list | work_experience\[\] | 工作履历列表 |
└ company_organization | i18n\[\] | 公司 / 组织 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ department | i18n\[\] | 部门 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ job | i18n\[\] | 岗位 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ description | i18n\[\] | 工作描述 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ start_date | string | 开始日期 |
└ end_date | string | 结束日期 |
└ custom_fields | object_field_data\[\] | 自定义字段 |
└ field_name | string | 字段名 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") |
└ education_list | education\[\] | 教育经历列表 |
└ school | i18n\[\] | 学校 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ level_of_education | enum | 学历,枚举值可通过文档【飞书人事枚举常量】学历(level_of_education)枚举定义获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ start_date | string | 开始日期 |
└ end_date | string | 结束日期 |
└ field_of_study | i18n\[\] | 专业 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ degree | enum | 学位,枚举值可通过文档【飞书人事枚举常量】学位(degree)枚举定义获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ school_name | enum | 学校名称 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ field_of_study_name | enum | 专业名称 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ country_region_id | string | 国家地区ID |
└ expected_end_date | string | 预期结束日期 |
└ custom_fields | object_field_data\[\] | 自定义字段 |
└ field_name | string | 字段名 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") |
└ bank_account_list | bank_account\[\] | 银行账号 |
└ bank_name | string | 银行名称,如果已经填入银行枚举,该字段可为空。如果要填写数据不在系统提供的枚举范围内,该字段存储自定义银行名称 |
└ bank_account_number | string | 银行账号 |
└ account_holder | string | 开户人姓名 |
└ bank | enum | 银行枚举,常见的银行枚举如:bank-5(交通银行)、bank-6(中国银行)、bank-7(中国建设银行)、bank-8(中国农业银行)、bank-9(中国工商银行)、bank-10(中国邮政储蓄银行)、bank-11(中国光大银行)、bank-12(中国民生银行)、bank-13(招商银行)、bank-14(中信银行)、bank-15(华夏银行) |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ branch_name | string | 支行名称 |
└ custom_fields | object_field_data\[\] | 自定义字段 |
└ field_name | string | 字段名 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") |
└ country_region_id | string | 国家/地区id,详细信息可通过【查询国家/地区信息】接口查询获得 |
└ bank_account_usage | enum\[\] | 银行卡用途,枚举值可通过文档【飞书人事枚举常量】银行卡用途(bank_account_usage)枚举定义部分获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ bank_account_type | enum | 银行卡类型,枚举值可通过文档【飞书人事枚举常量】银行卡类型(bank_account_type)枚举定义部分获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ currency_id | string | 货币id |
└ national_id_list | national_id\[\] | 证件号码 |
└ national_id_type_id | string | 国家证件类型,枚举值可通过【批量查询国家证件类型】接口获取 |
└ national_id_number | string | 证件号码 |
└ issue_date | string | 证件签发日期 |
└ expiration_date | string | 证件到期日期 |
└ country_region_id | string | 国家 / 地区 |
└ issued_by | string | 证件签发机构 |
└ custom_fields | object_field_data\[\] | 自定义字段 |
└ field_name | string | 字段名 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") |
└ dependent_list | dependent\[\] | 亲属列表 |
└ name | person_name | 亲属姓名 |
└ local_primary | string | 姓 - 本地文字 |
└ local_first_name | string | 名 - 本地文字 |
└ country_region_id | string | 国家 / 地区 |
└ name_type | enum | 姓名类型,枚举值可通过文档【飞书人事枚举常量】姓名类型(name_type)枚举定义部分获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ local_first_name_2 | string | 名 - 第二本地文字 |
└ local_primary_2 | string | 姓 - 第二本地文字 |
└ additional_name_type | enum | 补充姓名类型,比如emergency_contact_name(紧急联系人姓名) |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ first_name | string | 名 |
└ full_name | string | 全名 |
└ hereditary | string | 姓氏称谓 |
└ custom_name | string | 自定义姓名 |
└ custom_local_name | string | 本地文字的自定义姓名 |
└ middle_name | string | 中间名 |
└ name_primary | string | 姓 |
└ secondary | string | 第二姓氏 |
└ social | enum | 尊称 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ tertiary | string | 婚后姓氏 |
└ title | enum | 头衔,比如 Mr. Miss. Mrs. Prof. Dr. |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ local_middle_name | string | 本地中间名 |
└ local_secondary | string | 第二姓氏 - 本地文字 |
└ display_name_local_and_western_script | string | 展示姓名(本地和西方文字),按照如下规则自动计算得到 - 中国(包括中国香港、中国澳门、中国台湾)姓名,默认取 custom_local_name 字段的值,如果为空则取 custom_name 的值 - 非中国姓名,根据该国家/地区的规则自动将 local_primary、local_first_name、name_primary、first_name 等字段拼接在一起 |
└ display_name_local_script | string | 展示姓名(本地文字),按照如下规则自动计算得到 - 中国(包括中国香港、中国澳门、中国台湾)姓名,默认取 custom_local_name 字段的值 - 非中国姓名,根据该国家/地区的规则自动将 local_primary、local_first_name 等字段拼接在一起 |
└ display_name_western_script | string | 展示姓名(西方文字),按照如下规则自动计算得到 - 中国(包括中国香港、中国澳门、中国台湾)姓名,默认取 custom_name 字段的值 - 非中国姓名,根据该国家/地区的规则自动将 name_primary、first_name 等字段拼接在一起 |
└ custom_fields | object_field_data\[\] | 自定义字段 |
└ field_name | string | 字段名 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") |
└ relationship | enum | 亲属关系,枚举值可通过文档【飞书人事枚举常量】亲属关系(relationship)枚举定义获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ gender | enum | 亲属性别,枚举值可通过文档【飞书人事枚举常量】性别(gender)枚举定义部分获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ date_of_birth | string | 生日 |
└ nationality_id | string | 国籍 |
└ national_id_list | national_id\[\] | 证件号码 |
└ national_id_type_id | string | 国家证件类型,枚举值可通过【批量查询国家证件类型】接口获取 |
└ national_id_number | string | 证件号码 |
└ issue_date | string | 证件签发日期 |
└ expiration_date | string | 证件到期日期 |
└ country_region_id | string | 国家 / 地区 |
└ issued_by | string | 证件签发机构 |
└ custom_fields | object_field_data\[\] | 自定义字段 |
└ field_name | string | 字段名 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") |
└ spouses_working_status | enum | 配偶工作状态,比如working(在岗)、not_working(不在岗) |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ is_this_person_covered_by_health_insurance | boolean | 包含家属医疗保险 |
└ is_this_person_allowed_for_tax_deduction | boolean | 允许家属抵扣税款 |
└ custom_fields | object_field_data\[\] | 自定义字段 |
└ field_name | string | 字段名 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") |
└ dependent_name | string | 家庭成员姓名 |
└ employer | string | 工作单位 |
└ job | string | 岗位 |
└ phone | phone | 电话 |
└ international_area_code | enum | 国家区号 常见如:86_china(中国)、852_hong_kong(中国香港)、886_taiwan(中国台湾)、853_macao(中国澳门)、1_united_states_of_america(美利坚合众国)、7_russian_federation(俄罗斯联邦)、44_united_kingdom(英国)、81_japan(日本)、82_korea_republic_of(大韩民国)、91_india(印度) |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ phone_number | string | 电话号码 |
└ formatted_phone_number | string | 完整电话号码 |
└ custom_fields | object_field_data\[\] | 自定义字段 |
└ field_name | string | 字段名 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") |
└ address | address | 联系地址 |
└ full_address_local_script | string | 完整地址(本地文字) |
└ full_address_western_script | string | 完整地址(西方文字) |
└ id | string | 地址ID |
└ country_region_id | string | 国家 / 地区 |
└ region_id | string | 主要行政区 |
└ city_id | string | 城市 |
└ distinct_id | string | 区/县 |
└ local_address_line1 | string | 地址行 1(非拉丁语系的本地文字) |
└ local_address_line2 | string | 地址行 2(非拉丁语系的本地文字) |
└ local_address_line3 | string | 地址行 1(非拉丁语系的本地文字) |
└ local_address_line4 | string | 地址行 2(非拉丁语系的本地文字) |
└ local_address_line5 | string | 地址行 3(非拉丁语系的本地文字) |
└ local_address_line6 | string | 地址行 4(非拉丁语系的本地文字) |
└ local_address_line7 | string | 地址行 5(非拉丁语系的本地文字) |
└ local_address_line8 | string | 地址行 6(非拉丁语系的本地文字) |
└ local_address_line9 | string | 地址行 7(非拉丁语系的本地文字) |
└ postal_code | string | 地址行 8(非拉丁语系的本地文字) |
└ custom_fields | object_field_data\[\] | 地址行 9(非拉丁语系的本地文字) |
└ field_name | string | 字段名 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(123, 123.23, true, ["id1","id2], 2006-01-02 15:04:05]) |
└ birth_certificate_of_child | file\[\] | 出生证明 |
└ id | string | 上传文件ID |
└ emergency_contact_list | emergency_contact\[\] | 紧急联系人列表 |
└ name | person_name | 紧急联系人姓名 |
└ local_primary | string | 姓 - 本地文字 |
└ local_first_name | string | 名 - 本地文字 |
└ country_region_id | string | 国家 / 地区 |
└ name_type | enum | 姓名类型,枚举值可通过文档【飞书人事枚举常量】姓名类型(name_type)枚举定义部分获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ local_first_name_2 | string | 名 - 第二本地文字 |
└ local_primary_2 | string | 姓 - 第二本地文字 |
└ additional_name_type | enum | 补充姓名类型,比如emergency_contact_name(紧急联系人姓名) |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ first_name | string | 名 |
└ full_name | string | 全名 |
└ hereditary | string | 姓氏称谓 |
└ custom_name | string | 自定义姓名 |
└ custom_local_name | string | 本地文字的自定义姓名 |
└ middle_name | string | 中间名 |
└ name_primary | string | 姓 |
└ secondary | string | 第二姓氏 |
└ social | enum | 尊称 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ tertiary | string | 婚后姓氏 |
└ title | enum | 头衔,比如 Mr. Miss. Mrs. Prof. Dr. |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ local_middle_name | string | 本地中间名 |
└ local_secondary | string | 第二姓氏 - 本地文字 |
└ display_name_local_and_western_script | string | 展示姓名(本地和西方文字),按照如下规则自动计算得到 - 中国(包括中国香港、中国澳门、中国台湾)姓名,默认取 custom_local_name 字段的值,如果为空则取 custom_name 的值 - 非中国姓名,根据该国家/地区的规则自动将 local_primary、local_first_name、name_primary、first_name 等字段拼接在一起 |
└ display_name_local_script | string | 展示姓名(本地文字),按照如下规则自动计算得到 - 中国(包括中国香港、中国澳门、中国台湾)姓名,默认取 custom_local_name 字段的值 - 非中国姓名,根据该国家/地区的规则自动将 local_primary、local_first_name 等字段拼接在一起 |
└ display_name_western_script | string | 展示姓名(西方文字),按照如下规则自动计算得到 - 中国(包括中国香港、中国澳门、中国台湾)姓名,默认取 custom_name 字段的值 - 非中国姓名,根据该国家/地区的规则自动将 name_primary、first_name 等字段拼接在一起 |
└ custom_fields | object_field_data\[\] | 自定义字段 |
└ field_name | string | 字段名 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") |
└ relationship | enum | 紧急联系人与本人亲属关系,枚举值可通过文档【飞书人事枚举常量】亲属关系(relationship)枚举定义获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ phone_ist | phone\[\] | 紧急联系人电话 |
└ international_area_code | enum | 国家区号 常见如:86_china(中国)、852_hong_kong(中国香港)、886_taiwan(中国台湾)、853_macao(中国澳门)、1_united_states_of_america(美利坚合众国)、7_russian_federation(俄罗斯联邦)、44_united_kingdom(英国)、81_japan(日本)、82_korea_republic_of(大韩民国)、91_india(印度) |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ phone_number | string | 电话号码 |
└ custom_fields | object_field_data\[\] | 自定义字段 |
└ field_name | string | 字段名 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") |
└ custom_fields | object_field_data\[\] | 自定义字段 |
└ field_name | string | 字段名 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") |
└ legal_name | string | 法定姓名 |
└ date_entered_workforce | string | 参加工作日期 |
└ profile_image_id | string | 头像资源的 ID |
└ custom_fields | object_field_data\[\] | 自定义字段 |
└ field_name | string | 字段名 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") |
└ email_address | string | 邮箱 |
└ resident_tax_id_list | string\[\] | 纳税身份信息 |
└ age | int | 年龄 |
└ highest_level_of_education | education | 最高学历教育 |
└ school | i18n\[\] | 学校 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ level_of_education | enum | 学历,枚举值可通过文档【飞书人事枚举常量】学历(level_of_education)枚举定义获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ start_date | string | 开始日期 |
└ end_date | string | 结束日期 |
└ field_of_study | i18n\[\] | 专业 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ degree | enum | 学位,枚举值可通过文档【飞书人事枚举常量】学位(degree)枚举定义获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ school_name | enum | 学校名称 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ field_of_study_name | enum | 专业名称 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ country_region_id | string | 国家地区ID |
└ expected_end_date | string | 预期结束日期 |
└ custom_fields | object_field_data\[\] | 自定义字段 |
└ field_name | string | 字段名 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") |
└ highest_degree_of_education | education | 最高学位教育经历 |
└ school | i18n\[\] | 学校 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ level_of_education | enum | 学历,枚举值可通过文档【飞书人事枚举常量】学历(level_of_education)枚举定义获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ start_date | string | 开始日期 |
└ end_date | string | 结束日期 |
└ field_of_study | i18n\[\] | 专业 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ degree | enum | 学位,枚举值可通过文档【飞书人事枚举常量】学位(degree)枚举定义获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ school_name | enum | 学校名称 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ field_of_study_name | enum | 专业名称 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ country_region_id | string | 国家地区ID |
└ expected_end_date | string | 预期结束日期 |
└ custom_fields | object_field_data\[\] | 自定义字段 |
└ field_name | string | 字段名 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") |
└ personal_profile | personal_profile\[\] | 个人资料 |
└ personal_profile_id | string | 个人资料 ID |
└ personal_profile_type | enum | 个人资料类型,比如 银行储蓄卡复印件、证件照、个人信息采集表、生活照 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ files | file\[\] | 上传文件列表 |
└ id | string | 上传文件ID |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"person": {
"phone_number": "11111111111",
"legal_name": "张三",
"preferred_name": "张四",
"id": "646465654545",
"name_list": [
{
"local_primary": "黄",
"local_first_name": "四",
"country_region_id": "6862995757234914824",
"name_type": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"local_first_name_2": "五",
"local_primary_2": "王",
"additional_name_type": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"first_name": "帅",
"full_name": "刘梓新",
"hereditary": "王",
"middle_name": "大",
"name_primary": "王",
"secondary": "王",
"social": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"tertiary": "王",
"title": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"local_middle_name": "大",
"local_secondary": "王",
"display_name_local_and_western_script": "刘梓新",
"display_name_local_script": "刘梓新",
"display_name_western_script": "刘梓新",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
}
],
"gender": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"date_of_birth": "2020-01-01",
"nationality_id": "123456789",
"race": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"marital_status": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"phone_list": [
{
"international_area_code": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"phone_number": "010-12345678",
"formatted_phone_number": "+86 010-12345678",
"device_type": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"phone_usage": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"is_primary": true,
"is_public": true,
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
}
],
"address_list": [
{
"full_address_local_script": "中国北京北京",
"full_address_western_script": "Beijing, Beijing, China,",
"id": "6989822217869624863",
"country_region_id": "6862995757234914824",
"region_id": "6863326815667095047",
"city_id": "6863333254578046471",
"distinct_id": "6863333516579440141",
"local_address_line1": "丹佛测试地址-纽埃时区",
"local_address_line2": "PoewH",
"local_address_line3": "PoewH",
"local_address_line4": "jmwJc",
"local_address_line5": "jmwJc",
"local_address_line6": "jmwJc",
"local_address_line7": "jmwJc",
"local_address_line8": "rafSu",
"local_address_line9": "McPRG",
"postal_code": "611530",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
}
],
"email_list": [
{
"email": "12456@test.com",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
}
],
"work_experience_list": [
{
"company_organization": [
{
"lang": "zh-CN",
"value": "张三"
}
],
"department": [
{
"lang": "zh-CN",
"value": "张三"
}
],
"job": [
{
"lang": "zh-CN",
"value": "张三"
}
],
"description": [
{
"lang": "zh-CN",
"value": "张三"
}
],
"start_date": "2020-01-01",
"end_date": "2020-01-01",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
}
],
"education_list": [
{
"school": [
{
"lang": "zh-CN",
"value": "张三"
}
],
"level_of_education": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"start_date": "2011-09-01",
"end_date": "2015-06-30",
"field_of_study": [
{
"lang": "zh-CN",
"value": "张三"
}
],
"degree": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"school_name": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"field_of_study_name": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"country_region_id": "1",
"expected_end_date": "2011-09-01",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
}
],
"bank_account_list": [
{
"bank_name": "中国农业银行",
"bank_account_number": "6231200000001223",
"account_holder": "孟十五",
"bank": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"branch_name": "中国农业银行支行",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
],
"country_region_id": "12",
"bank_account_usage": [
{
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
}
],
"bank_account_type": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"currency_id": "12QueryCountryRegionSubdivisionDataReq"
}
],
"national_id_list": [
{
"national_id_type_id": "6863330041896371725",
"national_id_number": "1231131333",
"issue_date": "2020-04-01",
"expiration_date": "2020-05-21",
"country_region_id": "6862995757234914824",
"issued_by": "北京市公安局",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
}
],
"dependent_list": [
{
"name": {
"local_primary": "黄",
"local_first_name": "四",
"country_region_id": "6862995757234914824",
"name_type": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"local_first_name_2": "五",
"local_primary_2": "王",
"additional_name_type": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"first_name": "帅",
"full_name": "刘梓新",
"hereditary": "王",
"custom_name": "刘梓新",
"custom_local_name": "刘梓新",
"middle_name": "大",
"name_primary": "王",
"secondary": "王",
"social": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"tertiary": "王",
"title": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"local_middle_name": "大",
"local_secondary": "王",
"display_name_local_and_western_script": "刘梓新",
"display_name_local_script": "刘梓新",
"display_name_western_script": "刘梓新",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
},
"relationship": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"gender": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"date_of_birth": "2020-01-01",
"nationality_id": "7075702734054164011",
"national_id_list": [
{
"national_id_type_id": "6863330041896371725",
"national_id_number": "1231131333",
"issue_date": "2020-04-01",
"expiration_date": "2020-05-21",
"country_region_id": "6862995757234914824",
"issued_by": "北京市公安局",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
}
],
"spouses_working_status": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"is_this_person_covered_by_health_insurance": true,
"is_this_person_allowed_for_tax_deduction": false,
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
],
"dependent_name": "张三",
"employer": "海淀区交警大队",
"job": "保安",
"phone": {
"international_area_code": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"phone_number": "010-12345678",
"formatted_phone_number": "+86 010-12345678",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
},
"address": {
"full_address_local_script": "中国北京北京",
"full_address_western_script": "Beijing, Beijing, China,",
"id": "6989822217869624863",
"country_region_id": "6862995757234914824",
"region_id": "6863326815667095047",
"city_id": "6863333254578046471",
"distinct_id": "6863333516579440141",
"local_address_line1": "丹佛测试地址-纽埃时区",
"local_address_line2": "PoewH",
"local_address_line3": "丹佛测试地址-纽埃时区",
"local_address_line4": "PoewH",
"local_address_line5": "PoewH",
"local_address_line6": "jmwJc",
"local_address_line7": "jmwJc",
"local_address_line8": "jmwJc",
"local_address_line9": "jmwJc",
"postal_code": "rafSu",
"custom_fields": [
{
"field_name": "name",
"value": "Sandy"
}
]
},
"birth_certificate_of_child": [
{
"id": "150018109586e8ea745e47ae8feb3722dbe1d03a181336393633393133303431393831343930373235150200"
}
]
}
],
"emergency_contact_list": [
{
"name": {
"local_primary": "黄",
"local_first_name": "四",
"country_region_id": "6862995757234914824",
"name_type": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"local_first_name_2": "五",
"local_primary_2": "王",
"additional_name_type": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"first_name": "帅",
"full_name": "刘梓新",
"hereditary": "王",
"custom_name": "刘梓新",
"custom_local_name": "刘梓新",
"middle_name": "大",
"name_primary": "王",
"secondary": "王",
"social": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"tertiary": "王",
"title": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"local_middle_name": "大",
"local_secondary": "王",
"display_name_local_and_western_script": "刘梓新",
"display_name_local_script": "刘梓新",
"display_name_western_script": "刘梓新",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
},
"relationship": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"phone_ist": [
{
"international_area_code": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"phone_number": "010-12345678",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
}
],
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
],
"legal_name": "张三"
}
],
"date_entered_workforce": "2020-10-01",
"profile_image_id": "dfysuc8x76dsfsw",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
],
"email_address": "test@163.com",
"resident_tax_id_list": [
"123456"
],
"age": 25,
"highest_level_of_education": {
"school": [
{
"lang": "zh-CN",
"value": "张三"
}
],
"level_of_education": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"start_date": "2011-09-01",
"end_date": "2015-06-30",
"field_of_study": [
{
"lang": "zh-CN",
"value": "张三"
}
],
"degree": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"school_name": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"field_of_study_name": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"country_region_id": "1",
"expected_end_date": "2011-09-01",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
},
"highest_degree_of_education": {
"school": [
{
"lang": "zh-CN",
"value": "张三"
}
],
"level_of_education": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"start_date": "2011-09-01",
"end_date": "2015-06-30",
"field_of_study": [
{
"lang": "zh-CN",
"value": "张三"
}
],
"degree": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"school_name": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"field_of_study_name": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"country_region_id": "1",
"expected_end_date": "2011-09-01",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
},
"personal_profile": [
{
"personal_profile_id": "150018109586e8ea745e47ae8feb3722dbe1d03a181336393633393133303431393831343930373235150200",
"personal_profile_type": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"files": [
{
"id": "150018109586e8ea745e47ae8feb3722dbe1d03a181336393633393133303431393831343930373235150200"
}
]
}
]
}
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 1164001 | Internal error in transaction module | Please check direct manager |
| 400 | 1164002 | Update or delete operation needs IDList | Please check dotted manager |
| 400 | 1164003 | Action is invalid | Please check effective date |
| 400 | 1164004 | Action affected rows exceed threshold value | 影响的数据超过上限,请检查传入参数 |
| 400 | 1164005 | Tenant or operator not found | 数据对象不合法,请检查传入参数 |
| 400 | 1164006 | Update Action contains invalid ID | 操作的数据ID无效,请检查传入参数 |
| 400 | 1164007 | Action count exceeds threshold | 操作的数据条数超上限,请检查传入参数 |
| 400 | 1164008 | Record lock retrieval failed | 数据库操作失败,请检查传入参数或重试 |
| 400 | 1164009 | Field lock retrieval missing RecordID | 获取字段锁缺失参数RecordID,请检查传入参数 |
| 400 | 1164010 | Field lock retrieval failed | 字段锁获取失败,请检查传入参数 |
| 400 | 1164011 | Field lock retrieval missing FieldName | 获取字段锁缺失参数FieldName,请检查传入参数 |
| 400 | 1164012 | Operation assigned invalid fields | 操作的字段不合法,请检查传入参数 |
| 400 | 1164013 | Assigned ID but has no active time | 缺失字段active time,请检查传入参数 |
| 400 | 1164014 | Object ApiName has more than one action | 对ApiName的操作多于一个,请检查传入参数 |
| 400 | 1164101 | Timeline penetration calculation failed | 时间线计算错误,请检查传入参数 |
| 400 | 1164102 | Timeline effective time format invalid | 时间线生效时间参数不合法,请检查传入参数 |
| 400 | 1164103 | Timeline effective time should be later than first effective time | 时间线生效时间应晚于第一次生效时间,请检查传入参数 |
| 400 | 1164104 | No corresponding timeline record | 未找到对应的时间线记录,请检查传入参数 |
| 400 | 1164105 | Duplicated effective timeline record | 时间线生效时间相同的记录重复,请检查传入参数 |
| 400 | 1164106 | Timeline Update action invalid | 更新时间线操作不合法,请检查传入参数 |
| 400 | 1164107 | Timeline action affected rows exceed threshold value | 时间线更新操作影响的记录数超过上限,请检查传入参数 |
| 400 | 1164108 | Timeline invalidation action invalid | 时间线操作不合法,请检查传入参数 |
| 400 | 1164109 | Timeline action count exceeds threshold | 时间线操作影响的记录超上限,请检查传入参数 |
| 400 | 1164110 | Timeline object contains no StartTime or EndTime | 时间线记录缺失StartTime或EndTime,请检查传入参数 |
| 400 | 1164111 | Timeline object cannot find corresponding version | 对应版本的时间线记录未找到,请检查传入参数 |
| 400 | 1164112 | Create timeline object with record id duplicated | 创建的时间线对象的ID重复,请检查传入参数 |
| 400 | 1164113 | Timeline object contains no inner control fields wk_status or wk_tid | 时间线记录缺乏对应的字段wk_status或wk_tid,请检查传入参数 |
| 400 | 1164114 | Timeline update used duplicated Version ID | 更新时间线时VersionID重复,请检查传入参数 |
| 400 | 1164115 | Timeline versionID is not integer type | 时间线记录的VersionID不是合法的整数,请检查传入参数 |
| 400 | 1164116 | Timeline versionID type invalid | 时间线VersionID数据类型不合法,请检查传入参数 |
| 400 | 1164117 | Timeline version query request invalid | 时间线版本查询参数不合法,请检查传入参数 |
| 400 | 1164118 | Timeline version info contains no effective time | 时间线版本信息缺失生效时间,请检查传入参数 |
| 400 | 1164119 | Timeline first version cannot be corrected later than second version | 时间线第一个版本不能晚于后续版本,请检查传入参数 |
| 400 | 1164120 | Timeline version ID not exist | 时间线VersionID不存在,请检查传入参数 |
| 400 | 1164121 | Timeline first version cannot be invalidated | 时间线VersionID不合法,请检查传入参数 |
| 400 | 1164122 | Timeline field uniqueness violation | 时间线对象唯一性校验不通过,请检查传入参数 |
| 400 | 1164123 | Timeline update target is inactivated | 更新的时间线对象已失效,请检查传入参数 |
| 400 | 1164124 | The effective time of the first version cannot be a future moment | 第一个版本的生效时间不能晚于当前时间,请检查传入参数 |
| 400 | 1164125 | Timeline version's corresponding record does not exist | 时间线版本对应的记录不存在,请检查传入参数 |
| 400 | 1164126 | Timeline create versionID does not exist when converting to correct | 时间线VersionID不合法,请检查传入参数 |
| 400 | 1164127 | Timeline record is under reconstructing | 时间线记录创建中,请检查传入参数 |
| 400 | 1164128 | Timeline record reconstruct unlock failed | 时间线记录解锁失败,请检查传入参数 |
| 400 | 1164129 | Timeline version ID has already been invalidated | 时间线VersionID不合法,请检查传入参数 |
| 400 | 1164130 | Timeline create at should be later than first create at | 时间线创建时间不合法,请检查传入参数 |
| 400 | 1164201 | Timeline multi record effective time conflicted | 多条时间线记录生效时间冲突,请检查传入参数 |
| 400 | 1164202 | Timeline multi record has duplicated time range | 多条时间线记录的时间区间冲突,请检查传入参数 |
| 400 | 1164203 | Timeline multi record has no start time defined | 时间线记录缺失开始时间,请检查传入参数 |
| 400 | 1164204 | Timeline multi record has no biz group field defined | 时间线记录的字段Group未定义,请检查传入参数 |
| 400 | 1164205 | Timeline multi record update scenario lacking time field | 时间线更新场景缺失时间,请检查传入参数 |
| 400 | 1164206 | At the same effective time, the timeline field is updated repeatedly | 时间线生效时间重复,请检查传入参数 |
| 400 | 1164207 | Timeline multi record end time less than effective time | 时间线结束时间晚于生效时间,请检查传入参数 |
| 400 | 1164301 | Request param is invalid, pls check | 请求参数不合法,请检查传入参数 |
| 400 | 1164302 | Timeline record does not contain time information | 时间线记录缺失时间信息,请检查传入参数 |
| 400 | 1164401 | LookUp field is not a multi-LookUp | 查找的字段不合法,请检查传入参数 |
| 400 | 1164402 | LookUp field is not a single-LookUp | 查找的字段不合法,请检查传入参数 |
| 400 | 1164403 | The record corresponding to the lookup field value does not exist | 被查询的记录不存在,请检查传入参数 |
| 400 | 1164404 | LookUp field value query failed | 查询字段失败,请检查传入参数 |
| 400 | 1164405 | LookUp field value type incorrect | 查询字段的类型不正确,请检查传入参数 |
| 400 | 1164406 | Boolean type field type error | 传入的Boolean类型字段不合法,请检查传入参数 |
| 400 | 1164407 | Text type field is not i18n | Text类型的字段不是i18N类型,请检查传入参数 |
| 400 | 1164408 | Text type field value exceeds maximum length | Text类型的字段长度超限,请检查传入参数 |
| 400 | 1164409 | Text type field is not string | Text类型字段不是字符串,请检查传入参数 |
| 400 | 1164410 | The format for i18n error | 类型转换为i18n时失败,请检查传入参数 |
| 400 | 1164411 | The content for i18n error | i18n类型的内容不合法,请检查传入参数 |
| 400 | 1164412 | Enum fields type errors | 枚举类型错误,请检查传入参数 |
| 400 | 1164413 | The number of digits is too long | 数字字段长度超限,请检查传入参数 |
| 400 | 1164414 | Datetime field type error | DateTime字段不合法,请检查传入参数 |
| 400 | 1164415 | Datetime field time type error | DateTime字段的时间不合法,请检查传入参数 |
| 400 | 1164416 | Datetime field date type error | DateTime字段的日期不合法,请检查传入参数 |
| 400 | 1164417 | Image field type error | 图片类型字段不合法,请检查传入参数 |
| 400 | 1164418 | The fileID of the image field does not exist | FileID对应的图片不存在,请检查传入参数 |
| 400 | 1164419 | The fileID of the attachment field does not exist | FileID对应的附件不存在,请检查传入参数 |
| 400 | 1164420 | Attachment field type error | 附件类型字段不合法,请检查传入参数 |
| 400 | 1164421 | Required field not included | 缺乏必须的参数,请检查传入参数 |
| 400 | 1164422 | The value of the Required field is null. | 缺乏必须的参数,请检查传入参数 |
| 400 | 1164423 | Number field int or float type error | 数字类型字段不合法,请检查传入参数 |
| 400 | 1164424 | Decimal out of range | 浮点数越界,请检查传入参数 |
| 400 | 1164425 | Value out of range | 数据类型越界,请检查传入参数 |
| 400 | 1164426 | Enum should be single not multiple error | 枚举字段传入了多个,请检查传入参数 |
| 400 | 1164427 | Enum should be multiple not single error | 枚举字段传入了单个,请检查传入参数 |
| 400 | 1164428 | Enum value not exist | 枚举值不存在,请检查传入参数 |
| 400 | 1164429 | AutoNumber field type error | AutoNumber字段不合法,请检查传入参数 |
| 400 | 1164430 | Datetime field string formatting Error | 字符串转Datetime失败,请检查传入参数 |
| 400 | 1164431 | Attachment type field single value parsing failed | 附件类型参数不合法,请检查传入参数 |
| 400 | 1164432 | Attachment type field multiple value parsing failed | 附件类型参数不合法,请检查传入参数 |
| 400 | 1164433 | Filename extension error | 文件后缀错误,请检查传入参数 |
| 400 | 1164434 | Image field should include multiple values | 图片字段应包含多个值,请检查传入参数 |
| 400 | 1164435 | The lookup field contains duplicate keys | 查询的字段Key重复,请检查传入参数 |
| 400 | 1164436 | Required fields are empty | 缺乏必填字段,请检查传入参数 |
| 400 | 1164437 | Illegal back lookup | 查询参数错误,请检查传入参数 |
| 400 | 1164438 | Date field string formatting Error | 字符串转Date失败,请检查传入参数 |
| 400 | 1164439 | Time field string formatting Error | 字符串转Time失败,请检查传入参数 |
| 400 | 1164440 | Invalid time format | 时间参数不合法,请检查传入参数 |
| 400 | 1164441 | duplicate biz group for mulVersion | mulVersion包含多个重复的Group,请检查传入参数 |
| 400 | 1164442 | action update out of order | 操作顺序不当,请检查传入参数 |
| 400 | 1164443 | unique value has been used | 唯一键冲突,请检查传入参数 |
| 400 | 1164444 | un sup unique field | 唯一键冲突,请检查传入参数 |
| 400 | 1164445 | can not update pair field | 更新字段错误,请检查传入参数 |
| 400 | 1164446 | can not update multistage field | 不能更新multistage字段,请检查传入参数 |
| 400 | 1164447 | can not only create paired object | 不能创建pair object,请检查传入参数 |
| 400 | 1164448 | pair field is null | Pair field缺失,请检查传入参数 |
| 400 | 1164449 | pair field must one on one | Pair field不合法,请检查传入参数 |
| 400 | 1164450 | cascade must have wk_id field | 字段wk_id缺失,请检查传入参数 |
| 400 | 1164501 | Unable to delete as it is still in use | 不可删除正在使用的记录,请检查传入参数 |
