GeezerVison

docs-code

Go library for validation and generation of Russian official document codes.

Note: The API is not yet stable and may change in future versions.

Supported Document Codes

¹ OKATO validation checks the format and level ranges only; existence lookup and generation are not implemented yet and return okato.ErrNotImplemented. OKATO is not part of the top-level Validate/Generate dispatch — use the okato package directly.

Requirements

• Go 1.25+

Installation

go get github.com/sshaplygin/docs-code

Usage

Validate a document code

import (
	"log"

	docs_code "github.com/sshaplygin/docs-code"
)

isValid, err := docs_code.Validate(docs_code.INN, "526317984689")
if err != nil {
	log.Fatal(err)
}
if !isValid {
	log.Println("INN is invalid")
} else {
	log.Println("INN is valid")
}

Generate a document code

import (
	"fmt"
	"log"

	docs_code "github.com/sshaplygin/docs-code"
)

code, err := docs_code.Generate(docs_code.INN)
if err != nil {
	log.Fatal(err)
}
fmt.Println("Generated INN:", code)

Use a specific package directly

Each document type also exposes its own package with additional functions:

import "github.com/sshaplygin/docs-code/inn"

// Generate specific INN types
legalINN := inn.GenerateLegal()
physicalINN := inn.GeneratePhysical()

// Validate
ok, err := inn.Validate("526317984689")

Benchmarks

See BENCHMARKS.md for performance data.

Project Structure

docs-code/
├── bik/          # BIK validation and generation
├── inn/          # INN validation and generation
├── kpp/          # KPP validation and generation
├── ogrn/         # OGRN validation and generation
├── ogrnip/       # OGRNIP validation and generation
├── okato/        # OKATO (in progress)
├── snils/        # SNILS validation and generation
├── fts/          # Federal Tax Service data (regions, departments)
├── models/       # Shared error types
├── utils/        # Internal helpers
└── parser/       # Data parsers (BIK, OKATO, subjects)

References

• INN (ИНН)
• SNILS (СНИЛС)
• OGRN (ОГРН)
• OGRNIP (ОГРНИП)
• BIK (БИК)
• KPP (КПП)

License

MIT

Constants ¶

Variables ¶

var ErrUnsupportedDocType = errors.New("unsupported document type")

Functions ¶

func Generate(docType DocType) (string, error)

func Validate(docType DocType, code string) (bool, error)

Types ¶

type DocType uint

const (
	BIK DocType = iota
	INN
	KPP
	OGRN
	OGRNIP
	SNILS
)

type GenerateFunc func() string

type ValidateFunc func(code string) (bool, error)