App.Common_IDCard.Parse API Docs | The No-Code CURD API Platform

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 Params

Parameter	Type	Required	Default	Note	Description
HTTP_APPKEY	String	Required		MIN: 32	Common Put Your APPKEY
id_number	String	Required			身份证号码

API Debug

Submit Type:

Form Data

JSON RAW(application/json;charset=UTF-8)

JSON RAW

KEY	REQUIRED	VALUE
app_key	*Required
id_number	*Required

API Response

KEY	Type	Description
info.is_legal	Boolean	检查公民身份号码是否合法，true \| false
info.birthday	String	公民身份号码中包含的生日信息，如：1989-06-18
info.age	Int	根据生日计算的年龄
info.gender	String	身份证包含的性别信息，女 \| 男
info.code	String	GB/T 2260 的地区行政代码
info.province	String	省份名称或者直辖市名称
info.city	String	城市名称，如果是直辖市则返回 ''
info.area	String	区县名称
info.address	String	完整的地址

HTTP Response Code

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