Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guanguans/id-validator
China ID number validator. - 中国身份证号验证器。
https://github.com/guanguans/id-validator
id idcard idcard-check idcard-detect idcard-generator idcardnumber-validation idcardocr-china validate validation validator verify
Last synced: 2 days ago
JSON representation
China ID number validator. - 中国身份证号验证器。
- Host: GitHub
- URL: https://github.com/guanguans/id-validator
- Owner: guanguans
- License: mit
- Created: 2021-01-08T09:29:05.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-16T21:40:43.000Z (3 months ago)
- Last Synced: 2024-10-30T03:50:08.422Z (16 days ago)
- Topics: id, idcard, idcard-check, idcard-detect, idcard-generator, idcardnumber-validation, idcardocr-china, validate, validation, validator, verify
- Language: Go
- Homepage:
- Size: 515 KB
- Stars: 204
- Watchers: 3
- Forks: 40
- Open Issues: 2
-
Metadata Files:
- Readme: README-EN.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# id-validator
[简体中文](README.md) | [ENGLISH](README-EN.md)
> China ID number validator. - 中国身份证号验证器。
## Features
* Verify China ID number
* Get ID number information
* Upgrade 15-digit ID number to 18
* Forged ID number that meets the verification
## Requirement
* Go >= 1.14
## Installation
```shell script
$ go get -u github.com/guanguans/id-validator
```
## Usage
This is just a quick introduction, view the [GoDoc](https://godoc.org/github.com/guanguans/id-validator) for details.
Let's start with a trivial example:
```go
package main
import (
idvalidator "github.com/guanguans/id-validator"
"gopkg.in/ffmt.v1"
)
func main() {
// 验证身份证号合法性
ffmt.P(idvalidator.IsValid("500154199301135886", true)) // 严格模式验证大陆居民身份证18位
ffmt.P(idvalidator.IsValid("500154199301135886", false)) // 非严格模式验证大陆居民身份证18位
ffmt.P(idvalidator.IsValid("11010119900307803X", false)) // 大陆居民身份证末位是X18位
ffmt.P(idvalidator.IsValid("610104620927690", false)) // 大陆居民身份证15位
ffmt.P(idvalidator.IsValid("810000199408230021", false)) // 港澳居民居住证18位
ffmt.P(idvalidator.IsValid("830000199201300022", false)) // 台湾居民居住证18位
// 获取身份证号信息
ffmt.P(idvalidator.GetInfo("500154199301135886", true)) // 严格模式获取身份证号信息
ffmt.P(idvalidator.GetInfo("500154199301135886", false)) // 非严格模式获取身份证号信息
// []interface {}[
// github.com/guanguans/id-validator.IdInfo{ // 身份证号信息
// AddressCode: int(500154) // 地址码
// Abandoned: int(0) // 地址码是否废弃：1为废弃的，0为正在使用的
// Address: string("重庆市市辖区开州区") // 地址
// AddressTree: []string[ // 省市区三级列表
// string("重庆市") // 省
// string("市辖区") // 市
// string("开州区") // 区
// ]
// Birthday: <1993-01-13 00:00:00 +0800 CST> // 出生日期
// Constellation: string("摩羯座") // 星座
// ChineseZodiac: string("酉鸡") // 生肖
// Sex: int(0) // 性别：1为男性，0为女性
// Length: int(18) // 号码长度
// CheckBit: string("6") // 校验码
// }
// // 错误信息
// ]
// 生成可通过校验的假身份证号
ffmt.P(idvalidator.FakeId()) // 随机生成
ffmt.P(idvalidator.FakeRequireId(true, "江苏省", "200001", 1)) // 生成出生于2000年1月江苏省的男性居民身份证
// 15位号码升级为18位
ffmt.P(idvalidator.UpgradeId("610104620927690"))
// []interface {}[
// string("610104196209276908") // 升级后号码
// // 错误信息
// ]
}
```
## Testing
```shell script
$ make test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
* [guanguans](https://github.com/guanguans)
* [All Contributors](../../contributors)
## Related projects
* [jxlwqq/id-validator](https://github.com/jxlwqq/id-validator), by jxlwqq
* [jxlwqq/id-validator.py](https://github.com/jxlwqq/id-validator.py), by jxlwqq
* [mc-zone/IDValidator](https://github.com/mc-zone/IDValidator), by mc-zone
* [renyijiu/id_validator](https://github.com/renyijiu/id_validator), by renyijiu
## Reference material
* [People's Republic of China citizenship number](https://zh.wikipedia.org/wiki/中华人民共和国公民身份号码)
* [Ministry of Civil Affairs of the People's Republic of China: Administrative division code](http://www.mca.gov.cn/article/sj/xzqh/)
* [Historical data set of administrative division codes of the People's Republic of China](https://github.com/jxlwqq/address-code-of-china)
* [Notice of the General Office of the State Council on Issuing the Measures for the Application and Issuance of Residence Permits for Hong Kong, Macao and Taiwan Residents](http://www.gov.cn/zhengce/content/2018-08/19/content_5314865.htm)
* [Residence Permit for Hong Kong, Macao and Taiwan Residents](https://zh.wikipedia.org/wiki/港澳台居民居住证)
## License
The MIT License (MIT). Please see [License File](LICENSE) for more information.