1111 - healthcheck
1212 responses :
1313 200 :
14- description : " Device info"
14+ description : " Device info. "
1515 content :
1616 application/json :
1717 schema :
@@ -26,33 +26,69 @@ paths:
2626 - healthcheck
2727 responses :
2828 200 :
29- description : " License is valid"
29+ description : " The license is valid. "
3030 400 :
31- description : " License is not valid"
31+ description : " The license is not valid. "
3232
3333components :
3434 schemas :
3535 DeviceInfo :
3636 title : " DeviceInfo"
3737 type : object
38+ required : [app, licenseId, licenseType, licenseSerial, licenseValidUntil, scenarios, version]
3839 properties :
3940 app :
41+ description : Application name.
4042 type : string
4143 licenseId :
44+ description : Unique license identifier.
4245 type : string
46+ nullable : true
4347 licenseType :
48+ description : License type.
4449 type : string
50+ nullable : true
4551 licenseSerial :
52+ description : License serial number.
4653 type : string
54+ nullable : true
4755 licenseValidUntil :
56+ description : License validity date.
4857 type : string
4958 format : date-time
59+ nullable : true
5060 scenarios :
61+ description : List of supported scenarios.
5162 type : array
63+ nullable : true
5264 items :
5365 type : string
5466 version :
67+ description : Product version.
5568 type : string
69+ nullable : true
70+ documentsDatabase :
71+ description : Database information.
72+ type : object
73+ required : [id, version, exportDate, description]
74+ properties :
75+ id :
76+ description : Database identifier.
77+ type : string
78+ nullable : true
79+ version :
80+ description : Database version.
81+ type : string
82+ nullable : true
83+ exportDate :
84+ description : Date of database creation.
85+ type : string
86+ format : date
87+ nullable : true
88+ description :
89+ description : Description of the database contents, such as the list of supported countries and documents.
90+ type : string
91+ nullable : true
5692 example :
5793 app : " Regula Document Reader Web API"
5894 licenseId : " 4D43A2AF-E321-496C-9A4E-5A8F3D26DF0E"
@@ -61,3 +97,8 @@ components:
6197 licenseValidUntil : " 9999-12-31T23:59:59Z"
6298 scenarios : ["Mrz", "Barcode", "Locate"]
6399 version : " 7.5.297907.1721"
100+ documentsDatabase :
101+ id : " FullAuth"
102+ version : " 800111"
103+ exportDate : " 2024-11-11"
104+ description : " FullAuth: All documents"
0 commit comments