Page History

...

Code Block

language	text

validatorPddp/
├── validate_pddp.py                    # Validator script
├── requirements.txt                    # Python dependency (lxml)
├── README.md                           # Documentation
├── xsd/                                # WIPOOffline fallback copy of the ST.92 V2.0 schemas
│   ├── ST92PDDPIndex_V2_0.xsd
│   ├── ST96_Common_V9_0.xsd
│   ├── ST96_Design_V9_0.xsd
│   └── ST96_Trademark_V9_0.xsd
└── dtd/
    └── ST26SequenceListing_V1_3.dtd    # WIPO ST.26 DTD for sequence listings

...

By default the validator downloads the schemas directly from WIPO, so it always checks against the published versions:

ST.92 index schema: ST92PDDPIndex_V2_0.xsd (its three ST.96 imports are resolved automatically)
ST.96 V9.0 schemas, used for the supplementary artifacts: ST96XMLSchema_V9_0_Flattened.zip

Downloads are cached under .cache/ and reused on later runs. If a download fails, the validator falls back to the bundled xsd/ copy and reports that it did. Use --offline to force the bundled copy and never touch the network; those files are byte-identical to the published ones, so both modes validate against the same schema.

The ST.26 DTD is only distributed inside the ST.26 Annex II bundle and has no stable standalone URL, so it stays in dtd/ from https://www.wipo.int/standards/XMLSchema/ST92/V2_0/ST92PDDPIndex_V2_0.zip.

Installation

The validator needs Python 3.10+ and the lxml library (XSD/DTD validation is not available in the Python standard library).

...

Code Block

language	shell

# Validate all ZIP files in ../output (default)
.venv/bin/python validate_pddp.py

# Validate specific ZIP files and/or all ZIP files in a folder
.venv/bin/python validate_pddp.py Patent_NO_20210008_20210924.zip ./received/

# Also list every check that passed
.venv/bin/python validate_pddp.py -v ./output

# Report advisory findings as warnings instead of errors
.venv/bin/python validate_pddp.py --lenient ./output

# Use the bundled schemas, without any network access
.venv/bin/python validate_pddp.py --offline ./output

All options

Option	Default	Description
`paths ...`	`../output`	ZIP files and/or folders containing ZIP files
`-v, --verbose`	off	Also list the checks that passed
`--xsd FILE`	`xsd/ST92PDDPIndex_V2_0.xsd`	`schema URL\|FILE`	the WIPO URL above	ST.92 index schema to validate against
`--offline`	off	Use the bundled `xsd/` copy, never touch the network
`--refresh-schema`	off	Re-download the schemas, ignoring the cache
`--no-fallback`	off	Fail instead of falling back to the bundled schema
`--timeout SECONDS`	`30`	Schema download timeout
`--st96-schema URL`	the WIPO ST.96 zip above	Flattened ST.96 release for supplementary artifacts
`--st96-dir DIR`	-	Use an already-extracted ST.96 schema folder
`--no-st96`	off	Skip ST.96 validation of supplementary artifacts
`--lenient`	off	Report advisory findings as warnings instead of errors
ST.92 index schema	`--st26-dtd FILE`	`dtd/ST26SequenceListing_V1_3.dtd`	ST.26 sequence listing DTD

Strict by default: advisory findings are reported as errors, so nothing is silently accepted. Pass --lenient to keep them as warnings.

Exit code: 0 when no package has errors, 1 otherwise (can be used in scripts / CI).

Checks performed

