OkayAPI Docs


API Path: /api/App/Common_IDCard/Parse

API Description: 基于「公民身份号码」规则,获取身份证号码中包含的基础信息组件。仅用于开发和测试,不得用于商业用途。

1
API Traffic
HTTP/HTTPS
Protocol
GET/POST
Method
UTF-8
Charset
JSON
Response

API Debug   


API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
id_numberStringRequired身份证号码

API Debug

KEYREQUIREDVALUE
app_key *Required
id_number *Required

API Response

KEYTypeDescription
info.is_legalBoolean检查公民身份号码是否合法,true | false
info.birthdayString公民身份号码中包含的生日信息,如:1989-06-18
info.ageInt根据生日计算的年龄
info.genderString身份证包含的性别信息,女 | 男
info.codeStringGB/T 2260 的地区行政代码
info.provinceString省份名称或者直辖市名称
info.cityString城市名称,如果是直辖市则返回 ''
info.areaString区县名称
info.addressString完整的地址

HTTP Response Code

HTTP Status CodeDescription
Http Status = 200Success
Http Status = 400表示客户端参数错误
Http Status = 404表示接口服务不存在
Http Status = 500表示服务端内部错误