diff --git a/.github/ISSUE_TEMPLATE /config.yml b/.github/ISSUE_TEMPLATE/config.yml similarity index 100% rename from .github/ISSUE_TEMPLATE /config.yml rename to .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/workflows/update-clients.yml b/.github/workflows/update-clients.yml index 63d63bf..1bd518f 100644 --- a/.github/workflows/update-clients.yml +++ b/.github/workflows/update-clients.yml @@ -8,6 +8,10 @@ on: title: description: "Title For PR's" required: true + branch: + description: "OpenAPI branch" + required: true + default: "develop" jobs: title: @@ -31,7 +35,7 @@ jobs: uses: actions/checkout@v4 with: path: "DocumentReader-web-openapi" - ref: "develop" + ref: ${{ github.event.inputs.branch }} - name: Checkout JS Client Repo uses: actions/checkout@v4 @@ -75,7 +79,7 @@ jobs: uses: actions/checkout@v4 with: path: "DocumentReader-web-openapi" - ref: "develop" + ref: ${{ github.event.inputs.branch }} - name: Checkout Java Client Repo uses: actions/checkout@v4 @@ -111,7 +115,7 @@ jobs: uses: actions/checkout@v4 with: path: "DocumentReader-web-openapi" - ref: "develop" + ref: ${{ github.event.inputs.branch }} - name: Checkout Python Client Repo uses: actions/checkout@v4 @@ -147,7 +151,7 @@ jobs: uses: actions/checkout@v4 with: path: "DocumentReader-web-openapi" - ref: "develop" + ref: ${{ github.event.inputs.branch }} - name: Checkout C# Client Repo uses: actions/checkout@v4 diff --git a/.github/workflows/validate-spec.yml b/.github/workflows/validate-spec.yml index b2b245c..b343645 100644 --- a/.github/workflows/validate-spec.yml +++ b/.github/workflows/validate-spec.yml @@ -17,16 +17,16 @@ jobs: - name: Setup Node uses: actions/setup-node@v4 with: - node-version: 14 + node-version: 20 registry-url: https://registry.npmjs.org/ - name: Install redoc run: | - npm install -g redoc-cli - redoc-cli bundle index.yml + npm install -g @redocly/cli + redocly build-docs index.yml - name: Revert changes if: ${{ false }} run: | npm install -g @openapitools/openapi-generator-cli - openapi-generator-cli validate -i index.yml + openapi-generator-cli validate --recommend -i index.yml diff --git a/.github/workflows/verify-clients.yml b/.github/workflows/verify-clients.yml index e5f5a5b..ef7ee94 100644 --- a/.github/workflows/verify-clients.yml +++ b/.github/workflows/verify-clients.yml @@ -26,6 +26,7 @@ jobs: working-directory: python-client run: | ./update-models.sh + ./setup.sh verify-csharp: runs-on: ubuntu-latest @@ -45,6 +46,7 @@ jobs: working-directory: csharp-client run: | ./update-models.sh + ./setup.sh verify-js: runs-on: ubuntu-latest @@ -63,9 +65,8 @@ jobs: - name: Verify update JS client working-directory: js-client run: | - npm install ./update-models.sh - npm run check-types + ./setup.sh verify-java: runs-on: ubuntu-latest diff --git a/README.md b/README.md index 0ede455..af50ffd 100644 --- a/README.md +++ b/README.md @@ -23,37 +23,31 @@ * **rt - \*.yml** - files describing results types * **p - \*.yml** - files describing endpoints - ## Updating clients according to the current spec -To update clients, use `update clients` GitHub action. Specify title PR and press run. For each client **PR** with changes will be created. - -:warning: NOTE: Static typed clients, such as Java or C#, require adding all new **enums** to `update-models.sh` ENUM_MAPPINGS section. +When changes are added, the `update clients` action is automatically triggered. For each client **PR** with changes will be created. -:warning: NOTE: For some clients generator produces not-valid client code. See `update-models.sh` for ad-hocks fixing generator issues. +:warning: NOTE: Before working with a client, read `dev.md` which is available in each client repository. -:warning: NOTE: Do **not edit** generated code. Create wrappers, decorators, etc in ext folder. +:warning: NOTE: Do **not edit** generated code. Create wrappers, decorators, etc. in ext folder. -:bulb: All clients have RawResultItem container that is used for deserialization for undescribed types. This container is a simple map/dict. +:bulb: All clients have RawResultItem and AuthenticityCheckResultItem containers that are used for deserialization oneOf schemas. These containers are a simple map/dict. ## Spec validation -``` -docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli validate --recommend -i /local/index.yml + +```bash +docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli validate --recommend -i /local/index.yml ``` ## Building Redoc single page html documentation -Edit **rt.yml** - remove **components.schemas.ResultItem.discriminator** node - -Edit **rt-authenticity.yml** - remove **components.schemas.AuthenticityCheckResultItem.discriminator** - -Then run next command: -``` +```bash npx @redocly/cli build-docs index.yml -o=document-reader-static-doc.html ``` ## Bundle scheme to single .json file + ```bash -npx openapi-generator-cli generate -i index.yml -g openapi --skip-validate-spec +npx @openapitools/openapi-generator-cli generate -i index.yml -g openapi --skip-validate-spec ``` diff --git a/authenticity/e-check-diagnose.yml b/authenticity/e-check-diagnose.yml index 96d1d74..3e1c71f 100644 --- a/authenticity/e-check-diagnose.yml +++ b/authenticity/e-check-diagnose.yml @@ -1,7 +1,8 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: CheckDiagnose: + title: "CheckDiagnose" type: integer description: "Enumeration contains identifiers which determinate the single document element authenticity check outcome reason: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/check-diagnose/" enum: diff --git a/authenticity/e-critical.yml b/authenticity/e-critical.yml index eac10bd..cb2e9a6 100644 --- a/authenticity/e-critical.yml +++ b/authenticity/e-critical.yml @@ -1,7 +1,8 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: Critical: + title: "Critical" type: integer description: "Enumeration contains identifiers determining the criticality of the security element" enum: diff --git a/authenticity/e-result-type.yml b/authenticity/e-result-type.yml index 6fd64e4..ff31722 100644 --- a/authenticity/e-result-type.yml +++ b/authenticity/e-result-type.yml @@ -1,8 +1,10 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: AuthenticityResultType: + title: "AuthenticityResultType" type: integer + format: int64 description: "Enumeration describes available authenticity checks: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/authenticity-result-type/." enum: - 1 diff --git a/authenticity/e-visibility.yml b/authenticity/e-visibility.yml index 042f366..ce26dbe 100644 --- a/authenticity/e-visibility.yml +++ b/authenticity/e-visibility.yml @@ -1,7 +1,8 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: Visibility: + title: "Visibility" type: integer description: "Enumeration contains visibility status of the security element" enum: diff --git a/authenticity/rt-fiber.yml b/authenticity/rt-fiber.yml index 4952b4b..875c8ba 100644 --- a/authenticity/rt-fiber.yml +++ b/authenticity/rt-fiber.yml @@ -1,48 +1,52 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: - - FiberResult: - title: "Fibers Check" - allOf: - - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem" - - type: object - properties: - RectCount: - description: "For UV_Fibers authenticity result type" - type: integer - ExpectedCount: - description: "Expected fibers number. For UV_Fibers authentication result type" - type: integer - LightValue: - description: "For UV_Background authentication result type" - $ref: "../common.yml#/components/schemas/Light" - LightDisp: - description: "For UV_Background authentication result type" - type: integer - RectArray: - description: "Coordinates of located areas for defined fibers type" - type: array - items: - $ref: "../common.yml#/components/schemas/RectangleCoordinates" - Width: - description: "Fibers width value for located areas (in pixels)" - type: array - items: - type: integer - Length: - description: "Fibers length value for located areas (in pixels)" - type: array - items: - type: integer - Area: - description: "Fibers value for areas (in pixels)" - type: array - items: - type: integer - ColorValues: - description: "Fibers color value" - example: [BLUE, GREEN, RED] - type: array - items: - type: integer \ No newline at end of file + FiberItem: + title: "FiberItem" + type: object + required: + - RectCount + - ExpectedCount + - RectArray + - Width + - Length + - Area + - ColorValues + properties: + RectCount: + description: "For UV_Fibers authenticity result type" + type: integer + ExpectedCount: + description: "Expected fibers number. For UV_Fibers authentication result type" + type: integer + LightValue: # For UV_Background authentication result type + $ref: "../common.yml#/components/schemas/Light" + LightDisp: + description: "For UV_Background authentication result type" + type: integer + RectArray: + description: "Coordinates of located areas for defined fibers type" + type: array + items: + $ref: "../common.yml#/components/schemas/RectangleCoordinates" + Width: + description: "Fibers width value for located areas (in pixels)" + type: array + items: + type: integer + Length: + description: "Fibers length value for located areas (in pixels)" + type: array + items: + type: integer + Area: + description: "Fibers value for areas (in pixels)" + type: array + items: + type: integer + ColorValues: + description: "Fibers color value" + example: [BLUE, GREEN, RED] + type: array + items: + type: integer diff --git a/authenticity/rt-ident.yml b/authenticity/rt-ident.yml index feca0b6..61fb20d 100644 --- a/authenticity/rt-ident.yml +++ b/authenticity/rt-ident.yml @@ -1,24 +1,26 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: - - IdentResult: - title: "Ident Check" - allOf: - - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem" - - type: object - properties: - ElementType: - $ref: "../e-security-feature-type.yml#/components/schemas/SecurityFeatureType" - LightIndex: - $ref: "../common.yml#/components/schemas/Light" - Area: - $ref: "../common.yml#/components/schemas/RectangleCoordinates" - Image: - description: "Original image" - $ref: "../common.yml#/components/schemas/ImageData" - EtalonImage: - description: "Reference image" - $ref: "../common.yml#/components/schemas/ImageData" - AreaList: - $ref: "../rt-authenticity.yml#/components/schemas/AreaContainer" \ No newline at end of file + IdentItem: + title: "IdentItem" + type: object + required: + - ElementType + - LightIndex + - Image + - EtalonImage + properties: + ElementType: + $ref: "../e-security-feature-type.yml#/components/schemas/SecurityFeatureType" + LightIndex: + $ref: "../common.yml#/components/schemas/Light" + Area: + $ref: "../common.yml#/components/schemas/RectangleCoordinates" + Image: # Original image + $ref: "../common.yml#/components/schemas/ImageData" + EtalonImage: # Reference image + $ref: "../common.yml#/components/schemas/ImageData" + AreaList: + $ref: "../rt-authenticity.yml#/components/schemas/AreaContainer" + ElementID: + type: integer diff --git a/authenticity/rt-ocr-security-text.yml b/authenticity/rt-ocr-security-text.yml index 6ddfd2b..493de67 100644 --- a/authenticity/rt-ocr-security-text.yml +++ b/authenticity/rt-ocr-security-text.yml @@ -1,30 +1,39 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: - - OCRSecurityTextResult: - title: "OCR Security Text Check" - allOf: - - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem" - - type: object - properties: - CriticalFlag: - $ref: "./e-critical.yml#/components/schemas/Critical" - LightType: - $ref: "../common.yml#/components/schemas/Light" - FieldRect: - $ref: "../common.yml#/components/schemas/RectangleCoordinates" - EtalonResultType: - type: integer - EtalonFieldType: - type: integer - EtalonLightType: - type: integer - SecurityTextResultOCR: - type: string - EtalonResultOCR: - type: string - Reserved1: - type: integer - Reserved2: - type: integer \ No newline at end of file + OCRSecurityTextItem: + title: "OCRSecurityTextItem" + type: object + required: + - CriticalFlag + - LightType + - FieldRect + - EtalonResultType + - EtalonFieldType + - EtalonLightType + - EtalonFieldRect + - SecurityTextResultOCR + - EtalonResultOCR + properties: + CriticalFlag: + $ref: "./e-critical.yml#/components/schemas/Critical" + LightType: + $ref: "../common.yml#/components/schemas/Light" + FieldRect: + $ref: "../common.yml#/components/schemas/RectangleCoordinates" + EtalonResultType: + $ref: "../rt.yml#/components/schemas/ContainerType" + EtalonFieldType: + $ref: "../e-text-field-type.yml#/components/schemas/TextFieldType" + EtalonLightType: + $ref: "../common.yml#/components/schemas/Light" + EtalonFieldRect: + $ref: "../common.yml#/components/schemas/RectangleCoordinates" + SecurityTextResultOCR: + type: string + EtalonResultOCR: + type: string + Reserved1: + type: integer + Reserved2: + type: integer diff --git a/authenticity/rt-photo-ident.yml b/authenticity/rt-photo-ident.yml index 94f32ad..3e20ef9 100644 --- a/authenticity/rt-photo-ident.yml +++ b/authenticity/rt-photo-ident.yml @@ -1,40 +1,32 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: - - PhotoIdentResult: - title: "Photo Ident Check" - allOf: - - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem" - - type: object - properties: - LightIndex: - $ref: "../common.yml#/components/schemas/Light" - Area: - $ref: "../common.yml#/components/schemas/RectangleCoordinates" - SourceImage: - $ref: "../common.yml#/components/schemas/ImageData" - ResultImages: - $ref: "#/components/schemas/RawImageContainerList" - FieldTypesCount: - type: integer - FieldTypesList: - type: array - items: - type: integer - Step: - type: integer - Angle: - type: integer - Reserved3: - type: integer - - RawImageContainerList: + PhotoIdentItem: + title: "PhotoIdentItem" type: object + required: + - LightIndex + - Area + - SourceImage + - ResultImages properties: - Count: + LightIndex: + $ref: "../common.yml#/components/schemas/Light" + Area: + $ref: "../common.yml#/components/schemas/RectangleCoordinates" + SourceImage: + $ref: "../common.yml#/components/schemas/ImageData" + ResultImages: + $ref: "../common.yml#/components/schemas/RawImageContainerList" + FieldTypesCount: type: integer - Images: + FieldTypesList: type: array items: - $ref: "../common.yml#/components/schemas/ImageData" \ No newline at end of file + type: integer + Step: + type: integer + Angle: + type: integer + Reserved3: + type: integer diff --git a/authenticity/rt-security-feature.yml b/authenticity/rt-security-feature.yml index e7d7ca7..0693bf6 100644 --- a/authenticity/rt-security-feature.yml +++ b/authenticity/rt-security-feature.yml @@ -1,22 +1,24 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: - - SecurityFeatureResult: - title: "Security Feature Check" - allOf: - - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem" - - type: object - properties: - ElementType: - $ref: "../e-security-feature-type.yml#/components/schemas/SecurityFeatureType" - ElementRect: - $ref: "../common.yml#/components/schemas/RectangleCoordinates" - Visibility: - $ref: "./e-visibility.yml#/components/schemas/Visibility" - CriticalFlag: - $ref: "./e-critical.yml#/components/schemas/Critical" - AreaList: - $ref: "../rt-authenticity.yml#/components/schemas/AreaContainer" - Reserved2: - type: integer \ No newline at end of file + SecurityFeatureItem: + title: "SecurityFeatureItem" + type: object + required: + - ElementType + - ElementRect + - Visibility + - CriticalFlag + properties: + ElementType: + $ref: "../e-security-feature-type.yml#/components/schemas/SecurityFeatureType" + ElementRect: + $ref: "../common.yml#/components/schemas/RectangleCoordinates" + Visibility: + $ref: "./e-visibility.yml#/components/schemas/Visibility" + CriticalFlag: + $ref: "./e-critical.yml#/components/schemas/Critical" + AreaList: + $ref: "../rt-authenticity.yml#/components/schemas/AreaContainer" + Reserved2: + type: integer diff --git a/common.yml b/common.yml index cdc1627..3243dff 100644 --- a/common.yml +++ b/common.yml @@ -1,6 +1,4 @@ -openapi: 3.0.3 - - +openapi: 3.0.4 components: parameters: x-request: @@ -12,10 +10,12 @@ components: schemas: PageIndex: + title: "PageIndex" description: "Page index of the image from input list" type: integer Source: + title: "Source" description: "Document data sources" type: string enum: @@ -24,20 +24,24 @@ components: - "BARCODE" - "RFID" - "MAGNETIC" + - "EXTERNAL" x-enum-varnames: - "MRZ" - "VISUAL" - "BARCODE" - "RFID" - "MAGNETIC" + - "EXTERNAL" x-enum-descriptions: - "Machine readable zone (MRZ)" - "Visual zone" - "Barcode" - "RFID" - "Magnetic" + - "External" CheckResult: + title: "CheckResult" type: integer description: "0 - result is negative; 1 - result is positive; 2 - сheck was not performed" enum: @@ -53,8 +57,8 @@ components: - "Check was performed and result is POSITIVE" - "Check was NOT PERFORMED" - # todo update x-enum-descriptions Scenario: + title: "Scenario" type: string description: "Document processing scenario" enum: @@ -77,6 +81,7 @@ components: - "CreditCard" - "Capture" - "DTC" + - "RFID" x-enum-varnames: - "MRZ" - "BARCODE" @@ -97,6 +102,7 @@ components: - "CREDIT_CARD" - "CAPTURE" - "DTC" + - "RFID" x-enum-descriptions: - "Processing scenario for obtaining MRZ data" - "Processing scenario for obtaining barcode data" @@ -117,11 +123,11 @@ components: - "Processing scenario for obtaining bank card data" - "Scenario for obtaining an original image without any processing" - "Processing scenario for Digital Travel Credentials (DTC-VC) data processing" + - "Processing scenario for RFID chip processing" ImageData: + title: "ImageData" type: object - required: - - image properties: image: $ref: "#/components/schemas/ImageBase64" @@ -130,18 +136,21 @@ components: type: string ImageTransactionData: + title: "ImageTransactionData" type: object properties: image: $ref: './rt-images.yml#/components/schemas/ImagesFieldValue' ImageBase64: + title: "ImageBase64" description: "Base64 encoded image" type: string format: base64 example: "Base64 encoded image" RectangleCoordinates: + title: "RectangleCoordinates" description: "Coordinates of the rectangle region on a document image(result type 1). Represented by two points - (left, top) + (right, bottom)" type: object required: @@ -160,6 +169,7 @@ components: type: integer RfidLocation: + title: "RfidLocation" type: integer description: "Determines the presence and location of an RFID chip in a document. 0 - no rfid chip; 1 - chip is located in the document data page; 2 - chip is located in the back page or inlay of the document" enum: @@ -176,10 +186,14 @@ components: - "BACK_PAGE" RfidOrigin: + title: "RfidOrigin" type: object description: "Location of data in RFID chip" required: - dg + - dgTag + - tagEntry + - entryView properties: dg: description: "Source data group file" @@ -199,22 +213,35 @@ components: description: "Image light index" enum: - 0 + - 2 + - 4 - 6 - 24 - 128 + - 3072 x-enum-descriptions: - "No Light" + - "Upper/lower white" + - "Side white" - "White" - "Infrared" - "Ultraviolet" + - "Axial white" x-enum-varnames: - "OFF" + - "WHITE_TOP" + - "WHITE_SIDE" - "WHITE" - "IR" - "UV" + - "AXIAL_WHITE" Point: + title: "Point" type: object + required: + - x + - y properties: x: type: integer @@ -222,18 +249,21 @@ components: type: integer License: + title: "License" description: "Base64 encoded data" type: string format: byte example: "Base64 encoded data" EncryptedRCL: + title: "EncryptedRCL" description: "Base64 encoded data" type: string format: byte example: "Base64 encoded data" FaceApi: + title: "FaceApi" type: object properties: url: @@ -252,7 +282,8 @@ components: type: integer description: "The maximum number of results to be returned." threshold: - type: float + type: number + format: float description: "The similarity threshold." group_ids: type: array @@ -287,3 +318,183 @@ components: type: integer example: 5 description: "Estimated duration of validity for a child's passport, years. Default: 5." + + VisualExtendedFieldItem: + title: "VisualExtendedFieldItem" + type: object + required: + - wFieldType + - FieldName + - StringsCount + - StringsResult + - Buf_Length + - Buf_Text + properties: + wFieldType: + $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" + FieldName: + description: "Field symbolic name (null-terminated string)" + type: string + StringsCount: + description: "Number of StringsResult array elements" + type: number + StringsResult: + type: array + description: "Array of recognizing probabilities for a each line of text field. + Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results." + items: + $ref: "#/components/schemas/StringRecognitionResult" + Buf_Length: + description: "Buf_Text text string length" + type: number + Buf_Text: + type: string + description: "Text field data in UTF8 format. + Results of reading different lines of a multi-line field are separated by '^'" + FieldMask: + type: string + Validity: + type: integer + InComparison: + type: integer + wLCID: + $ref: "./e-lcid.yml#/components/schemas/LCID" + Reserved2: + type: integer + Reserved3: + type: integer + + StringRecognitionResult: + title: "StringRecognitionResult" + type: object + description: "Describes single row recognition results in multi-line text field of a document" + required: + - SymbolsCount + - StringResult + properties: + SymbolsCount: + description: "Number of StringResult array elements" + type: number + StringResult: + type: array + description: "Array of recognition results for individual characters of a string" + items: + $ref: "#/components/schemas/SymbolRecognitionResult" + Buf_Length: + description: "Buf_Text text string length" + type: number + Buf_Text: + type: string + description: "Text field data in UTF8 format. + Results of reading different lines of a multi-line field are separated by '^'" + Reserved: + type: integer + + SymbolRecognitionResult: + title: "SymbolRecognitionResult" + type: object + description: "Describes a single character recognition results in the text field line" + required: + - CandidatesCount + - ListOfCandidates + properties: + SymbolRect: # Coordinates of the symbol in the normalized image of the document + $ref: "#/components/schemas/RectangleCoordinates" + CandidatesCount: + description: "Number of significant elements of ListOfCandidates array" + type: number + ListOfCandidates: + type: array + description: "Array of candidate characters. Sorted in descending order of recognition probabilities + (the first element has highest probability)" + items: + $ref: "#/components/schemas/SymbolCandidate" + BaseLineBottom: + type: integer + BaseLineTop: + type: integer + + SymbolCandidate: + title: "SymbolCandidate" + required: + - SymbolCode + - SymbolProbability + type: object + description: "Describes an individual character recognition candidate" + properties: + SymbolCode: + type: integer + format: int64 + description: "Unicode symbol code" + SymbolProbability: + type: integer + description: "character recognition probability (0–100,%)" + minimum: 0 + maximum: 100 + Class: + type: integer + SubClass: + type: integer + + RawImageContainerList: + title: "RawImageContainerList" + type: object + required: + - Count + - Images + properties: + Count: + type: integer + Images: + type: array + items: + $ref: "#/components/schemas/ImageData" + + DocumentPosition: + title: "DocumentPosition" + type: object + required: + - docFormat + - Angle + - Width + - Height + - Center + - LeftBottom + - LeftTop + - RightBottom + - RightTop + - Dpi + properties: + docFormat: + $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentFormat" + Angle: + description: "Document rotation angle" + type: number + Width: + description: "Document width" + type: integer + Height: + description: "Document height" + type: integer + Center: + $ref: "./common.yml#/components/schemas/Point" + LeftBottom: + $ref: "./common.yml#/components/schemas/Point" + LeftTop: + $ref: "./common.yml#/components/schemas/Point" + RightBottom: + $ref: "./common.yml#/components/schemas/Point" + RightTop: + $ref: "./common.yml#/components/schemas/Point" + Dpi: + type: integer + Inverse: + type: integer + ObjArea: + type: integer + ObjIntAngleDev: + type: integer + PerspectiveTr: + type: integer + ResultStatus: + type: integer diff --git a/e-barcode-type.yml b/e-barcode-type.yml index 3335b56..b345aca 100644 --- a/e-barcode-type.yml +++ b/e-barcode-type.yml @@ -1,7 +1,8 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: BarcodeType: + title: "BarcodeType" type: integer description: "Enumeration contains the types of barcodes that can be processed" enum: diff --git a/e-document-type.yml b/e-document-type.yml index 2e25c5a..48fe305 100644 --- a/e-document-type.yml +++ b/e-document-type.yml @@ -1,7 +1,8 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: DocumentType: + title: "DocumentType" type: integer description: "Possible values for document types" enum: diff --git a/e-graphic-field-type.yml b/e-graphic-field-type.yml index e29bf96..fe943ae 100644 --- a/e-graphic-field-type.yml +++ b/e-graphic-field-type.yml @@ -1,10 +1,13 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: GraphicFieldName: + title: "GraphicFieldName" description: "Human readable field name. Do not bind to this name - use GraphicFieldType instead." type: string + GraphicFieldType: + title: "GraphicFieldType" type: integer enum: - 201 @@ -18,6 +21,7 @@ components: - 209 - 210 - 211 + - 212 - 213 - 250 - 300 @@ -45,6 +49,7 @@ components: - "Area with dynamic color change" - "Additional Portrait" - "Stamp" + - "Portrait of child" - "Contact chip" - "Undefined image type" - "Fingerprint (thumb, left hand)" @@ -72,6 +77,7 @@ components: - "COLOR_DYNAMIC" - "GHOST_PORTRAIT" - "STAMP" + - "PORTRAIT_OF_CHILD" - "CONTACT_CHIP" - "OTHER" - "FINGER_LEFT_THUMB" diff --git a/e-input-barcode-type.yml b/e-input-barcode-type.yml index f69448c..b812111 100644 --- a/e-input-barcode-type.yml +++ b/e-input-barcode-type.yml @@ -1,7 +1,8 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: InputBarcodeType: + title: "InputBarcodeType" type: string description: "Enumeration contains the types of barcodes that can be processed" enum: diff --git a/e-lcid.yml b/e-lcid.yml index bd8bca7..bac0756 100644 --- a/e-lcid.yml +++ b/e-lcid.yml @@ -1,8 +1,8 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: - LCID: + title: "LCID" description: | Locale id. Used to tag same typed fields declared in several languages. For example: name can be provided in both native and latin variants. @@ -36,10 +36,15 @@ components: - 1026 - 1109 - 1027 + - 3076 + - 5124 - 2052 + - 4100 + - 1028 - 1050 - 1029 - 1030 + - 1125 - 2067 - 1043 - 3081 @@ -134,6 +139,7 @@ components: - 1089 - 1053 - 2077 + - 1114 - 1097 - 1092 - 1098 @@ -197,10 +203,15 @@ components: - "BULGARIAN" - "BURMESE" - "CATALAN" + - "CHINESE_HONGKONG_SAR" + - "CHINESE_MACAO_SAR" - "CHINESE" + - "CHINESE_SINGAPORE" + - "CHINESE_TAIWAN" - "CROATIAN" - "CZECH" - "DANISH" + - "DIVEHI" - "DUTCH_BELGIUM" - "DUTCH_NETHERLANDS" - "ENGLISH_AUSTRALIA" @@ -295,6 +306,7 @@ components: - "SWAHILI" - "SWEDISH" - "SWEDISH_FINLAND" + - "SYRIAC" - "TAMIL" - "TATAR" - "TELUGU" @@ -309,9 +321,9 @@ components: - "VIETNAMESE" - "CTC_SIMPLIFIED" - "CTC_TRADITIONAL" - - "BengaliBangladesh" - - "BengaliIndia" - - "Assamese" + - "BENGALI_BANGLADESH" + - "BENGALI_INDIA" + - "ASSAMESE" - "ORIYA" - "MALAYALAM" - "LAO" @@ -358,10 +370,15 @@ components: - "Bulgarian" - "Burmese" - "Catalan" + - "Chinese (HongKong S.A.R.)" + - "Chinese (Macao S.A.R.)" - "Chinese" + - "Chinese (Singapore)" + - "Chinese (Taiwan)" - "Croatian" - "Czech" - "Danish" + - "Divehi" - "Dutch (Belgium)" - "Dutch (Netherlands)" - "English (Australia)" @@ -456,6 +473,7 @@ components: - "Swahili" - "Swedish" - "Swedish (Finland)" + - "Syriac" - "Tamil" - "Tatar" - "Telugu" @@ -490,4 +508,4 @@ components: - "Bank Card CVV2" - "Abkhazian (Cyrillic)" - "Karakalpak (Latin)" - - "Urdu Detection" \ No newline at end of file + - "Urdu Detection" diff --git a/e-parsing-error-codes.yml b/e-parsing-error-codes.yml index 7469f92..fef8cd0 100644 --- a/e-parsing-error-codes.yml +++ b/e-parsing-error-codes.yml @@ -1,136 +1,146 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: ParsingErrorCodes: + title: "ParsingErrorCodes" type: integer + format: int64 description: "The enumeration contains error codes that can return during the RFID chip processing." enum: - 1 - - -2147483647 - - -2147483646 - - -2147483645 - - -2147483640 - - -2147483639 - - -2147483638 - - -2147483631 - - -2147483629 - - -2147483628 - - -2147483627 - - -2147483626 - - -2147483630 - - -2147483625 - - -2147483624 - - -2147483623 - - -2147483622 - - -2147483621 - - -2147483620 - - -2147483619 - - -2147483618 - - -2147483617 - - -2147483616 - - -2147483615 - - -2147483614 - - -2147483613 - - -2147483612 - - -2147483611 - - -2147483610 - - -2147483609 - - -2147483600 - - -2147483599 - - -2147483598 - - -2147483597 - - -2147483596 - - -2147483594 - - -2147483595 - - -2147483568 - - -2147483567 - - -2147483566 - - -2147483565 - - -2147483564 - - -2147483563 - - -2147483562 - - -2147483561 - - -2147483560 - - -2147483559 - - -2147483558 - - -2147483536 - - -2147483535 - - -2130706415 - - -2130706400 - - -2130706399 - - -2130706398 - - -2130706397 - - -2130706396 - - -2130706395 - - -2130706394 - - -2130706393 - - -2130706392 - - -2130706391 - - -2130706390 - - -2130706389 - - -2130706388 - - -2130706387 - - -2130706386 - - -2130706385 - - -2130706384 - - -2130706383 - - -2130706382 - - -2130706381 - - -2130706380 - - -2130706379 - - -2130706378 - - -2130706377 - - -2130706376 - - -2130706368 - - -2130706367 - - -2130706366 - - -2130706365 - - -2130706364 - - -2130706363 - - -2130706352 - - -2130706351 - - -2130706350 - - -2130706349 - - -2130706348 - - -2130706347 - - -2130706346 - - -2130706345 - - -2130706320 - - -2130706319 - - -2130706318 - - -2130706336 - - -2130706334 - - -2130706333 - - -2130706332 - - -2130706331 - - -2130706080 - - -2130706079 - - -2130706078 - - -2130706077 - - -2130706076 - - -2130706075 - - -2130706074 - - -2130706073 - - -2130706072 - - -2130706071 - - -2130706070 - - -2130705920 - - -2130705919 - - -2130705918 - - -2130705917 - - -2130705916 - - -2130705915 - - -2130705664 - - -2130705663 - - -2130705662 - - -2130705661 - - -2130705660 - - -2130705659 - - -2130705658 - - -2130705657 - - -2130705656 - - -2130705655 - - -2130705654 + - 2147483649 + - 2147483650 + - 2147483651 + - 2147483656 + - 2147483657 + - 2147483658 + - 2147483665 + - 2147483667 + - 2147483668 + - 2147483669 + - 2147483670 + - 2147483666 + - 2147483671 + - 2147483672 + - 2147483673 + - 2147483674 + - 2147483675 + - 2147483676 + - 2147483677 + - 2147483678 + - 2147483679 + - 2147483680 + - 2147483681 + - 2147483682 + - 2147483683 + - 2147483684 + - 2147483685 + - 2147483686 + - 2147483687 + - 2147483712 + - 2147483713 + - 2147483714 + - 2147483715 + - 2147483716 + - 2147483717 + - 2147483718 + - 2147483719 + - 2147483696 + - 2147483697 + - 2147483698 + - 2147483699 + - 2147483700 + - 2147483702 + - 2147483701 + - 2147483728 + - 2147483729 + - 2147483730 + - 2147483731 + - 2147483732 + - 2147483733 + - 2147483734 + - 2147483735 + - 2147483736 + - 2147483737 + - 2147483738 + - 2147483760 + - 2147483761 + - 2164260881 + - 2164260896 + - 2164260897 + - 2164260898 + - 2164260899 + - 2164260900 + - 2164260901 + - 2164260902 + - 2164260903 + - 2164260904 + - 2164260905 + - 2164260906 + - 2164260907 + - 2164260908 + - 2164260909 + - 2164260910 + - 2164260911 + - 2164260912 + - 2164260913 + - 2164260914 + - 2164260915 + - 2164260916 + - 2164260917 + - 2164260918 + - 2164260919 + - 2164260920 + - 2164260928 + - 2164260929 + - 2164260930 + - 2164260931 + - 2164260932 + - 2164260933 + - 2164260944 + - 2164260945 + - 2164260946 + - 2164260947 + - 2164260948 + - 2164260949 + - 2164260950 + - 2164260951 + - 2164260976 + - 2164260977 + - 2164260978 + - 2164260960 + - 2164260962 + - 2164260963 + - 2164260964 + - 2164260965 + - 2164261216 + - 2164261217 + - 2164261218 + - 2164261219 + - 2164261220 + - 2164261221 + - 2164261222 + - 2164261223 + - 2164261224 + - 2164261225 + - 2164261226 + - 2164261376 + - 2164261377 + - 2164261378 + - 2164261379 + - 2164261380 + - 2164261381 + - 2164261632 + - 2164261633 + - 2164261634 + - 2164261635 + - 2164261636 + - 2164261637 + - 2164261638 + - 2164261639 + - 2164261640 + - 2164261641 + - 2164261642 x-enum-descriptions: - "OK" - "ASN: Incorrect data" @@ -162,6 +172,14 @@ components: - "ASN Signer info: Sign algorithms incorrect data" - "ASN Signer info: Signature incorrect data" - "ASN Signer info: Unsigned attributes incorrect data" + - "ASN DTC Signer info: Incorrect data" + - "ASN DTC Signer info: Certificate incorrect data" + - "ASN DTC Signer info: Digest algorithms incorrect data" + - "ASN DTC Signer info: Signed attributes incorrect data" + - "ASN DTC Signer info: Sign algorithms incorrect data" + - "ASN DTC Signer info: Signature incorrect data" + - "ASN DTC Security info: Incorrect data" + - "ASN DTC Content info: Incorrect data" - "ICAO LDS object: Unsupported digest algorithm" - "ICAO Signed data: Signer info empty" - "ICAO Signer info: Unsupported digest algorithm" @@ -289,6 +307,14 @@ components: - "errLDS_ASN_SignerInfo_SignAlg_IncorrectData" - "errLDS_ASN_SignerInfo_Signature_IncorrectData" - "errLDS_ASN_SignerInfo_UnsignedAttrs_IncorrectData" + - "errLDS_ASN_DTC_SignerInfo_IncorrectData" + - "errLDS_ASN_DTC_SignerInfo_Certificate_IncorrectData" + - "errLDS_ASN_DTC_SignerInfo_DigestAlg_IncorrectData" + - "errLDS_ASN_DTC_SignerInfo_SignedAttrs_IncorrectData" + - "errLDS_ASN_DTC_SignerInfo_SignAlg_IncorrectData" + - "errLDS_ASN_DTC_SignerInfo_Signature_IncorrectData" + - "errLDS_ASN_DTC_SecurityInfo_IncorrectData" + - "errLDS_ASN_DTC_ContentInfo_IncorrectData" - "errLDS_ICAO_LDSObject_UnsupportedDigestAlgorithm" - "errLDS_ICAO_SignedData_SignerInfos_Empty" - "errLDS_ICAO_SignerInfo_UnsupportedDigestAlgorithm" diff --git a/e-parsing-notification-codes.yml b/e-parsing-notification-codes.yml index 4a3d1d3..f539439 100644 --- a/e-parsing-notification-codes.yml +++ b/e-parsing-notification-codes.yml @@ -1,149 +1,156 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: ParsingNotificationCodes: + title: "ParsingNotificationCodes" type: integer + format: int64 description: "The enumeration contains possible values of notification codes returned during the RFID chip processing." enum: - - -1879048191 - - -1879048190 - - -1879048189 - - -1879048188 - - -1879048187 - - -1879048186 - - -1879048184 - - -1879048178 - - -1879048177 - - -1879048176 - - -1879048169 - - -1879047680 - - -1879047679 - - -1879047678 - - -1879047677 - - -1879047676 - - -1879047675 - - -1879047674 - - -1879047673 - - -1879047672 - - -1879047671 - - -1879047670 - - -1879047669 - - -1879047668 - - -1879047667 - - -1879047666 - - -1879047665 - - -1879047664 - - -1879047663 - - -1879047662 - - -1879047661 - - -1879047660 - - -1879047659 - - -1879047658 - - -1879047657 - - -1879047656 - - -1879047655 - - -1879047654 - - -1879047653 - - -1879047652 - - -1879047651 - - -1879047650 - - -1879047649 - - -1879047648 - - -1879047647 - - -1879047646 - - -1879047645 - - -1879047644 - - -1879047643 - - -1879047642 - - -1879047640 - - -1879047639 - - -1879047638 - - -1879047637 - - -1879047636 - - -1879047635 - - -1879047634 - - -1879047633 - - -1879047631 - - -1879047630 - - -1879047629 - - -1879047628 - - -1879047627 - - -1879047626 - - -1879047625 - - -1879047624 - - -1879047623 - - -1879047622 - - -1879047621 - - -1879047620 - - -1879047619 - - -1879047618 - - -1879047617 - - -1879047616 - - -1879047615 - - -1879047614 - - -1879047613 - - -1879047612 - - -1879047611 - - -1879047610 - - -1879047609 - - -1879047608 - - -1879047607 - - -1879047606 - - -1879047605 - - -1879047604 - - -1879047603 - - -1879047602 - - -1879047601 - - -1879048160 - - -1879048159 - - -1879048158 - - -1879048157 - - -1879048156 - - -1879048155 - - -1879048154 - - -1879048144 - - -1879048143 - - -1879048142 - - -1879048141 - - -1879047936 - - -1879047776 - - -1879047775 - - -1879047935 - - -1879047934 - - -1879047933 - - -1879047927 - - -1879047760 - - -1879047759 - - -1879047758 - - -1879047932 - - -1879047931 - - -1879047930 - - -1879047929 - - -1879047928 - - -1879047744 - - -1879047736 - - -1879047728 - - -1879047720 - - -1879047926 - - -1879047925 - - -1879047924 - - -1879047923 - - -1879047922 - - -1879047921 - - -1879047920 - - -1879047919 - - -1879047918 - - -1879047909 - - -1879047908 - - -1879047907 - - -1879047906 - - -1879047905 - - -1879047915 - - -1879047914 - - -1879047913 - - -1879047912 - - -1879047911 - - -1879047910 + - 2415919105 + - 2415919106 + - 2415919107 + - 2415919108 + - 2415919109 + - 2415919110 + - 2415919112 + - 2415919118 + - 2415919119 + - 2415919120 + - 2415919127 + - 2415919616 + - 2415919617 + - 2415919618 + - 2415919619 + - 2415919620 + - 2415919621 + - 2415919622 + - 2415919623 + - 2415919624 + - 2415919625 + - 2415919626 + - 2415919627 + - 2415919628 + - 2415919629 + - 2415919630 + - 2415919631 + - 2415919632 + - 2415919633 + - 2415919634 + - 2415919635 + - 2415919636 + - 2415919637 + - 2415919638 + - 2415919639 + - 2415919640 + - 2415919641 + - 2415919642 + - 2415919643 + - 2415919644 + - 2415919645 + - 2415919646 + - 2415919647 + - 2415919648 + - 2415919649 + - 2415919650 + - 2415919651 + - 2415919652 + - 2415919653 + - 2415919654 + - 2415919656 + - 2415919657 + - 2415919658 + - 2415919659 + - 2415919660 + - 2415919661 + - 2415919662 + - 2415919663 + - 2415919665 + - 2415919666 + - 2415919667 + - 2415919668 + - 2415919669 + - 2415919670 + - 2415919671 + - 2415919672 + - 2415919673 + - 2415919674 + - 2415919675 + - 2415919676 + - 2415919677 + - 2415919678 + - 2415919679 + - 2415919680 + - 2415919681 + - 2415919682 + - 2415919683 + - 2415919684 + - 2415919685 + - 2415919686 + - 2415919687 + - 2415919688 + - 2415919689 + - 2415919690 + - 2415919691 + - 2415919692 + - 2415919693 + - 2415919694 + - 2415919695 + - 2415919696 + - 2415919697 + - 2415919698 + - 2415919699 + - 2415919700 + - 2415919136 + - 2415919137 + - 2415919138 + - 2415919139 + - 2415919140 + - 2415919141 + - 2415919142 + - 2415919152 + - 2415919153 + - 2415919154 + - 2415919155 + - 2415919360 + - 2415919520 + - 2415919521 + - 2415919361 + - 2415919362 + - 2415919363 + - 2415919369 + - 2415919536 + - 2415919537 + - 2415919538 + - 2415919364 + - 2415919365 + - 2415919366 + - 2415919367 + - 2415919368 + - 2415919552 + - 2415919560 + - 2415919568 + - 2415919576 + - 2415919370 + - 2415919371 + - 2415919372 + - 2415919373 + - 2415919374 + - 2415919375 + - 2415919376 + - 2415919377 + - 2415919378 + - 2415919387 + - 2415919388 + - 2415919389 + - 2415919390 + - 2415919391 + - 2415919381 + - 2415919382 + - 2415919383 + - 2415919384 + - 2415919385 + - 2415919386 - 139272 - 139273 - 139274 @@ -159,74 +166,170 @@ components: - 139286 - 139287 - 139288 - - -1878982656 - - -1878917120 - - -1878851584 - - -1878786048 - - -1878720512 - - -1878654976 - - -1878589440 - - -1878523904 - - -1878458368 - - -1878392832 - - -1878327296 - - -1877999616 - - -1877934080 - - -1877868544 - - -1877803008 - - -1877737472 - - -1877671936 - - -1877606400 - - -1877540864 - - -1877475328 - - -1877409792 - - -1877344256 - - -1862270976 - - -1862270975 - - -1862270974 - - -1862270973 - - -1862270972 - - -1862270971 - - -1862270970 - - -1862270969 - - -1862270968 - - -1862270967 - - -1862270966 - - -1862270965 - - -1862270964 - - -1862270963 - - -1862270962 - - -1862270720 - - -1862270719 - - -1862270718 - - -1862270717 - - -1862270716 - - -1862270715 - - -1862270714 - - -1862270713 - - -1862270712 - - -1862270711 - - -1862270710 - - -1862270709 - - -1862270708 - - -1862270707 - - -1862270706 - - -1862270705 - - -1862270704 - - -1862270463 - - -1862270462 - - -1862270461 - - -1862270460 - - -1862270208 - - -1845493483 - - -1845493482 - - -1845493481 - - -1845493480 - - -1845493479 - - -1879047600 - - -1879047599 - 139289 - - -1879047598 + - 2415984640 + - 2416050176 + - 2416115712 + - 2416181248 + - 2416246784 + - 2416312320 + - 2416377856 + - 2416443392 + - 2416508928 + - 2416574464 + - 2416640000 + - 2416705536 + - 2416967680 + - 2417033216 + - 2417098752 + - 2417164288 + - 2417229824 + - 2417295360 + - 2417360896 + - 2417426432 + - 2417491968 + - 2417557504 + - 2417623040 + - 2449539072 + - 2449604608 + - 2449670144 + - 2449735680 + - 2449801232 + - 2449801248 + - 2449801264 + - 2449801265 + - 2449801266 + - 2449801280 + - 2449801281 + - 2449801282 + - 2449801283 + - 2449801284 + - 2449801285 + - 2449801286 + - 2449801287 + - 2449801288 + - 2449801289 + - 2449801290 + - 2449801291 + - 2449801292 + - 2449801293 + - 2449801294 + - 2449801295 + - 2449801296 + - 2449801297 + - 2449801298 + - 2449801312 + - 2449801313 + - 2449801314 + - 2449801315 + - 2449801316 + - 2449801328 + - 2449801329 + - 2449801330 + - 2449801331 + - 2449801344 + - 2449801345 + - 2449801346 + - 2449801347 + - 2449801348 + - 2449801349 + - 2449801350 + - 2449801351 + - 2449801360 + - 2449801361 + - 2449801362 + - 2449801363 + - 2449801364 + - 2449801365 + - 2449801366 + - 2449801367 + - 2449801368 + - 2449801369 + - 2449801370 + - 2449801371 + - 2449801372 + - 2449801373 + - 2449801374 + - 2449801375 + - 2449801376 + - 2449801377 + - 2449801378 + - 2449801379 + - 2449801380 + - 2449801381 + - 2449801382 + - 2449801392 + - 2449801408 + - 2449801424 + - 2449801425 + - 2449801426 + - 2449801427 + - 2449801440 + - 2449801441 + - 2449801442 + - 2449801443 + - 2449801444 + - 2449801445 + - 2449801446 + - 2449801447 + - 2449801448 + - 2449801449 + - 2449801450 + - 2449801451 + - 2449801452 + - 2449801453 + - 2449801454 + - 2449801456 + - 2449801457 + - 2449801458 + - 2449801459 + - 2449801460 + - 2449801461 + - 2449801462 + - 2449801463 + - 2415919872 + - 2432696320 + - 2432696321 + - 2432696322 + - 2432696323 + - 2432696324 + - 2432696325 + - 2432696326 + - 2432696327 + - 2432696328 + - 2432696329 + - 2432696330 + - 2432696331 + - 2432696332 + - 2432696333 + - 2432696334 + - 2432696576 + - 2432696577 + - 2432696578 + - 2432696579 + - 2432696580 + - 2432696581 + - 2432696582 + - 2432696583 + - 2432696584 + - 2432696585 + - 2432696586 + - 2432696587 + - 2432696588 + - 2432696589 + - 2432696590 + - 2432696591 + - 2432696592 + - 2432696833 + - 2432696834 + - 2432696835 + - 2432696836 + - 2432697088 + - 2449473813 + - 2449473814 + - 2449473815 + - 2449473816 + - 2449473817 x-enum-descriptions: - "ASN certificate: Incorrect version" - "ASN certificate: Non-matching signature algorithm" @@ -236,7 +339,7 @@ components: - "ASN certificate: Empty subject" - "ASN certificate: Unsupported critical extension" - "ASN certificate: Forced default CSCA role" - - "ASN certificate: Forced Default DS role" + - "ASN certificate: Forced default DS role" - "ASN certificate: Incorrect issuer subject DS" - "ASN certificate: Duplicating extensions" - "ICAO certificate: Version missed" @@ -267,8 +370,8 @@ components: - "ICAO certificate extension: Ext key usage incorrect usage" - "ICAO certificate extension: Ext key usage incorrect data" - "ICAO certificate extension Auth key: ID missed" - - "ICAO certificate extension Auth key: Incorrect data" - - "ICAO certificate extension Auth key: Key ID missed" + - "ICAO certificate extension Auth key: ID incorrect data" + - "ICAO certificate extension Auth key: ID key ID missed" - "ICAO certificate extension: Subject key ID missed" - "ICAO certificate extension: Subject key ID incorrect data" - "ICAO certificate extension: Private key UP missed" @@ -295,7 +398,7 @@ components: - "ICAO certificate extension Doc type list: Version" - "ICAO certificate extension Doc type list: Doc types" - "ICAO certificate extension Doc type list: Doc types empty" - - "ICAO certificate extension: Dert policies incorrect data" + - "ICAO certificate extension: Cert policies incorrect data" - "ICAO certificate extension: Cert policies empty" - "ICAO certificate extension: Cert policies policy ID missed" - "ICAO certificate extension: CRL dist point missed" @@ -312,11 +415,16 @@ components: - "ICAO certificate extension: Name change incorrect data" - "ICAO certificate extension: Name change non-compliant" - "ICAO certificate extension: Name change critical" - - "ICAO certificate extension Doc type list: non-compliant" + - "ICAO certificate extension Doc type list: Non-compliant" - "ICAO certificate extension Doc type list: Critical" - "ICAO certificate extension: Optional critical" - "ICAO certificate: Subject non-compliant" - "ICAO certificate: Subject common name non-compliant" + - "ICAO certificate: Chain country non-matching" + - "ICAO certificate: Visual MRZ country non-matching" + - "ICAO certificate: MRZ country non-matching" + - "ICAO certificate: Issuer country non-uppercase" + - "ICAO certificate: Subject country non-uppercase" - "ICAO COM: LDS version incorrect" - "ICAO COM: LDS version missing" - "ICAO COM: Unicode version incorrect" @@ -344,8 +452,8 @@ components: - "ICAO LDS object: DG hash extra" - "ICAO LDS object: Version incorrect" - "ICAO master list: Version incorrect" - - "ICAO Deviation list: Version incorrect" - - "BSI: Defect list version incorrect" + - "ICAO deviation list: Version incorrect" + - "BSI: Defect list version incorrect" - "BSI: Black list version incorrect" - "ASN signer info: Version incorrect" - "ASN signer info: SID incorrect choice" @@ -382,6 +490,7 @@ components: - "MRZ: Optional data incorrect checksum" - "MRZ: Incorrect checksum" - "MRZ: Incorrect" + - "MRZ: Country code visual MRZ non-matching" - "Biometrics: Format owner missing" - "Biometrics: Format owner incorrect" - "Biometrics: Format type missing" @@ -393,63 +502,158 @@ components: - "Biometrics: BDB format ID incorrect" - "Biometrics: BDB version incorrect" - "Biometrics: BDB data length incorrect" - - "Biometrics: BDB Data Gender" - - "Biometrics: BDB Data Eye Color" - - "Biometrics: BDB Data Hair Color" - - "Biometrics: BDB Data Pose Angle Yaw" - - "Biometrics: BDB Data Pose Angle Pitch" - - "Biometrics: BDB Data Pose Angle Roll" - - "Biometrics: BDB Data Pose Angle U Yaw" - - "Biometrics: BDB Data Pose Angle U Pitch" - - "Biometrics: BDB Data Pose Angle U Roll" - - "Biometrics: BDB Data Face Image Type" - - "Biometrics: BDB Data Image Data Type" - - "SI: PACE Info Unsupported Std Parameters" - - "SI: PACE Info Deprecated Version" - - "SI: PACE Domain Params Using Std Ref" - - "SI: PACE Domain Params Unsupported Algorithm" - - "SI: CA Info Incorrect Version" - - "SI: CA PublicKey Unsupported Algorithm" - - "SI: CA Domain Params Unsupported Algorithm" - - "SI: TA Info Incorrect Version" - - "SI: TA Info File ID For Version 2" - - "SI: eID Security Unsupported Digest Algorithm" + - "Biometrics: BDB data incorrect" + - "Biometrics: BDB data gender" + - "Biometrics: BDB data eye color" + - "Biometrics: BDB data hair color" + - "Biometrics: BDB data pose angle yaw" + - "Biometrics: BDB data pose angle pitch" + - "Biometrics: BDB data pose angle roll" + - "Biometrics: BDB data pose angle U yaw" + - "Biometrics: BDB data pose angle U pitch" + - "Biometrics: BDB data pose angle U roll" + - "Biometrics: BDB data face image type" + - "Biometrics: BDB data image data type" + - "Biometrics: RB data incorrect" + - "Biometrics: RB item incorrect" + - "Biometrics: RB item missing" + - "Biometrics: RB item unexpected" + - "Biometrics: RB RID incorrect" + - "Biometrics: RB image R incorrect" + - "Biometrics: RB image item incorrect" + - "Biometrics: RB image item missing" + - "Biometrics: RB image item unexpected" + - "Biometrics: RB image info item incorrect" + - "Biometrics: RB image info item missing" + - "Biometrics: RB image info item unexpected" + - "Biometrics: RB image info format incorrect" + - "Biometrics: RB image info format unsupported" + - "Biometrics: RB image info kind incorrect" + - "Biometrics: RB image info kind unsupported" + - "Biometrics: RB image info post APB incorrect" + - "Biometrics: RB image info lossy TA incorrect" + - "Biometrics: RB image info lossy TA unsupported" + - "Biometrics: RB image info cam 2 subj unsupported" + - "Biometrics: RB image info sens diag unsupported" + - "Biometrics: RB image info lens F unsupported" + - "Biometrics: RB image info im size incorrect" + - "Biometrics: RB image info im size unsupported" + - "Biometrics: RB image info im meas incorrect" + - "Biometrics: RB image info color incorrect" + - "Biometrics: RB image info color unsupported" + - "Biometrics: RB image info color map incorrect" + - "Biometrics: RB image capt item incorrect" + - "Biometrics: RB image capt item unexpected" + - "Biometrics: RB image capt spectral unsupported" + - "Biometrics: RB image capt tech code incorrect" + - "Biometrics: RB image capt tech code unsupported" + - "Biometrics: RB date item incorrect" + - "Biometrics: RB date item missing" + - "Biometrics: RB date item unexpected" + - "Biometrics: RB date incorrect" + - "Biometrics: RB quality item incorrect" + - "Biometrics: RB quality item missing" + - "Biometrics: RB quality item unexpected" + - "Biometrics: RB quality alg ID item incorrect" + - "Biometrics: RB quality SoE item incorrect" + - "Biometrics: RB quality score item incorrect" + - "Biometrics: RB quality error item incorrect" + - "Biometrics: RB quality error item unsupported" + - "Biometrics: RB PAD item incorrect" + - "Biometrics: RB PAD item unexpected" + - "Biometrics: RB PAD decision item incorrect" + - "Biometrics: RB PAD decision item unsupported" + - "Biometrics: RB PAD score item incorrect" + - "Biometrics: RB PAD score reg ID item incorrect" + - "Biometrics: RB PAD SoE item incorrect" + - "Biometrics: RB PAD SoE score item incorrect" + - "Biometrics: RB PAD SoE error item incorrect" + - "Biometrics: RB PAD SoE error item unsupported" + - "Biometrics: RB PAD external data item incorrect" + - "Biometrics: RB PAD external data type item incorrect" + - "Biometrics: RB PAD context item incorrect" + - "Biometrics: RB PAD context item unsupported" + - "Biometrics: RB PAD S level item incorrect" + - "Biometrics: RB PAD S level item unsupported" + - "Biometrics: RB PAD risk level item incorrect" + - "Biometrics: RB PAD criteria item incorrect" + - "Biometrics: RB PAD criteria item unsupported" + - "Biometrics: RB PAD date item incorrect" + - "Biometrics: RB PAD date item missing" + - "Biometrics: RB PAD date item unexpected" + - "Biometrics: RB PAD date incorrect" + - "Biometrics: RB session ID incorrect" + - "Biometrics: RB derived incorrect" + - "Biometrics: RB device incorrect" + - "Biometrics: RB device item unexpected" + - "Biometrics: RB device model ID item incorrect" + - "Biometrics: RB device cert ID item incorrect" + - "Biometrics: RB metadata item incorrect" + - "Biometrics: RB metadata item unexpected" + - "Biometrics: RB metadata gender item incorrect" + - "Biometrics: RB metadata gender item unsupported" + - "Biometrics: RB metadata eye item incorrect" + - "Biometrics: RB metadata eye item unsupported" + - "Biometrics: RB metadata hair item incorrect" + - "Biometrics: RB metadata hair item unsupported" + - "Biometrics: RB metadata height item incorrect" + - "Biometrics: RB metadata props item incorrect" + - "Biometrics: RB metadata props item unexpected" + - "Biometrics: RB metadata express item incorrect" + - "Biometrics: RB metadata express item unexpected" + - "Biometrics: RB metadata pose item incorrect" + - "Biometrics: RB metadata pose item unexpected" + - "Biometrics: RB landmark item incorrect" + - "Biometrics: RB landmark item missing" + - "Biometrics: RB landmark item unexpected" + - "Biometrics: RB landmark kind item incorrect" + - "Biometrics: RB landmark mpeg4 item incorrect" + - "Biometrics: RB landmark mpeg4 item unsupported" + - "Biometrics: RB landmark antr L item incorrect" + - "Biometrics: RB landmark coordinate item incorrect" + - "DTC content info: Version incorrect" + - "SI: PACE info unsupported std parameters" + - "SI: PACE info deprecated version" + - "SI: PACE domain params using std ref" + - "SI: PACE domain params unsupported algorithm" + - "SI: CA info incorrect version" + - "SI: CA public key unsupported algorithm" + - "SI: CA domain params unsupported algorithm" + - "SI: TA info incorrect version" + - "SI: TA info file ID for version 2" + - "SI: eID security unsupported digest algorithm" - "SI: RI info incorrect version" - "SI: RI domain params unsupported algorithm" - "SI: AA info incorrect version" - "SI: AA info unsupported algorithm" - "SI: AA info inconsistent algorithm reference" - - "SI: PACE Info Not Available" - - "SI: PACE Info No Std Parameters" - - "SI: PACE Info No Matching Domain Params" - - "SI: CA Info Not Available" - - "SI: CA Domain Params No Required Option" - - "SI: CA Domain Params Not Available" - - "SI: CA Anonymous Infos" - - "SI: CA Info No Matching Domain Params" - - "SI: CA Info No Matching Public Key" - - "SI: CA Incorrect Infos Quantity" - - "SI: TA Info Not Available" - - "SI: Card Info Locator Multiple Entries" - - "SI: eID Security Info Multiple Entries" - - "SI: Privileged TI Multiple Entries" - - "SI: Privileged TI Incorrect Usage" - - "SI: RI domain params multiple entries" - - "SI: Storage PACE Info Non Consistant" - - "CV Certificate: Profile incorrect version" - - "CV Certificate: Validity" - - "CV Certificate: Non CVCA domain parameters" - - "CV Certificate: Private key incorrect version" + - "SI: storage PACE info not available" + - "SI: storage PACE info no std parameters" + - "SI: storage PACE info no matching domain params" + - "SI: storage CA info not available" + - "SI: storage CA domain params no required option" + - "SI: storage CA domain params not available" + - "SI: storage CA anonymous infos" + - "SI: storage CA info no matching domain params" + - "SI: storage CA info no matching public key" + - "SI: storage CA incorrect infos quantity" + - "SI: storage TA info not available" + - "SI: storage card info locator multiple entries" + - "SI: storage eID security info multiple entries" + - "SI: storage privileged TI multiple entries" + - "SI: storage privileged TI incorrect usage" + - "SI: storage RI domain params multiple entries" + - "SI: storage PACE infos non consistent" + - "CV certificate: Profile incorrect version" + - "CV certificate: Validity" + - "CV certificate: non CVCA domain parameters" + - "CV certificate: private key incorrect version" - "TA: PACE static binding used" - "Auth ML signer info: Certificate validity" - "Auth ML signer info: Certificate root is not trusted" - - "Auth ML signer info: Certificate cannot find CSCA" + - "Auth ML signer info: Certificate can't find CSCA" - "Auth ML signer info: Certificate revoked" - "Auth ML signer info: Certificate signature invalid" - - "Country Codes from certificate chain don't match" - - "Country Codes from certificate and visual MRZ don't match" - - "Incorrect MRZ, country code doesn't match codes from Visual MRZ" - - "Country Codes from certificate and DG1 MRZ don't match" x-enum-varnames: - "ntfLDS_ASN_Certificate_IncorrectVersion" - "ntfLDS_ASN_Certificate_NonMatchingSignatureAlgorithm" @@ -540,6 +744,11 @@ components: - "ntfLDS_ICAO_Certificate_Ext_Optional_Critical" - "ntfLDS_ICAO_Certificate_Subject_NonCompliant" - "ntfLDS_ICAO_Certificate_Subject_CommonNameNonCompliant" + - "ntfLDS_ICAO_Certificate_Chain_Country_NonMatching" + - "ntfLDS_ICAO_Certificate_VisualMrz_Country_NonMatching" + - "ntfLDS_ICAO_Certificate_MRZ_Country_NonMatching" + - "ntfLDS_ICAO_Certificate_Issuer_CountryNonUpperCase" + - "ntfLDS_ICAO_Certificate_Subject_CountryNonUpperCase" - "ntfLDS_ICAO_COM_LDS_Version_Incorrect" - "ntfLDS_ICAO_COM_LDS_Version_Missing" - "ntfLDS_ICAO_COM_Unicode_Version_Incorrect" @@ -605,6 +814,7 @@ components: - "ntfLDS_MRZ_OptionalData_IncorrectChecksum" - "ntfLDS_MRZ_IncorrectChecksum" - "ntfLDS_MRZ_Incorrect" + - "ntfLDS_MRZ_CountryCode_VisualMrz_NonMatching" - "ntfLDS_Biometrics_FormatOwner_Missing" - "ntfLDS_Biometrics_FormatOwner_Incorrect" - "ntfLDS_Biometrics_FormatType_Missing" @@ -616,6 +826,7 @@ components: - "ntfLDS_Biometrics_BDB_FormatID_Incorrect" - "ntfLDS_Biometrics_BDB_Version_Incorrect" - "ntfLDS_Biometrics_BDB_DataLength_Incorrect" + - "ntfLDS_Biometrics_BDB_Data_Incorrect" - "ntfLDS_Biometrics_BDB_Data_Gender" - "ntfLDS_Biometrics_BDB_Data_EyeColor" - "ntfLDS_Biometrics_BDB_Data_HairColor" @@ -627,6 +838,104 @@ components: - "ntfLDS_Biometrics_BDB_Data_PoseAngleU_Roll" - "ntfLDS_Biometrics_BDB_Data_FaceImageType" - "ntfLDS_Biometrics_BDB_Data_ImageDataType" + - "ntfLDS_Biometrics_RB_Data_Incorrect" + - "ntfLDS_Biometrics_RB_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Item_Missing" + - "ntfLDS_Biometrics_RB_Item_Unexpected" + - "ntfLDS_Biometrics_RB_RID_Incorrect" + - "ntfLDS_Biometrics_RB_ImageR_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Item_Missing" + - "ntfLDS_Biometrics_RB_Image_Item_Unexpected" + - "ntfLDS_Biometrics_RB_Image_Info_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Info_Item_Missing" + - "ntfLDS_Biometrics_RB_Image_Info_Item_Unexpected" + - "ntfLDS_Biometrics_RB_Image_Info_Format_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Info_Format_Unsupported" + - "ntfLDS_Biometrics_RB_Image_Info_Kind_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Info_Kind_Unsupported" + - "ntfLDS_Biometrics_RB_Image_Info_PostAPB_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Info_LossyTA_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Info_LossyTA_Unsupported" + - "ntfLDS_Biometrics_RB_Image_Info_Cam2Subj_Unsupported" + - "ntfLDS_Biometrics_RB_Image_Info_SensDiag_Unsupported" + - "ntfLDS_Biometrics_RB_Image_Info_LensF_Unsupported" + - "ntfLDS_Biometrics_RB_Image_Info_ImSize_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Info_ImSize_Unsupported" + - "ntfLDS_Biometrics_RB_Image_Info_ImMeas_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Info_Color_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Info_Color_Unsupported" + - "ntfLDS_Biometrics_RB_Image_Info_ColorMap_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Capt_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Capt_Item_Unexpected" + - "ntfLDS_Biometrics_RB_Image_Capt_Spectral_Unsupported" + - "ntfLDS_Biometrics_RB_Image_Capt_TechCode_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Capt_TechCode_Unsupported" + - "ntfLDS_Biometrics_RB_Date_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Date_Item_Missing" + - "ntfLDS_Biometrics_RB_Date_Item_Unexpected" + - "ntfLDS_Biometrics_RB_Date_Incorrect" + - "ntfLDS_Biometrics_RB_Quality_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Quality_Item_Missing" + - "ntfLDS_Biometrics_RB_Quality_Item_Unexpected" + - "ntfLDS_Biometrics_RB_Quality_AlgID_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Quality_SoE_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Quality_Score_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Quality_Error_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Quality_Error_Item_Unsupported" + - "ntfLDS_Biometrics_RB_PAD_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_Item_Unexpected" + - "ntfLDS_Biometrics_RB_PAD_Decision_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_Decision_Item_Unsupported" + - "ntfLDS_Biometrics_RB_PAD_Score_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_Score_RegID_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_SoE_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_SoE_Score_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_SoE_Error_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_SoE_Error_Item_Unsupported" + - "ntfLDS_Biometrics_RB_PAD_ExtData_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_ExtData_Type_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_Context_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_Context_Item_Unsupported" + - "ntfLDS_Biometrics_RB_PAD_SLevel_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_SLevel_Item_Unsupported" + - "ntfLDS_Biometrics_RB_PAD_RiskLevel_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_Criteria_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_Criteria_Item_Unsupported" + - "ntfLDS_Biometrics_RB_PAD_Date_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_Date_Item_Missing" + - "ntfLDS_Biometrics_RB_PAD_Date_Item_Unexpected" + - "ntfLDS_Biometrics_RB_PAD_Date_Incorrect" + - "ntfLDS_Biometrics_RB_SessionID_Incorrect" + - "ntfLDS_Biometrics_RB_Derived_Incorrect" + - "ntfLDS_Biometrics_RB_Device_Incorrect" + - "ntfLDS_Biometrics_RB_Device_Item_Unexpected" + - "ntfLDS_Biometrics_RB_Device_ModelID_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Device_CertID_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Metadata_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Metadata_Item_Unexpected" + - "ntfLDS_Biometrics_RB_Metadata_Gender_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Metadata_Gender_Item_Unsupported" + - "ntfLDS_Biometrics_RB_Metadata_Eye_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Metadata_Eye_Item_Unsupported" + - "ntfLDS_Biometrics_RB_Metadata_Hair_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Metadata_Hair_Item_Unsupported" + - "ntfLDS_Biometrics_RB_Metadata_Height_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Metadata_Props_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Metadata_Props_Item_Unexpected" + - "ntfLDS_Biometrics_RB_Metadata_Express_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Metadata_Express_Item_Unexpected" + - "ntfLDS_Biometrics_RB_Metadata_Pose_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Metadata_Pose_Item_Unexpected" + - "ntfLDS_Biometrics_RB_LandMark_Item_Incorrect" + - "ntfLDS_Biometrics_RB_LandMark_Item_Missing" + - "ntfLDS_Biometrics_RB_LandMark_Item_Unexpected" + - "ntfLDS_Biometrics_RB_LandMark_Kind_Item_Incorrect" + - "ntfLDS_Biometrics_RB_LandMark_Mpeg4_Item_Incorrect" + - "ntfLDS_Biometrics_RB_LandMark_Mpeg4_Item_Unsupported" + - "ntfLDS_Biometrics_RB_LandMark_AntrL_Item_Incorrect" + - "ntfLDS_Biometrics_RB_LandMark_Coord_Item_Incorrect" + - "ntfLDS_DTC_ContentInfo_Version_Incorrect" - "ntfLDS_SI_PACE_Info_UnsupportedStdParameters" - "ntfLDS_SI_PACE_Info_DeprecatedVersion" - "ntfLDS_SI_PACE_DomainParams_UsingStdRef" @@ -669,7 +978,3 @@ components: - "ntfLDS_Auth_MLSignerInfo_Certificate_CantFindCSCA" - "ntfLDS_Auth_MLSignerInfo_Certificate_Revoked" - "ntfLDS_Auth_MLSignerInfo_Certificate_SignatureInvalid" - - "ntfLDS_ICAO_Certificate_Chain_Country_NonMatching" - - "ntfLDS_ICAO_Certificate_VisualMrz_Country_NonMatching" - - "ntfLDS_MRZ_CountryCode_VisualMrz_NonMatching" - - "ntfLDS_ICAO_Certificate_MRZ_Country_NonMatching" diff --git a/e-rfid-data-file-type.yml b/e-rfid-data-file-type.yml new file mode 100644 index 0000000..c9c19d8 --- /dev/null +++ b/e-rfid-data-file-type.yml @@ -0,0 +1,210 @@ +openapi: 3.0.4 +components: + schemas: + RfidDataFileType: + title: "RfidDataFileType" + type: integer + description: "Enumeration contains a set of constants that define the file type + (or logical belonging of the data object) within the context of the communication session with electronic document" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + - 10 + - 11 + - 12 + - 13 + - 14 + - 15 + - 16 + - 17 + - 18 + - 19 + - 20 + - 21 + - 22 + - 23 + - 57 + - 58 + - 62 + - 63 + - 64 + - 101 + - 102 + - 103 + - 104 + - 105 + - 106 + - 107 + - 108 + - 109 + - 110 + - 111 + - 112 + - 113 + - 114 + - 115 + - 116 + - 117 + - 118 + - 119 + - 120 + - 121 + - 150 + - 151 + - 152 + - 153 + - 154 + - 155 + - 156 + - 157 + - 158 + - 159 + - 160 + - 161 + - 162 + - 163 + - 164 + - 165 + - 166 + - 167 + - 200 + - 201 + - 202 + - 300 + - 301 + - 302 + - 400 + - 401 + - 500 + - 501 + - 600 + - 601 + - 602 + - 603 + - 604 + - 700 + - 701 + - 702 + - 703 + - 704 + - 710 + - 711 + - 712 + - 713 + - 714 + - 715 + - 800 + - 832 + - 900 + - 901 + - 902 + - 1000 + x-enum-varnames: + - "UNSPECIFIED" + - "PASSPORT_DG1" + - "PASSPORT_DG2" + - "PASSPORT_DG3" + - "PASSPORT_DG4" + - "PASSPORT_DG5" + - "PASSPORT_DG6" + - "PASSPORT_DG7" + - "PASSPORT_DG8" + - "PASSPORT_DG9" + - "PASSPORT_DG10" + - "PASSPORT_DG11" + - "PASSPORT_DG12" + - "PASSPORT_DG13" + - "PASSPORT_DG14" + - "PASSPORT_DG15" + - "PASSPORT_DG16" + - "PASSPORT_DG17" + - "PASSPORT_DG18" + - "PASSPORT_DG19" + - "PASSPORT_DG20" + - "PASSPORT_SOD" + - "PASSPORT_CVCA" + - "PASSPORT_COM" + - "DTC_DG17" + - "DTC_DG18" + - "DTC_DG22" + - "DTC_DG23" + - "DTC_DG24" + - "ID_DG1" + - "ID_DG2" + - "ID_DG3" + - "ID_DG4" + - "ID_DG5" + - "ID_DG6" + - "ID_DG7" + - "ID_DG8" + - "ID_DG9" + - "ID_DG10" + - "ID_DG11" + - "ID_DG12" + - "ID_DG13" + - "ID_DG14" + - "ID_DG15" + - "ID_DG16" + - "ID_DG17" + - "ID_DG18" + - "ID_DG19" + - "ID_DG20" + - "ID_DG21" + - "DL_COM" + - "DL_DG1" + - "DL_DG2" + - "DL_DG3" + - "DL_DG4" + - "DL_DG5" + - "DL_DG6" + - "DL_DG7" + - "DL_DG8" + - "DL_DG9" + - "DL_DG10" + - "DL_DG11" + - "DL_DG12" + - "DL_DG13" + - "DL_DG14" + - "DL_SOD" + - "DL_CE" + - "DL_CVCA" + - "PACE_CARD_ACCESS" + - "PACE_CARD_SECURITY" + - "PACE_CHIP_SECURITY" + - "MIFARE_DATA" + - "MIFARE_VALIDITY" + - "AUTHENTICITY_V2" + - "ATR" + - "DIR" + - "E_SIGN_PK" + - "E_SIGN_SIGNED_DATA" + - "CERTIFICATE" + - "MASTER_LIST" + - "DEFECT_LIST" + - "DEVIATION_LIST" + - "BLACK_LIST" + - "APP_DIRECTORY" + - "SESSION" + - "LOG_DATA" + - "CHIP_PROPERTIES" + - "DTC_INFO" + - "POST_CA_RESPONSE" + - "POST_CA_PUBLIC_KEY" + - "POST_CA_INFO" + - "POST_CA_D_PARAMS" + - "POST_CA_CHECK_PK" + - "POST_CA_CHECK_SK" + - "SAM_DATA" + - "SAM_DATA_MAX" + - "VDS" + - "VDS_NC" + - "DS" + - "USER_DEFINED" diff --git a/e-rfid-data-group-type-tag.yml b/e-rfid-data-group-type-tag.yml new file mode 100644 index 0000000..3af858d --- /dev/null +++ b/e-rfid-data-group-type-tag.yml @@ -0,0 +1,193 @@ +openapi: 3.0.4 +components: + schemas: + RfidDataGroupTypeTag: + title: "RfidDataGroupTypeTag" + type: integer + description: "Enumeration representing RFID Data Group Types. + Constants with prefix correspond to the informational data groups of ePassport + application, with prefix EID_ – those of eID application, with prefix EDL_ – + eDL application" + enum: + - 96 + - 97 + - 117 + - 99 + - 118 + - 101 + - 102 + - 103 + - 104 + - 105 + - 106 + - 107 + - 108 + - 109 + - 110 + - 111 + - 112 + - 119 + - 113 + - 114 + - 115 + - 116 + - 98 + - 97 + - 98 + - 99 + - 100 + - 101 + - 102 + - 103 + - 104 + - 105 + - 106 + - 107 + - 108 + - 109 + - 110 + - 111 + - 112 + - 113 + - 114 + - 115 + - 116 + - 117 + - 96 + - 119 + - 83 + - 97 + - 107 + - 108 + - 101 + - 103 + - 117 + - 99 + - 118 + - 112 + - 109 + - 113 + - 111 + - 110 + x-enum-descriptions: + - "Common Data Element" + - "Data Group 1" + - "Data Group 2" + - "Data Group 3" + - "Data Group 4" + - "Data Group 5" + - "Data Group 6" + - "Data Group 7" + - "Data Group 8" + - "Data Group 9" + - "Data Group 10" + - "Data Group 11" + - "Data Group 12" + - "Data Group 13" + - "Data Group 14" + - "Data Group 15" + - "Data Group 16" + - "Security Object Document" + - "Data Group 17" + - "Data Group 18" + - "Data Group 22" + - "Data Group 23" + - "Data Group 24" + - "eID, Data Group 1" + - "eID, Data Group 2" + - "eID, Data Group 3" + - "eID, Data Group 4" + - "eID, Data Group 5" + - "eID, Data Group 6" + - "eID, Data Group 7" + - "eID, Data Group 8" + - "eID, Data Group 9" + - "eID, Data Group 10" + - "eID, Data Group 11" + - "eID, Data Group 12" + - "eID, Data Group 13" + - "eID, Data Group 14" + - "eID, Data Group 15" + - "eID, Data Group 16" + - "eID, Data Group 17" + - "eID, Data Group 18" + - "eID, Data Group 19" + - "eID, Data Group 20" + - "eID, Data Group 21" + - "eDL, Common Data Element" + - "eDL, Security Object Document" + - "eDL, Card Entitlement" + - "eDL, Data Group 1" + - "eDL, Data Group 2" + - "eDL, Data Group 3" + - "eDL, Data Group 4" + - "eDL, Data Group 5" + - "eDL, Data Group 6" + - "eDL, Data Group 7" + - "eDL, Data Group 8" + - "eDL, Data Group 9" + - "eDL, Data Group 11" + - "eDL, Data Group 12" + - "eDL, Data Group 13" + - "eDL, Data Group 14" + x-enum-varnames: + - "COM" + - "DG1" + - "DG2" + - "DG3" + - "DG4" + - "DG5" + - "DG6" + - "DG7" + - "DG8" + - "DG9" + - "DG10" + - "DG11" + - "DG12" + - "DG13" + - "DG14" + - "DG15" + - "DG16" + - "SOD" + - "DG17" + - "DG18" + - "DG22" + - "DG23" + - "DG24" + - "EID_DG1" + - "EID_DG2" + - "EID_DG3" + - "EID_DG4" + - "EID_DG5" + - "EID_DG6" + - "EID_DG7" + - "EID_DG8" + - "EID_DG9" + - "EID_DG10" + - "EID_DG11" + - "EID_DG12" + - "EID_DG13" + - "EID_DG14" + - "EID_DG15" + - "EID_DG16" + - "EID_DG17" + - "EID_DG18" + - "EID_DG19" + - "EID_DG20" + - "EID_DG21" + - "EDL_COM" + - "EDL_SOD" + - "EDL_CE" + - "EDL_DG1" + - "EDL_DG2" + - "EDL_DG3" + - "EDL_DG4" + - "EDL_DG5" + - "EDL_DG6" + - "EDL_DG7" + - "EDL_DG8" + - "EDL_DG9" + - "EDL_DG11" + - "EDL_DG12" + - "EDL_DG13" + - "EDL_DG14" diff --git a/e-rfid-error-codes.yml b/e-rfid-error-codes.yml index a656f7d..e0ec272 100644 --- a/e-rfid-error-codes.yml +++ b/e-rfid-error-codes.yml @@ -1,351 +1,359 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: RFIDErrorCodes: + title: "RFIDErrorCodes" type: integer + format: int64 description: "Enumeration contains a set of error codes returned by SDK" enum: - - -2147458430 - - -2147458429 - - -2147458112 - - -2147458111 - - -2147456637 - - -2147456636 - - -2147456635 - - -2147456384 - - -2147456382 - - -2147456376 - - -2147456256 - - -2147418111 - - -2147418110 - - -2147418108 - - -2147418107 - - -2147418106 - - -2147418104 - - -2147418103 - - -2147418102 - - -2147418101 - - -2147418100 - - -2147352576 - - -2147352575 - - -2147352574 - - -2147352573 - - -2147352572 - - -2147352571 - - -2147352570 - - -2147352560 - - -2146409536 - - -2097152000 - - -2097151999 - - -2097151998 - - -2097151984 - - -2097151983 - - -2097151982 - - -2097151981 - - -2097151980 - - -2097151979 - - -2097151978 - - -2097151977 - - -2097151976 - - -2097151975 - - -2097151974 - - -2097151973 - - -2097151972 - - -2097151968 - - -2097151967 - - -2097151966 - - -2097151965 - - -2097151964 - - -2097151963 - - -2097151962 - - -2097151961 - - -2097151960 - - -2097151959 - - -2097151958 - - -2097151952 - - -2097151951 - - -2097151936 - - -2097151935 - - -2097151934 - - -2097151920 - - -2097151919 - - -2097151918 - - -2097151904 - - -2097086464 - - -2097020928 - - -2096955392 - - -2096889856 - - -2096824320 - - -2096758784 - - -2096693248 - - -2096627712 - - -2080374784 - - -2080309248 - - -2080243712 - - -2080178176 - - -2080112640 - - -2080047104 - - -2079981568 - - -2079916032 - - -2079850496 - - -2079784960 - - -2079719424 - - -2079653888 - - -2079588352 - - -2079522816 - - -2079457280 - - -2079391744 - - -2046820352 - - -2046820351 - - -2046820096 - - -2046820095 - - -2046820094 - - -2046820093 - - -2046819840 - - -2046819839 - - -2046819838 - - -2046819837 - - -2046819836 - - -2046819584 - - -2046819583 - - -2046819582 - - -2046819581 - - -2046819580 - - -2046819579 - - -2046819578 - - -2046819577 - - -2046819576 - - -2046819575 - - -1 - 1 - 2 + - 4294967295 + - 2147549185 + - 2147549186 + - 2147549188 + - 2147549189 + - 2147549190 + - 2147549191 + - 2147549192 + - 2147549193 + - 2147549194 + - 2147549195 + - 2147549196 + - 2147614720 + - 2147614721 + - 2147614722 + - 2147614723 + - 2147614724 + - 2147614725 + - 2147614726 + - 2147614736 + - 2248146944 + - 2248146945 + - 2248147200 + - 2248147201 + - 2248147202 + - 2248147203 + - 2248147456 + - 2248147457 + - 2248147458 + - 2248147459 + - 2248147460 + - 2248147712 + - 2248147713 + - 2248147714 + - 2248147715 + - 2248147716 + - 2248147717 + - 2248147718 + - 2248147719 + - 2248147720 + - 2248147721 + - 2147510914 + - 2147508866 + - 2147511040 + - 2147510016 + - 2147510912 + - 2147510920 + - 2147509185 + - 2147509184 + - 2147508867 + - 2147510659 + - 2147510660 + - 2147510661 + - 2148557760 + - 2197815296 + - 2197815297 + - 2197815298 + - 2197815312 + - 2197815313 + - 2197815314 + - 2197815315 + - 2197815316 + - 2197815317 + - 2197815318 + - 2197815319 + - 2197815320 + - 2197815321 + - 2197815322 + - 2197815323 + - 2197815324 + - 2197815328 + - 2197815329 + - 2197815330 + - 2197815331 + - 2197815332 + - 2197815333 + - 2197815334 + - 2197815335 + - 2197815336 + - 2197815337 + - 2197815338 + - 2197815344 + - 2197815345 + - 2197815360 + - 2197815361 + - 2197815362 + - 2197815376 + - 2197815377 + - 2197815378 + - 2197815392 + - 2197880832 + - 2197946368 + - 2198011904 + - 2198077440 + - 2198142976 + - 2198208512 + - 2198274048 + - 2198339584 + - 2214592512 + - 2214658048 + - 2214723584 + - 2214789120 + - 2214854656 + - 2214920192 + - 2214985728 + - 2215051264 + - 2215116800 + - 2215182336 + - 2215247872 + - 2215313408 + - 2215378944 + - 2215444480 + - 2215510016 + - 2215575552 x-enum-descriptions: - - "LAYER6: Reading beyond EOF / Unexpected EOF" - - "LAYER6: PWD deactivated" - - "LAYER6: PWD blocked" - - "LAYER6: PWD suspended" - - "LAYER6: PWD blocked 2" - - "LAYER6: PWD deactivated 2" - - "LAYER6: PWD suspended 2" - - "LAYER6: Incorrect params" - - "LAYER6: File selection failure / file not found" - - "LAYER6: No reference data" - - "LAYER6: Reading beyond EOF / Unexpected EOF" - - "RFID: No chip is detected" - - "RFID: Unavailable" - - "RFID: Invalid parameter in ExecuteCommand() call found" - - "RFID: Device is uninitialized" - - "RFID: Out of memory" + - "RFID: No error" + - "RFID: Already done" + - "RFID: Failed" + - "RFID: No chip detected" + - "RFID: Not available" + - "RFID: Invalid parameter" + - "RFID: Not initialized" + - "RFID: Not enough memory" + - "RFID: Not enough data" - "RFID: Invalid directory" - "RFID: Unknown command" - - "RFID File: IO Error" - - "RFID: RFID is busy" - - "RFID: The firmware needs to be updated to a newer version" + - "RFID: File IO error" + - "RFID: Busy" + - "RFID: Old firmware" - "PCSC: Failed" - - "PCSC: The reader is unavailable" - - "PCSC: The card cannot be connected" - - "PCSC: The card is not connected" - - "PCSC: Operation is cancelled" - - "PCSC: The card is busy" - - "PCSC: Failed Smart Card" - - "PCSC: ExtLe Failed" - - "LAYER6: PWD failed" - - "RFID: Not performed" + - "PCSC: Reader not available" + - "PCSC: Can't connect card" + - "PCSC: Card is not connected" + - "PCSC: Operation cancelled" + - "PCSC: Card is busy" + - "PCSC: Failed smart card" + - "PCSC: ExtLe failed" + - "Layer 6: Security manager" + - "Layer 6: App selection failure" + - "Layer 6: Mutual auth MAC fail" + - "Layer 6: Mutual auth ENC fail" + - "Layer 6: Mutual auth failure" + - "Layer 6: Mutual auth failure data" + - "Layer 6: SM DO8E missing" + - "Layer 6: SM DO87 missing" + - "Layer 6: SM DO99 missing" + - "Layer 6: SM MAC incorrect" + - "Layer 6: SM DO87 incorrect" + - "Layer 6: NON TLV response data" + - "Layer 6: Wrong RND ICC length" + - "Layer 6: Int auth failure" + - "Layer 6: MSE set KAT failure" + - "Layer 6: MSE set DST failure" + - "Layer 6: PSO certificate failure" + - "Layer 6: MSE set at failure" + - "Layer 6: Get challenge failure" + - "Layer 6: EXT auth failure" + - "Layer 6: GENERAL auth failure" + - "Layer 6: File not found" + - "Layer 6: File EOF1" + - "Layer 6: File EOF2" + - "Layer 6: Wrong length" + - "Layer 6: Incorrect params" + - "Layer 6: No reference data" + - "Layer 6: PWD suspended" + - "Layer 6: PWD blocked" + - "Layer 6: PWD deactivated" + - "Layer 6: PWD blocked 2" + - "Layer 6: PWD deactivated 2" + - "Layer 6: PWD suspended 2" + - "Layer 6: PWD failed" + - "RFID: NotPerformed" - "RFID: Session is closed" - - "RFID: Unsupported terminal operation" - - "RFID: Terminal type unknown" - - "RFID: Terminal type bad certificate" - - "RFID: Terminal type not set" - - "RFID: Unknown procedure type" - - "RFID: Unsupported procedure type" - - "RFID: Procedure type not set" - - "RFID: Access key unknown type" - - "RFID: Access key unsupported SM type" - - "RFID: Access key incorrect SM type" - - "RFID: Access key restricted" - - "RFID: Access key incorrect data" - - "RFID: Access key not set" - - "RFID: PWD management not authorized" - - "RFID: Access control unknown type" - - "RFID: SM required" - - "RFID: PACE required" - - "RFID: CA keys required" - - "RFID: TA required" - - "RFID: CA required" - - "RFID: Incorrect option CA" - - "RFID: CA failed" - - "RFID: TA failed" - - "RFID: AA failed" - - "RFID: RI failed" - - "RFID: SO signature check failed" - - "RFID: Hash check failed" - - "RFID: Invalid aux data - date of expiry" - - "RFID: Invalid aux data - date of birth" - - "RFID: Invalid aux data - community ID" - - "RFID: eSign requires app selection" - - "RFID: eSign PIN not set" - - "RFID: eSign PIN not verified" - - "RFID: Incorrect data" - - "RFID file: Insufficient data" - - "RFID file: Incorrect data" - - "RFID file: Unexpected data" - - "RFID file: Contains unexpected data" - - "RFID file: Wrong tag" - - "RFID file: Cannot use data" - - "RFID file: Cannot read data" - - "RFID file: Access denied" - - "RFID: Layer 34 - No error" - - "RFID: Layer 34 - Timeout" - - "RFID: Layer 34 - Collision" - - "RFID: Layer 34 - CRC" - - "RFID: Layer 34 - Data integrity" - - "RFID: Layer 34 - Data length" - - "RFID: Layer 34 - RFU" - - "RFID: Layer 34 - Too many collision" - - "RFID: Layer 34 - Protocol B" - - "RFID: Layer 34 - Data contents" - - "RFID: Layer 34 - Protocol" - - "RFID: Layer 34 - Globa timeout" - - "RFID: Layer 34 - MIFARE auth" - - "RFID: Layer 34 - SAM error" - - "RFID: Layer 34 - SAM collision" - - "RFID: Layer 34 - SAM acknowledge" - - "LAYER6: Secure Messaging was not activated" - - "LAYER6: ISO7816_A_03 Application selection failure" - - "LAYER6: ISO7816_B_01 Mutual authentication MAC failure" - - "LAYER6: ISO7816_B_02 Mutual authentication encryption failure" - - "LAYER6: ISO7816_B_03 Mutual authentication failure" - - "LAYER6: ISO7816_B_03 Mutual authentication failure data" - - "LAYER6: SM failure – MAC missing" - - "LAYER6: SM failure – cryptogram missing" - - "LAYER6: SM failure – secured status bytes missing" - - "LAYER6: SM failure – incorrect MAC" - - "LAYER6: SM failure – incorrect cryptogram" - - "LAYER6: Not TLV response data" - - "LAYER6: Wrong data length (APDU_INS_GET_CHALLENGE)" - - "LAYER6: APDU_INS_INTERNAL_AUTHENTICATE failure" - - "LAYER6: MSE:Set KAT failure" - - "LAYER6: MSE:Set DST failure" - - "LAYER6: PSO CERTIFICATE failure" - - "LAYER6: MSE:Set AT failure" - - "LAYER6: GET CHALLENGE failure" - - "LAYER6: APDU_INS_EXTERNAL_AUTHENTICATE (external authentication) failure" - - "LAYER6: General Authenticity Failure" - - "RFID: Failed" - - "RFID: No error" - - "RFID: The requested operation is already performed" + - "Session terminal: Unsupported operation" + - "Session terminal type: Unknown" + - "Session terminal type: Bad certificate" + - "Session terminal type: Not set" + - "Session procedure type: Unknown" + - "Session procedure type: Unsupported" + - "Session procedure type: Not set" + - "Session access key: Unknown type" + - "Session access key: Unsupported SM type" + - "Session access key: Incorrect SM type" + - "Session access key: Restricted" + - "Session access key: Incorrect data" + - "Session access key: Not set" + - "Session pwd management: Not authorized" + - "Session access control: Unknown type" + - "Session access control: Requires SM" + - "Session access control: Requires PACE" + - "Session access control: Requires CA keys" + - "Session access control: Requires TA" + - "Session access control: Requires CA" + - "Session access control: Incorrect option CA" + - "Session access control: CA Failed" + - "Session access control: TA Failed" + - "Session access control: AA Failed" + - "Session access control: RI Failed" + - "Session PA: Signature check failed" + - "Session PA: Hash check failed" + - "Session invalid aux data: Date of expiry" + - "Session invalid aux data: Date of birth" + - "Session invalid aux data: Community ID" + - "Session eSign: Requires app selection" + - "Session eSign: PIN not set" + - "Session eSign: PIN not verified" + - "Session: Incorrect data" + - "Session file: Not enough data" + - "Session file: Incorrect data" + - "Session file: Unexpected data" + - "Session file: Contents unexpected data" + - "Session file: Wrong tag" + - "Session file: Cant use data" + - "Session file: Cant read data" + - "Session file: Access denied" + - "Layer 34: No error" + - "Layer 34: Time out" + - "Layer 34: Collision" + - "Layer 34: CRC" + - "Layer 34: Data integrity" + - "Layer 34: Data length" + - "Layer 34: RFU" + - "Layer 34: Collision too many" + - "Layer 34: Protocol B" + - "Layer 34: Data contents" + - "Layer 34: Protocol" + - "Layer 34: Global timeOut" + - "Layer 34: MIFARE auth" + - "Layer 34: SAM error" + - "Layer 34: SAM collision" + - "Layer 34: SAM acknowledge" x-enum-varnames: - - "RFID_ERROR_LAYER6_FILE_EOF1" - - "RFID_ERROR_LAYER6_PWD_DEACTIVATED" - - "RFID_ERROR_LAYER6_PWD_BLOCKED" - - "RFID_ERROR_LAYER6_PWD_SUSPEND" - - "RFID_ERROR_LAYER6_PWD_BLOCKED2" - - "RFID_ERROR_LAYER6_PWD_DEACTIVATED2" - - "RFID_ERROR_LAYER6_PWD_SUSPEND2" - - "RFID_ERROR_LAYER6_INCORRECT_PARAMS" - - "RFID_ERROR_LAYER6_FILE_NOT_FOUND" - - "RFID_ERROR_LAYER6_NO_REFERENCE_DATA" - - "RFID_ERROR_LAYER6_FILE_EOF2" - - "RFID_ERROR_NO_CHIP_DETECTED" - - "RFID_ERROR_NOT_AVAILABLE" - - "RFID_ERROR_INVALID_PARAMETER" - - "RFID_ERROR_NOT_INITIALIZED" - - "RFID_ERROR_NOT_ENOUGH_MEMORY" - - "RFID_ERROR_INVALID_DIRECTORY" - - "RFID_ERROR_UNKNOWN_COMMAND" - - "RFID_ERROR_FILE_IO_ERROR" - - "RFID_ERROR_BUSY" - - "RFID_ERROR_OLD_FIRMWARE" - - "RFID_ERROR_PCSC_FAILED" - - "RFID_ERROR_PCSC_READER_NOT_AVAILABLE" - - "RFID_ERROR_PCSC_CANT_CONNECT_CARD" - - "RFID_ERROR_PCSC_CARD_IS_NOT_CONNECTED" - - "RFID_ERROR_PCSC_OPERATION_CANCELLED" - - "RFID_ERROR_PCSC_CARD_IS_BUSY" - - "RFID_ERROR_PCSC_FAILED_SCARD" - - "RFID_ERROR_PCSC_EXT_LE_FAILED" - - "RFID_ERROR_LAYER6_PWD_FAILED" - - "RFID_ERROR_NOT_PERFORMED" - - "RFID_ERROR_SESSION_IS_CLOSED" - - "RFID_ERROR_SESSION_TERMINAL_UNSUPPORTED_OPERATION" - - "RFID_ERROR_SESSION_TERMINAL_TYPE_UNKNOWN" - - "RFID_ERROR_SESSION_TERMINAL_TYPE_BAD_CERTIFICATE" - - "RFID_ERROR_SESSION_TERMINAL_TYPE_NOT_SET" - - "RFID_ERROR_SESSION_PROCEDURE_TYPE_UNKNOWN" - - "RFID_ERROR_Session_Procedure_Type_Unsupported" - - "RFID_ERROR_SESSION_PROCEDURE_TYPE_NOT_SET" - - "RFID_ERROR_SESSION_ACCESS_KEY_UNKNOWN_TYPE" - - "RFID_ERROR_SESSION_ACCESS_KEY_UNSUPPORTED_SM_TYPE" - - "RFID_ERROR_SESSION_ACCESS_KEY_INCORRECT_SM_TYPE" - - "RFID_ERROR_SESSION_ACCESS_KEY_RESTRICTED" - - "RFID_ERROR_SESSION_ACCESS_KEY_INCORRECT_DATA" - - "RFID_ERROR_SESSION_ACCESS_KEY_NOT_SET" - - "RFID_ERROR_SESSION_PWD_MANAGEMENT_NOT_AUTHORIZED" - - "RFID_ERROR_SESSION_ACCESS_CONTROL_UNKNOWN_TYPE" - - "RFID_ERROR_SESSION_ACCESS_CONTROL_REQUIRES_SM" - - "RFID_ERROR_SESSION_ACCESS_CONTROL_REQUIRES_PACE" - - "RFID_ERROR_SESSION_ACCESS_CONTROL_REQUIRES_CA_KEYS" - - "RFID_ERROR_SESSION_ACCESS_CONTROL_REQUIRES_TA" - - "RFID_ERROR_SESSION_ACCESS_CONTROL_REQUIRES_CA" - - "RFID_ERROR_SESSION_ACCESS_CONTROL_INCORRECT_OPTION_CA" - - "RFID_ERROR_SESSION_ACCESS_CONTROL_CA_FAILED" - - "RFID_ERROR_SESSION_ACCESS_CONTROL_TA_FAILED" - - "RFID_ERROR_SESSION_ACCESS_CONTROL_AA_FAILED" - - "RFID_ERROR_SESSION_ACCESS_CONTROL_RI_FAILED" - - "RFID_ERROR_SESSION_PA_SIGNATURE_CHECK_FAILED" - - "RFID_ERROR_SESSION_PA_HASH_CHECK_FAILED" - - "RFID_ERROR_SESSION_INVALID_AUX_DATA_DATE_OF_EXPIRY" - - "RFID_ERROR_SESSION_INVALID_AUX_DATA_DATE_OF_BIRTH" - - "RFID_ERROR_SESSION_INVALID_AUX_DATA_COMMUNITY_ID" - - "RFID_ERROR_SESSION_E_SIGN_REQUIRES_APP_SELECTION" - - "RFID_ERROR_SESSION_E_SIGN_PIN_NOT_SET" - - "RFID_ERROR_SESSION_E_SIGN_PIN_NOT_VERIFIED" - - "RFID_ERROR_SESSION_INCORRECT_DATA" - - "RFID_ERROR_SESSION_FILE_NOT_ENOUGH_DATA" - - "RFID_ERROR_SESSION_FILE_INCORRECT_DATA" - - "RFID_ERROR_SESSION_FILE_UNEXPECTED_DATA" - - "RFID_ERROR_SESSION_FILE_CONTENTS_UNEXPECTED_DATA" - - "RFID_ERROR_SESSION_FILE_WRONG_TAG" - - "RFID_ERROR_SESSION_FILE_CANT_USE_DATA" - - "RFID_ERROR_SESSION_FILE_CANT_READ_DATA" - - "RFID_ERROR_SESSION_FILE_ACCESS_DENIED" - - "RFID_ERROR_LAYER34_NO_ERROR" - - "RFID_ERROR_LAYER34_TIME_OUT" - - "RFID_ERROR_LAYER34_COLLISION" - - "RFID_ERROR_LAYER34_CRC" - - "RFID_ERROR_LAYER34_DATA_INTEGRITY" - - "RFID_ERROR_LAYER34_DATA_LENGTH" - - "RFID_ERROR_Layer34_RFU" - - "RFID_ERROR_LAYER34_COLLISION_TOO_MANY" - - "RFID_ERROR_LAYER34_PROTOCOL_B" - - "RFID_ERROR_LAYER34_DATA_CONTENTS" - - "RFID_ERROR_LAYER34_PROTOCOL" - - "RFID_ERROR_LAYER34_GLOBAL_TIME_OUT" - - "RFID_ERROR_LAYER34_MIFARE_AUTH" - - "RFID_ERROR_LAYER34_SAM_ERROR" - - "RFID_ERROR_LAYER34_SAM_COLLISION" - - "RFID_ERROR_LAYER34_SAM_ACKNOWLEDGE" - - "RFID_ERROR_LAYER6_SECURITY_MANAGER" - - "RFID_ERROR_LAYER6_APP_SELECTION_FAILURE" - - "RFID_ERROR_LAYER6_MUTUAL_AUTH_MAC_FAIL" - - "RFID_ERROR_LAYER6_MUTUAL_AUTH_ENC_FAIL" - - "RFID_ERROR_LAYER6_MUTUAL_AUTH_FAILURE" - - "RFID_ERROR_LAYER6_MUTUAL_AUTH_FAILURE_DATA" - - "RFID_ERROR_LAYER6_SM_DO_8E_MISSING" - - "RFID_ERROR_LAYER6_SM_DO_87_MISSING" - - "RFID_ERROR_LAYER6_SM_DO_99_MISSING" - - "RFID_ERROR_LAYER6_SM_MAC_INCORRECT" - - "RFID_ERROR_LAYER6_SM_DO_87_INCORRECT" - - "RFID_ERROR_LAYER6_NON_TLV_RESPONSE_DATA" - - "RFID_ERROR_LAYER6_WRONG_RND_ICC_LENGTH" - - "RFID_ERROR_LAYER6_INT_AUTH_FAILURE" - - "RFID_ERROR_LAYER6_MSE_SET_KAT_FAILURE" - - "RFID_ERROR_LAYER6_MSE_SET_DST_FAILURE" - - "RFID_ERROR_LAYER6_PSO_CERTIFICATE_FAILURE" - - "RFID_ERROR_LAYER6_MSE_SET_AT_FAILURE" - - "RFID_ERROR_LAYER6_GET_CHALLENGE_FAILURE" - - "RFID_ERROR_LAYER6_EXT_AUTH_FAILURE" - - "RFID_ERROR_LAYER6_GENERAL_AUTH_FAILURE" - - "RFID_ERROR_FAILED" - - "RFID_ERROR_NO_ERROR" - - "RFID_ERROR_ALREADY_DONE" + - "RFID_Error_NoError" + - "RFID_Error_AlreadyDone" + - "RFID_Error_Failed" + - "RFID_Error_NoChipDetected" + - "RFID_Error_NotAvailable" + - "RFID_Error_InvalidParameter" + - "RFID_Error_NotInitialized" + - "RFID_Error_NotEnoughMemory" + - "RFID_Error_NotEnoughData" + - "RFID_Error_InvalidDirectory" + - "RFID_Error_UnknownCommand" + - "RFID_Error_FileIOError" + - "RFID_Error_Busy" + - "RFID_Error_OldFirmware" + - "RFID_Error_PCSC_Failed" + - "RFID_Error_PCSC_ReaderNotAvailable" + - "RFID_Error_PCSC_CantConnectCard" + - "RFID_Error_PCSC_CardIsNotConnected" + - "RFID_Error_PCSC_OperationCancelled" + - "RFID_Error_PCSC_CardIsBusy" + - "RFID_Error_PCSC_FailedSCard" + - "RFID_Error_PCSC_ExtLe_Failed" + - "RFID_LAYER6_SECURITY_MANAGER" + - "RFID_LAYER6_APP_SELECTION_FAILURE" + - "RFID_LAYER6_MUTUAL_AUTH_MAC_FAIL" + - "RFID_LAYER6_MUTUAL_AUTH_ENC_FAIL" + - "RFID_LAYER6_MUTUAL_AUTH_FAILURE" + - "RFID_LAYER6_MUTUAL_AUTH_FAILURE_DATA" + - "RFID_LAYER6_SM_DO8E_MISSING" + - "RFID_LAYER6_SM_DO87_MISSING" + - "RFID_LAYER6_SM_DO99_MISSING" + - "RFID_LAYER6_SM_MAC_INCORRECT" + - "RFID_LAYER6_SM_DO87_INCORRECT" + - "RFID_LAYER6_NON_TLV_RESPONSE_DATA" + - "RFID_LAYER6_WRONG_RND_ICC_LENGTH" + - "RFID_LAYER6_INT_AUTH_FAILURE" + - "RFID_LAYER6_MSE_SET_KAT_FAILURE" + - "RFID_LAYER6_MSE_SET_DST_FAILURE" + - "RFID_LAYER6_PSO_CERTIFICATE_FAILURE" + - "RFID_LAYER6_MSE_SET_AT_FAILURE" + - "RFID_LAYER6_GET_CHALLENGE_FAILURE" + - "RFID_LAYER6_EXT_AUTH_FAILURE" + - "RFID_LAYER6_GENERAL_AUTH_FAILURE" + - "RFID_LAYER6_FILE_NOT_FOUND" + - "RFID_LAYER6_FILE_EOF1" + - "RFID_LAYER6_FILE_EOF2" + - "RFID_LAYER6_WRONG_LENGTH" + - "RFID_LAYER6_INCORRECT_PARAMS" + - "RFID_LAYER6_NO_REFERENCE_DATA" + - "RFID_LAYER6_PWD_SUSPENDED" + - "RFID_LAYER6_PWD_BLOCKED" + - "RFID_LAYER6_PWD_DEACTIVATED" + - "RFID_LAYER6_PWD_BLOCKED_2" + - "RFID_LAYER6_PWD_DEACTIVATED_2" + - "RFID_LAYER6_PWD_SUSPENDED_2" + - "RFID_LAYER6_PWD_FAILED" + - "RFID_Error_NotPerformed" + - "RFID_Error_Session_IsClosed" + - "RFID_Error_Session_Terminal_UnsupportedOperation" + - "RFID_Error_Session_TerminalType_Unknown" + - "RFID_Error_Session_TerminalType_BadCertificate" + - "RFID_Error_Session_TerminalType_NotSet" + - "RFID_Error_Session_ProcedureType_Unknown" + - "RFID_Error_Session_ProcedureType_Unsupported" + - "RFID_Error_Session_ProcedureType_NotSet" + - "RFID_Error_Session_AccessKey_UnknownType" + - "RFID_Error_Session_AccessKey_UnsupportedSMType" + - "RFID_Error_Session_AccessKey_IncorrectSMType" + - "RFID_Error_Session_AccessKey_Restricted" + - "RFID_Error_Session_AccessKey_IncorrectData" + - "RFID_Error_Session_AccessKey_NotSet" + - "RFID_Error_Session_PwdManagement_NotAuthorized" + - "RFID_Error_Session_AccessControl_UnknownType" + - "RFID_Error_Session_AccessControl_RequiresSM" + - "RFID_Error_Session_AccessControl_RequiresPACE" + - "RFID_Error_Session_AccessControl_RequiresCAKeys" + - "RFID_Error_Session_AccessControl_RequiresTA" + - "RFID_Error_Session_AccessControl_RequiresCA" + - "RFID_Error_Session_AccessControl_IncorrectOptionCA" + - "RFID_Error_Session_AccessControl_CA_Failed" + - "RFID_Error_Session_AccessControl_TA_Failed" + - "RFID_Error_Session_AccessControl_AA_Failed" + - "RFID_Error_Session_AccessControl_RI_Failed" + - "RFID_Error_Session_PA_SignatureCheckFailed" + - "RFID_Error_Session_PA_HashCheckFailed" + - "RFID_Error_Session_InvalidAuxData_DateOfExpiry" + - "RFID_Error_Session_InvalidAuxData_DateOfBirth" + - "RFID_Error_Session_InvalidAuxData_CommunityID" + - "RFID_Error_Session_eSign_RequiresAppSelection" + - "RFID_Error_Session_eSign_PIN_NotSet" + - "RFID_Error_Session_eSign_PIN_NotVerified" + - "RFID_Error_Session_IncorrectData" + - "RFID_Error_Session_File_NotEnoughData" + - "RFID_Error_Session_File_IncorrectData" + - "RFID_Error_Session_File_UnexpectedData" + - "RFID_Error_Session_File_Contents_UnexpectedData" + - "RFID_Error_Session_File_WrongTag" + - "RFID_Error_Session_File_CantUseData" + - "RFID_Error_Session_File_CantReadData" + - "RFID_Error_Session_File_AccessDenied" + - "RFID_Error_Layer34_NoError" + - "RFID_Error_Layer34_TimeOut" + - "RFID_Error_Layer34_Collision" + - "RFID_Error_Layer34_CRC" + - "RFID_Error_Layer34_DataIntegrity" + - "RFID_Error_Layer34_DataLength" + - "RFID_Error_Layer34_RFU" + - "RFID_Error_Layer34_Collision_TooMany" + - "RFID_Error_Layer34_ProtocolB" + - "RFID_Error_Layer34_DataContents" + - "RFID_Error_Layer34_Protocol" + - "RFID_Error_Layer34_GlobalTimeOut" + - "RFID_Error_Layer34_MIFARE_Auth" + - "RFID_Error_Layer34_SAM_Error" + - "RFID_Error_Layer34_SAM_Collision" + - "RFID_Error_Layer34_SAM_Acknowledge" diff --git a/e-rfid-pkd-resourcetype.yml b/e-rfid-pkd-resourcetype.yml index ae5ce0f..d8f2f79 100644 --- a/e-rfid-pkd-resourcetype.yml +++ b/e-rfid-pkd-resourcetype.yml @@ -1,7 +1,8 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: RFIDPKDResourceType: + title: "RFIDPKDResourceType" type: integer description: "Enumeration contains a set of constants that define the type of certificate" enum: diff --git a/e-security-feature-type.yml b/e-security-feature-type.yml index 4ebf848..6867496 100644 --- a/e-security-feature-type.yml +++ b/e-security-feature-type.yml @@ -1,7 +1,8 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: SecurityFeatureType: + title: "SecurityFeatureType" type: integer description: "Enumeration contains identifiers determining type of features for a document authenticity checks: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/security-feature-type/" enum: @@ -58,6 +59,8 @@ components: - 51 - 52 - 53 + - 54 + - 55 x-enum-descriptions: - "Blank element" - "Personalization element" @@ -112,6 +115,8 @@ components: - "Contact chip check" - "Head position check" - "Black and white copy check" + - "Liveness dynaprint" + - "Liveness geometry check" x-enum-varnames: - "BLANK" - "FILL" @@ -166,3 +171,5 @@ components: - "CONTACT_CHIP_CLASSIFICATION" - "HEAD_POSITION_CHECK" - "LIVENESS_BLACK_AND_WHITE_COPY_CHECK" + - "LIVENESS_DYNAPRINT" + - "LIVENESS_GEOMETRY_CHECK" diff --git a/e-text-field-type.yml b/e-text-field-type.yml index 82642c5..e93d74a 100644 --- a/e-text-field-type.yml +++ b/e-text-field-type.yml @@ -1,7 +1,8 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: TextFieldType: + title: "TextFieldType" type: integer enum: - 0 @@ -648,6 +649,9 @@ components: - 692 - 693 - 694 + - 695 + - 696 + - 697 x-enum-descriptions: - "Document class code" - "Issuing state code" @@ -1293,6 +1297,9 @@ components: - "EF.CardAccess" - "Short flight number" - "Airline code" + - "MVC Agency" + - "Issuing state code (Alpha-2)" + - "Nationality code (Alpha-2)" x-enum-varnames: - "DOCUMENT_CLASS_CODE" - "ISSUING_STATE_CODE" @@ -1938,3 +1945,6 @@ components: - "EF_CARD_ACCESS" - "SHORT_FLIGHT_NUMBER" - "AIRLINE_CODE" + - "FT_MVC_AGENCY" + - "FT_ISSUING_STATE_CODE_ALPHA2" + - "FT_NATIONALITY_CODE_ALPHA2" diff --git a/index.yml b/index.yml index 2098914..c759abc 100644 --- a/index.yml +++ b/index.yml @@ -1,13 +1,13 @@ -openapi: 3.0.3 +openapi: 3.0.4 info: - version: 7.2.0 + version: 8.1.0 title: Regula Document Reader Web API x-logo: url: "https://static-content.regulaforensics.com/Icons/Logos/Regula-logo.svg" href: "https://regulaforensics.com" description: | Documents recognition as easy as reading two bytes. - + # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android @@ -26,17 +26,17 @@ paths: /api/process: $ref: "./p-process.yml#/paths/~1process" /api/v2/transaction/{transactionId}/process: - $ref: "./p-transaction.yml#/paths/~1transaction~1{transactionId}~1process" + $ref: "./p-transaction.yml#/paths/~1transaction~1%7BtransactionId%7D~1process" /api/v2/transaction/{transactionId}: - $ref: "./p-transaction.yml#/paths/~1transaction~1{transactionId}" + $ref: "./p-transaction.yml#/paths/~1transaction~1%7BtransactionId%7D" /api/v2/transaction/{transactionId}/results: - $ref: "./p-transaction.yml#/paths/~1transaction~1{transactionId}~1results" + $ref: "./p-transaction.yml#/paths/~1transaction~1%7BtransactionId%7D~1results" /api/v2/transaction/{transactionId}/file: - $ref: "./p-transaction.yml#/paths/~1transaction~1{transactionId}~1file" + $ref: "./p-transaction.yml#/paths/~1transaction~1%7BtransactionId%7D~1file" /api/v2/tag/{tagId}: - $ref: "./p-transaction.yml#/paths/~1tag~1{tagId}" + $ref: "./p-transaction.yml#/paths/~1tag~1%7BtagId%7D" /api/v2/tag/{tagId}/transactions: - $ref: "./p-transaction.yml#/paths/~1tag~1{tagId}~1transactions" + $ref: "./p-transaction.yml#/paths/~1tag~1%7BtagId%7D~1transactions" /api/ping: $ref: "./p-ping.yml#/paths/~1ping" /api/healthz: @@ -46,7 +46,7 @@ paths: tags: - name: process - description: Everything about perfoming request and parsing response + description: Everything about performing request and parsing response - name: status_model x-displayName: Status Model description: | @@ -65,7 +65,7 @@ tags: - name: document_model x-displayName: Document Model description: | - **Choosen Document model:** + **Chosen Document model:** **Candidates model:** @@ -74,7 +74,6 @@ tags: description: | - x-tagGroups: - name: Requests tags: @@ -91,12 +90,6 @@ x-tagGroups: components: schemas: - Status: - $ref: "./rt-status.yml#/components/schemas/Status" - Text: - $ref: "./rt-text.yml#/components/schemas/Text" - Images: - $ref: "./rt-images.yml#/components/schemas/Images" DocumentImage: $ref: "./common.yml#/components/schemas/ImageData" TransactionImage: @@ -105,7 +98,7 @@ components: $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesList" ChosenDocumentType: $ref: "./rt-doc-type-old.yml#/components/schemas/OneCandidate" - AuthenticityCheckResult: - $ref: "./rt-authenticity.yml#/components/schemas/AuthenticityCheckResult" - AuthenticityResultType: - $ref: "./authenticity/e-result-type.yml#/components/schemas/AuthenticityResultType" + RFIDPKDResourceType: + $ref: "./e-rfid-pkd-resourcetype.yml#/components/schemas/RFIDPKDResourceType" + ParsingErrorCodes: + $ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes" diff --git a/openapitools.json b/openapitools.json index bfebfaa..0e01b85 100644 --- a/openapitools.json +++ b/openapitools.json @@ -2,6 +2,6 @@ "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json", "spaces": 2, "generator-cli": { - "version": "5.0.0" + "version": "7.12.0" } } diff --git a/p-healthcheck.yml b/p-healthcheck.yml index 090d32c..ad2d868 100644 --- a/p-healthcheck.yml +++ b/p-healthcheck.yml @@ -1,5 +1,4 @@ -openapi: 3.0.3 - +openapi: 3.0.4 paths: /healthz: parameters: @@ -33,9 +32,16 @@ paths: components: schemas: Healthcheck: - title: "Health check" + title: "Healthcheck" type: object - required: [app, licenseId, licenseType, licenseSerial, licenseValidUntil, scenarios, version] + required: + - app + - licenseId + - licenseType + - licenseSerial + - licenseValidUntil + - scenarios + - version properties: app: description: Application name. @@ -67,10 +73,17 @@ components: description: Product version. type: string nullable: true + metadata: + type: object + additionalProperties: true documentsDatabase: description: Database information. type: object - required: [id, version, exportDate, description] + required: + - id + - version + - exportDate + - description properties: id: description: Database identifier. @@ -83,7 +96,6 @@ components: exportDate: description: Date of database creation. type: string - format: date nullable: true description: description: Description of the database contents, such as the list of supported countries and documents. diff --git a/p-ping.yml b/p-ping.yml index a0b7205..2796051 100644 --- a/p-ping.yml +++ b/p-ping.yml @@ -1,5 +1,4 @@ -openapi: 3.0.3 - +openapi: 3.0.4 paths: /ping: parameters: @@ -25,19 +24,58 @@ components: type: object properties: app-name: + description: Application name. type: string version: + description: Product version. type: string license-id: + description: Unique license identifier. type: string license-serial: + description: License serial number. + type: string + license-type: type: string valid-until: + description: License validity date. type: string format: date-time server-time: type: string - format: date-time + supported-scenarios: + description: List of supported scenarios. + type: array + items: + type: string + metadata: + type: object + additionalProperties: true + documents-database: + description: Database information. + type: object + required: + - id + - version + - export-date + - description + properties: + id: + description: Database identifier. + type: string + nullable: true + version: + description: Database version. + type: string + nullable: true + export-date: + description: Date of database creation. + type: string + nullable: true + description: + description: Description of the database contents, such as the list of supported countries and documents. + type: string + nullable: true example: app-name: "Regula Process Manager Service" version: "5.3.104980.123" diff --git a/p-process.yml b/p-process.yml index 8e2f380..32150f0 100644 --- a/p-process.yml +++ b/p-process.yml @@ -1,5 +1,4 @@ -openapi: 3.0.3 - +openapi: 3.0.4 paths: /process: parameters: @@ -135,13 +134,13 @@ paths: components: schemas: - ############################# ############################# Requests objects - - # todo different image input types ProcessRequest: + title: "ProcessRequest" type: object + required: + - processParam properties: processParam: $ref: "#/components/schemas/ProcessParams" @@ -185,11 +184,12 @@ components: description: "URLs to the document images for processing." items: type: string - required: - - processParam ProcessParams: + title: "ProcessParams" type: object + required: + - scenario properties: generateDTCVC: type: boolean @@ -198,12 +198,15 @@ components: description: "The list of LCID types to recognize. If empty, values with all LCID types will be extracted. Empty by default." type: array items: - type: integer + $ref: "./e-lcid.yml#/components/schemas/LCID" + checkLiveness: + description: "This parameter is used to enable document liveness check." + type: boolean lcidIgnoreFilter: description: "The list of LCID types to ignore during the recognition. If empty, values with all LCID types will be extracted. Narrowing down the list can reduce processing time. Empty by default." type: array items: - type: integer + $ref: "./e-lcid.yml#/components/schemas/LCID" oneShotIdentification: type: boolean description: "This parameter allows processing an image that contains a person and a document and compare the portrait photo from the document with the person's face" @@ -255,9 +258,7 @@ components: By default it is set to system locale default (where the service is running)." type: string example: "MM/dd/yyyy" - measureSystem: - description: "This option allows you to set the system of measurement used for converting original values - in document to output result values. Metric by default." + measureSystem: # This option allows you to set the system of measurement used for converting original values in document to output result values. Metric by default. $ref: "#/components/schemas/MeasureSystem" imageDpiOutMax: description: "This parameter controls maximum resolution in dpi of output images. @@ -285,8 +286,7 @@ components: description: "When enabled, results will contain transaction processing log. Disabled by default" type: boolean # default false - logLevel: - description: "When used together with 'log' parameter enabled, sets the level of logs detalization. 'INFO' by default." + logLevel: # When used together with 'log' parameter enabled, sets the level of logs detalization. 'INFO' by default. $ref: "#/components/schemas/LogLevel" # default: "INFO" forceDocID: @@ -329,8 +329,7 @@ components: type: boolean deprecated: true # default: false - forceDocFormat: - description: "Force use of specified document format when locating and recognizing document to reduce the number of candidates." + forceDocFormat: # Force use of specified document format when locating and recognizing document to reduce the number of candidates. $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentFormat" noGraphics: description: "When enabled, no graphic fields will be cropped from document image. Disabled by default." @@ -375,8 +374,7 @@ components: description: "This option can be disabled to stop parsing after barcode is read. Enabled by default." type: boolean # default true - convertCase: - description: "This option allows output text case transformation. No changes applied by default to original values." + convertCase: # This option allows output text case transformation. No changes applied by default to original values. $ref: "#/components/schemas/TextPostProcessing" splitNames: description: "When enabled, the Surname and GivenNames fields from MRZ will be divided into @@ -394,9 +392,7 @@ components: items: $ref: "./e-document-type.yml#/components/schemas/DocumentType" processAuth: - description: "Authenticity checks that should be performed regardless of the document type. - The available checks are listed in the eRPRM_Authenticity enum. - Note that only supported by your license checks can be added. " + description: "Authenticity checks that should be performed regardless of the document type. The available checks are listed in the eRPRM_Authenticity enum. Note that only supported by your license checks can be added." type: integer format: int64 deviceId: @@ -424,7 +420,7 @@ components: type: object description: "Params for the RFID chip data reprocessing" properties: - paSensitiveCodesDisable: + paIgnoreNotificationCodes: description: "A list of notification codes that should be ignored during passive authentication (PA)" type: array items: @@ -432,7 +428,7 @@ components: checkAuth: type: boolean description: "This parameter is used to enable authenticity checks" -# default: true + # default: true authParams: $ref: '#/components/schemas/AuthParams' mrzDetectMode: @@ -440,15 +436,15 @@ components: generateNumericCodes: type: boolean description: "This parameter is used to generate numeric representation for issuing state and nationality codes" -# default: false + # default: false strictBarcodeDigitalSignatureCheck: type: boolean description: "This parameter if enabled will require all necessary certificates to verify digital signature in barcode data to be present in order for the Barcode format check to succeed." -# default: false + # default: false selectLongestNames: type: boolean description: "Select the longest value from the different value sources and write it to the value field if comparison is done successfully. The parameter applies this logic to the personal names, such as given name, surname, surname and given name, middle name and etc." -# default: false + # default: false doBarcodes: description: "Set the types of barcodes to process." type: array @@ -457,11 +453,16 @@ components: strictDLCategoryExpiry: description: "Set to force DL categories expiry date to affect the overall status or not. As documents usually have their own date of expiry, which might be less or greater than category expiry date, this might be handy for specific cases." type: boolean -# default: false - required: - - scenario + # default: false + generateAlpha2Codes: + description: "Set to generate Alpha-2 codes for nationality and issuing state fields." + type: boolean + pdfPagesLimit: + description: "Limits the number of pages to be processed from a PDF file." + type: integer MRZFormat: + title: "MRZFormat" type: string enum: - "1x30" @@ -486,6 +487,7 @@ components: - "2x30" TextPostProcessing: + title: "TextPostProcessing" type: integer enum: - 0 @@ -504,6 +506,7 @@ components: - "Capital" mrzDetectModeEnum: + title: "mrzDetectModeEnum" type: integer description: "Make better MRZ detection on complex noisy backgrounds, like BW photocopy of some documents." enum: @@ -516,105 +519,92 @@ components: - "eMDM_BlurBeforeBinarization" AuthParams: + title: "AuthParams" type: object properties: checkLiveness: type: boolean description: "This parameter is used to enable document liveness check" -# default: true - + # default: true livenessParams: $ref: '#/components/schemas/LivenessParams' - checkUVLuminiscence: type: boolean description: "This parameter is used to enable Document luminescence check in UV light" -# default: true - + # default: true checkIRB900: type: boolean description: "This parameter is used to enable B900 ink MRZ contrast check in IR light" -# default: true - + # default: true checkImagePatterns: type: boolean description: "This parameter is used to enable Image patterns presence/absence check (position, shape, color)" -# default: true - + # default: true checkFibers: type: boolean description: "This parameter is used to enable Fibers detection" -# default: true - + # default: true checkExtMRZ: type: boolean description: "This parameter is used to enable Extended MRZ Check" -# default: true - + # default: true checkExtOCR: type: boolean description: "This parameter is used to enable Extended OCR Check" -# default: true - + # default: true checkAxial: type: boolean description: "This parameter is used to enable laminate integrity check in axial light" -# default: true - + # default: true checkBarcodeFormat: type: boolean description: "This parameter is used to enable Barcode format check (code metadata, data format, contents format, etc.)" -# default: true - + # default: true checkIRVisibility: type: boolean description: "This parameter is used to enable Document elements visibility check in IR light" -# default: true - + # default: true checkIPI: type: boolean description: "This parameter is used to enable Invisible Personal Information (IPI) check" -# default: true - + # default: true checkPhotoEmbedding: type: boolean description: "This parameter is used to enable Owner's photo embedding check (is photo printed or sticked)" -# default: true - + # default: true checkPhotoComparison: type: boolean description: "This parameter is used to enable Portrait comparison check" -# default: true - + # default: true checkLetterScreen: type: boolean description: "This parameter is used to enable LetterScreen check" -# default: false + # default: false checkSecurityText: type: boolean description: "This parameter is used to enable Security text check" # default: true - LivenessParams: + title: "LivenessParams" type: object properties: checkOVI: type: boolean description: "This parameter is used to enable OVI check" -# default: true + # default: true checkMLI: type: boolean description: "This parameter is used to enable MLI check" -# default: true + # default: true checkHolo: type: boolean description: "This parameter is used to enable Hologram detection" -# default: true + # default: true checkED: type: boolean description: "This parameter is used to enable Electronic device detection" -# default: true + # default: true checkBlackAndWhiteCopy: type: boolean description: "This parameter is used to enable Black and white copy check" @@ -623,8 +613,13 @@ components: type: boolean description: "This parameter is used to enable Dynaprint check" # default: true + checkGeometry: + type: boolean + description: "This parameter is used to enable Geometry check" + # default: true MeasureSystem: + title: "MeasureSystem" type: integer example: 0 enum: @@ -638,6 +633,7 @@ components: - "IMPERIAL" LogLevel: + title: "LogLevel" type: string enum: - FatalError @@ -658,8 +654,8 @@ components: - "Info" - "Debug" - PerDocumentConfig: + title: "PerDocumentConfig" type: object properties: docID: @@ -672,8 +668,8 @@ components: type: integer example: 2 - ImageQA: + title: "ImageQA" type: object properties: brightnessThreshold: @@ -702,6 +698,9 @@ components: description: "This option enables colorness check while performing image quality validation." type: boolean # default: false + moireCheck: + description: "This option enables screen capture (moire patterns) check while performing image quality validation." + type: boolean documentPositionIndent: description: "This parameter specifies the necessary margin. Default 0." type: integer @@ -713,6 +712,7 @@ components: $ref: "./rt-image-quality.yml#/components/schemas/InputImageQualityChecks" ProcessRequestImage: + title: "ProcessRequestImage" type: object properties: ImageData: @@ -730,6 +730,7 @@ components: image: "" ProcessSystemInfo: + title: "ProcessSystemInfo" type: object properties: license: @@ -742,14 +743,20 @@ components: ############################# ############################# Response objects ProcessResponse: + title: "ProcessResponse" type: object required: + - ChipPage - ProcessingFinished - ContainerList - TransactionInfo + - morePagesAvailable + - elapsedTime properties: ChipPage: $ref: "./common.yml#/components/schemas/RfidLocation" + CoreLibResultCode: + type: integer ProcessingFinished: $ref: "#/components/schemas/ProcessingStatus" ContainerList: @@ -768,8 +775,12 @@ components: elapsedTime: type: integer description: "Time the document processing has taken, ms." + metadata: + type: object + additionalProperties: true ProcessingStatus: + title: "ProcessingStatus" type: integer enum: - 0 @@ -785,6 +796,7 @@ components: - "TIMEOUT" TransactionInfo: + title: "TransactionInfo" type: object properties: ComputerName: @@ -817,6 +829,7 @@ components: "UserName": "user" DocumentsDatabase: + title: "DocumentsDatabase" type: object description: "Document database information" properties: diff --git a/p-transaction.yml b/p-transaction.yml index 4feec7e..611684f 100644 --- a/p-transaction.yml +++ b/p-transaction.yml @@ -1,8 +1,4 @@ -openapi: 3.0.3 -info: - version: 6.9.0 - title: Regula Document Reader Web API - +openapi: 3.0.4 paths: /transaction/{transactionId}/process: post: @@ -29,17 +25,7 @@ paths: content: application/json: schema: - type: object - properties: - OutData: - $ref: '#/components/schemas/OutData' - InData: - $ref: '#/components/schemas/InData' - tag: - type: string - transactionId: - type: string - format: uuid + $ref: '#/components/schemas/TransactionProcessResult' "400": description: "Bad request. Check your input data." "403": @@ -84,9 +70,6 @@ paths: name: withImages schema: type: boolean - enum: - - true - - false description: With base64 images or url summary: Get Reprocess transaction result tags: @@ -97,35 +80,12 @@ paths: content: application/json: schema: - type: object - properties: - ChipPage: - $ref: "./common.yml#/components/schemas/RfidLocation" - ProcessingFinished: - $ref: "./p-process.yml#/components/schemas/ProcessingStatus" - ContainerList: - $ref: "./rt.yml#/components/schemas/ContainerList" - TransactionInfo: - $ref: "./p-process.yml#/components/schemas/TransactionInfo" - log: - description: "Base64 encoded transaction processing log" - type: string - passBackObject: - type: object - description: "Free-form object provided in request. See passBackObject property of ProcessRequest." - additionalProperties: true - morePagesAvailable: - type: integer - elapsedTime: - type: integer - description: "Time the document processing has taken, ms." - CoreLibResultCode: - type: integer - + $ref: "./p-process.yml#/components/schemas/ProcessResponse" "400": description: "Bad request. Check your input data." "403": description: "Bad license. Either server or request does not contain valid license." + /transaction/{transactionId}/file: get: parameters: @@ -155,6 +115,7 @@ paths: format: binary "404": description: "File not found" + /tag/{tagId}: delete: parameters: @@ -178,6 +139,7 @@ paths: description: "Bad request. Check your input data." "403": description: "Bad license. Either server or request does not contain valid license." + /tag/{tagId}/transactions: get: parameters: @@ -205,6 +167,7 @@ paths: components: schemas: ListTransactionsByTagResponse: + title: "ListTransactionsByTagResponse" type: object properties: items: @@ -214,7 +177,9 @@ components: metadata: type: object additionalProperties: true + GetTransactionsByTagResponse: + title: "GetTransactionsByTagResponse" type: object properties: id: @@ -228,7 +193,23 @@ components: type: string format: 'date-time' description: "Last time updated" + + TransactionProcessResult: + title: "TransactionProcessResult" + type: object + properties: + OutData: + $ref: '#/components/schemas/OutData' + InData: + $ref: '#/components/schemas/InData' + tag: + type: string + transactionId: + type: string + format: uuid + TransactionProcessGetResponse: + title: "TransactionProcessGetResponse" type: object properties: transactionId: @@ -242,6 +223,7 @@ components: $ref: '#/components/schemas/InData' OutData: + title: "OutData" type: object properties: url: @@ -253,6 +235,7 @@ components: $ref: "#/components/schemas/OutDataTransactionImagesFieldValue" InData: + title: "InData" type: object properties: video: @@ -272,7 +255,10 @@ components: $ref: "#/components/schemas/InDataTransactionImagesFieldValue" TransactionProcessRequest: + title: "TransactionProcessRequest" type: object + required: + - processParam properties: processParam: $ref: "./p-process.yml#/components/schemas/ProcessParams" @@ -280,6 +266,15 @@ components: type: array items: $ref: "./p-process.yml#/components/schemas/ProcessRequestImage" + tag: + type: string + description: "Session ID" + tenant: + type: string + description: "Customer name" + env: + type: string + description: "Environment type" livePortrait: type: string format: base64 @@ -302,10 +297,9 @@ components: dtc: type: string description: "Digital Travel Credential (DTC-VC) data in base64 format for processing" - required: - - processParam InDataTransactionImagesFieldValue: + title: "InDataTransactionImagesFieldValue" type: object properties: light: @@ -319,6 +313,7 @@ components: description: "Image url" OutDataTransactionImagesFieldValue: + title: "OutDataTransactionImagesFieldValue" type: object properties: fieldType: @@ -334,6 +329,7 @@ components: description: "Image url" TransactionScenarioRequest: + title: "TransactionScenarioRequest" type: object properties: scenario: diff --git a/rt-authenticity.yml b/rt-authenticity.yml index 9773d9d..c1c25ae 100644 --- a/rt-authenticity.yml +++ b/rt-authenticity.yml @@ -1,21 +1,20 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: - - AuthenticityResult: - title: "Authenticity Checks" - allOf: - - type: object - required: - - AuthenticityCheckList - properties: - AuthenticityCheckList: - $ref: "#/components/schemas/AuthenticityCheckList" - - $ref: "./rt.yml#/components/schemas/ResultItem" + AuthenticityCheckListItem: + title: "AuthenticityCheckListItem" + type: object + required: + - AuthenticityCheckList + properties: + AuthenticityCheckList: + $ref: "#/components/schemas/AuthenticityCheckList" AuthenticityCheckList: + title: "AuthenticityCheckList" type: object required: + - Count - List properties: Count: @@ -28,6 +27,7 @@ components: $ref: "#/components/schemas/AuthenticityCheckResult" AuthenticityCheckResult: + title: "AuthenticityCheckResult" type: object required: - Type @@ -38,29 +38,58 @@ components: $ref: "./authenticity/e-result-type.yml#/components/schemas/AuthenticityResultType" Result: $ref: "./common.yml#/components/schemas/CheckResult" + Count: + type: integer + description: "Count of items in List" List: type: array items: - anyOf: + oneOf: - $ref: "#/components/schemas/SecurityFeatureResult" - $ref: "#/components/schemas/IdentResult" - $ref: "#/components/schemas/FiberResult" - $ref: "#/components/schemas/OCRSecurityTextResult" - $ref: "#/components/schemas/PhotoIdentResult" - AuthenticityType: - type: integer - description: "Same as authenticity result type, but used for safe parsing of not-described values: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/authenticity-result-type/" - default: 0 + SecurityFeatureResult: + title: "SecurityFeatureResult" + allOf: + - $ref: "#/components/schemas/AuthenticityCheckResultItem" + - $ref: "./authenticity/rt-security-feature.yml#/components/schemas/SecurityFeatureItem" + + IdentResult: + title: "IdentResult" + allOf: + - $ref: "#/components/schemas/AuthenticityCheckResultItem" + - $ref: "./authenticity/rt-ident.yml#/components/schemas/IdentItem" + + FiberResult: + title: "FiberResult" + allOf: + - $ref: "#/components/schemas/AuthenticityCheckResultItem" + - $ref: "./authenticity/rt-fiber.yml#/components/schemas/FiberItem" + + OCRSecurityTextResult: + title: "OCRSecurityTextResult" + allOf: + - $ref: "#/components/schemas/AuthenticityCheckResultItem" + - $ref: "./authenticity/rt-ocr-security-text.yml#/components/schemas/OCRSecurityTextItem" + + PhotoIdentResult: + title: "PhotoIdentResult" + allOf: + - $ref: "#/components/schemas/AuthenticityCheckResultItem" + - $ref: "./authenticity/rt-photo-ident.yml#/components/schemas/PhotoIdentItem" AuthenticityCheckResultItem: + title: "AuthenticityCheckResultItem" description: "Common fields for all authenticity result objects" type: object required: - Type properties: Type: - $ref: "#/components/schemas/AuthenticityType" + $ref: "./authenticity/e-result-type.yml#/components/schemas/AuthenticityResultType" ElementResult: $ref: "./common.yml#/components/schemas/CheckResult" ElementDiagnose: @@ -79,40 +108,29 @@ components: 32: "IdentResult" 64: "OCRSecurityTextResult" 128: "PhotoIdentResult" - 256: "PhotoIdentResult" 512: "SecurityFeatureResult" 1024: "IdentResult" - 2048: "IdentResult" 4096: "SecurityFeatureResult" 8192: "SecurityFeatureResult" - 16384: "FiberResult" 32768: "IdentResult" 65536: "SecurityFeatureResult" 131072: "IdentResult" 262144: "IdentResult" 524288: "IdentResult" 1048576: "IdentResult" + 2097152: "IdentResult" + 4194304: "SecurityFeatureResult" 8388608: "SecurityFeatureResult" - - - SecurityFeatureResult: - $ref: "./authenticity/rt-security-feature.yml#/components/schemas/SecurityFeatureResult" - - IdentResult: - $ref: "./authenticity/rt-ident.yml#/components/schemas/IdentResult" - - FiberResult: - $ref: "./authenticity/rt-fiber.yml#/components/schemas/FiberResult" - - OCRSecurityTextResult: - $ref: "./authenticity/rt-ocr-security-text.yml#/components/schemas/OCRSecurityTextResult" - - PhotoIdentResult: - $ref: "./authenticity/rt-photo-ident.yml#/components/schemas/PhotoIdentResult" + 16777216: "OCRSecurityTextResult" AreaContainer: + title: "AreaContainer" description: "Checked fragment coordinates" type: object + required: + - Count + - List + - Points properties: Count: type: integer @@ -126,11 +144,14 @@ components: $ref: "#/components/schemas/PointsContainer" PointsContainer: + title: "PointsContainer" type: object + required: + - PointsList properties: PointCount: type: integer PointsList: type: array items: - $ref: "./common.yml#/components/schemas/Point" \ No newline at end of file + $ref: "./common.yml#/components/schemas/Point" diff --git a/rt-barcodes.yml b/rt-barcodes.yml index 415cd59..739e637 100644 --- a/rt-barcodes.yml +++ b/rt-barcodes.yml @@ -1,20 +1,21 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: - - DocBarCodeInfo: - title: "Document BarCode Info" - description: "Raw data from BarCodes" - allOf: - - type: object - properties: - DocBarCodeInfo: - $ref: "#/components/schemas/DocBarCodeInfoFieldsList" - - $ref: "./rt.yml#/components/schemas/ResultItem" - + DocBarCodeInfoItem: + title: "DocBarCodeInfoItem" + type: object + required: + - DocBarCodeInfo + properties: + DocBarCodeInfo: + $ref: "#/components/schemas/DocBarCodeInfoFieldsList" DocBarCodeInfoFieldsList: + title: "DocBarCodeInfoFieldsList" type: object + required: + - nFields + - pArrayFields properties: nFields: type: integer @@ -26,10 +27,20 @@ components: $ref: "#/components/schemas/pArrayField" pArrayField: + title: "pArrayField" type: object + required: + - bcAngle_DETECT + - bcCodeResult + - bcCountModule + - bcDataModule + - bcROI_DETECT + - bcType_DECODE + - bcType_DETECT properties: bcAngle_DETECT: - type: float + type: number + format: float bcCodeResult: type: integer bcCountModule: @@ -45,17 +56,26 @@ components: bcTextDecoderTypes: type: integer bcTextFieldType: - type: integer + $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" bcType_DECODE: - type: integer + $ref: "./e-barcode-type.yml#/components/schemas/BarcodeType" bcType_DETECT: type: integer bcPDF417INFO: + title: "bcPDF417INFO" type: object + required: + - Angle + - bcColumn + - bcErrorLevel + - bcRow + - minX + - minY properties: Angle: - type: float + type: number + format: float bcColumn: type: integer bcErrorLevel: @@ -63,12 +83,20 @@ components: bcRow: type: integer minX: - type: float + type: number + format: float minY: - type: float + type: number + format: float bcROI_DETECT: + title: "bcROI_DETECT" type: object + required: + - bottom + - left + - right + - top properties: bottom: type: integer @@ -80,7 +108,12 @@ components: type: integer DataModule: + title: "DataModule" type: object + required: + - mData + - mLength + - mType properties: mData: type: string @@ -91,4 +124,26 @@ components: mReserver2: type: integer mType: - type: integer + $ref: "#/components/schemas/BarCodeModuleType" + + BarCodeModuleType: + title: "BarCodeModuleType" + type: integer + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + x-enum-descriptions: + - "Module contains text data" + - "Module contains byte data" + - "Module contains numeric data" + - "Shifts in byte compaction mode (for PDF417)" + - "Module contains any data" + x-enum-varnames: + - "TEXT" + - "BYTE" + - "NUM" + - "SHIFT" + - "ALL" diff --git a/rt-byte-array-data.yml b/rt-byte-array-data.yml index cd8a883..c74bd74 100644 --- a/rt-byte-array-data.yml +++ b/rt-byte-array-data.yml @@ -1,14 +1,12 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: - ByteArrayResult: - title: "ByteArray" - allOf: - - type: object - required: - - ByteArray - properties: - ByteArray: - description: "Byte array in base64" - type: string - - $ref: "./rt.yml#/components/schemas/ResultItem" + ByteArrayItem: + title: "ByteArrayItem" + type: object + required: + - ByteArray + properties: + ByteArray: + description: "Byte array in base64" + type: string diff --git a/rt-doc-type-old.yml b/rt-doc-type-old.yml index d4ef6c0..34389c0 100644 --- a/rt-doc-type-old.yml +++ b/rt-doc-type-old.yml @@ -1,36 +1,30 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: + CandidatesListItem: + title: "CandidatesListItem" + type: object + properties: + CandidatesList: + $ref: "#/components/schemas/DocumentTypesCandidatesList" - ChosenDocumentTypeResult: - title: "Chosen Document Type" - description: "Contains information about the type of document that was determined - based on the analysis of the provided image" - allOf: - - type: object - properties: - OneCandidate: - $ref: "#/components/schemas/OneCandidate" - XML_buffer: - type: string - readOnly: true - - $ref: "./rt.yml#/components/schemas/ResultItem" - - DocumentTypesCandidatesResult: - title: "Document Types Candidates" - allOf: - - type: object - properties: - CandidatesList: - $ref: "#/components/schemas/DocumentTypesCandidatesList" - - $ref: "./rt.yml#/components/schemas/ResultItem" - + OneCandidateItem: + title: "OneCandidateItem" + type: object + required: + - OneCandidate + properties: + OneCandidate: + $ref: "#/components/schemas/OneCandidate" + XML_buffer: + type: string + readOnly: true DocumentTypesCandidatesList: + title: "DocumentTypesCandidatesList" type: object properties: - RecResult: - description: "Overall recognition result" + RecResult: # Overall recognition result $ref: "#/components/schemas/DocumentTypeRecognitionResult" Candidates: type: array @@ -38,6 +32,7 @@ components: $ref: "#/components/schemas/OneCandidate" DocumentTypeRecognitionResult: + title: "DocumentTypeRecognitionResult" type: integer enum: - 0 @@ -54,8 +49,19 @@ components: OneCandidate: + title: "OneCandidate" type: object description: "Contains information about one document type candidate" + required: + - ID + - P + - Rotated180 + - RFID_Presence + - NecessaryLights + - CheckAuthenticity + - UVExp + - AuthenticityNecessaryLights + - OVIExp properties: DocumentName: type: string @@ -69,8 +75,11 @@ components: example: 0.9913095831871032 minimum: 0 maximum: 1 + Rotated180: + description: "Indicates if the document of the given type is rotated by 180 degrees" + type: integer RFID_Presence: - description: "Indication of the presence of an RFID chip in the document (electronic document indicator)" + description: # Indication of the presence of an RFID chip in the document (electronic document indicator) $ref: "./common.yml#/components/schemas/RfidLocation" FDSIDList: $ref: "#/components/schemas/FDSIDList" @@ -88,16 +97,35 @@ components: type: integer description: "Combination of lighting scheme identifiers (combination of Light enum) needed to perform all authenticity checks specified in CheckAuthenticity" + OVIExp: + description: "Camera exposure value necessary when obtaining document images of the given type for AXIAL lighting scheme" + type: number + RotationAngle: + type: integer FDSIDList: + title: "FDSIDList" description: "Extended document type info and Regula's 'Information Reference Systems' links" type: object + required: + - ICAOCode + - Count + - List + - dType + - dFormat + - dMRZ + - dYear + - dCountryName + - isDeprecated properties: ICAOCode: type: string minLength: 3 maxLength: 3 description: "ICAO code of the issuing country" + Count: + description: "Number of elements in the List" + type: number List: type: array items: @@ -130,9 +158,11 @@ components: description: "Whether the document is deprecated" DocumentFormat: + title: "DocumentFormat" type: integer description: "Defining the geometric format of documents in accordance with ISO / IEC 7810" enum: + - -1 - 0 - 1 - 2 @@ -147,6 +177,7 @@ components: - 1000 - 1002 x-enum-descriptions: + - "Unknown document format" - "ID1 document format" - "ID2 document format" - "ID3 document format" @@ -161,6 +192,7 @@ components: - "Arbitrary format" - "Flexible format. Standard formats can be resized during cropping, depending on various factors: light, background..." x-enum-varnames: + - "UNKNOWN" - "ID1" - "ID2" - "ID3" diff --git a/rt-document-position.yml b/rt-document-position.yml index a25739d..25c0043 100644 --- a/rt-document-position.yml +++ b/rt-document-position.yml @@ -1,37 +1,11 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: - - DocumentPositionResult: - title: "Document Position" - description: "Contains information about document position on the input image, its center, angle, etc" - allOf: - - type: object - properties: - DocumentPosition: - $ref: "#/components/schemas/DocumentPosition" - - $ref: "./rt.yml#/components/schemas/ResultItem" - - DocumentPosition: + DocumentPositionItem: + title: "DocumentPositionItem" type: object + required: + - DocumentPosition properties: - docFormat: - $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentFormat" - Angle: - type: number - Width: - type: integer - Height: - type: integer - Center: - $ref: "./common.yml#/components/schemas/Point" - LeftBottom: - $ref: "./common.yml#/components/schemas/Point" - LeftTop: - $ref: "./common.yml#/components/schemas/Point" - RightBottom: - $ref: "./common.yml#/components/schemas/Point" - RightTop: - $ref: "./common.yml#/components/schemas/Point" - Dpi: - type: integer + DocumentPosition: + $ref: "./common.yml#/components/schemas/DocumentPosition" diff --git a/rt-encrypted-rcl.yml b/rt-encrypted-rcl.yml index 524cecc..592f61a 100644 --- a/rt-encrypted-rcl.yml +++ b/rt-encrypted-rcl.yml @@ -1,15 +1,11 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: - - EncryptedRCLResult: - title: "EncryptedRCL" - allOf: - - type: object - description: "Contains encrypted result container list" - required: - - EncryptedRCL - properties: - EncryptedRCL: - $ref: "./common.yml#/components/schemas/EncryptedRCL" - - $ref: "./rt.yml#/components/schemas/ResultItem" + EncryptedRCLItem: + title: "EncryptedRCLItem" + type: object + required: + - EncryptedRCL + properties: + EncryptedRCL: + $ref: "./common.yml#/components/schemas/EncryptedRCL" diff --git a/rt-face-detection.yml b/rt-face-detection.yml new file mode 100644 index 0000000..6b7d79b --- /dev/null +++ b/rt-face-detection.yml @@ -0,0 +1,62 @@ +openapi: 3.0.4 +components: + schemas: + FaceDetectionItem: + title: "FaceDetectionItem" + type: object + properties: + FaceDetection: + $ref: "#/components/schemas/FaceDetection" + + FaceDetection: + title: "FaceDetection" + type: object + required: + - Count + - CountFalseDetection + - Res + properties: + Count: + type: integer + CountFalseDetection: + type: integer + Res: + type: array + items: + $ref: "#/components/schemas/FaceItem" + Reserved1: + type: integer + Reserved2: + type: integer + + FaceItem: + title: "FaceItem" + type: object + required: + - CoincidenceToPhotoArea + - FaceRect + - FieldRect + - GraphFieldNumber + - Landmarks + - LightType + - Orientation + - Probability + properties: + CoincidenceToPhotoArea: + type: integer + FaceRect: + $ref: "./common.yml#/components/schemas/RectangleCoordinates" + FieldRect: + $ref: "./common.yml#/components/schemas/RectangleCoordinates" + GraphFieldNumber: + type: integer + Landmarks: + type: array + items: + $ref: "./common.yml#/components/schemas/Point" + LightType: + $ref: "./common.yml#/components/schemas/Light" + Orientation: + type: integer + Probability: + type: integer diff --git a/rt-image-data.yml b/rt-image-data.yml index c298df8..81b8088 100644 --- a/rt-image-data.yml +++ b/rt-image-data.yml @@ -1,52 +1,46 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: - - GraphicsResult: - title: "Graphics (legacy)" - description: "Graphic fields extracted from one of the document sources. - Returns separate results for each provided page." + DocGraphicsInfoItem: + title: "DocGraphicsInfoItem" + type: object required: - DocGraphicsInfo - allOf: - - type: object - properties: - DocGraphicsInfo: - $ref: "#/components/schemas/GraphicFieldsList" - - $ref: "./rt.yml#/components/schemas/ResultItem" + properties: + DocGraphicsInfo: + $ref: "#/components/schemas/GraphicFieldsList" GraphicFieldsList: + title: "GraphicFieldsList" type: object required: - pArrayFields + - nFields properties: pArrayFields: type: array items: $ref: "#/components/schemas/GraphicField" + nFields: + description: "Number of pArrayFields array elements" + type: number GraphicField: + title: "GraphicField" + description: "Information about one graphic field - abstract class" type: object required: + - FieldRect - FieldType + - FieldName - image properties: + FieldRect: + $ref: "./common.yml#/components/schemas/RectangleCoordinates" FieldType: $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldType" + FieldName: + description: "Graphic field symbolic name" + type: string image: $ref: "./common.yml#/components/schemas/ImageData" - FieldRect: - description: "Coordinates of the graphic field in the normalized image of the document" - $ref: "./common.yml#/components/schemas/RectangleCoordinates" - RFID_OriginDG: - description: "Source data group file. Only for Result.RFID_GRAPHICS result." - type: integer - RFID_OriginDGTag: - description: "Index of the source record of the image with biometric information in the information data group. Only for Result.RFID_GRAPHICS result." - type: integer - RFID_OriginTagEntry: - type: integer - description: "Index of the template in the record with biometric data. Only for Result.RFID_GRAPHICS result." - RFID_OriginEntryView: - type: integer - description: "Index of the variant of the biometric data template. Only for Result.RFID_GRAPHICS result." diff --git a/rt-image-quality.yml b/rt-image-quality.yml index 89155c6..7bcc462 100644 --- a/rt-image-quality.yml +++ b/rt-image-quality.yml @@ -1,34 +1,35 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: - - ImageQualityResult: - title: "Image Quality Checks" - allOf: - - type: object - required: - - ImageQualityCheckList - properties: - ImageQualityCheckList: - $ref: "#/components/schemas/ImageQualityCheckList" - - $ref: "./rt.yml#/components/schemas/ResultItem" - + ImageQualityCheckListItem: + title: "ImageQualityCheckListItem" + type: object + required: + - ImageQualityCheckList + properties: + ImageQualityCheckList: + $ref: "#/components/schemas/ImageQualityCheckList" ImageQualityCheckList: + title: "ImageQualityCheckList" type: object required: - result - List + - Count properties: - result: - description: "Overall image quality status, combined from check statuses in the list." + result: # Overall image quality status, combined from check statuses in the list. $ref: "./common.yml#/components/schemas/CheckResult" List: type: array items: $ref: "#/components/schemas/ImageQualityCheck" + Count: + description: "Number of List array elements" + type: number ImageQualityCheckType: + title: "ImageQualityCheckType" type: integer description: "Image quality check type" enum: @@ -63,6 +64,7 @@ components: - "Signals if the document image has occlusion" InputImageQualityChecks: + title: "InputImageQualityChecks" type: string description: "Input image quality checks for the document processing" enum: @@ -96,10 +98,17 @@ components: - "Signals if the document image is bright enough" - "Signals if the document image has occlusion" - AreaArray: + title: "AreaArray" type: object + required: + - Count + - List + - Points properties: + Count: + description: "Number of elements in List and Points" + type: number List: type: array items: @@ -110,7 +119,10 @@ components: $ref: "#/components/schemas/PointArray" PointArray: + title: "PointArray" type: object + required: + - PointsList properties: PointsList: type: array @@ -118,7 +130,15 @@ components: $ref: "./common.yml#/components/schemas/Point" ImageQualityCheck: + title: "ImageQualityCheck" type: object + required: + - type + - result + - featureType + - mean + - std_dev + - probability properties: type: $ref: "#/components/schemas/ImageQualityCheckType" @@ -129,10 +149,13 @@ components: areas: $ref: "#/components/schemas/AreaArray" mean: + description: "Check mean value" type: number format: float std_dev: + description: "Check deviation value" type: number format: float probability: + description: "Check probability value" type: integer diff --git a/rt-images.yml b/rt-images.yml index ec74b62..8b8eb78 100644 --- a/rt-images.yml +++ b/rt-images.yml @@ -1,25 +1,28 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: - - ImagesResult: - title: "Images" - allOf: - - type: object - required: - - Images - properties: - Images: - $ref: "#/components/schemas/Images" - - $ref: "./rt.yml#/components/schemas/ResultItem" - + ImagesItem: + title: "ImagesItem" + type: object + required: + - Images + properties: + Images: + $ref: "#/components/schemas/Images" Images: + title: "Images" type: object required: - availableSourceList - fieldList properties: + fieldCount: + type: integer + description: "Fields count" + availableSourceCount: + type: integer + description: "Available sources count" availableSourceList: type: array items: @@ -30,10 +33,11 @@ components: $ref: "#/components/schemas/ImagesField" ImagesAvailableSource: + title: "ImagesAvailableSource" type: object required: + - containerType - source - - sourceName properties: containerType: $ref: "./rt.yml#/components/schemas/ContainerType" @@ -41,6 +45,7 @@ components: $ref: "./common.yml#/components/schemas/Source" ImagesField: + title: "ImagesField" type: object required: - fieldName @@ -55,22 +60,24 @@ components: type: array items: $ref: "#/components/schemas/ImagesFieldValue" + valueCount: + description: "Field value count" + type: number ImagesFieldValue: + title: "ImagesFieldValue" type: object required: - containerType - lightIndex - pageIndex - source - - value properties: source: $ref: "./common.yml#/components/schemas/Source" value: $ref: "./common.yml#/components/schemas/ImageBase64" - originalValue: - description: "Only for images from RFID. Image as was originally stored in the RFID chip." + originalValue: # Only for images from RFID. Image as was originally stored in the RFID chip. $ref: "./common.yml#/components/schemas/ImageBase64" originalPageIndex: description: "Original page index" @@ -81,9 +88,8 @@ components: $ref: "./common.yml#/components/schemas/Light" containerType: $ref: "./rt.yml#/components/schemas/ContainerType" - fieldRect: - description: "Only for images from VISUAL. Coordinates of the image in the normalized image of the document." + fieldRect: # Only for images from VISUAL. Coordinates of the image in the normalized image of the document. $ref: "./common.yml#/components/schemas/RectangleCoordinates" rfidOrigin: - description: "Only for images from RFID. Image location in RFID chip." - $ref: "./common.yml#/components/schemas/RfidOrigin" \ No newline at end of file + description: # Only for images from RFID. Image location in RFID chip. + $ref: "./common.yml#/components/schemas/RfidOrigin" diff --git a/rt-license.yml b/rt-license.yml index fdfe20a..2bb89be 100644 --- a/rt-license.yml +++ b/rt-license.yml @@ -1,15 +1,11 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: - - LicenseResult: - title: "License" - allOf: - - type: object - description: "Contains license" - required: - - License - properties: - License: - $ref: "./common.yml#/components/schemas/License" - - $ref: "./rt.yml#/components/schemas/ResultItem" + LicenseItem: + title: "LicenseItem" + type: object + required: + - License + properties: + License: + $ref: "./common.yml#/components/schemas/License" diff --git a/rt-mrz-detector.yml b/rt-mrz-detector.yml new file mode 100644 index 0000000..9c0241a --- /dev/null +++ b/rt-mrz-detector.yml @@ -0,0 +1,61 @@ +openapi: 3.0.4 +components: + schemas: + ResultMRZDetectorItem: + title: "ResultMRZDetectorItem" + type: object + required: + - ResultMRZDetector + properties: + ResultMRZDetector: + $ref: "#/components/schemas/ResultMRZDetector" + + ResultMRZDetector: + title: "ResultMRZDetector" + type: object + required: + - MRZFormat + - MRZRows + - MRZRowsNum + - boundingQuadrangle + properties: + MRZFormat: + type: integer + MRZRows: + type: array + items: + $ref: "#/components/schemas/MRZRowsItem" + MRZRowsNum: + type: integer + boundingQuadrangle: + type: array + items: + type: number + + MRZRowsItem: + title: "MRZRowsItem" + type: object + required: + - length + - maxLength + - symbols + properties: + length: + type: integer + maxLength: + type: integer + symbols: + type: array + items: + $ref: "#/components/schemas/Symbol" + + Symbol: + title: "Symbol" + type: object + required: + - boundingRect + properties: + boundingRect: + type: array + items: + type: integer diff --git a/rt-mrz-position.yml b/rt-mrz-position.yml new file mode 100644 index 0000000..a477095 --- /dev/null +++ b/rt-mrz-position.yml @@ -0,0 +1,11 @@ +openapi: 3.0.4 +components: + schemas: + MrzPositionItem: + title: "MrzPositionItem" + type: object + required: + - MrzPosition + properties: + MrzPosition: + $ref: "./common.yml#/components/schemas/DocumentPosition" diff --git a/rt-mrz-test-quality.yml b/rt-mrz-test-quality.yml new file mode 100644 index 0000000..21c0f82 --- /dev/null +++ b/rt-mrz-test-quality.yml @@ -0,0 +1,209 @@ +openapi: 3.0.4 +components: + schemas: + MRZTestQualityItem: + title: "MRZTestQualityItem" + type: object + required: + - MRZTestQuality + properties: + MRZTestQuality: + $ref: "#/components/schemas/MRZTestQuality" + + MRZTestQuality: + title: "MRZTestQuality" + type: object + required: + - CHECK_SUMS + - CONTRAST_PRINT + - DOC_FORMAT + - MRZ_FORMAT + - PRINT_POSITION + - STAIN_MRZ + - SYMBOLS_PARAM + - StrCount + - Strings + - TEXTUAL_FILLING + properties: + CHECK_SUMS: + $ref: "./common.yml#/components/schemas/CheckResult" + CONTRAST_PRINT: + $ref: "./common.yml#/components/schemas/CheckResult" + DOC_FORMAT: + type: integer + MRZ_FORMAT: + type: integer + PRINT_POSITION: + $ref: "./common.yml#/components/schemas/CheckResult" + STAIN_MRZ: + $ref: "./common.yml#/components/schemas/CheckResult" + SYMBOLS_PARAM: + $ref: "./common.yml#/components/schemas/CheckResult" + StrCount: + type: integer + Strings: + type: array + items: + $ref: "#/components/schemas/StringItem" + TEXTUAL_FILLING: + $ref: "./common.yml#/components/schemas/CheckResult" + + StringItem: + title: "StringItem" + type: object + required: + - ALIGNMENT_SYMBOLS_IN_STRING + - CHECK_SUMS + - ErrorPOSITION + - FieldCount + - Fields + - STRINGS_DISTANCE + - STRINGS_INTERVAL + - STRING_FILLING + - STRING_POSITION + - SYMBOLS_PARAM + - SizeError_ALIGNMENT + - SizeError_DISTANCE + - SizeError_INTERVAL + - StringAngle + - StringBorders + - SymbolsCount + - SymbolsEstimations + properties: + ALIGNMENT_SYMBOLS_IN_STRING: + $ref: "./common.yml#/components/schemas/CheckResult" + CHECK_SUMS: + $ref: "./common.yml#/components/schemas/CheckResult" + ErrorPOSITION: + $ref: "#/components/schemas/ErrorCoordinates" + FieldCount: + type: integer + Fields: + type: array + items: + $ref: "#/components/schemas/FieldItem" + STRINGS_DISTANCE: + $ref: "./common.yml#/components/schemas/CheckResult" + STRINGS_INTERVAL: + $ref: "./common.yml#/components/schemas/CheckResult" + STRING_FILLING: + $ref: "./common.yml#/components/schemas/CheckResult" + STRINGS_POSITION: + $ref: "./common.yml#/components/schemas/CheckResult" + SYMBOLS_PARAM: + $ref: "./common.yml#/components/schemas/CheckResult" + SizeError_ALIGNMENT: + type: number + SizeError_DISTANCE: + type: number + SizeError_INTERVAL: + type: number + StringAngle: + type: number + StringBorders: + $ref: "./common.yml#/components/schemas/RectangleCoordinates" + SymbolsCount: + type: integer + SymbolsEstimations: + type: array + items: + $ref: "#/components/schemas/SymbolEstimationItem" + + SymbolEstimationItem: + title: "SymbolEstimationItem" + type: object + required: + - ALIGNMENT_NEAREST_SYMBOLS + - CONTRAST_PRINT + - CONTRAST_SYMBOL + - CharSymbol + - EDGE + - EMPTINESS + - STAIN + - SYMBOLS_INTERVAL + - SYMBOL_PARAM + - SYMBOL_SIZE + - SizeErrorAlignWithNext + - SizeErrorAlignWithPrev + - SizeErrorIntervWithNext + - SizeErrorIntervWithPrev + - SizeErrorSymbolHeight + - SizeErrorSymbolWidth + - SymbolBounds + properties: + ALIGNMENT_NEAREST_SYMBOLS: + type: integer + CONTRAST_PRINT: + type: integer + CONTRAST_SYMBOL: + type: integer + CharSymbol: + type: integer + EDGE: + type: integer + EMPTINESS: + type: integer + STAIN: + type: integer + SYMBOLS_INTERVAL: + type: integer + SYMBOL_PARAM: + type: integer + SYMBOL_SIZE: + type: integer + SizeErrorAlignWithNext: + type: number + SizeErrorAlignWithPrev: + type: number + SizeErrorIntervWithNext: + type: number + SizeErrorIntervWithPrev: + type: number + SizeErrorSymbolHeight: + type: number + SizeErrorSymbolWidth: + type: number + SymbolBounds: + $ref: "./common.yml#/components/schemas/RectangleCoordinates" + + FieldItem: + title: "FieldItem" + type: object + required: + - FieldLength + - FieldPos + - FieldType + - TEST_RESULT + - ValidCheckSum + - reserved + properties: + FieldLength: + type: integer + FieldPos: + type: integer + FieldType: + type: integer + TEST_RESULT: + type: integer + ValidCheckSum: + type: integer + reserved: + type: integer + + ErrorCoordinates: + title: "ErrorPosition" + type: object + required: + - left + - top + - right + - bottom + properties: + Left: + type: number + Top: + type: number + Right: + type: number + Bottom: + type: number diff --git a/rt-ocr-lexical-analisis.yml b/rt-ocr-lexical-analysis.yml similarity index 81% rename from rt-ocr-lexical-analisis.yml rename to rt-ocr-lexical-analysis.yml index f5c0f35..0647b1f 100644 --- a/rt-ocr-lexical-analisis.yml +++ b/rt-ocr-lexical-analysis.yml @@ -1,32 +1,39 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: - - LexicalAnalysisResult: - title: "Lexical Analysis" - description: | - Lexical data analysis allows you to compare the results of reading the text data of the MRZ, - the document filling area, barcodes and data from the memory of the RFID chip for an additional - assessment of the authenticity of the document. Single result for all pages. - Consider using Result.TEXT type for more simplicity. - allOf: - - type: object - properties: - ListVerifiedFields: - $ref: "#/components/schemas/ListVerifiedFields" - - $ref: "./rt.yml#/components/schemas/ResultItem" - + ListVerifiedFieldsItem: + title: "ListVerifiedFields" + type: object + required: + - ListVerifiedFields + properties: + ListVerifiedFields: + $ref: "#/components/schemas/ListVerifiedFields" ListVerifiedFields: + title: "ListVerifiedFields" type: object + required: + - Count + - pFieldMaps properties: + Count: + description: "Number of pFieldMaps array elements" + type: number pFieldMaps: type: array items: $ref: "#/components/schemas/VerifiedFieldMap" + pDateFormat: + type: string VerifiedFieldMap: + title: "VerifiedFieldMap" type: object + required: + - wFieldType + - wLCID + - Matrix properties: wFieldType: $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" @@ -46,11 +53,11 @@ components: type: string Matrix: $ref: "#/components/schemas/ComparisonMatrix" - example: {FieldType: 185, Field_MRZ: "37", Field_Visual: "37", Matrix: [1,0,0,0,0,3,0,0,0,0]} ComparisonMatrix: + title: "ComparisonMatrix" type: array minItems: 10 maxItems: 10 @@ -74,6 +81,7 @@ components: example: [1,0,0,0,0,3,0,0,0,0] VerificationResult: + title: "VerificationResult" type: integer enum: - 0 diff --git a/rt-raw-image.yml b/rt-raw-image.yml index a16e6e1..99c8f61 100644 --- a/rt-raw-image.yml +++ b/rt-raw-image.yml @@ -1,15 +1,11 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: - - DocumentImageResult: - title: "Document Image" - description: "Contains document image." - allOf: - - type: object - required: - - RawImageContainer - properties: - RawImageContainer: - $ref: "./common.yml#/components/schemas/ImageData" - - $ref: "./rt.yml#/components/schemas/ResultItem" + RawImageContainerItem: + title: "RawImageContainerItem" + type: object + required: + - RawImageContainer + properties: + RawImageContainer: + $ref: "./common.yml#/components/schemas/ImageData" diff --git a/rt-rfid-binary-data.yml b/rt-rfid-binary-data.yml new file mode 100644 index 0000000..65a2222 --- /dev/null +++ b/rt-rfid-binary-data.yml @@ -0,0 +1,1205 @@ +openapi: 3.0.4 +components: + schemas: + TDocBinaryInfoItem: + title: "TDocBinaryInfoItem" + type: object + required: + - TDocBinaryInfo + properties: + TDocBinaryInfo: + $ref: "#/components/schemas/TDocBinaryInfo" + + TDocBinaryInfo: + title: "TDocBinaryInfo" + type: object + properties: + RFID_BINARY_DATA: + $ref: "#/components/schemas/BinaryData" + RFID_RAW_DATA: + type: array + items: + $ref: "#/components/schemas/RfidRawData" + + BinaryData: + title: "BinaryData" + description: "Structure is used for storing the results of one bar-code module reading." + type: object + properties: + RFID_Authentication_Info: + type: object + additionalProperties: true + RFID_MIFARE_Data_Validity: + type: object + additionalProperties: true + RFID_MIFARE_Data: + type: object + additionalProperties: true + RFID_EF_COM: + type: object + additionalProperties: true + RFID_DG1: + $ref: "#/components/schemas/RfidDG1" + RFID_DG2: + type: object + additionalProperties: true + RFID_DG3: + type: object + additionalProperties: true + RFID_DG4: + type: object + additionalProperties: true + RFID_DG5: + type: object + additionalProperties: true + RFID_DG6: + type: object + additionalProperties: true + RFID_DG7: + type: object + additionalProperties: true + RFID_DG8: + type: object + additionalProperties: true + RFID_DG9: + type: object + additionalProperties: true + RFID_DG10: + type: object + additionalProperties: true + RFID_DG11: + type: object + additionalProperties: true + RFID_DG12: + type: object + additionalProperties: true + RFID_DG13: + type: object + additionalProperties: true + RFID_DG14: + type: object + additionalProperties: true + RFID_DG15: + type: object + additionalProperties: true + RFID_DG16: + type: object + additionalProperties: true + RFID_EF_SOD: + type: object + additionalProperties: true + eID_DG1: + type: object + additionalProperties: true + eID_DG2: + type: object + additionalProperties: true + eID_DG3: + type: object + additionalProperties: true + eID_DG4: + type: object + additionalProperties: true + eID_DG5: + type: object + additionalProperties: true + eID_DG6: + type: object + additionalProperties: true + eID_DG7: + type: object + additionalProperties: true + eID_DG8: + type: object + additionalProperties: true + eID_DG9: + type: object + additionalProperties: true + eID_DG10: + type: object + additionalProperties: true + eID_DG11: + type: object + additionalProperties: true + eID_DG12: + type: object + additionalProperties: true + eID_DG13: + type: object + additionalProperties: true + eID_DG14: + type: object + additionalProperties: true + eID_DG15: + type: object + additionalProperties: true + eID_DG16: + type: object + additionalProperties: true + eID_DG17: + type: object + additionalProperties: true + eID_DG18: + type: object + additionalProperties: true + eID_DG19: + type: object + additionalProperties: true + eID_DG20: + type: object + additionalProperties: true + eID_DG21: + type: object + additionalProperties: true + eDL_COM: + type: object + additionalProperties: true + eDL_SOD: + type: object + additionalProperties: true + eDL_DG1: + type: object + additionalProperties: true + eDL_DG2: + type: object + additionalProperties: true + eDL_DG3: + type: object + additionalProperties: true + eDL_DG4: + type: object + additionalProperties: true + eDL_DG5: + type: object + additionalProperties: true + eDL_DG6: + type: object + additionalProperties: true + eDL_DG7: + type: object + additionalProperties: true + eDL_DG8: + type: object + additionalProperties: true + eDL_DG9: + type: object + additionalProperties: true + eDL_DG10: + type: object + additionalProperties: true + eDL_DG11: + type: object + additionalProperties: true + eDL_DG12: + type: object + additionalProperties: true + eDL_DG13: + type: object + additionalProperties: true + eDL_DG14: + type: object + additionalProperties: true + Visible_Digital_Seal: + type: object + additionalProperties: true + Visible_Digital_Seal_NC: + type: object + additionalProperties: true + Digital_Signature: + type: object + additionalProperties: true + RFID_Session_Data: + $ref: "#/components/schemas/RfidSessionData" + RFID_Session_Data_Status: + $ref: "./rt-status.yml#/components/schemas/detailsRFID" + RFID_ePassp_Directory: + description: Indexes of groups that aren't read + type: array + items: + $ref: "./e-rfid-data-file-type.yml#/components/schemas/RfidDataFileType" + + RfidDG1: + title: "RfidDG1" + description: "Structure used to store the contents of EF.DG1 informational data group of + ePassport application – document MRZ data" + type: object + required: + - Type + - DocumentID + - DocumentType + - State + - Holder + - DocumentNumber + - CheckDigitDocumentNumber + - Nationality + - Birthday + - CheckDigitBirthday + - Sex + - ExpiryDate + - CheckDigitExpiryDate + - OptionalData + - CheckDigitOptionalData + - CheckDigitComposite + properties: + Type: + $ref: "./e-rfid-data-group-type-tag.yml#/components/schemas/RfidDataGroupTypeTag" + DocumentID: + $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentFormat" + DocumentType: + description: "Symbolic code of document type" + type: string + State: + description: "Symbolic code of document issuing state" + type: string + Holder: + description: "DO’s name and surname" + type: string + DocumentNumber: + description: "Document number" + type: string + CheckDigitDocumentNumber: + description: "Check digit of document number" + type: number + Nationality: + description: "Symbolic code of DO’s nationality" + type: string + Birthday: + description: "DO’s date of birth" + type: string + CheckDigitBirthday: + description: "Check digit of DO’s date of birth" + type: number + Sex: + description: "DO’s sex" + type: string + ExpiryDate: + description: "Term of validity of the document" + type: string + CheckDigitExpiryDate: + description: "Check digit of term of validity of the document" + type: number + OptionalData: + description: "DO’s personal number or other additional data" + type: string + CheckDigitOptionalData: + description: "Check digit of additional data" + type: number + CheckDigitComposite: + description: "General check digit" + type: number + + RfidSessionData: + title: "RfidSessionData" + description: "Structure is used to describe the results of work with the SDK within the context of the current communication + session with electronic document" + type: object + required: + - Applications + - AccessControls + - CardProperties + - ExtLeSupport + - ProcessTime + - RootFiles + - TotalBytesSent + - TotalBytesReceived + - Session_key + - Session_terminal + - Session_procedure + - SecurityObjects + properties: + VirtualMode: + description: "Sign of virtual session when working with loaded data from a previous communication session + with the electronic document" + type: string + SDKVersion: + description: "Text SDKVersion value in format A.B (e.g. 3.1)" + type: string + DriverVersion: + description: "Text DriverVersion value in format A.B.C.D (e.g. 6.2.5.4)" + type: string + FirmwareVersion: + description: "Text FirmwareVersion value in format A.B (e.g. 5.19)" + type: string + Applications: + description: "List of containers to store information about the involved applications of electronic document" + type: array + items: + $ref: "#/components/schemas/RfidApplication" + AccessControls: + description: "List of containers to store information about the supported procedures of authentication and secure data access + within the context of the session" + type: array + items: + $ref: "#/components/schemas/RfidAccessControlInfo" + CardProperties: + $ref: "#/components/schemas/RfidCardPropertiesExt" + ExtLeSupport: + $ref: "./e-rfid-error-codes.yml#/components/schemas/RFIDErrorCodes" + ProcessTime: + description: "Time of processing, milliseconds" + type: number + RootFiles: + description: "List of containers to store information about the read files of the root Master File" + type: array + items: {} + TotalBytesSent: + description: "Total number of bytes transmitted to the RFID-chip during the whole session" + type: number + TotalBytesReceived: + description: "Total number of bytes received from the RFID-chip during the whole session" + type: number + Session_key: + $ref: "#/components/schemas/RfidAccessKey" + Session_terminal: + $ref: "#/components/schemas/RfidTerminal" + Session_procedure: + $ref: "#/components/schemas/RfidAuthenticationProcedureType" + SecurityObjects: + description: "List of containers to store information about the detected document security objects" + type: array + items: + $ref: "#/components/schemas/RfidSecurityObject" + Status: + $ref: "./common.yml#/components/schemas/CheckResult" + + RfidSecurityObject: + title: "RfidSecurityObject" + description: "Structure is used to describe the contents of a single document security object (SO) and the results of its check + within the context of the communication session with electronic document" + type: object + required: + - Version + - ObjectType + - FileReference + - Notifications + - SignerInfos + properties: + Version: + description: "Security object version" + type: number + ObjectType: + description: "Identifier of the security object" + type: string + FileReference: + description: "Reference to the source file of the security object data" + type: number + Notifications: + description: "List of remarks arisen during the analysis of SO data structure." + type: array + items: + $ref: "./e-parsing-notification-codes.yml#/components/schemas/ParsingNotificationCodes" + SignerInfos: + description: "List of containers to store information about digital signature objects contained in the SO" + type: array + items: + $ref: "#/components/schemas/RfidSignerInfoEx" + + RfidSignerInfoEx: + title: "RfidSignerInfoEx" + description: "Structure is used to describe the contents of a single copy of + digital signature of the document security object and the results of its check within the + context of the communication session with electronic document" + type: object + required: + - Version + - Issuer + - SerialNumber + - SubjectKeyIdentifier + - DigestAlgorithm + - SignedAttributes + - SignatureAlgorithm + - Signature + - PA_Status + - CertificateChain + - DataToHash + - Notifications + properties: + Version: + description: "Version of SignerInfo ASN.1 structure" + type: number + Issuer: + $ref: "#/components/schemas/RfidDistinguishedName" + SerialNumber: + $ref: "#/components/schemas/TrfFtBytes" + SubjectKeyIdentifier: + $ref: "#/components/schemas/TrfFtBytes" + DigestAlgorithm: + description: "Hash algorithm identifier (OID) for digital signature generation" + type: string + SignedAttributes: + description: "List of the signed attributes" + type: array + items: + $ref: "#/components/schemas/RfidAttributeData" + SignatureAlgorithm: + description: "Digital signature algorithm identifier (OID)" + type: string + Signature: + $ref: "#/components/schemas/TrfFtBytes" + PA_Status: + $ref: "./e-rfid-error-codes.yml#/components/schemas/RFIDErrorCodes" + CertificateChain: + description: "Certificate chain, used for the digital signature verification." + type: array + items: + $ref: "#/components/schemas/RfidCertificateEx" + DataToHash: + description: "Binary data array used to calculate the hash value for digital signature verification. Base64 encoded." + type: string + Notifications: + type: array + items: + $ref: "./e-parsing-notification-codes.yml#/components/schemas/ParsingNotificationCodes" + + RfidCertificateEx: + title: "RfidCertificateEx" + description: "Structure is used to describe the certificate contents used for the digital signature verification + of the document security object within the context of the communication session with electronic document." + type: object + required: + - Version + - SerialNumber + - SignatureAlgorithm + - Issuer + - Validity + - Subject + - SubjectPKAlgorithm + - Extensions + - Notifications + - Origin + - Type + - FileName + - PA_Status + properties: + Version: + description: "Version of Certificate ASN.1 structure" + type: number + SerialNumber: + description: "Certificate serial number. Base64 encoded." + type: string + SignatureAlgorithm: + description: "Certificate digital signature algorithm identifier (OID); + String in the format S1 (S2), where S1 – algorithm name, S2 – identifier (OID string)." + type: string + Issuer: + $ref: "#/components/schemas/RfidDistinguishedName" + Validity: + $ref: "#/components/schemas/RfidValidity" + Subject: + $ref: "#/components/schemas/RfidDistinguishedName" + SubjectPKAlgorithm: + description: "Certificate public key algorithm identifier (OID); + String in the format S1 (S2), where S1 – algorithm name, S2 – identifier (OID string)." + type: string + Extensions: + description: "List of the certificate extensions" + type: array + items: + $ref: "#/components/schemas/RfidPkiExtension" + Notifications: + description: "List of remarks arisen during the analysis of the certificate data + structure and its validity verification." + type: array + items: + $ref: "./e-parsing-notification-codes.yml#/components/schemas/ParsingNotificationCodes" + Origin: + $ref: "#/components/schemas/RfidCertificateOrigin" + Type: + $ref: "#/components/schemas/RfidCertificateType" + FileName: + $ref: "#/components/schemas/TrfFtString" + PA_Status: + $ref: "./e-rfid-error-codes.yml#/components/schemas/RFIDErrorCodes" + + RfidPkiExtension: + title: "RfidPkiExtension" + description: "Extension identifier (OID, ASCII string); + Contents of the identifier in the format S1 (S2), where S1 – attribute name, S2 – identifier (OID string)" + type: object + required: + - Type + - Data + properties: + Type: + description: "Extension identifier (OID, ASCII string); + Contents of the identifier in the format S1 (S2), where S1 – attribute name, S2 – identifier (OID string)" + type: string + Data: + description: "Extension binary data. Base64 encoded." + type: string + + RfidValidity: + title: "RfidValidity" + description: "Structure contains information on a certificate validity." + type: object + required: + - NotBefore + - NotAfter + properties: + NotBefore: + $ref: "#/components/schemas/TrfFtString" + NotAfter: + $ref: "#/components/schemas/TrfFtString" + + RfidAttributeData: + title: "RfidAttributeData" + description: "Structure contains the data of one attribute of the digital signature object." + type: object + required: + - Type + - Data + properties: + Type: + description: "Contents of the identifier in the format S1 (S2), where S1 – attribute name, S2 – identifier (OID string)" + type: string + Data: + description: "Attribute binary data. Base64 encoded." + type: string + + RfidDistinguishedName: + title: "RfidDistinguishedName" + description: "Contents of the identifier in binary form. Base64 encoded." + type: object + required: + - Data + - FriendlyName + - Attributes + properties: + Data: + description: "Contents of the identifier in binary form. Base64 encoded." + type: string + FriendlyName: + $ref: "#/components/schemas/TrfFtString" + Attributes: + description: "List of individual attributes contained in the identifier" + type: array + items: + $ref: "#/components/schemas/RfidAttributeName" + + RfidAttributeName: + title: "RfidAttributeName" + description: "Structure contains information that serves as the distinguished name (identifier) of an object." + type: object + required: + - Type + - Value + properties: + Type: + description: "Attribute identifier (OID ASCII string); contents of the identifier in the format S1 (S2), + where S1 – attribute name, S2 – identifier (OID string)" + type: string + Value: + $ref: "#/components/schemas/TrfFtString" + + TrfFtString: + title: "TrfFtString" + description: "Structure is used to store information about the numeric field (4 bytes) that is a part of one of the informational + data groups." + type: object + required: + - Data + properties: + Type: + type: integer + Status: + description: "Result of logical analysis of compliance of the contents of the field + with the requirements of the specification" + type: integer + Format: + description: "Mask of format of text information (for example, «YYMMDD» for date of birth)" + type: string + Data: + description: "Numeric value." + type: string + + RfidApplication: + title: "RfidApplication" + description: "Structure is used to describe the contents of a single LDS application and their analysis within the context + of the communication session with electronic document" + type: object + required: + - Type + - Status + - ApplicationID + - Version + - UnicodeVersion + - DataHashAlgorithm + - Files + properties: + Type: + $ref: "#/components/schemas/RfidApplicationType" + Status: + $ref: "./e-rfid-error-codes.yml#/components/schemas/RFIDErrorCodes" + ApplicationID: + description: "Application identifier" + type: string + Version: + description: "Version of the application" + type: string + UnicodeVersion: + description: "Unicode version for application" + type: string + DataHashAlgorithm: + description: "Algorithm for calculating hash values for files for the procedure of PA" + type: string + Files: + description: "List of containers to store information about the read files of the application" + type: array + items: + $ref: "#/components/schemas/RfidDataFile" + + RfidApplicationType: + title: "RfidApplicationType" + type: integer + description: "Enumeration contains a set of constants that define the type + of application within the context of the communication session with electronic document" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 0 + x-enum-descriptions: + - "Not defined" + - "ePassport application" + - "eID application" + - "eSign application" + - "eDL application" + - "TravelRecords application" + - "VisaRecords application" + - "AddBiometrics application" + - "Digital Travel Credentials" + - "Master File" + x-enum-varnames: + - "UNSPECIFIED" + - "E_PASSPORT" + - "E_ID" + - "E_SIGN" + - "E_DL" + - "LDS2_TravelRecords" + - "LDS2_VisaRecords" + - "LDS2_AddBiometrics" + - "eDTC_PC" + - "ROOT_FILES" + + RfidDataFile: + title: "RfidDataFile" + description: "Structure is used to describe the contents of a single file of the LDS of electronic document and the analysis + of its contents within the context of the communication session with electronic document" + type: object + required: + - Type + - ReadingStatus + properties: + FileID: + description: "File identifier. Each byte of FileID represented by its hexadecimal value. The individual bytes are separated by spaces (e.g. 01 1E)" + type: string + Type: + $ref: "./e-rfid-data-file-type.yml#/components/schemas/RfidDataFileType" + FileData: + $ref: "#/components/schemas/TrfFtBytes" + ReadingStatus: + $ref: "./e-rfid-error-codes.yml#/components/schemas/RFIDErrorCodes" + ReadingTime: + description: "Time of reading, milliseconds" + type: number + PA_Status: + $ref: "./e-rfid-error-codes.yml#/components/schemas/RFIDErrorCodes" + Notifications: + description: "List of remarks arisen when reading data from the memory of the chip and analysing their ASN.1-structure." + type: array + items: + $ref: "./e-parsing-notification-codes.yml#/components/schemas/ParsingNotificationCodes" + DocFields_Text: + description: "List of document text fields formed on the basis of the file contents" + type: array + items: + $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" + DocFields_Graphics: + description: "List of document graphic fields formed on the basis of the file contents" + type: array + items: + $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldType" + DocFields_Originals: + description: "List of the original binary representation of graphic document fields formed on the basis of the file contents" + type: array + items: + $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldType" + ParsedData: + $ref: "#/components/schemas/ParsedData" + SecurityObject_Certificates: + $ref: "#/components/schemas/SecurityObjectCertificates" + + SecurityObjectCertificates: + title: "SecurityObjectCertificates" + type: object + properties: + Certificate_Data: + $ref: "#/components/schemas/CertificateData" + + CertificateData: + title: "CertificateData" + type: object + required: + - Data + - Length + properties: + Data: + type: string + Length: + type: integer + + ParsedData: + title: "ParsedData" + properties: + ParsingNotifications: + type: array + items: + type: integer + format: int64 + + TrfFtBytes: + title: "TrfFtBytes" + description: "Structure is used to store an array of binary information that is a part of one of the informational data groups" + type: object + required: + - Type + - Status + - Length + - Data + properties: + Type: + description: "Logical type of the field" + type: integer + Status: + description: "Result of logical analysis of compliance of the contents of the field + with the requirements of the specification" + type: number + Length: + description: "Length of Data array" + type: number + Data: + description: "Binary data array. Base64 encoded." + type: string + nullable: true + + RfidAccessControlInfo: + title: "RfidAccessControlInfo" + description: "Structure is used to describe the results of a single authentication procedure or a procedure of secure data access + within the context of the communication session with electronic document" + type: object + required: + - Type + - Status + - Notifications + properties: + Type: + $ref: "#/components/schemas/RfidAccessControlProcedureType" + Status: + $ref: "./e-rfid-error-codes.yml#/components/schemas/RFIDErrorCodes" + ActiveOptionIdx: + description: "Index of the active variant of the procedure" + type: number + Notifications: + description: "List of remarks arisen during the procedure." + type: array + items: + $ref: "./e-parsing-notification-codes.yml#/components/schemas/ParsingNotificationCodes" + AccessControlOptions: + description: "List of structures with are used to describe the variants of the authentication or secure data access procedure + performance within the context of the communication session with electronic document" + type: array + items: {} + + RfidAccessControlProcedureType: + title: "RfidAccessControlProcedureType" + type: integer + description: "Enumeration contains a set of constants that + define the type of authentication or secure data access procedure" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 10 + - 11 + x-enum-descriptions: + - "Type is not defined" + - "BAC/BAP" + - "PACE" + - "CA" + - "TA" + - "AA" + - "RI" + - "Card info" + - "DTC info" + x-enum-varnames: + - "UNDEFINED" + - "BAC" + - "PACE" + - "CA" + - "TA" + - "AA" + - "RI" + - "CARD_INFO" + - "DTC_INFO" + + RfidCardPropertiesExt: + title: "RfidCardPropertiesExt" + description: "Structure is used to store extended information about the + characteristics of the RFID-chip located in the scope of the reader" + type: object + required: + - RFID_Type + - Baudrate1 + - Baudrate2 + - Support_4 + - ChipType_A + - Support_Mifare + - MifareMemory + - UID + - ATQ_A + - SAK + - ATQ_B + - BitRateS + - BitRateR + - ATR + properties: + RFID_Type: + $ref: "#/components/schemas/RfidType" + Baudrate1: + description: "Numeric Baudrate1 value in hexadecimal format (e.g. 0x0000000F)" + type: string + Baudrate2: + description: "Numeric Baudrate2 value in hexadecimal format" + type: string + Support_4: + description: "Boolean Support_4 value" + type: boolean + ChipType_A: + $ref: "#/components/schemas/RfidAChip" + Support_Mifare: + description: "Sign of support for ISO/IEC 14443-3 data exchange protocol" + type: boolean + MifareMemory: + description: "Amount of operational memory MIFARE® of the chip, kilobytes" + type: number + UID: + description: "UID contents in text format. Each byte is represented by its hexadecimal value. The individual bytes are separated + by spaces (e.g. F9 4F 41 60)" + type: string + ATQ_A: + description: "Reply of the «A» type chip to «REQA» command of ISO/IEC 14443-3 + protocol (Answer To Request, Type A – ATQA) – for the internal use by + the main control library" + SAK: + description: "Response of type-A RFID-chip to SELECT command of ISO/IEC 14443-3 protocol (Select Acknowledge, SAK)." + ATQ_B: + description: "ATQ_B contents in text format. Each byte is represented by its hexadecimal value. The individual bytes are + separated by spaces (e.g. 50 F9 4F 41 60 00 00 00 00 77 81 81)" + BitRateS: + $ref: "#/components/schemas/RfidBaudRate" + BitRateR: + $ref: "#/components/schemas/RfidBaudRate" + ATR: + description: "ATR-string of RFID-chip" + type: string + + RfidType: + title: "RfidType" + type: integer + description: "Enumeration contains a set of constants specifying the type of the RFID-chip + by the physical parameters of connection between antennas of the chip and the reader" + enum: + - 0 + - 1 + - 2 + x-enum-descriptions: + - "Unknown" + - "Type A" + - "Type B" + x-enum-varnames: + - "UNKNOWN" + - "A" + - "B" + + RfidAChip: + title: "RfidAChip" + type: integer + description: "Enumeration contains a set of constants specifying the type of the RFIDchip from MIFARE® family + (for chips of type A)" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + x-enum-descriptions: + - "Unknown" + - "MIFARE® 1K" + - "MIFARE® 4K" + - "MIFARE® Ultralight" + - "MIFARE® DESFire" + - "MIFARE® ProX or SmartMX xD(T)" + x-enum-varnames: + - "UNKNOWN" + - "MIFARE_1K" + - "MIFARE_4K" + - "MIFARE_ULTRALIGHT" + - "MIFARE_DES_FIRE" + - "MIFARE_PROX" + + RfidBaudRate: + title: "RfidBaudRate" + type: integer + description: "Enumeration contains a set of constants specifying the rate of data exchange between the reader and the RFID-chip" + enum: + - 0 + - 1 + - 2 + - 4 + - 8 + - 16 + - 32 + - 64 + x-enum-descriptions: + - "Unknown" + - "106 bits/s" + - "212 bits/s" + - "424 bits/s" + - "848 bits/s" + - "1695 bits/s" + - "3390 bits/s" + - "6780 bits/s" + x-enum-varnames: + - "UNKNOWN" + - "RFBR_106" + - "RFBR_212" + - "RFBR_424" + - "RFBR_848" + - "RFBR_1695" + - "RFBR_3390" + - "RFBR_6780" + + RfidAccessKey: + title: "RfidAccessKey" + description: "Structure is used to describe the contents of secure data access key within + the context of the communication session with electronic document" + type: object + required: + - AccessKey + - KeyType + - AccessType + - CheckFullKeyMatching + properties: + AccessKey: + description: "Key contents" + type: string + KeyType: + $ref: "#/components/schemas/RfidPasswordType" + AccessType: + $ref: "#/components/schemas/RfidAccessControlProcedureType" + CheckFullKeyMatching: + description: "Logical sign of the need for a full comparison of AccessKey + contents with the contents of DG1 (MRZ) data group" + type: boolean + + RfidPasswordType: + title: "RfidPasswordType" + type: integer + description: "Enumeration contains a set of constants specifying the rate of data exchange between the reader and the RFID-chip" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + x-enum-descriptions: + - "Unknown type" + - "MRZ" + - "CAN" + - "PIN" + - "PUK" + - "eSign-PIN" + - "Scanning Area Identifier (for eDL application)" + - "MRZ hash" + x-enum-varnames: + - "UNKNOWN" + - "MRZ" + - "CAN" + - "PIN" + - "PUK" + - "PIN_E_SIGN" + - "SAI" + - "MRZ_HASH" + + RfidTerminal: + title: "RfidTerminal" + description: "Structure is used to describe the terminal type within the context of the + communication session with electronic document" + type: object + required: + - TermType + - AuthReq + - AuthReq2 + properties: + TermType: + $ref: "#/components/schemas/RfidTerminalType" + AuthReq: + description: "Declared (set) combination of flags of access rights to the functionality of the document (combination of + eRfidTerminalAuthorizationRequirement values)" + type: number + AuthReq2: + description: "Declared (set) combination of flags of access rights to the functionality of the document (combination of + RfidTerminalAuthorizationRequirement values)" + type: number + + RfidTerminalType: + title: "RfidTerminalType" + type: integer + description: "Enumeration contains a set of constants that define the type + of terminal within the context of the communication session with electronic document" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + x-enum-descriptions: + - "Not defined" + - "Inspection system" + - "Authentication terminal" + - "Signature terminal" + - "Unauthenticated terminal" + x-enum-varnames: + - "UNDEFINED" + - "INSPECTION_SYSTEM" + - "AUTHENTICATION_TERMINAL" + - "SIGNATURE_TERMINAL" + - "UNAUTHENTICATED_TERMINAL" + + RfidAuthenticationProcedureType: + title: "RfidAuthenticationProcedureType" + type: integer + description: "Enumeration contains a set of constants that define the type of performed procedure of document authentication + within the current session" + enum: + - 0 + - 1 + - 2 + - 3 + x-enum-descriptions: + - "Not defined" + - "Standard authentication procedure" + - "Advanced authentication procedure" + - "General authentication procedure" + x-enum-varnames: + - "UNDEFINED" + - "STANDARD" + - "ADVANCED" + - "GENERAL" + + RfidCertificateOrigin: + title: "RfidCertificateOrigin" + type: integer + description: "Enumeration contains a set of constants that define the source of certificate used in the procedure + of document security object digital signature verification" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + x-enum-descriptions: + - "The source is not defined" + - "Local PKD" + - "Document security object" + - "User-defined" + - "Contents of the Master List" + - "Security object of the Master List" + - "Security object of the Defect List" + - "Security object of the Deviation List" + - "Security object of the Black List" + x-enum-varnames: + - "UNDEFINED" + - "PKD" + - "SECURITY_OBJECT" + - "USER_DEFINED" + - "MASTER_LIST_PKD" + - "MASTER_LIST_SO" + - "DEFECT_LIST_SO" + - "DEVIATION_LIST_SO" + - "BLACK_LIST_SO" + + RfidCertificateType: + title: "RfidCertificateType" + type: integer + description: "Enumeration contains a set of constants that define the type + of certificate used in the procedure of document security object digital signature verification" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + - 10 + - 11 + x-enum-descriptions: + - "Type is not defined" + - "CSCA" + - "CSCA-link" + - "DS" + - "Master List signer" + - "Deviaton List signer" + - "Defect List signer" + - "Black List signer" + - "LDS 2" + - "Barcode signer (VDS)" + - "Barcode signer (VDS for non-constrained environment)" + - "DTC signer" + x-enum-varnames: + - "UNDEFINED" + - "CSCA" + - "CSCA_LINK" + - "DS" + - "MLS" + - "DEV_LS" + - "DEF_LS" + - "BLS" + - "LDS2" + - "BCS" + - "BCS_NC" + - "DTCS" + + RfidRawData: + title: "RfidRawData" + type: object + required: + - Data + - FieldType + properties: + Data: + type: string + FieldType: + type: integer diff --git a/rt-rfid-graphics-info.yml b/rt-rfid-graphics-info.yml new file mode 100644 index 0000000..c8a5527 --- /dev/null +++ b/rt-rfid-graphics-info.yml @@ -0,0 +1,61 @@ +openapi: 3.0.4 +components: + schemas: + TOriginalRFIDGraphicsInfoItem: + title: "TOriginalRFIDGraphicsInfoItem" + type: object + required: + - TOriginalRFIDGraphicsInfo + properties: + TOriginalRFIDGraphicsInfo: + $ref: "#/components/schemas/TOriginalRFIDGraphicsInfo" + + TOriginalRFIDGraphicsInfo: + title: "TOriginalRFIDGraphicsInfo" + type: object + required: + - RFID_ORIGINAL_GRAPH_DATA + properties: + RFID_ORIGINAL_GRAPH_DATA: + type: array + items: + $ref: "#/components/schemas/GraphData" + + GraphData: + title: "GraphData" + type: object + required: + - FieldType + - File_Image + - GraphicsType + - OriginDG + - OriginDGTag + - OriginEntryView + - OriginTagEntry + properties: + FieldType: + type: integer + File_Image: + $ref: "#/components/schemas/FileImage" + GraphicsType: + type: integer + OriginDG: + type: integer + OriginDGTag: + type: integer + OriginEntryView: + type: integer + OriginTagEntry: + type: integer + + FileImage: + title: "FileImage" + type: object + required: + - Data + - Length + properties: + Data: + type: string + Length: + type: integer diff --git a/rt-rfid-text-data.yml b/rt-rfid-text-data.yml new file mode 100644 index 0000000..10551d0 --- /dev/null +++ b/rt-rfid-text-data.yml @@ -0,0 +1,50 @@ +openapi: 3.0.4 +components: + schemas: + RFIDDocVisualExtendedInfoItem: + title: "RFIDDocVisualExtendedInfoItem" + type: object + required: + - DocVisualExtendedInfo + properties: + DocVisualExtendedInfo: + $ref: "#/components/schemas/RFIDDocVisualExtendedInfo" + + RFIDDocVisualExtendedInfo: + title: "RFIDDocVisualExtendedInfo" + type: object + description: "Container for extracted text fields. Fields are identified by type and language" + required: + - nFields + - pArrayFields + properties: + nFields: + description: "Number of pArrayFields array elements" + type: number + pArrayFields: + type: array + items: + $ref: "#/components/schemas/RFIDDocVisualExtendedField" + + RFIDDocVisualExtendedField: + title: "RFIDDocVisualExtendedField" + allOf: + - $ref: "./common.yml#/components/schemas/VisualExtendedFieldItem" + - $ref: "#/components/schemas/RFIDDocVisualExtendedFieldItem" + + RFIDDocVisualExtendedFieldItem: + title: "RFIDDocVisualExtendedFieldItem" + type: object + required: + - OriginDG + - OriginTagEntry + properties: + OriginDG: + type: integer + OriginDGTag: + type: integer + OriginTagEntry: + description: "Record index of the text field source in the data group" + type: number + OriginEntryView: + type: integer diff --git a/rt-status.yml b/rt-status.yml index f394618..b0cd7ed 100644 --- a/rt-status.yml +++ b/rt-status.yml @@ -1,53 +1,44 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: + StatusItem: + title: "StatusItem" + type: object + required: + - Status + properties: + Status: + $ref: "#/components/schemas/Status" - StatusResult: - title: "Status" - allOf: - - type: object - required: - - Status - properties: - Status: - $ref: "#/components/schemas/Status" - - $ref: "./rt.yml#/components/schemas/ResultItem" - - - # $ref with description doesnt work right now, waiting for OAS 3.1 (comming soon) - # allOf should be used here to replace description from CheckResult - # see https://github.com/OAI/OpenAPI-Specification/issues/556#issuecomment-192007034 - # but java codegen produce invalid code for allOf `int complete=null` Status: + title: "Status" type: object required: - overallStatus - optical + - portrait + - rfid + - stopList - detailsOptical properties: - overallStatus: - description: "Overall checks status. Root status." + overallStatus: # Overall checks status. Rootx status $ref: "./common.yml#/components/schemas/CheckResult" - optical: - description: "Overall optical checks combined status" + optical: # Overall optical checks combined status $ref: "./common.yml#/components/schemas/CheckResult" - portrait: - description: "Portrait comparison status" + portrait: # Portrait comparison status $ref: "./common.yml#/components/schemas/CheckResult" - rfid: - description: "Overall RFID checks combined status" + rfid: # Overall RFID checks combined status $ref: "./common.yml#/components/schemas/CheckResult" - stopList: - description: "Stop list check status" + stopList: # Stop list check status $ref: "./common.yml#/components/schemas/CheckResult" detailsRFID: - description: "Details on performed RFID checks" $ref: "#/components/schemas/detailsRFID" detailsOptical: - description: "Details on performed optical checks" $ref: "#/components/schemas/detailsOptical" detailsOptical: + title: "detailsOptical" + description: "Details on performed optical checks" type: object required: - overallStatus @@ -59,32 +50,29 @@ components: - security - text properties: - overallStatus: - description: "Overall optical checks combined status" + overallStatus: # Overall optical checks combined status $ref: "./common.yml#/components/schemas/CheckResult" - docType: - description: "Status of document type recognition" + docType: # Status of document type recognition $ref: "./common.yml#/components/schemas/CheckResult" - expiry: - description: "Status of document expiration" + expiry: # Status of document expiration $ref: "./common.yml#/components/schemas/CheckResult" - imageQA: - description: "Status of document image quality check" + imageQA: # Status of document image quality check $ref: "./common.yml#/components/schemas/CheckResult" - mrz: - description: "Status of document MRZ" + mrz: # Status of document MRZ $ref: "./common.yml#/components/schemas/CheckResult" pagesCount: description: "Number of processed pages in the document" type: integer - security: - description: "Authenticity verification status" + security: # Authenticity verification status $ref: "./common.yml#/components/schemas/CheckResult" - text: - description: "Status of text fields analysis" + text: # Status of text fields analysis $ref: "./common.yml#/components/schemas/CheckResult" + vds: + type: integer detailsRFID: + title: "detailsRFID" + description: "Details on performed RFID checks" type: object required: - overallStatus @@ -95,24 +83,17 @@ components: - PACE - TA properties: - overallStatus: - description: "Overall RFID checks combined status" + overallStatus: # Overall RFID checks combined status $ref: "./common.yml#/components/schemas/CheckResult" - AA: - description: "Active Authentication status" + AA: # Active Authentication status $ref: "./common.yml#/components/schemas/CheckResult" - BAC: - description: "Basic Access Control (BAC) status" + BAC: # Basic Access Control (BAC) status $ref: "./common.yml#/components/schemas/CheckResult" - CA: - description: "Chip Authentication status" + CA: # Chip Authentication status $ref: "./common.yml#/components/schemas/CheckResult" - PA: - description: "Passive Authentication status" + PA: # Passive Authentication status $ref: "./common.yml#/components/schemas/CheckResult" - PACE: - description: "Password Authenticated Connection Establishment (PACE) status" + PACE: # Password Authenticated Connection Establishment (PACE) status $ref: "./common.yml#/components/schemas/CheckResult" - TA: - description: "Terminal Authentication status" + TA: # Terminal Authentication status $ref: "./common.yml#/components/schemas/CheckResult" diff --git a/rt-text-data.yml b/rt-text-data.yml index f7f1d67..f3fb5ce 100644 --- a/rt-text-data.yml +++ b/rt-text-data.yml @@ -1,105 +1,43 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: - - TextDataResult: - title: "Text Data (legacy)" - description: "Text fields extracted from one document source. - Contains results of specific source for each provided page." - allOf: - - type: object - properties: - DocVisualExtendedInfo: - $ref: "#/components/schemas/DocVisualExtendedInfo" - - $ref: "./rt.yml#/components/schemas/ResultItem" + DocVisualExtendedInfoItem: + title: "DocVisualExtendedInfoItem" + type: object + required: + - DocVisualExtendedInfo + properties: + DocVisualExtendedInfo: + $ref: "#/components/schemas/DocVisualExtendedInfo" DocVisualExtendedInfo: + title: "DocVisualExtendedInfo" type: object description: "Container for extracted text fields. Fields are identified by type and language" required: + - nFields - pArrayFields properties: + nFields: + description: "Number of pArrayFields array elements" + type: number pArrayFields: type: array items: $ref: "#/components/schemas/DocVisualExtendedField" DocVisualExtendedField: + title: "DocVisualExtendedField" type: object - required: - - wFieldType - - FieldName - - wLCID - properties: - wFieldType: - $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" - FieldName: - description: "Field name. Only use to search values for fields with fieldType=50(other). In general, use wFieldType for lookup." - type: string - wLCID: - $ref: "./e-lcid.yml#/components/schemas/LCID" - StringsResult: - type: array - description: "Array of recognizing probabilities for a each line of text field. - Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results." - items: - $ref: "#/components/schemas/StringRecognitionResult" - Buf_Text: - type: string - description: "Text field data in UTF8 format. - Results of reading different lines of a multi-line field are separated by '^'" - FieldRect: - description: "Coordinates of the text field in the normalized image of the document. - Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results." - $ref: "./common.yml#/components/schemas/RectangleCoordinates" - RFID_OriginDG: - description: "Origin data group information. Only for Result.RFID_TEXT results." - type: integer - RFID_OriginTagEntry: - type: integer - description: "Index of the text field record in origin data group. Only for Result.RFID_TEXT results." - - StringRecognitionResult: - type: object - description: "Describes single row recognition results in multi-line text field of a document" - required: - - StringResult - properties: - StringResult: - type: array - description: "Array of recognition results for individual characters of a string" - items: - $ref: "#/components/schemas/SymbolRecognitionResult" + allOf: + - $ref: "./common.yml#/components/schemas/VisualExtendedFieldItem" + - $ref: "#/components/schemas/DocVisualExtendedFieldItem" - SymbolRecognitionResult: + DocVisualExtendedFieldItem: + title: "DocVisualExtendedFieldItem" type: object - description: "Describes a single character recognition results in the text field line" required: - - SymbolRect - - ListOfCandidates + - FieldRect properties: - SymbolRect: - description: "Coordinates of the symbol in the normalized image of the document" + FieldRect: # Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results. $ref: "./common.yml#/components/schemas/RectangleCoordinates" - ListOfCandidates: - type: array - description: "Array of candidate characters. Sorted in descending order of recognition probabilities - (the first element has highest probability)" - items: - $ref: "#/components/schemas/SymbolCandidate" - - SymbolCandidate: - required: - - SymbolCode - - SymbolProbability - type: object - description: "Describes an individual character recognition candidate" - properties: - SymbolCode: - type: integer - description: "Unicode symbol code" - SymbolProbability: - type: integer - description: "character recognition probability (0–100,%)" - minimum: 0 - maximum: 100 diff --git a/rt-text.yml b/rt-text.yml index fdbaf63..5752f6e 100644 --- a/rt-text.yml +++ b/rt-text.yml @@ -1,37 +1,36 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: - - TextResult: - title: "Text" - allOf: - - type: object - required: - - Text - properties: - Text: - $ref: "#/components/schemas/Text" - - $ref: "./rt.yml#/components/schemas/ResultItem" + TextItem: + title: "TextItem" + type: object + required: + - Text + properties: + Text: + $ref: "#/components/schemas/Text" Text: + title: "Text" type: object description: "Contains all document text fields data with validity and cross-source compare checks" required: - status - validityStatus - comparisonStatus + - dateFormat - fieldList - availableSourceList properties: - status: - description: "Overall status of all checks from all text fields" + status: # Overall status of all checks from all text fields $ref: "./common.yml#/components/schemas/CheckResult" - validityStatus: - description: "Overall status of validity from all text fields from all sources" + validityStatus: # Overall status of validity from all text fields from all sources $ref: "./common.yml#/components/schemas/CheckResult" - comparisonStatus: - description: "Overall status of data comparison from different sources for each text field" + comparisonStatus: # Overall status of data comparison from different sources for each text field $ref: "./common.yml#/components/schemas/CheckResult" + dateFormat: + description: "Date format" + type: string fieldList: type: array items: @@ -42,10 +41,12 @@ components: $ref: "#/components/schemas/TextAvailableSource" TextField: + title: "TextField" type: object required: - fieldType - fieldName + - lcid - status - validityStatus - comparisonStatus @@ -61,14 +62,14 @@ components: type: string lcid: $ref: "./e-lcid.yml#/components/schemas/LCID" - status: - description: "Overall status of all checks from all values" + lcidName: + description: "LCID name" + type: string + status: # Overall status of all checks from all values $ref: "./common.yml#/components/schemas/CheckResult" - validityStatus: - description: "Overall status of validity from all values" + validityStatus: # Overall status of validity from all values $ref: "./common.yml#/components/schemas/CheckResult" - comparisonStatus: - description: "Overall status of data comparison from different sources" + comparisonStatus: # Overall status of data comparison from different sources $ref: "./common.yml#/components/schemas/CheckResult" value: description: "The most confidence value, selected from valueList" @@ -90,13 +91,15 @@ components: items: $ref: "#/components/schemas/CrossSourceValueComparison" - # todo originalValidity очн путает, может в validityList сделать validityList = originalValidity && validityList TextFieldValue: + title: "TextFieldValue" type: object required: - value - pageIndex - source + - originalValidity + - probability properties: source: $ref: "./common.yml#/components/schemas/Source" @@ -106,6 +109,8 @@ components: originalValue: description: "Original value as seen in the document" type: string + originalValidity: + $ref: "./common.yml#/components/schemas/CheckResult" originalSymbols: type: array items: @@ -117,15 +122,19 @@ components: type: integer minimum: 0 maximum: 100 - fieldRect: - description: "Only for visual and mrz results. Coordinates of the rectangle region on a document image(result type 1). Represented by two points - (left, top) + (right, bottom)" + fieldRect: # Only for visual and mrz results. Coordinates of the rectangle region on a document image(result type 1). Represented by two points - (left, top) + (right, bottom) $ref: "./common.yml#/components/schemas/RectangleCoordinates" - rfidOrigin: - description: "Only for rfid images. Text location in rfid chip." + rfidOrigin: # Only for rfid images. Text location in rfid chip. $ref: "./common.yml#/components/schemas/RfidOrigin" + containerType: + $ref: "./rt.yml#/components/schemas/ContainerType" OriginalSymbol: + title: "OriginalSymbol" type: object + required: + - code + - probability properties: code: description: "Unicode symbol code" @@ -140,6 +149,7 @@ components: $ref: "./common.yml#/components/schemas/RectangleCoordinates" SourceValidity: + title: "SourceValidity" type: object required: - source @@ -151,6 +161,7 @@ components: $ref: "./common.yml#/components/schemas/CheckResult" CrossSourceValueComparison: + title: "CrossSourceValueComparison" type: object required: - sourceLeft @@ -165,6 +176,7 @@ components: $ref: "./common.yml#/components/schemas/CheckResult" TextAvailableSource: + title: "TextAvailableSource" type: object required: - source @@ -172,8 +184,7 @@ components: properties: source: $ref: "./common.yml#/components/schemas/Source" - validityStatus: - description: "Overall status of validity from all fields for given source" + validityStatus: # Overall status of validity from all fields for given source $ref: "./common.yml#/components/schemas/CheckResult" containerType: $ref: "./rt.yml#/components/schemas/ContainerType" diff --git a/rt.yml b/rt.yml index 71be4c7..7ab2509 100644 --- a/rt.yml +++ b/rt.yml @@ -1,19 +1,21 @@ -openapi: 3.0.3 +openapi: 3.0.4 components: schemas: - ContainerType: + title: "ContainerType" type: integer description: "Same as Result type, but used for safe parsing of not-described values. See Result type." default: 0 Result: + title: "Result" type: integer enum: - 1 - 3 - 5 - 6 + - 7 - 8 - 9 - 15 @@ -22,15 +24,23 @@ components: - 18 - 19 - 20 + - 26 - 30 + - 32 - 33 - 34 + - 35 - 36 - 37 + - 38 - 39 - 49 - 50 + - 61 + - 62 - 85 + - 87 + - 97 - 101 - 102 - 103 @@ -42,6 +52,7 @@ components: - "Contains MRZ OCR results" - "Contains raw information about barcodes on the input image" - "Contains cropped graphic fields from Visual zone" + - "Contains result of MRZTestQuality" - "Contains list of document type candidates with their probabilities and descriptions" - "Contains description of determined document type, if any" - "Contains lexical data analysis results that allow you to compare MRZ OCR results, Visual zone OCR results, barcodes and RFID chip data for an additional assessment of the authenticity of the document (this is an old format, better use TEXT type)" @@ -50,15 +61,23 @@ components: - "Contains barcode parsing result with text fields" - "Contains barcode parsing result with graphic fields" - "Contains result of document authenticity checks" + - "Contains result of DocVisualExtendedInfoContainer" - "Contains image quality check results" + - "Contains result of DocGraphicsInfoContainer" - "Contains check statuses with details, grouped by source" - "Contains result of portraits comparison" + - "Contains result of DocGraphicsInfoContainer" - "Contains document textual fields from all sources (mrz, rfid, visual, barcode) with validity and cross-source compare checks" - "Contains images from all document sources (mrz, rfid, visual, barcode)" + - "Contains result of DocGraphicsInfoContainer" - "Contains result of fingerprints comparison" - "Contains encrypted ResultContainerList" - "Contains license" + - "Contains result of MRZ position" + - "Contains result of barcode position" - "Contains information about document position on the input image, its center, angle, etc" + - "Contains result of MRZDetectorResult" + - "Contains result of FaceDetection" - "Contains RFID raw data" - "Contains RFID text results" - "Contains RFID graphic results" @@ -70,6 +89,7 @@ components: - "MRZ_TEXT" - "BARCODES" - "VISUAL_GRAPHICS" + - "MRZ_TEST_QUALITY" - "DOCUMENT_TYPE_CANDIDATES" - "DOCUMENT_TYPE" - "LEXICAL_ANALYSIS" @@ -78,15 +98,23 @@ components: - "BARCODE_TEXT" - "BARCODE_GRAPHICS" - "AUTHENTICITY" + - "MAGNETIC_STRIPE_TEXT_DATA" - "IMAGE_QUALITY" + - "LIVE_PORTRAIT" - "STATUS" - "PORTRAIT_COMPARISON" + - "EXT_PORTRAIT" - "TEXT" - "IMAGES" + - "FINGERPRINTS" - "FINGERPRINT_COMPARISON" - "ENCRYPTED_RCL" - "LICENSE" + - "MRZ_POSITION" + - "BARCODE_POSITION" - "DOCUMENT_POSITION" + - "MRZ_DETECTOR" + - "FACE_DETECTION" - "RFID_RAW_DATA" - "RFID_TEXT" - "RFID_GRAPHICS" @@ -95,6 +123,7 @@ components: - "DTC_VC" ResultItem: + title: "ResultItem" type: object description: "Common fields for all result objects" required: @@ -109,7 +138,7 @@ components: page_idx: type: integer result_type: - $ref: "#/components/schemas/ContainerType" + $ref: "#/components/schemas/Result" discriminator: propertyName: result_type mapping: @@ -117,6 +146,7 @@ components: 3: "TextDataResult" 5: "DocBarCodeInfo" 6: "GraphicsResult" + 7: "MRZTestQualityResult" 8: "DocumentTypesCandidatesResult" 9: "ChosenDocumentTypeResult" 15: "LexicalAnalysisResult" @@ -125,20 +155,32 @@ components: 18: "TextDataResult" 19: "GraphicsResult" 20: "AuthenticityResult" + 26: "TextDataResult" 30: "ImageQualityResult" + 32: "GraphicsResult" 33: "StatusResult" 34: "AuthenticityResult" + 35: "GraphicsResult" 36: "TextResult" 37: "ImagesResult" + 38: "GraphicsResult" 39: "AuthenticityResult" 49: "EncryptedRCLResult" 50: "LicenseResult" + 61: "MRZPositionResult" + 62: "DocumentPositionResult" 85: "DocumentPositionResult" - 102: "TextDataResult" + 87: "MRZDetectorResult" + 97: "FaceDetectionResult" + 101: "DocumentBinaryInfoResult" + 102: "RFIDTextDataResult" 103: "GraphicsResult" + 104: "DocumentBinaryInfoResult" + 105: "RFIDGraphicsInfoResult" 109: "ByteArrayResult" ContainerList: + title: "ContainerList" type: object description: "List with various objects, containing processing results" required: @@ -150,7 +192,7 @@ components: List: type: array items: - anyOf: + oneOf: - $ref: "#/components/schemas/StatusResult" - $ref: "#/components/schemas/TextResult" - $ref: "#/components/schemas/DocumentImageResult" @@ -166,52 +208,167 @@ components: - $ref: "#/components/schemas/DocBarCodeInfo" - $ref: "#/components/schemas/LicenseResult" - $ref: "#/components/schemas/EncryptedRCLResult" + - $ref: "#/components/schemas/DocumentBinaryInfoResult" - $ref: "#/components/schemas/ByteArrayResult" - - DocumentPositionResult: - $ref: "./rt-document-position.yml#/components/schemas/DocumentPositionResult" - - DocumentImageResult: - $ref: "./rt-raw-image.yml#/components/schemas/DocumentImageResult" + - $ref: "#/components/schemas/FaceDetectionResult" + - $ref: "#/components/schemas/MRZDetectorResult" + - $ref: "#/components/schemas/MRZPositionResult" + - $ref: "#/components/schemas/MRZTestQualityResult" + - $ref: "#/components/schemas/RFIDGraphicsInfoResult" + - $ref: "#/components/schemas/RFIDTextDataResult" StatusResult: - $ref: "./rt-status.yml#/components/schemas/StatusResult" + title: "StatusResult" + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-status.yml#/components/schemas/StatusItem" TextResult: - $ref: "./rt-text.yml#/components/schemas/TextResult" + title: "TextResult" + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-text.yml#/components/schemas/TextItem" + + DocumentImageResult: + title: "DocumentImageResult" + description: "Contains document image." + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-raw-image.yml#/components/schemas/RawImageContainerItem" ImagesResult: - $ref: "./rt-images.yml#/components/schemas/ImagesResult" + title: "ImagesResult" + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-images.yml#/components/schemas/ImagesItem" - LexicalAnalysisResult: - $ref: "./rt-ocr-lexical-analisis.yml#/components/schemas/LexicalAnalysisResult" + ChosenDocumentTypeResult: + title: "ChosenDocumentTypeResult" + description: "Contains information about the type of document that was determined + based on the analysis of the provided image" + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-doc-type-old.yml#/components/schemas/OneCandidateItem" + + DocumentTypesCandidatesResult: + title: "DocumentTypesCandidatesResult" + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-doc-type-old.yml#/components/schemas/CandidatesListItem" TextDataResult: - $ref: "./rt-text-data.yml#/components/schemas/TextDataResult" + title: "TextDataResult" + description: "Text fields extracted from one document source. + Contains results of specific source for each provided page." + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-text-data.yml#/components/schemas/DocVisualExtendedInfoItem" GraphicsResult: - $ref: "./rt-image-data.yml#/components/schemas/GraphicsResult" + title: "GraphicsResult" + description: "Graphic fields extracted from one of the document sources. + Returns separate results for each provided page." + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-image-data.yml#/components/schemas/DocGraphicsInfoItem" ByteArrayResult: - $ref: "./rt-byte-array-data.yml#/components/schemas/ByteArrayResult" - - DocumentTypesCandidatesResult: - $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesResult" + title: "ByteArrayResult" + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-byte-array-data.yml#/components/schemas/ByteArrayItem" - ChosenDocumentTypeResult: - $ref: "./rt-doc-type-old.yml#/components/schemas/ChosenDocumentTypeResult" + LexicalAnalysisResult: + title: "LexicalAnalysisResult" + description: | + Lexical data analysis allows you to compare the results of reading the text data of the MRZ, + the document filling area, barcodes and data from the memory of the RFID chip for an additional + assessment of the authenticity of the document. Single result for all pages. + Consider using Result.TEXT type for more simplicity. + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-ocr-lexical-analysis.yml#/components/schemas/ListVerifiedFieldsItem" AuthenticityResult: - $ref: "./rt-authenticity.yml#/components/schemas/AuthenticityResult" + title: "AuthenticityResult" + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-authenticity.yml#/components/schemas/AuthenticityCheckListItem" ImageQualityResult: - $ref: "./rt-image-quality.yml#/components/schemas/ImageQualityResult" + title: "ImageQualityResult" + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-image-quality.yml#/components/schemas/ImageQualityCheckListItem" + + DocumentPositionResult: + title: "DocumentPositionResult" + description: "Contains information about document position on the input image, its center, angle, etc" + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-document-position.yml#/components/schemas/DocumentPositionItem" DocBarCodeInfo: - $ref: "./rt-barcodes.yml#/components/schemas/DocBarCodeInfo" + title: "DocBarCodeInfo" + description: "Raw data from BarCodes" + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-barcodes.yml#/components/schemas/DocBarCodeInfoItem" LicenseResult: - $ref: "./rt-license.yml#/components/schemas/LicenseResult" + title: "LicenseResult" + description: "Contains license" + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-license.yml#/components/schemas/LicenseItem" EncryptedRCLResult: - $ref: "./rt-encrypted-rcl.yml#/components/schemas/EncryptedRCLResult" + title: "EncryptedRCLResult" + description: "Contains encrypted result container list" + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-encrypted-rcl.yml#/components/schemas/EncryptedRCLItem" + + DocumentBinaryInfoResult: + title: "DocumentBinaryInfoResult" + description: "Structure is used to store the data reading results from the RFID-chip in + a form of a list of the logically separated data groups." + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-rfid-binary-data.yml#/components/schemas/TDocBinaryInfoItem" + + FaceDetectionResult: + title: "FaceDetectionResult" + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-face-detection.yml#/components/schemas/FaceDetectionItem" + + MRZDetectorResult: + title: "MRZDetectorResult" + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-mrz-detector.yml#/components/schemas/ResultMRZDetectorItem" + + MRZPositionResult: + title: "MRZPositionResult" + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-mrz-position.yml#/components/schemas/MrzPositionItem" + + MRZTestQualityResult: + title: "MRZTestQualityResult" + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-mrz-test-quality.yml#/components/schemas/MRZTestQualityItem" + + RFIDGraphicsInfoResult: + title: "RFIDGraphicsInfoResult" + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-rfid-graphics-info.yml#/components/schemas/TOriginalRFIDGraphicsInfoItem" + + RFIDTextDataResult: + title: "RFIDTextDataResult" + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-rfid-text-data.yml#/components/schemas/RFIDDocVisualExtendedInfoItem"