#Group	Check	Result if it fails
1Archive	ZIP file opens and CRC is correctevery entry passes its CRC	ERROR
Archive	No encrypted entries and no duplicate entry names	ERROR
Archive	No absolute paths, `..` traversal, backslashes or control characters in entry names	ERROR
2Archive	`PriorityDocumentIndex.xml` present at the root of the ZIPZIP root, with exact casing	ERROR
Index	Well-formed XML, parsed with entity expansion and network access disabled	ERROR
Index	No DOCTYPE and no XML entity references	ERROR
3Index	Root element is `pde:PriorityDocumentIndex`	ERROR
Index	Valid `PriorityDocumentIndex.xml` valid against `ST92PDDPIndex_V2_0.xsd`	ERROR
4Index	Document categories match `IPRightKindCategory` (e.g. only `PatentMandatoryDocumentCategory` in a patent package)	ERROR
5Index	Mandatory documents present: Priority priority document PDF (all types), Certification page (designs, trademarks), certification page and representation (designs, trademarks)	ERROR
5bIndex	Patent package without a separate Certification certification page (the certification it must then be part of the priority document PDF)	WARNING		advisory
Index	`ApplicationFilingDate` and `DocumentDate` parse and are not in the future	ERROR
Index6	ZIP name `<Kind>_<Office>_<Number>_<YYYYMMDD>.zip` matches kind / office in the index	ERROR
6b	ZIP name number / date match the application number / filing date in the index	WARNING
/ advisory
References	7	Every file listed in the index exists in the ZIP (`DocumentLocationURI` may be a folder or the full path)	ERROR		ERROR
References	`com:FileName` contains no path component	ERROR
References	`DocumentLocationURI` is relative and does not escape the package	ERROR
References	Mandatory documents live under `MandatoryArtifacts/`, supplementary under `SupplementaryArtifacts/`	ERROR
References7b	`DocumentLocationURI` is an external URL	WARNING	8	File ; file in the ZIP not listed in the index	WARNING	; one file referenced by several entries	advisory
Content	No empty files	ERROR
Content	Declared `DocumentFileFormatCategory` matches both the file extension and the actual bytes	ERROR
Content9	File content matches its extension (PDF, PNG, JPEG, WAV, MP3, STL, ZIP, TAR, XML)	ERROR
Content	PDF structure: header, `startxref`, `%%EOF`, `/Root`	ERROR
Content	PNG structure: per-chunk CRCs, IHDR/IDAT/IEND present, non-zero dimensions	ERROR
Content	WAV structure: RIFF size agrees with the file, `fmt` and `data` chunks present and in bounds	ERROR
Content	STL structure: facet / loop / vertex counts agree (ASCII) or size matches the triangle count (binary)	ERROR
Content	Zipped artifacts open, are unencrypted and CRC-clean	ERROR
Content	`PageTotalQuantity` matches the PDF page count; `DocumentSizeQuantity` matches the real byte size	advisory
Content	Internal XML	10	Every XML file is well-formed	ERROR
Content	Supplementary artifacts valid against the published ST.96 V9.0 schemas	ERROR
11Content	ST.26 sequence listings valid against the ST.26 DTD	ERROR
Content	ST.26 cross-checks: `fileName`, `SequenceTotalQuantity`, `sequenceIDNumber` runs 1..n, `INSDSeq_length` matches the sequence	ERROR
Content	ST.26 characters within the Annex IV Basic Latin subset	advisory

Checks marked advisory are reported as errors by default and as warnings with --lenient.

Note

title	Limitations	Bibliographic and classification data (ST.96)

Bibliographic and classification data are now validated against the published ST.96 V9.0 schemas, not just checked for well-formedness.

Note that these documents belong to the per-right ST.96 namespaces, not to Common: pat:BibliographicData and pat:PatentClassificationBag for patents, dgn:DesignApplication and com:DesignClassificationBag (Locarno) for designs, tmk:TrademarkApplication and tmk:GoodsServicesBag (Nice) for trademarks.

The trimmed ST96_Common_V9_0.xsd shipped inside the ST.92 Annex I bundle declares only 16 global elements, a subset built for the index schema. It is not a substitute for the full ST.96 Common namespace, which is why the supplementary artifacts are checked against the ST.96 release insteadThe ST.92 V2.0 schema set does not declare the ST.96 root elements used in bibliographic and classification data (e.g. com:PatentBibliographicData), so those XML files are only checked for well-formedness.

Example output

Code Block

language	shell

