asisteam/mvcr-document-validator

Implemenation of communication with MVCR document validator API

v1.2 2020-05-06 09:39 UTC

Requires

• php: >= 7.1
• ext-curl: *
• ext-libxml: *
• ext-simplexml: *
• nette/di: ^2.4 || ~3.0.0

Requires (Dev)

• mockery/mockery: ^1.2
• ninjify/nunjuck: ^0.2.0
• ninjify/qa: ^0.8.0

MIT

• Tomas Sedlacek

• api
• passport
• mvcr
• personal id card
• gun license

README

Credits

The development is under AsisTeam s.r.o.. Feel free to use and contribute.

Install

composer require asisteam/mvcr-document-validator

Versions

Overview

This package communicates with MVČR API and check if given document is found amomg registered invalid documents. Create Validator client instance and call it's validate method passing the given Document entity.

Following document types can be validated:

• Czech personal id cards
• Czech passports (issued centrally or regionally)
• Czech gun licenses

Original MVČR documentation to be found at: https://www.mvcr.cz/clanek/neplatne-doklady-ve-formatu-xml.aspx

Usage

Juc create Document object and Validator instance and pass the Document to Validator's method validate, which returns ValidatorResult object. Using ValidatorResult you can verify whether the given document is marked as invalid in MVČR registries or not. Furthermore you may get the information when the document was added to the registries and when the registries themselves were last updated.

Please use DocumentType enum for specifying the document type.

$document = new Document('123456AB', DocumentType::PERSONAL_ID_CARD);
$response = (new Validator())->validate($document);

// true if given document was found in registry of invalid documents
$response->isInvalid();

Or you can configure it as Nette Framework DI service

extensions:
	mvcr.doc_validator: AsisTeam\MVCR\DocumentValidator\Bridges\Nette\DI\ValidatorExtension
	
mvcr.doc_validator:
	timeout: 5

If any problem during doing the Request to API or parsing the response the ResponseException in being thrown.