>>>> .venv/bin/python validate_pddp.py -v ../output/Patent_NO_20250011_20251117.zip ../output/Patent_IB_PCT-IB2026-544115_20260112.zip
[FAIL] Patent_NO_20250011_20251117.zip
    WARN  No separate 'Certification page' document; make sure the certification is included in the priority document PDF
    ERROR PriorityDocumentIndex.xml XSD: line 17: Element '{http://www.wipo.int/standards/XMLSchema/PriorityDocumentExchange}SupplementaryDocumentBag': Missing child element(s). Expected is ( {http://www.wipo.int/standards/XMLSchema/PriorityDocumentExchange}SupplementaryDocument ).
[OK] Patent_IB_PCT-IB2026-544115_20260112.zip

2IB_PCT-IB2026-134592_20260103.zip
ST.92 schema: https://www.wipo.int/standards/XMLSchema/ST92/V2_0/ST92PDDPIndex_V2_0.xsd
ST.96 schema: https://www.wipo.int/standards/en/st96/v9-0/annex-iii/ST96XMLSchema_V9_0_Flattened.zip
Mode:         strict

[OK] Patent_IB_PCT-IB2026-134592_20260103.zip
    ok    ZIP integrity OK
    ok    11 ZIP entr(ies), all names safe and unique
    ok    PriorityDocumentIndex.xml valid against the ST.92 V2.0 schema
    ok    Document categories consistent with 'Patent'
    ok    Mandatory documents present: ['Certification page', 'Priority document PDF', 'Sequence listing']
    ok    ZIP file name consistent with index
    ok    All 7 referenced files resolved
    ok    MandatoryArtifacts/..._PriorityDocument.pdf: PDF OK (2,847 bytes, 3 page(s))
    ok    MandatoryArtifacts/..._SequenceListing_ST26.xml: valid against the ST.26 DTD
    ok    SupplementaryArtifacts/..._BibliographicData.xml: valid against ST.96 V9.0 (BibliographicData_V9_0.xsd)
    ok    SupplementaryArtifacts/..._ClassificationData.xml: valid against ST.96 V9.0 (Patent_V9_0.xsd)

1 package(s) checked: 1 passed, 0 failed.

Without -v only problems are listed:

>>>> .venv/bin/python validate_pddp.py ./received/
[FAIL] Patent_XX_1234567_20260101.zip
    ERROR MandatoryArtifacts/doc.pdf: declared format 'PNG' does not match extension '.pdf' (expected ['.png'])
    ERROR SupplementaryArtifacts/bib.xml ST.96: line 11: Element 'InventionTitle': This element is not expected. Expected is ( InventionTitleBag ).

1 package(s) checked: 10 passed, 1 failed.

Common errors

Message	Cause / fix
`SupplementaryDocumentBag': Missing child element(s)`	An empty `<pde:SupplementaryDocumentBag>` is not allowed. Remove the element if there are no supplementary documents.
`'Text' is not a valid value of the union type ... DocumentFileFormatCategoryType`	File format values are case sensitive: use `TEXT`, `PDF`, `XML`, …
`No declaration for element INSDSeq_organism`	Not part of ST.26. The organism must be given as the `organism` qualifier of the `source` feature.
`<PatentBibliographicData> is not a global element`	There is no such element in the ST.96 Common namespace. Bibliographic data belongs to the per-right namespaces: `pat:BibliographicData`, `dgn:DesignApplication`, `tmk:TrademarkApplication`.
`declared format 'X' does not match extension '.y'`	`DocumentFileFormatCategory` disagrees with the file it points at. Fix whichever is wrong.
`PageTotalQuantity N != M page(s) found in the PDF`	The declared page count does not match the PDF. Advisory, so it only fails the run in strict mode.
`mandatory document stored under SupplementaryArtifacts/`	Mandatory artifacts must sit under `MandatoryArtifacts/` and supplementary ones under `SupplementaryArtifacts/`.
`Path traversal in ZIP entry`	The package contains an entry with `..` or an absolute path. Rebuild it with relative paths only.
`content is not a valid STL/PDF/... file`	The file does not contain what its extension says (e.g. an HTML page saved with a .stl extension).

Note

title	Requirements

Python 3.10+ and lxml.

Network access to www.wipo.int is used to fetch the schemas on first run. Behind a proxy or offline, run with --offline to use the bundled copies.

Page tree

Versions Compared

Old Version 2

New Version 3

Key

Installation

All options

Checks performed

Example output

Common errors