diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS deleted file mode 100644 index 5a51e66b..00000000 --- a/.github/CODEOWNERS +++ /dev/null @@ -1 +0,0 @@ -* @ikliashchou diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml deleted file mode 100644 index bc255586..00000000 --- a/.github/ISSUE_TEMPLATE/config.yml +++ /dev/null @@ -1,5 +0,0 @@ -blank_issues_enabled: false -contact_links: - - name: Submit a request - url: https://support.regulaforensics.com/hc/requests/new?utm_source=github - about: Submit any requests to Regula Support Team diff --git a/.github/workflows/back-merge-handler.yml b/.github/workflows/back-merge-handler.yml deleted file mode 100644 index 0346f030..00000000 --- a/.github/workflows/back-merge-handler.yml +++ /dev/null @@ -1,84 +0,0 @@ -name: Back Merge handler - -on: - push: - branches: - - master - - stable - -jobs: - pr_master_to_stable: - runs-on: ubuntu-latest - if: github.ref_name == 'master' - steps: - - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - - name: Check if PR exists - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - run: | - prs=$(gh pr list \ - --repo "$GITHUB_REPOSITORY" \ - --json baseRefName,headRefName \ - --jq ' - map(select(.baseRefName == "stable" and .headRefName == "master")) - | length - ') - if ((prs > 0)); then - echo "Pull Request already exists" - echo "SKIP=true" >> $GITHUB_ENV - fi - - - name: Check if stable is ahead - run: | - commits=$(git rev-list origin/stable..origin/master --count) - if ((commits == 0)); then - echo "No diffs was found between branches" - echo "SKIP=true" >> $GITHUB_ENV - fi - - - name: Create Pull Request - if: env.SKIP != 'true' - run: gh pr create -B stable -H master --title '[GitHub Actions] Merge master -> stable' --label back-merge --body 'Autogenerated Pull Request for `back-merge` triggered by Github Actions' - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - pr_stable_to_develop: - runs-on: ubuntu-latest - if: github.ref_name == 'stable' - steps: - - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - - name: Check if PR exists - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - run: | - prs=$(gh pr list \ - --repo "$GITHUB_REPOSITORY" \ - --json baseRefName,headRefName \ - --jq ' - map(select(.baseRefName == "develop" and .headRefName == "stable")) - | length - ') - if ((prs > 0)); then - echo "Pull Request already exists" - echo "SKIP=true" >> $GITHUB_ENV - fi - - - name: Check if stable is ahead - run: | - commits=$(git rev-list origin/develop..origin/stable --count) - if ((commits == 0)); then - echo "No diffs was found between branches" - echo "SKIP=true" >> $GITHUB_ENV - fi - - - name: Create Pull Request - if: env.SKIP != 'true' - run: gh pr create -B develop -H stable --title '[GitHub Actions] Merge stable -> develop' --label back-merge --body 'Autogenerated Pull Request for `back-merge` triggered by Github Actions' - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/make-prs-for-client-repos.yml b/.github/workflows/make-prs-for-client-repos.yml deleted file mode 100644 index 7dc6e50c..00000000 --- a/.github/workflows/make-prs-for-client-repos.yml +++ /dev/null @@ -1,64 +0,0 @@ -name: Make PRs for OpenAPI and client repositories - -on: - workflow_dispatch: - inputs: - source_branch: - description: "Source branch" - default: "develop" - type: choice - required: true - options: - - develop - - master - - stable - target_branch: - description: "Target branch" - default: "master" - type: choice - required: true - options: - - develop - - master - - stable - -jobs: - python-webclient-pr: - runs-on: ubuntu-latest - steps: - - name: Create PR for Python WebClient Repo - run: gh pr create --base ${{ inputs.target_branch }} --head ${{ inputs.source_branch }} --title '[GitHub Actions] Merge ${{ inputs.source_branch }} -> ${{ inputs.target_branch }}' --label OpenAPI --body 'Autogenerated Pull Request triggered by Github Actions in OpenAPI repository' --repo regulaforensics/DocumentReader-web-python-client - env: - GITHUB_TOKEN: ${{ secrets.REGULA_GITHUB_PUSH_TOKEN }} - - java-webclient-pr: - runs-on: ubuntu-latest - steps: - - name: Create PR for Java WebClient Repo - run: gh pr create --base ${{ inputs.target_branch }} --head ${{ inputs.source_branch }} --title '[GitHub Actions] Merge ${{ inputs.source_branch }} -> ${{ inputs.target_branch }}' --label OpenAPI --body 'Autogenerated Pull Request triggered by Github Actions in OpenAPI repository' --repo regulaforensics/DocumentReader-web-java-client - env: - GITHUB_TOKEN: ${{ secrets.REGULA_GITHUB_PUSH_TOKEN }} - - js-webclient-pr: - runs-on: ubuntu-latest - steps: - - name: Create PR for JS WebClient Repo - run: gh pr create --base ${{ inputs.target_branch }} --head ${{ inputs.source_branch }} --title '[GitHub Actions] Merge ${{ inputs.source_branch }} -> ${{ inputs.target_branch }}' --label OpenAPI --body 'Autogenerated Pull Request triggered by Github Actions in OpenAPI repository' --repo regulaforensics/DocumentReader-web-js-client - env: - GITHUB_TOKEN: ${{ secrets.REGULA_GITHUB_PUSH_TOKEN }} - - csharp-webclient-pr: - runs-on: ubuntu-latest - steps: - - name: Create PR for CSharp WebClient Repo - run: gh pr create --base ${{ inputs.target_branch }} --head ${{ inputs.source_branch }} --title '[GitHub Actions] Merge ${{ inputs.source_branch }} -> ${{ inputs.target_branch }}' --label OpenAPI --body 'Autogenerated Pull Request triggered by Github Actions in OpenAPI repository' --repo regulaforensics/DocumentReader-web-csharp-client - env: - GITHUB_TOKEN: ${{ secrets.REGULA_GITHUB_PUSH_TOKEN }} - - openapi-pr: - runs-on: ubuntu-latest - steps: - - name: Create PR for OpenAPI Repo - run: gh pr create --base ${{ inputs.target_branch }} --head ${{ inputs.source_branch }} --title '[GitHub Actions] Merge ${{ inputs.source_branch }} -> ${{ inputs.target_branch }}' --label OpenAPI --body 'Autogenerated Pull Request triggered by Github Actions in OpenAPI repository' --repo regulaforensics/DocumentReader-web-openapi - env: - GITHUB_TOKEN: ${{ secrets.REGULA_GITHUB_PUSH_TOKEN }} diff --git a/.github/workflows/update-clients.yml b/.github/workflows/update-clients.yml deleted file mode 100644 index 964a81d0..00000000 --- a/.github/workflows/update-clients.yml +++ /dev/null @@ -1,224 +0,0 @@ -name: update clients - -on: - push: - branches: [develop] - workflow_dispatch: - inputs: - title: - description: "Title For PR's" - required: true - branch: - description: "OpenAPI branch" - required: true - default: "develop" - -jobs: - title: - runs-on: ubuntu-latest - outputs: - title: ${{ steps.get-title.outputs.fmt_title }} - steps: - - id: get-title - run: | - if [[ ${{ github.event_name }} == 'workflow_dispatch' ]]; then - echo "fmt_title=${{ github.event.inputs.title }}" >> "$GITHUB_OUTPUT" - else - echo "fmt_title=${GITHUB_SHA::8}" >> "$GITHUB_OUTPUT" - fi - - update-js-client: - needs: title - runs-on: ubuntu-latest - steps: - - name: Checkout Specification Repo - uses: actions/checkout@v4 - with: - path: "DocumentReader-web-openapi" - ref: ${{ github.event.inputs.branch }} - - - name: Checkout JS Client Repo - uses: actions/checkout@v4 - with: - repository: "regulaforensics/DocumentReader-web-js-client" - token: ${{ secrets.REGULA_GITHUB_PUSH_TOKEN }} - path: "js-client" - ref: "develop" - - - name: Update Model According To Specification - working-directory: js-client - run: | - npm install - ./update-models.sh - - - name: Push Changes Back To Client Repo - working-directory: js-client - run: | - git checkout -b ${GITHUB_SHA::8} - git config --local user.email "action@github.com" - git config --local user.name "GitHub Action" - - if git diff-index --quiet HEAD --; then - echo "No changes to commit." - exit 0 - fi - - git add --all - git commit -m "Commit: ${{ needs.title.outputs.title }}" -a - - if [ $? -eq 0 ]; then - git push --set-upstream origin ${GITHUB_SHA::8} - gh pr create --fill --base develop - else - echo "Nothing to commit." - fi - env: - GITHUB_TOKEN: ${{ secrets.REGULA_GITHUB_PUSH_TOKEN }} - - update-java-client: - needs: title - runs-on: ubuntu-latest - steps: - - name: Specify Java Version - uses: actions/setup-java@v4 - with: - distribution: "zulu" - java-version: 11 - java-package: jdk - - - name: Checkout Specification Repo - uses: actions/checkout@v4 - with: - path: "DocumentReader-web-openapi" - ref: ${{ github.event.inputs.branch }} - - - name: Checkout Java Client Repo - uses: actions/checkout@v4 - with: - repository: "regulaforensics/DocumentReader-web-java-client" - token: ${{ secrets.REGULA_GITHUB_PUSH_TOKEN }} - path: "java-client" - ref: "develop" - - - name: Update Model According To Specification - working-directory: java-client - run: | - ./update-models.sh - - - name: Push Changes Back To Client Repo - working-directory: java-client - run: | - git checkout -b ${GITHUB_SHA::8} - git config --local user.email "action@github.com" - git config --local user.name "GitHub Action" - - if git diff-index --quiet HEAD --; then - echo "No changes to commit." - exit 0 - fi - - git add --all - git commit -m "Commit: ${{ needs.title.outputs.title }}" -a - - if [ $? -eq 0 ]; then - git push --set-upstream origin ${GITHUB_SHA::8} - gh pr create --fill --base develop - else - echo "Nothing to commit." - fi - env: - GITHUB_TOKEN: ${{ secrets.REGULA_GITHUB_PUSH_TOKEN }} - - update-python-client: - needs: title - runs-on: ubuntu-latest - steps: - - name: Checkout Specification Repo - uses: actions/checkout@v4 - with: - path: "DocumentReader-web-openapi" - ref: ${{ github.event.inputs.branch }} - - - name: Checkout Python Client Repo - uses: actions/checkout@v4 - with: - repository: "regulaforensics/DocumentReader-web-python-client" - token: ${{ secrets.REGULA_GITHUB_PUSH_TOKEN }} - path: "python-client" - ref: "develop" - - - name: Update Model According To Specification - working-directory: python-client - run: | - ./update-models.sh - - - name: Push Changes Back To Client Repo - working-directory: python-client - run: | - git checkout -b ${GITHUB_SHA::8} - git config --local user.email "action@github.com" - git config --local user.name "GitHub Action" - - if git diff-index --quiet HEAD --; then - echo "No changes to commit." - exit 0 - fi - - git add --all - git commit -m "Commit: ${{ needs.title.outputs.title }}" -a - - if [ $? -eq 0 ]; then - git push --set-upstream origin ${GITHUB_SHA::8} - gh pr create --fill --base develop - else - echo "Nothing to commit." - fi - env: - GITHUB_TOKEN: ${{ secrets.REGULA_GITHUB_PUSH_TOKEN }} - - update-csharp-client: - needs: title - runs-on: ubuntu-latest - steps: - - name: Checkout Specification Repo - uses: actions/checkout@v4 - with: - path: "DocumentReader-web-openapi" - ref: ${{ github.event.inputs.branch }} - - - name: Checkout C# Client Repo - uses: actions/checkout@v4 - with: - repository: "regulaforensics/DocumentReader-web-csharp-client" - token: ${{ secrets.REGULA_GITHUB_PUSH_TOKEN }} - path: "csharp-client" - ref: "develop" - - - name: Update Model According To Specification - working-directory: csharp-client - run: | - ./update-models.sh - - - name: Push Changes Back To Client Repo - working-directory: csharp-client - run: | - git checkout -b ${GITHUB_SHA::8} - git config --local user.email "action@github.com" - git config --local user.name "GitHub Action" - - if git diff-index --quiet HEAD --; then - echo "No changes to commit." - exit 0 - fi - - git add --all - git commit -m "Commit: ${{ needs.title.outputs.title }}" -a - - if [ $? -eq 0 ]; then - git push --set-upstream origin ${GITHUB_SHA::8} - gh pr create --fill --base develop - else - echo "Nothing to commit." - fi - env: - GITHUB_TOKEN: ${{ secrets.REGULA_GITHUB_PUSH_TOKEN }} diff --git a/.github/workflows/validate-spec.yml b/.github/workflows/validate-spec.yml deleted file mode 100644 index b3436458..00000000 --- a/.github/workflows/validate-spec.yml +++ /dev/null @@ -1,32 +0,0 @@ -name: validate specification - -on: - pull_request: - branches: - - master - - develop - - stable - -jobs: - validate-specification: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - - - name: Setup Node - uses: actions/setup-node@v4 - with: - node-version: 20 - registry-url: https://registry.npmjs.org/ - - - name: Install redoc - run: | - 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 --recommend -i index.yml diff --git a/.github/workflows/verify-clients.yml b/.github/workflows/verify-clients.yml deleted file mode 100644 index 2833d91d..00000000 --- a/.github/workflows/verify-clients.yml +++ /dev/null @@ -1,96 +0,0 @@ -name: verify clients - -on: - pull_request: - branches: - - master - - develop - - stable - -jobs: - verify-python: - runs-on: ubuntu-latest - steps: - - name: Checkout Specification Repo - uses: actions/checkout@v4 - with: - path: "DocumentReader-web-openapi" - - - name: Checkout Python Client Repo - uses: actions/checkout@v4 - with: - repository: "regulaforensics/DocumentReader-web-python-client" - path: "python-client" - - - name: Verify update Python client - working-directory: python-client - run: | - ./update-models.sh strict - ./setup.sh - - verify-csharp: - runs-on: ubuntu-latest - steps: - - name: Checkout Specification Repo - uses: actions/checkout@v4 - with: - path: "DocumentReader-web-openapi" - - - name: Checkout CSharp Client Repo - uses: actions/checkout@v4 - with: - repository: "regulaforensics/DocumentReader-web-csharp-client" - path: "csharp-client" - - - name: Verify update CSharp client - working-directory: csharp-client - run: | - ./update-models.sh strict - ./setup.sh - - verify-js: - runs-on: ubuntu-latest - steps: - - name: Checkout Specification Repo - uses: actions/checkout@v4 - with: - path: "DocumentReader-web-openapi" - - - name: Checkout JS Client Repo - uses: actions/checkout@v4 - with: - repository: "regulaforensics/DocumentReader-web-js-client" - path: "js-client" - - - name: Verify update JS client - working-directory: js-client - run: | - ./update-models.sh - ./setup.sh - - verify-java: - runs-on: ubuntu-latest - steps: - - name: Specify Java Version - uses: actions/setup-java@v4 - with: - distribution: "zulu" - java-version: 11 - java-package: jdk - - - name: Checkout Specification Repo - uses: actions/checkout@v4 - with: - path: "DocumentReader-web-openapi" - - - name: Checkout Java Client Repo - uses: actions/checkout@v4 - with: - repository: "regulaforensics/DocumentReader-web-java-client" - path: "java-client" - - - name: Verify update Java client - working-directory: java-client - run: | - ./update-models.sh strict - ./gradlew clean :example:run diff --git a/.gitignore b/.gitignore index 28193047..ae30ac8d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,10 +1,3 @@ .idea -document-reader-api-doc.html -/.openapi-generator/VERSION -/.openapi-generator/FILES -/openapi.json document-reader-static-doc.html -*.DS_Store -*.txt -*.strings -*.json + diff --git a/.openapi-generator-ignore b/.openapi-generator-ignore deleted file mode 100644 index 6dd68349..00000000 --- a/.openapi-generator-ignore +++ /dev/null @@ -1,28 +0,0 @@ -# OpenAPI Generator Ignore -# Generated by openapi-generator https://github.com/openapitools/openapi-generator - -# Use this file to prevent files from being overwritten by the generator. -# The patterns follow closely to .gitignore or .dockerignore. - -# As an example, the C# client generator defines ApiClient.cs. -# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: -#ApiClient.cs - -# You can match any string of characters against a directory, file or extension with a single asterisk (*): -#foo/*/qux -# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux - -# You can recursively match patterns against a directory, file or extension with a double asterisk (**): -#foo/**/qux -# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux - -# You can also negate patterns with an exclamation (!). -# For example, you can ignore all files in a docs folder with the file extension .md: -#docs/*.md -# Then explicitly reverse the ignore rule for a single file: -#!docs/README.md - -FILES -VERSION -*.* -!openapi.json \ No newline at end of file diff --git a/README.md b/README.md deleted file mode 100644 index af50ffdc..00000000 --- a/README.md +++ /dev/null @@ -1,53 +0,0 @@ -# Regula Document Reader OpenAPI definitions - -[![documentation](https://img.shields.io/badge/docs-en-f6858d?style=flat-square)](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation) -[![release](https://img.shields.io/github/v/release/regulaforensics/DocumentReader-web-openapi?style=flat-square)](https://github.com/regulaforensics/DocumentReader-web-openapi/releases) - -## Main GitHub repository - -* [https://github.com/regulaforensics/DocumentReader-web-openapi](https://github.com/regulaforensics/DocumentReader-web-openapi) - -## 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 -* [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client -* [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core - -## Structure - -* **index.yml** - definition entry point -* **common.yml** - small enums and popular models -* **rt.yml** - definitions import of all possible results types -* **e - \*.yml** - files with huge enum definitions -* **rt - \*.yml** - files describing results types -* **p - \*.yml** - files describing endpoints - -## Updating clients according to the current spec - -When changes are added, the `update clients` action is automatically triggered. For each client **PR** with changes will be created. - -: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. - -:bulb: All clients have RawResultItem and AuthenticityCheckResultItem containers that are used for deserialization oneOf schemas. These containers are a simple map/dict. - - -## Spec validation - -```bash -docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli validate --recommend -i /local/index.yml -``` - -## Building Redoc single page html documentation - -```bash -npx @redocly/cli build-docs index.yml -o=document-reader-static-doc.html -``` - -## Bundle scheme to single .json file - -```bash -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 deleted file mode 100644 index 5c454446..00000000 --- a/authenticity/e-check-diagnose.yml +++ /dev/null @@ -1,265 +0,0 @@ -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: - - 0 - - 1 - - 2 - - 3 - - 4 - - 5 - - 7 - - 8 - - 10 - - 11 - - 12 - - 13 - - 14 - - 15 - - 20 - - 21 - - 22 - - 23 - - 24 - - 25 - - 26 - - 27 - - 28 - - 29 - - 30 - - 31 - - 33 - - 34 - - 40 - - 41 - - 42 - - 43 - - 44 - - 50 - - 51 - - 52 - - 53 - - 54 - - 55 - - 60 - - 65 - - 66 - - 67 - - 80 - - 81 - - 82 - - 83 - - 84 - - 85 - - 86 - - 87 - - 88 - - 90 - - 91 - - 92 - - 93 - - 94 - - 95 - - 96 - - 100 - - 101 - - 102 - - 103 - - 104 - - 110 - - 111 - - 112 - - 113 - - 114 - - 115 - - 116 - - 117 - - 118 - - 119 - - 120 - - 121 - - 122 - - 130 - - 131 - - 132 - - 133 - - 134 - - 140 - - 141 - - 142 - - 143 - - 144 - - 145 - - 150 - - 151 - - 152 - - 153 - - 154 - - 155 - - 156 - - 160 - - 161 - - 170 - - 180 - - 181 - - 182 - - 183 - - 184 - - 185 - - 186 - - 187 - - 190 - - 200 - - 201 - - 202 - - 203 - - 204 - - 205 - - 220 - - 221 - - 222 - - 230 - - 238 - - 239 - - 240 - - 241 - - 243 - - 244 - - 245 - - 246 - - 247 - - 248 - - 250 - x-enum-varnames: - - "UNKNOWN" - - "PASS" - - "INVALID_INPUT_DATA" - - "INTERNAL_ERROR" - - "EXCEPTION_IN_MODULE" - - "UNCERTAIN_VERIFICATION" - - "NECESSARY_IMAGE_NOT_FOUND" - - "PHOTO_SIDES_NOT_FOUND" - - "INVALID_CHECKSUM" - - "SYNTAX_ERROR" - - "LOGIC_ERROR" - - "SOURCES_COMPARISON_ERROR" - - "FIELDS_COMPARISON_LOGIC_ERROR" - - "INVALID_FIELD_FORMAT" - - "TRUE_LUMINESCENCE_ERROR" - - "FALSE_LUMINESCENCE_ERROR" - - "FIXED_PATTERN_ERROR" - - "LOW_CONTRAST_IN_IR_LIGHT" - - "INCORRECT_BACKGROUND_LIGHT" - - "BACKGROUND_COMPARISON_ERROR" - - "INCORRECT_TEXT_COLOR" - - "PHOTO_FALSE_LUMINESCENCE" - - "TOO_MUCH_SHIFT" - - "CONTACT_CHIP_TYPE_MISMATCH" - - "FIBERS_NOT_FOUND" - - "TOO_MANY_OBJECTS" - - "SPECKS_IN_UV" - - "TOO_LOW_RESOLUTION" - - "INVISIBLE_ELEMENT_PRESENT" - - "VISIBLE_ELEMENT_ABSENT" - - "ELEMENT_SHOULD_BE_COLORED" - - "ELEMENT_SHOULD_BE_GRAYSCALE" - - "PHOTO_WHITE_IR_DONT_MATCH" - - "UV_DULL_PAPER_MRZ" - - "FALSE_LUMINESCENCE_IN_MRZ" - - "UV_DULL_PAPER_PHOTO" - - "UV_DULL_PAPER_BLANK" - - "UV_DULL_PAPER_ERROR" - - "FALSE_LUMINESCENCE_IN_BLANK" - - "BAD_AREA_IN_AXIAL" - - "FALSE_IPI_PARAMETERS" - - "ENCRYPTED_IPI_NOT_FOUND" - - "ENCRYPTED_IPI_DATA_DONT_MATCH" - - "FIELD_POS_CORRECTOR_HIGHLIGHT_IR" - - "FIELD_POS_CORRECTOR_GLARES_IN_PHOTO_AREA" - - "FIELD_POS_CORRECTOR_PHOTO_REPLACED" - - "FIELD_POS_CORRECTOR_LANDMARKS_CHECK_ERROR" - - "FIELD_POS_CORRECTOR_FACE_PRESENCE_CHECK_ERROR" - - "FIELD_POS_CORRECTOR_FACE_ABSENCE_CHECK_ERROR" - - "FIELD_POS_CORRECTOR_INCORRECT_HEAD_POSITION" - - "FIELD_POS_CORRECTOR_AGE_CHECK_ERROR" - - "FIELD_POS_CORRECTOR_SEX_CHECK_ERROR" - - "OVI_IR_INVISIBLE" - - "OVI_INSUFFICIENT_AREA" - - "OVI_COLOR_INVARIABLE" - - "OVI_BAD_COLOR_FRONT" - - "OVI_BAD_COLOR_SIDE" - - "OVI_WIDE_COLOR_SPREAD" - - "OVI_BAD_COLOR_PERCENT" - - "HOLOGRAM_ELEMENT_ABSENT" - - "HOLOGRAM_SIDE_TOP_IMAGES_ABSENT" - - "HOLOGRAM_ELEMENT_PRESENT" - - "HOLOGRAM_FRAMES_IS_ABSENT" - - "HOLOGRAM_HOLO_FIELD_IS_ABSENT" - - "PHOTO_PATTERN_INTERRUPTED" - - "PHOTO_PATTERN_SHIFTED" - - "PHOTO_PATTERN_DIFFERENT_COLORS" - - "PHOTO_PATTERN_IR_VISIBLE" - - "PHOTO_PATTERN_NOT_INTERSECT" - - "PHOTO_SIZE_IS_WRONG" - - "PHOTO_PATTERN_INVALID_COLOR" - - "PHOTO_PATTERN_SHIFTED_VERT" - - "PHOTO_PATTERN_PATTERN_NOT_FOUND" - - "PHOTO_PATTERN_DIFFERENT_LINES_THICKNESS" - - "PHOTO_IS_NOT_RECTANGLE" - - "PHOTO_CORNERS_IS_WRONG" - - "DOCUMENT_IS_CANCELLING" - - "TEXT_COLOR_SHOULD_BE_BLUE" - - "TEXT_COLOR_SHOULD_BE_GREEN" - - "TEXT_COLOR_SHOULD_BE_RED" - - "TEXT_SHOULD_BE_BLACK" - - "TEXT_IS_ABSENT" - - "BARCODE_WAS_READ_WITH_ERRORS" - - "BARCODE_DATA_FORMAT_ERROR" - - "BARCODE_SIZE_PARAMS_ERROR" - - "NOT_ALL_BARCODES_READ" - - "GLARES_IN_BARCODE_AREA" - - "NO_CERTIFICATE_FOR_DIGITAL_SIGNATURE_CHECK" - - "PORTRAIT_COMPARISON_PORTRAITS_DIFFER" - - "PORTRAIT_COMPARISON_NO_SERVICE_REPLY" - - "PORTRAIT_COMPARISON_SERVICE_ERROR" - - "PORTRAIT_COMPARISON_NOT_ENOUGH_IMAGES" - - "PORTRAIT_COMPARISON_NO_LIVE_PHOTO" - - "PORTRAIT_COMPARISON_NO_SERVICE_LICENSE" - - "PORTRAIT_COMPARISON_NO_PORTRAIT_DETECTED" - - "MOBILE_IMAGES_UNSUITABLE_LIGHT_CONDITIONS" - - "MOBILE_IMAGES_WHITE_UV_NO_DIFFERENCE" - - "FINGERPRINTS_COMPARISON_MISMATCH" - - "HOLO_PHOTO_FACE_NOT_DETECTED" - - "HOLO_PHOTO_FACE_COMPARISON_FAILED" - - "HOLO_PHOTO_GLARE_IN_CENTER_ABSENT" - - "HOLO_PHOTO_HOLO_ELEMENT_SHAPE_ERROR" - - "HOLO_PHOTO_ALGORITHMS_STEPS_ERROR" - - "HOLO_PHOTO_HOLO_AREAS_NOT_LOADED" - - "HOLO_PHOTO_FINISHED_BY_TIMEOUT" - - "HOLO_PHOTO_DOCUMENT_OUTSIDE_FRAME" - - "LIVENESS_DEPTH_CHECK_FAILED" - - "MRZ_QUALITY_WRONG_SYMBOL_POSITION" - - "MRZ_QUALITY_WRONG_BACKGROUND" - - "MRZ_QUALITY_WRONG_MRZ_WIDTH" - - "MRZ_QUALITY_WRONG_MRZ_HEIGHT" - - "MRZ_QUALITY_WRONG_LINE_POSITION" - - "MRZ_QUALITY_WRONG_FONT_TYPE" - - "OCR_QUALITY_TEXT_POSITION" - - "OCR_QUALITY_INVALID_FONT" - - "OCR_QUALITY_INVALID_BACKGROUND" - - "LASINK_INVALID_LINES_FREQUENCY" - - "DOC_LIVENESS_DOCUMENT_NOT_LIVE" - - "DOC_LIVENESS_BLACK_AND_WHITE_COPY_DETECTED" - - "DOC_LIVENESS_ELECTRONIC_DEVICE_DETECTED" - - "DOC_LIVENESS_INVALID_BARCODE_BACKGROUND" - - "CHD_ICAO_IDB_BASE32_ERROR" - - "CHD_ICAO_IDB_ZIPPED_ERROR" - - "CHD_ICAO_IDB_MESSAGE_ZONE_EMPTY" - - "CHD_ICAO_IDB_SIGNATURE_MUST_BE_PRESENT" - - "CHD_ICAO_IDB_SIGNATURE_MUST_NOT_BE_PRESENT" - - "CHD_ICAO_IDB_CERTIFICATE_MUST_NOT_BE_PRESENT" - - "CHD_INCORRECT_OBJECT_COLOR" diff --git a/authenticity/e-critical.yml b/authenticity/e-critical.yml deleted file mode 100644 index cb2e9a62..00000000 --- a/authenticity/e-critical.yml +++ /dev/null @@ -1,16 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - Critical: - title: "Critical" - type: integer - description: "Enumeration contains identifiers determining the criticality of the security element" - enum: - - 0 - - 1 - x-enum-descriptions: - - "Security element may be absent in a valid document" - - "Security element must be present in a valid document" - x-enum-varnames: - - "NOT_CRITICAL" - - "CRITICAL" diff --git a/authenticity/e-result-type.yml b/authenticity/e-result-type.yml deleted file mode 100644 index ff317221..00000000 --- a/authenticity/e-result-type.yml +++ /dev/null @@ -1,77 +0,0 @@ -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 - - 2 - - 4 - - 8 - - 16 - - 32 - - 64 - - 128 - - 512 - - 1024 - - 4096 - - 8192 - - 32768 - - 65536 - - 131072 - - 262144 - - 524288 - - 1048576 - - 2097152 - - 4194304 - - 8388608 - - 16777216 - x-enum-descriptions: - - "Document luminescence check in UV light" - - "B900 ink MRZ contrast check in IR light" - - "Image patterns presence/absence check (position, shape, color)" - - "Confirm laminate integrity check in axial light" - - "Protection fibers presence check (color, density) in UV light" - - "Document elements visibility check in IR light" - - "OCR for the text field in UV light comparison with other text sources check" - - "Invisible Personal Information (IPI) visualization" - - "Owner's photo embedding check (is photo printed or sticked)" - - "OVI check. Deprecated, use Document liveness check instead" - - "Hologram presence check. Deprecated" - - "Owner's photo area advanced check (photo shape, size, position, etc.)" - - "Portrait comparison check (document printed vs chip vs live)" - - "Barcode format check (code metadata, data format, contents format, etc.)" - - "Kinegram check" - - "LetterScreen check" - - "Hologram detection and validation check" - - "Fingerprint comparison check" - - "Document liveness check" - - "Extended OCR Check" - - "Extended MRZ check" - - "Encrypted IPI" - x-enum-varnames: - - "UV_LUMINESCENCE" - - "IR_B900" - - "IMAGE_PATTERN" - - "AXIAL_PROTECTION" - - "UV_FIBERS" - - "IR_VISIBILITY" - - "OCR_SECURITY_TEXT" - - "IPI" - - "PHOTO_EMBED_TYPE" - - "OVI" - - "HOLOGRAMS" - - "PHOTO_AREA" - - "PORTRAIT_COMPARISON" - - "BARCODE_FORMAT_CHECK" - - "KINEGRAM" - - "LETTER_SCREEN" - - "HOLOGRAM_DETECTION" - - "FINGERPRINT_COMPARISON" - - "LIVENESS" - - "EXTENDED_OCR_CHECK" - - "EXTENDED_MRZ_CHECK" - - "ENCRYPTED_IPI" diff --git a/authenticity/e-visibility.yml b/authenticity/e-visibility.yml deleted file mode 100644 index ce26dbef..00000000 --- a/authenticity/e-visibility.yml +++ /dev/null @@ -1,25 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - Visibility: - title: "Visibility" - type: integer - description: "Enumeration contains visibility status of the security element" - enum: - - 0 - - 1 - - 2 - - 4 - - 8 - x-enum-descriptions: - - "Invisible" - - "Visible" - - "Colored" - - "Grayscale" - - "Visible vs IR match" - x-enum-varnames: - - "INVISIBLE" - - "VISIBLE" - - "COLORED" - - "GRAYSCALE" - - "WHITE_IR_MATCHING" diff --git a/authenticity/rt-fiber.yml b/authenticity/rt-fiber.yml deleted file mode 100644 index 875c8bac..00000000 --- a/authenticity/rt-fiber.yml +++ /dev/null @@ -1,52 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - 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 deleted file mode 100644 index 61fb20d7..00000000 --- a/authenticity/rt-ident.yml +++ /dev/null @@ -1,26 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - 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 deleted file mode 100644 index 493de67a..00000000 --- a/authenticity/rt-ocr-security-text.yml +++ /dev/null @@ -1,39 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - 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 deleted file mode 100644 index 3e20ef9f..00000000 --- a/authenticity/rt-photo-ident.yml +++ /dev/null @@ -1,32 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - PhotoIdentItem: - title: "PhotoIdentItem" - type: object - required: - - LightIndex - - Area - - SourceImage - - ResultImages - properties: - 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 - FieldTypesList: - type: array - items: - 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 deleted file mode 100644 index 0693bf60..00000000 --- a/authenticity/rt-security-feature.yml +++ /dev/null @@ -1,24 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - 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 deleted file mode 100644 index 9e834cbc..00000000 --- a/common.yml +++ /dev/null @@ -1,520 +0,0 @@ -openapi: 3.0.4 -components: - parameters: - x-request: - in: header - name: X-RequestID - schema: - type: string - description: It allows the client and server to correlate each HTTP request. HTTP requests with an identifier are sent from the client to the server and back again. - - 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: - - "MRZ" - - "VISUAL" - - "BARCODE" - - "RFID" - - "MAGNETIC" - - "EXTERNAL" - - "LIVE" - - "FINGERPRINT" - x-enum-varnames: - - "MRZ" - - "VISUAL" - - "BARCODE" - - "RFID" - - "MAGNETIC" - - "EXTERNAL" - - "LIVE" - - "FINGERPRINT" - x-enum-descriptions: - - "Machine readable zone (MRZ)" - - "Visual zone" - - "Barcode" - - "RFID" - - "Magnetic" - - "External" - - "Live" - - "Fingerprint" - - CheckResult: - title: "CheckResult" - type: integer - description: "0 - result is negative; 1 - result is positive; 2 - сheck was not performed" - enum: - - 0 - - 1 - - 2 - x-enum-varnames: - - "ERROR" - - "OK" - - "WAS_NOT_DONE" - x-enum-descriptions: - - "Check was performed and result is NEGATIVE" - - "Check was performed and result is POSITIVE" - - "Check was NOT PERFORMED" - - Scenario: - title: "Scenario" - type: string - description: "Document processing scenario" - enum: - - "Mrz" - - "Barcode" - - "Locate" - - "Ocr" - - "DocType" - - "MrzOrBarcode" - - "MrzOrLocate" - - "MrzAndLocate" - - "BarcodeAndLocate" - - "MrzOrOcr" - - "MrzOrBarcodeOrOcr" - - "LocateVisual_And_MrzOrOcr" - - "FullProcess" - - "FullAuth" - - "RusStamp" - - "OcrFree" - - "CreditCard" - - "Capture" - - "DTC" - - "RFID" - x-enum-varnames: - - "MRZ" - - "BARCODE" - - "LOCATE" - - "OCR" - - "DOCTYPE" - - "MRZ_OR_BARCODE" - - "MRZ_OR_LOCATE" - - "MRZ_AND_LOCATE" - - "BARCODE_AND_LOCATE" - - "MRZ_OR_OCR" - - "MRZ_OR_BARCODE_OR_OCR" - - "LOCATE_VISUAL_AND_MRZ_OR_OCR" - - "FULL_PROCESS" - - "FULL_AUTH" - - "RUS_STAMP" - - "OCR_FREE" - - "CREDIT_CARD" - - "CAPTURE" - - "DTC" - - "RFID" - x-enum-descriptions: - - "Processing scenario for obtaining MRZ data" - - "Processing scenario for obtaining barcode data" - - "Processing scenario for detecting document boundaries" - - "Processing scenario for obtaining visual zone OCR results" - - "Processing scenario for document type recognition" - - "Processing scenario for obtaining MRZ and/or barcode data" - - "Processing scenario for detecting document boundaries and/or obtaining MRZ data" - - "Processing scenario for detecting document boundaries and obtaining MRZ data" - - "Processing scenario for detecting the document boundaries and obtaining barcode data" - - "Processing scenario for obtaining MRZ data or visual zone OCR results" - - "Processing scenario for obtaining MRZ or barcode or visual zone OCR results" - - "Processing scenario for detecting document boundaries and obtaining MRZ data or visual zone OCR results" - - "Processing scenario for obtaining all document data" - - "Processing scenario for obtaining all document data and document authentication" - - "Processing scenario for obtaining data from registration stamps" - - "Processing scenario for obtaining OCR results of any image" - - "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 - properties: - image: - $ref: "#/components/schemas/ImageBase64" - format: - description: "Image format" - 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: - - left - - top - - right - - bottom - properties: - left: - type: integer - top: - type: integer - right: - type: integer - bottom: - 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: - - 0 - - 1 - - 2 - x-enum-descriptions: - - "There is no RFID chip in the document" - - "The RFID chip is located in the document data page" - - "The RFID chip is located in the back page or inlay of the document" - x-enum-varnames: - - "NONE" - - "MAIN_PAGE" - - "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" - type: integer - dgTag: - description: "Index of the source record of the image with biometric information in the information data group" - type: integer - tagEntry: - description: "Index of the template in the record with biometric data" - type: integer - entryView: - description: "Index of the variant of the biometric data template" - type: integer - - Light: - type: integer - 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 - y: - 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: - type: string - example: "https://faceapi.regulaforensics.com" - description: "The URL of the Regula Face Web service to be used." - mode: - type: string - example: "match" - description: "The processing mode: \"match\" or \"match+search\"." - search: - type: object - description: "A search filter that can be applied if the \"match+search\" mode is enabled. May include limit, threshold, group_ids. If the group_ids are specified, the search is performed only in these groups. Find more information in the OpenAPI documentation." - properties: - limit: - type: integer - description: "The maximum number of results to be returned." - threshold: - type: number - format: float - description: "The similarity threshold." - group_ids: - type: array - items: - type: string - description: " The groups where to conduct the search." - threshold: - type: integer - example: 75 - description: "The similarity threshold, 0-100. Above 75 means that the faces' similarity is verified, below 75 is not." - serviceTimeout: - type: integer - example: 3000 - description: "The Regula Face Web service requests timeout, ms." - proxy: - type: string - example: "http://localhost:8080" - description: "Proxy to use, should be set according to the cURL standard." - proxy_userpwd: - type: string - example: "user:pass" - description: "Username and password to use for proxy authentication, should be set according to the cURL standard." - proxy_type: - type: integer - example: 0 - description: "Proxy protocol type, should be set according to the cURL standard." - childAgeThreshold: - type: integer - example: 13 - description: "The age threshold for the portrait comparison. Default: 13." - childDocValidityYears: - 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 - 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 - - GlaresCheckParams: - title: "GlaresCheckParams" - type: object - properties: - imgMarginPart: - type: number - format: float - description: "Margin from the edges of the image. 0.35 = 35%" - example: 0.35 - maxGlaringPart: - type: number - format: float - description: "The maximum allowable part of the area occupied by the glare. The same: 0.06 = 6%" - example: 0.0 diff --git a/e-barcode-type.yml b/e-barcode-type.yml deleted file mode 100644 index b345aca1..00000000 --- a/e-barcode-type.yml +++ /dev/null @@ -1,70 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - BarcodeType: - title: "BarcodeType" - type: integer - description: "Enumeration contains the types of barcodes that can be processed" - enum: - - 0 - - 1 - - 2 - - 3 - - 4 - - 5 - - 6 - - 7 - - 8 - - 9 - - 10 - - 11 - - 12 - - 13 - - 14 - - 15 - - 16 - - 17 - - 18 - - 19 - x-enum-varnames: - - "UNKNOWN" - - "CODE128" - - "CODE39" - - "EAN8" - - "ITF" - - "PDF417" - - "STF" - - "MTF" - - "IATA" - - "CODABAR" - - "UPCA" - - "CODE93" - - "UPCE" - - "EAN13" - - "QRCODE" - - "AZTEC" - - "DATAMATRIX" - - "ALL_1D" - - "CODE11" - - "JABCODE" - x-enum-descriptions: - - "Unknown" - - "Code 128" - - "Code 39" - - "EAN-8" - - "ITF" - - "PDF417" - - "STF" - - "MTF" - - "IATA" - - "Codabar" - - "UPC-A" - - "Code 93" - - "UPC-E" - - "EAN-13" - - "QR code" - - "Aztec code" - - "Datamatrix" - - "All 1D barcodes" - - "Code 11" - - "JAB code" diff --git a/e-document-type.yml b/e-document-type.yml deleted file mode 100644 index 48fe305d..00000000 --- a/e-document-type.yml +++ /dev/null @@ -1,700 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - DocumentType: - title: "DocumentType" - type: integer - description: "Possible values for document types" - enum: - - 0 - - 11 - - 12 - - 13 - - 14 - - 15 - - 16 - - 17 - - 20 - - 21 - - 22 - - 23 - - 24 - - 25 - - 26 - - 27 - - 28 - - 29 - - 30 - - 32 - - 33 - - 34 - - 35 - - 36 - - 37 - - 38 - - 39 - - 40 - - 41 - - 42 - - 43 - - 44 - - 45 - - 46 - - 47 - - 48 - - 49 - - 50 - - 51 - - 52 - - 53 - - 54 - - 55 - - 56 - - 57 - - 58 - - 59 - - 60 - - 61 - - 62 - - 63 - - 64 - - 65 - - 66 - - 67 - - 68 - - 69 - - 70 - - 71 - - 72 - - 73 - - 74 - - 75 - - 76 - - 77 - - 78 - - 79 - - 80 - - 81 - - 82 - - 83 - - 84 - - 85 - - 86 - - 87 - - 88 - - 89 - - 90 - - 91 - - 92 - - 93 - - 94 - - 95 - - 96 - - 97 - - 98 - - 99 - - 100 - - 101 - - 102 - - 103 - - 104 - - 105 - - 106 - - 107 - - 108 - - 109 - - 110 - - 111 - - 112 - - 113 - - 114 - - 115 - - 116 - - 117 - - 118 - - 119 - - 120 - - 121 - - 122 - - 123 - - 124 - - 125 - - 126 - - 127 - - 128 - - 129 - - 130 - - 131 - - 132 - - 133 - - 134 - - 135 - - 136 - - 137 - - 138 - - 139 - - 140 - - 141 - - 142 - - 143 - - 144 - - 145 - - 146 - - 147 - - 148 - - 149 - - 150 - - 151 - - 152 - - 153 - - 154 - - 155 - - 156 - - 157 - - 158 - - 159 - - 160 - - 161 - - 162 - - 163 - - 164 - - 165 - - 166 - - 167 - - 168 - - 169 - - 170 - - 171 - - 172 - - 173 - - 174 - - 175 - - 176 - - 177 - - 178 - - 179 - - 180 - - 181 - - 182 - - 183 - - 184 - - 185 - - 186 - - 187 - - 188 - - 189 - - 190 - - 191 - - 192 - - 193 - - 194 - - 195 - - 196 - - 197 - - 198 - - 199 - - 200 - - 201 - - 202 - - 203 - - 204 - - 205 - - 206 - - 207 - - 208 - - 209 - - 210 - - 211 - - 212 - - 213 - - 214 - - 215 - - 216 - - 217 - - 218 - - 219 - - 220 - - 221 - - 222 - - 223 - - 224 - - 225 - - 226 - - 227 - - 228 - - 229 - - 230 - - 231 - - 232 - - 233 - - 234 - - 235 - - 236 - - 237 - - 238 - - 239 - - 240 - - 241 - - 242 - x-enum-descriptions: - - "Not defined" - - "Passport" - - "Identity card" - - "Diplomatic passport" - - "Service passport" - - "Seamans identity document" - - "Identity card for residence" - - "Travel document" - - "National identity card" - - "Social identity card" - - "Alien's identity card" - - "Privileged identity card" - - "Residence permit identity card" - - "Origin card" - - "Emergency passport" - - "Alien's passport" - - "Alternative identity card" - - "Visa ID2" - - "Visa ID3" - - "Authorization card" - - "Beginner permit" - - "Border crossing card" - - "Chauffeur license" - - "Chauffeur license under 18" - - "Chauffeur license under 21" - - "Commercial driving license" - - "Commercial driving license instructional permit" - - "Commercial driving license under 18" - - "Commercial driving license under 21" - - "Commercial instruction permit" - - "Commercial new permit" - - "Concealed carry license" - - "Concealed firearm permit" - - "Conditional driving license" - - "Department of veterans affairs identity card" - - "Diplomatic driving license" - - "Driving license" - - "Driving license instructional permit" - - "Driving license instructional permit under 18" - - "Driving license instructional permit under 21" - - "Driving license learners permit" - - "Driving license learners permit under 18" - - "Driving license learners permit under 21" - - "Driving license novice" - - "Driving license novice under 18" - - "Driving license novice under 21" - - "Driving license registered offender" - - "Driving license restricted under 18" - - "Driving license restricted under 21" - - "Driving license temporary visitor" - - "Driving license temporary visitor under 18" - - "Driving license temporary visitor under 21" - - "Driving license under 18" - - "Driving license under 21" - - "Employment driving permit" - - "Enhanced chauffeur license" - - "Enhanced chauffeur license under 18" - - "Enhanced chauffeur license under 21" - - "Enhanced commercial driving license" - - "Enhanced driving license" - - "Enhanced driving license under 18" - - "Enhanced driving license under 21" - - "Enhanced identity card" - - "Enhanced identity card under 18" - - "Enhanced identity card under 21" - - "Enhanced operators license" - - "Firearms permit" - - "Full provisional license" - - "Full provisional license under 18" - - "Full provisional license under 21" - - "Geneva conventions identity card" - - "Graduated driving license under 18" - - "Graduated driving license under 21" - - "Graduated instruction permit under 18" - - "Graduated instruction permit under 21" - - "Graduated license under 18" - - "Graduated license under 21" - - "Handgun carry permit" - - "Identity and privilege card" - - "Identity card mobility impaired" - - "Identity card registered offender" - - "Identity card temporary visitor" - - "Identity card temporary visitor under 18" - - "Identity card temporary visitor under 21" - - "Identity card under 18" - - "Identity card under 21" - - "Other" - - "Ignition interlock permit" - - "Immigrant visa" - - "Instruction permit" - - "Instruction permit under 18" - - "Instruction permit under 21" - - "Interim driving license" - - "Interim identity card" - - "Intermediate driving license" - - "Intermediate driving license under 18" - - "Intermediate driving license under 21" - - "Junior driving license" - - "Learner instructional permit" - - "Learner license" - - "Learner license under 18" - - "Learner license under 21" - - "Learner permit" - - "Learner permit under 18" - - "Learner permit under 21" - - "Limited license" - - "Limited permit" - - "Limited term driving license" - - "Limited term identity card" - - "Liquor identity card" - - "New permit" - - "New permit under 18" - - "New permit under 21" - - "Non-US citizen driving license" - - "Occupational driving license" - - "Oneida tribe of indians identity card" - - "Operator license" - - "Operator license under 18" - - "Operator license under 21" - - "Permanent driving license" - - "Permit to re-enter" - - "Probationary auto license" - - "Probationary driving license under 18" - - "Probationary driving license under 21" - - "Probationary vehicle sales person license" - - "Provisional driving license" - - "Provisional driving license under 18" - - "Provisional driving license under 21" - - "Provisional license" - - "Provisional license under 18" - - "Provisional license under 21" - - "Public passenger chauffeur license" - - "Racing and gaming comission card" - - "Refugee travel document" - - "Renewal permit" - - "Restricted commercial driver license" - - "Restricted driver license" - - "Restricted permit" - - "Seasonal permit" - - "Seasonal resident identity card" - - "Seasonal citizen identity card" - - "Sex offender" - - "Social security card" - - "Temporary driving license" - - "Temporary driving license under 18" - - "Temporary driving license under 21" - - "Temporary identity card" - - "Temporary instruction permit identity card" - - "Temporary instruction permit identity card under 18" - - "Temporary instruction permit identity card under 21" - - "Temporary visitor driving license" - - "Temporary visitor driving license under 18" - - "Temporary visitor driving license under 21" - - "Uniformed services identity card" - - "Vehicle sales person license" - - "Worker identification credential" - - "Commercial driving license novice" - - "Commercial driving license novice under 18" - - "Commercial driving license novice under 21" - - "Passport card" - - "Passport resident card" - - "Personal identification verification" - - "Temporary operator license" - - "Driving license under 19" - - "Identity card under 19" - - "Visa" - - "Temporary passport" - - "Voting card" - - "Health card" - - "Certificate of citizenship" - - "Address card" - - "Airport immigration card" - - "Alien registration card" - - "APEH card" - - "Coupon to driving license" - - "Crew member certificate" - - "Document for return" - - "E-card" - - "Employment card" - - "HKSAR immigration form" - - "Immigrant card" - - "Labour card" - - "Laissez passer" - - "Lawyer identity certificate" - - "License card" - - "Passport stateless" - - "Passport child" - - "Passport consular" - - "Passport diplomatic service" - - "Passport official" - - "Passport provisional" - - "Passport special" - - "Permission to the local border traffic" - - "Registration certificate" - - "Sedesol card" - - "Social card" - - "TB card" - - "Vehicle passport" - - "W document" - - "Diplomatic identity card" - - "Consular identity card" - - "Income tax card" - - "Residence permit" - - "Document of identity" - - "Border crossing permit" - - "Passport limited validity" - - "Sim card" - - "Tax card" - - "Company card" - - "Domestic passport" - - "Identity certificate" - - "Resident id card" - - "Armed forces identity card" - - "Professional card" - - "Registration stamp" - - "Driver card" - - "Driver training certificate" - - "Qualification driving license" - - "Membership card" - - "Public vehicle driver authority card" - - "Marine license" - - "Temporary learner license" - - "Temporary commercial driving license" - - "Interim instructional permit" - - "Certificate of competency" - - "Certificate of proficiency" - - "Trade license" - - "Passport page" - - "Invoice" - - "Passenger locator form" - x-enum-varnames: - - "NOT_DEFINED" - - "PASSPORT" - - "IDENTITY_CARD" - - "DIPLOMATIC_PASSPORT" - - "SERVICE_PASSPORT" - - "SEAMANS_IDENTITY_DOCUMENT" - - "IDENTITY_CARD_FOR_RESIDENCE" - - "TRAVEL_DOCUMENT" - - "NATIONAL_IDENTITY_CARD" - - "SOCIAL_IDENTITY_CARD" - - "ALIENS_IDENTITY_CARD" - - "PRIVILEGED_IDENTITY_CARD" - - "RESIDENCE_PERMIT_IDENTITY_CARD" - - "ORIGIN_CARD" - - "EMERGENCY_PASSPORT" - - "ALIENS_PASSPORT" - - "ALTERNATIVE_IDENTITY_CARD" - - "VISA_ID2" - - "VISA_ID3" - - "AUTHORIZATION_CARD" - - "BEGINNER_PERMIT" - - "BORDER_CROSSING_CARD" - - "CHAUFFEUR_LICENSE" - - "CHAUFFEUR_LICENSE_UNDER_18" - - "CHAUFFEUR_LICENSE_UNDER_21" - - "COMMERCIAL_DRIVING_LICENSE" - - "COMMERCIAL_DRIVING_LICENSE_INSTRUCTIONAL_PERMIT" - - "COMMERCIAL_DRIVING_LICENSE_UNDER_18" - - "COMMERCIAL_DRIVING_LICENSE_UNDER_21" - - "COMMERCIAL_INSTRUCTION_PERMIT" - - "COMMERCIAL_NEW_PERMIT" - - "CONCEALED_CARRY_LICENSE" - - "CONCEALED_FIREARM_PERMIT" - - "CONDITIONAL_DRIVING_LICENSE" - - "DEPARTMENT_OF_VETERANS_AFFAIRS_IDENTITY_CARD" - - "DIPLOMATIC_DRIVING_LICENSE" - - "DRIVING_LICENSE" - - "DRIVING_LICENSE_INSTRUCTIONAL_PERMIT" - - "DRIVING_LICENSE_INSTRUCTIONAL_PERMIT_UNDER_18" - - "DRIVING_LICENSE_INSTRUCTIONAL_PERMIT_UNDER_21" - - "DRIVING_LICENSE_LEARNERS_PERMIT" - - "DRIVING_LICENSE_LEARNERS_PERMIT_UNDER_18" - - "DRIVING_LICENSE_LEARNERS_PERMIT_UNDER_21" - - "DRIVING_LICENSE_NOVICE" - - "DRIVING_LICENSE_NOVICE_UNDER_18" - - "DRIVING_LICENSE_NOVICE_UNDER_21" - - "DRIVING_LICENSE_REGISTERED_OFFENDER" - - "DRIVING_LICENSE_RESTRICTED_UNDER_18" - - "DRIVING_LICENSE_RESTRICTED_UNDER_21" - - "DRIVING_LICENSE_TEMPORARY_VISITOR" - - "DRIVING_LICENSE_TEMPORARY_VISITOR_UNDER_18" - - "DRIVING_LICENSE_TEMPORARY_VISITOR_UNDER_21" - - "DRIVING_LICENSE_UNDER_18" - - "DRIVING_LICENSE_UNDER_21" - - "EMPLOYMENT_DRIVING_PERMIT" - - "ENHANCED_CHAUFFEUR_LICENSE" - - "ENHANCED_CHAUFFEUR_LICENSE_UNDER_18" - - "ENHANCED_CHAUFFEUR_LICENSE_UNDER_21" - - "ENHANCED_COMMERCIAL_DRIVING_LICENSE" - - "ENHANCED_DRIVING_LICENSE" - - "ENHANCED_DRIVING_LICENSE_UNDER_18" - - "ENHANCED_DRIVING_LICENSE_UNDER_21" - - "ENHANCED_IDENTITY_CARD" - - "ENHANCED_IDENTITY_CARD_UNDER_18" - - "ENHANCED_IDENTITY_CARD_UNDER_21" - - "ENHANCED_OPERATORS_LICENSE" - - "FIREARMS_PERMIT" - - "FULL_PROVISIONAL_LICENSE" - - "FULL_PROVISIONAL_LICENSE_UNDER_18" - - "FULL_PROVISIONAL_LICENSE_UNDER_21" - - "GENEVA_CONVENTIONS_IDENTITY_CARD" - - "GRADUATED_DRIVING_LICENSE_UNDER_18" - - "GRADUATED_DRIVING_LICENSE_UNDER_21" - - "GRADUATED_INSTRUCTION_PERMIT_UNDER_18" - - "GRADUATED_INSTRUCTION_PERMIT_UNDER_21" - - "GRADUATED_LICENSE_UNDER_18" - - "GRADUATED_LICENSE_UNDER_21" - - "HANDGUN_CARRY_PERMIT" - - "IDENTITY_AND_PRIVILEGE_CARD" - - "IDENTITY_CARD_MOBILITY_IMPAIRED" - - "IDENTITY_CARD_REGISTERED_OFFENDER" - - "IDENTITY_CARD_TEMPORARY_VISITOR" - - "IDENTITY_CARD_TEMPORARY_VISITOR_UNDER_18" - - "IDENTITY_CARD_TEMPORARY_VISITOR_UNDER_21" - - "IDENTITY_CARD_UNDER_18" - - "IDENTITY_CARD_UNDER_21" - - "OTHER" - - "IGNITION_INTERLOCK_PERMIT" - - "IMMIGRANT_VISA" - - "INSTRUCTION_PERMIT" - - "INSTRUCTION_PERMIT_UNDER_18" - - "INSTRUCTION_PERMIT_UNDER_21" - - "INTERIM_DRIVING_LICENSE" - - "INTERIM_IDENTITY_CARD" - - "INTERMEDIATE_DRIVING_LICENSE" - - "INTERMEDIATE_DRIVING_LICENSE_UNDER_18" - - "INTERMEDIATE_DRIVING_LICENSE_UNDER_21" - - "JUNIOR_DRIVING_LICENSE" - - "LEARNER_INSTRUCTIONAL_PERMIT" - - "LEARNER_LICENSE" - - "LEARNER_LICENSE_UNDER_18" - - "LEARNER_LICENSE_UNDER_21" - - "LEARNER_PERMIT" - - "LEARNER_PERMIT_UNDER_18" - - "LEARNER_PERMIT_UNDER_21" - - "LIMITED_LICENSE" - - "LIMITED_PERMIT" - - "LIMITED_TERM_DRIVING_LICENSE" - - "LIMITED_TERM_IDENTITY_CARD" - - "LIQUOR_IDENTITY_CARD" - - "NEW_PERMIT" - - "NEW_PERMIT_UNDER_18" - - "NEW_PERMIT_UNDER_21" - - "NON_US_CITIZEN_DRIVING_LICENSE" - - "OCCUPATIONAL_DRIVING_LICENSE" - - "ONEIDA_TRIBE_OF_INDIANS_IDENTITY_CARD" - - "OPERATOR_LICENSE" - - "OPERATOR_LICENSE_UNDER_18" - - "OPERATOR_LICENSE_UNDER_21" - - "PERMANENT_DRIVING_LICENSE" - - "PERMIT_TO_REENTER" - - "PROBATIONARY_AUTO_LICENSE" - - "PROBATIONARY_DRIVING_LICENSE_UNDER_18" - - "PROBATIONARY_DRIVING_LICENSE_UNDER_21" - - "PROBATIONARY_VEHICLE_SALES_PERSON_LICENSE" - - "PROVISIONAL_DRIVING_LICENSE" - - "PROVISIONAL_DRIVING_LICENSE_UNDER_18" - - "PROVISIONAL_DRIVING_LICENSE_UNDER_21" - - "PROVISIONAL_LICENSE" - - "PROVISIONAL_LICENSE_UNDER_18" - - "PROVISIONAL_LICENSE_UNDER_21" - - "PUBLIC_PASSENGER_CHAUFFEUR_LICENSE" - - "RACING_AND_GAMING_COMISSION_CARD" - - "REFUGEE_TRAVEL_DOCUMENT" - - "RENEWAL_PERMIT" - - "RESTRICTED_COMMERCIAL_DRIVER_LICENSE" - - "RESTRICTED_DRIVER_LICENSE" - - "RESTRICTED_PERMIT" - - "SEASONAL_PERMIT" - - "SEASONAL_RESIDENT_IDENTITY_CARD" - - "SEASONAL_CITIZEN_IDENTITY_CARD" - - "SEX_OFFENDER" - - "SOCIAL_SECURITY_CARD" - - "TEMPORARY_DRIVING_LICENSE" - - "TEMPORARY_DRIVING_LICENSE_UNDER_18" - - "TEMPORARY_DRIVING_LICENSE_UNDER_21" - - "TEMPORARY_IDENTITY_CARD" - - "TEMPORARY_INSTRUCTION_PERMIT_IDENTITY_CARD" - - "TEMPORARY_INSTRUCTION_PERMIT_IDENTITY_CARD_UNDER_18" - - "TEMPORARY_INSTRUCTION_PERMIT_IDENTITY_CARD_UNDER_21" - - "TEMPORARY_VISITOR_DRIVING_LICENSE" - - "TEMPORARY_VISITOR_DRIVING_LICENSE_UNDER_18" - - "TEMPORARY_VISITOR_DRIVING_LICENSE_UNDER_21" - - "UNIFORMED_SERVICES_IDENTITY_CARD" - - "VEHICLE_SALES_PERSON_LICENSE" - - "WORKER_IDENTIFICATION_CREDENTIAL" - - "COMMERCIAL_DRIVING_LICENSE_NOVICE" - - "COMMERCIAL_DRIVING_LICENSE_NOVICE_UNDER_18" - - "COMMERCIAL_DRIVING_LICENSE_NOVICE_UNDER_21" - - "PASSPORT_CARD" - - "PASSPORT_RESIDENT_CARD" - - "PERSONAL_IDENTIFICATION_VERIFICATION" - - "TEMPORARY_OPERATOR_LICENSE" - - "DRIVING_LICENSE_UNDER_19" - - "IDENTITY_CARD_UNDER_19" - - "VISA" - - "TEMPORARY_PASSPORT" - - "VOTING_CARD" - - "HEALTH_CARD" - - "CERTIFICATE_OF_CITIZENSHIP" - - "ADDRESS_CARD" - - "AIRPORT_IMMIGRATION_CARD" - - "ALIEN_REGISTRATION_CARD" - - "APEH_CARD" - - "COUPON_TO_DRIVING_LICENSE" - - "CREW_MEMBER_CERTIFICATE" - - "DOCUMENT_FOR_RETURN" - - "E_CARD" - - "EMPLOYMENT_CARD" - - "HKSAR_IMMIGRATION_FORM" - - "IMMIGRANT_CARD" - - "LABOUR_CARD" - - "LAISSEZ_PASSER" - - "LAWYER_IDENTITY_CERTIFICATE" - - "LICENSE_CARD" - - "PASSPORT_STATELESS" - - "PASSPORT_CHILD" - - "PASSPORT_CONSULAR" - - "PASSPORT_DIPLOMATIC_SERVICE" - - "PASSPORT_OFFICIAL" - - "PASSPORT_PROVISIONAL" - - "PASSPORT_SPECIAL" - - "PERMISSION_TO_THE_LOCAL_BORDER_TRAFFIC" - - "REGISTRATION_CERTIFICATE" - - "SEDESOL_CARD" - - "SOCIAL_CARD" - - "TB_CARD" - - "VEHICLE_PASSPORT" - - "W_DOCUMENT" - - "DIPLOMATIC_IDENTITY_CARD" - - "CONSULAR_IDENTITY_CARD" - - "INCOME_TAX_CARD" - - "RESIDENCE_PERMIT" - - "DOCUMENT_OF_IDENTITY" - - "BORDER_CROSSING_PERMIT" - - "PASSPORT_LIMITED_VALIDITY" - - "SIM_CARD" - - "TAX_CARD" - - "COMPANY_CARD" - - "DOMESTIC_PASSPORT" - - "IDENTITY_CERTIFICATE" - - "RESIDENT_ID_CARD" - - "ARMED_FORCES_IDENTITY_CARD" - - "PROFESSIONAL_CARD" - - "REGISTRATION_STAMP" - - "DRIVER_CARD" - - "DRIVER_TRAINING_CERTIFICATE" - - "QUALIFICATION_DRIVING_LICENSE" - - "MEMBERSHIP_CARD" - - "PUBLIC_VEHICLE_DRIVER_AUTHORITY_CARD" - - "MARINE_LICENSE" - - "TEMPORARY_LEARNER_LICENSE" - - "TEMPORARY_COMMERCIAL_DRIVING_LICENSE" - - "INTERIM_INSTRUCTIONAL_PERMIT" - - "CERTIFICATE_OF_COMPETENCY" - - "CERTIFICATE_OF_PROFICIENCY" - - "TRADE_LICENSE" - - "PASSPORT_PAGE" - - "INVOICE" - - "PASSENGER_LOCATOR_FORM" diff --git a/e-graphic-field-type.yml b/e-graphic-field-type.yml deleted file mode 100644 index fe943ae1..00000000 --- a/e-graphic-field-type.yml +++ /dev/null @@ -1,95 +0,0 @@ -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 - - 202 - - 203 - - 204 - - 205 - - 206 - - 207 - - 208 - - 209 - - 210 - - 211 - - 212 - - 213 - - 250 - - 300 - - 301 - - 302 - - 303 - - 304 - - 305 - - 306 - - 307 - - 308 - - 309 - - 313 - - 314 - - 315 - x-enum-descriptions: - - "Document holder photo" - - "Fingerprint of document holder" - - "Image of the iris of document holder" - - "Signature of document holder" - - "Barcode image" - - "Image of document confirming owner citizenship" - - "Cropped and rotated with perspective compensation (front side) of a document. Single input image can contain multiple document side/pages, which will be returned as separated results. Most coordinates in other types defined on that image." - - "Image of the rear side of the document" - - "Area with dynamic color change" - - "Additional Portrait" - - "Stamp" - - "Portrait of child" - - "Contact chip" - - "Undefined image type" - - "Fingerprint (thumb, left hand)" - - "Fingerprint (index, left hand)" - - "Fingerprint (middle, left hand)" - - "Fingerprint (ring, left hand)" - - "Fingerprint (little, left hand)" - - "Fingerprint (thumb, right hand)" - - "Fingerprint (index, right hand)" - - "Fingerprint (middle, right hand)" - - "Fingerprint (ring, right hand)" - - "Fingerprint (little, right hand)" - - "Fingerprint (four without thumb on right hand)" - - "Fingerprint (four without thumb on left hand" - - "Fingerprint (two thumbs)" - x-enum-varnames: - - "PORTRAIT" - - "FINGERPRINT" - - "EYE" - - "SIGNATURE" - - "BAR_CODE" - - "PROOF_OF_CITIZENSHIP" - - "DOCUMENT_FRONT" - - "DOCUMENT_REAR" - - "COLOR_DYNAMIC" - - "GHOST_PORTRAIT" - - "STAMP" - - "PORTRAIT_OF_CHILD" - - "CONTACT_CHIP" - - "OTHER" - - "FINGER_LEFT_THUMB" - - "FINGER_LEFT_INDEX" - - "FINGER_LEFT_MIDDLE" - - "FINGER_LEFT_RING" - - "FINGER_LEFT_LITTLE" - - "FINGER_RIGHT_THUMB" - - "FINGER_RIGHT_INDEX" - - "FINGER_RIGHT_MIDDLE" - - "FINGER_RIGHT_RING" - - "FINGER_RIGHT_LITTLE" - - "FINGER_RIGHT_FOUR_FINGERS" - - "FINGER_LEFT_FOUR_FINGERS" - - "FINGER_TWO_THUMBS" diff --git a/e-input-barcode-type.yml b/e-input-barcode-type.yml deleted file mode 100644 index b8121111..00000000 --- a/e-input-barcode-type.yml +++ /dev/null @@ -1,70 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - InputBarcodeType: - title: "InputBarcodeType" - type: string - description: "Enumeration contains the types of barcodes that can be processed" - enum: - - "bct_unknown" - - "bct_Code128" - - "bct_Code39" - - "bct_EAN8" - - "bct_ITF" - - "bct_PDF417" - - "bct_STF" - - "bct_MTF" - - "bct_IATA" - - "bct_CODABAR" - - "bct_UPCA" - - "bct_CODE93" - - "bct_UPCE" - - "bct_EAN13" - - "bct_QRCODE" - - "bct_AZTEC" - - "bct_DATAMATRIX" - - "bct_ALL_1D" - - "bct_Code11" - - "bct_JABCODE" - x-enum-varnames: - - "UNKNOWN" - - "CODE128" - - "CODE39" - - "EAN8" - - "ITF" - - "PDF417" - - "STF" - - "MTF" - - "IATA" - - "CODABAR" - - "UPCA" - - "CODE93" - - "UPCE" - - "EAN13" - - "QRCODE" - - "AZTEC" - - "DATAMATRIX" - - "ALL_1D" - - "CODE11" - - "JABCODE" - x-enum-descriptions: - - "Unknown" - - "Code 128" - - "Code 39" - - "EAN-8" - - "ITF" - - "PDF417" - - "STF" - - "MTF" - - "IATA" - - "Codabar" - - "UPC-A" - - "Code 93" - - "UPC-E" - - "EAN-13" - - "QR code" - - "Aztec code" - - "Datamatrix" - - "All 1D barcodes" - - "Code 11" - - "JAB code" diff --git a/e-lcid.yml b/e-lcid.yml deleted file mode 100644 index f70ca0c6..00000000 --- a/e-lcid.yml +++ /dev/null @@ -1,511 +0,0 @@ -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. - Based on Microsoft locale id (https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-lcid/70feba9f-294e-491e-b6eb-56532684c37f). - type: integer - enum: - - 0 - - 1078 - - 1052 - - 5121 - - 15361 - - 3073 - - 2049 - - 11265 - - 13313 - - 12289 - - 4097 - - 6145 - - 8193 - - 16385 - - 1025 - - 10241 - - 7169 - - 14337 - - 9217 - - 1067 - - 2092 - - 1068 - - 1069 - - 1059 - - 1026 - - 1109 - - 1027 - - 3076 - - 5124 - - 2052 - - 4100 - - 1028 - - 1050 - - 1029 - - 1030 - - 1125 - - 2067 - - 1043 - - 3081 - - 10249 - - 4105 - - 9225 - - 6153 - - 8201 - - 5129 - - 13321 - - 7177 - - 11273 - - 2057 - - 1033 - - 12297 - - 1061 - - 1080 - - 1065 - - 1035 - - 2060 - - 3084 - - 1036 - - 5132 - - 6156 - - 4108 - - 1071 - - 1110 - - 1079 - - 3079 - - 1031 - - 5127 - - 4103 - - 2055 - - 1032 - - 1095 - - 1037 - - 1081 - - 1038 - - 1039 - - 1057 - - 1040 - - 2064 - - 1041 - - 1099 - - 1087 - - 1107 - - 1111 - - 1042 - - 1088 - - 1062 - - 1063 - - 1086 - - 2110 - - 1082 - - 1102 - - 1104 - - 1044 - - 2068 - - 1045 - - 1046 - - 2070 - - 1094 - - 1047 - - 1048 - - 1049 - - 1103 - - 3098 - - 2074 - - 1115 - - 1051 - - 1060 - - 11274 - - 16394 - - 13322 - - 9226 - - 5130 - - 7178 - - 12298 - - 17418 - - 4106 - - 18442 - - 2058 - - 19466 - - 6154 - - 15370 - - 10250 - - 20490 - - 1034 - - 3082 - - 14346 - - 8202 - - 1089 - - 1053 - - 2077 - - 1114 - - 1097 - - 1092 - - 1098 - - 1054 - - 1055 - - 1064 - - 1090 - - 1058 - - 1056 - - 2115 - - 1091 - - 1066 - - 50001 - - 50002 - - 2117 - - 1093 - - 1101 - - 1096 - - 1100 - - 1108 - - 1113 - - 1118 - - 1120 - - 1121 - - 1123 - - 2137 - - 4096 - - 10000 - - 10001 - - 10002 - - 10003 - - 10004 - - 10011 - - 10012 - - 10560 - x-enum-varnames: - - "LATIN" - - "AFRIKAANS" - - "ALBANIAN" - - "ARABIC_ALGERIA" - - "ARABIC_BAHRAIN" - - "ARABIC_EGYPT" - - "ARABIC_IRAQ" - - "ARABIC_JORDAN" - - "ARABIC_KUWAIT" - - "ARABIC_LEBANON" - - "ARABIC_LIBYA" - - "ARABIC_MOROCCO" - - "ARABIC_OMAN" - - "ARABIC_QATAR" - - "ARABIC_SAUDI_ARABIA" - - "ARABIC_SYRIA" - - "ARABIC_TUNISIA" - - "ARABIC_UAE" - - "ARABIC_YEMEN" - - "ARABIC_ARMENIAN" - - "AZERI_CYRILIC" - - "AZERI_LATIN" - - "BASQUE" - - "BELARUSIAN" - - "BULGARIAN" - - "BURMESE" - - "CATALAN" - - "CHINESE_HONGKONG_SAR" - - "CHINESE_MACAO_SAR" - - "CHINESE" - - "CHINESE_SINGAPORE" - - "CHINESE_TAIWAN" - - "CROATIAN" - - "CZECH" - - "DANISH" - - "DIVEHI" - - "DUTCH_BELGIUM" - - "DUTCH_NETHERLANDS" - - "ENGLISH_AUSTRALIA" - - "ENGLISH_BELIZE" - - "ENGLISH_CANADA" - - "ENGLISH_CARRIBEAN" - - "ENGLISH_IRELAND" - - "ENGLISH_JAMAICA" - - "ENGLISH_NEW_ZEALAND" - - "ENGLISH_PHILIPPINES" - - "ENGLISH_SOUTH_AFRICA" - - "ENGLISH_TRINIDAD" - - "ENGLISH_UK" - - "ENGLISH_US" - - "ENGLISH_ZIMBABWE" - - "ESTONIAN" - - "FAROESE" - - "FARSI" - - "FINNISH" - - "FRENCH_BELGIUM" - - "FRENCH_CANADA" - - "FRENCH_FRANCE" - - "FRENCH_LUXEMBOURG" - - "FRENCH_MONACO" - - "FRENCH_SWITZERLAND" - - "FYRO_MACEDONIAN" - - "GALICIAN" - - "GEORGIAN" - - "GERMAN_AUSTRIA" - - "GERMAN_GERMANY" - - "GERMAN_LIECHTENSTEIN" - - "GERMAN_LUXEMBOURG" - - "GERMAN_SWITZERLAND" - - "GREEK" - - "GUJARATI" - - "HEBREW" - - "HINDI_INDIA" - - "HUNGARIAN" - - "ICELANDIC" - - "INDONESIAN" - - "ITALIAN_ITALY" - - "ITALIAN_SWITZERLAND" - - "JAPANESE" - - "KANNADA" - - "KAZAKH" - - "KHMER" - - "KONKANI" - - "KOREAN" - - "KYRGYZ_CYRILICK" - - "LATVIAN" - - "LITHUANIAN" - - "MALAY_MALAYSIA" - - "MALAY_BRUNEI_DARUSSALAM" - - "MALTESE" - - "MARATHI" - - "MONGOLIAN_CYRILIC" - - "NORWEGIAN_BOKMAL" - - "NORWEGIAN_NYORSK" - - "POLISH" - - "PORTUGUESE_BRAZIL" - - "PORTUGUESE_PORTUGAL" - - "PUNJABI" - - "RHAETO_ROMANIC" - - "ROMANIAN" - - "RUSSIAN" - - "SANSKRIT" - - "SERBIAN_CYRILIC" - - "SERBIAN_LATIN" - - "SINHALA" - - "SLOVAK" - - "SLOVENIAN" - - "SPANISH_ARGENTINA" - - "SPANISH_BOLIVIA" - - "SPANISH_CHILE" - - "SPANICH_COLOMBIA" - - "SPANISH_COSTA_RICA" - - "SPANISH_DOMINICAN_REPUBLIC" - - "SPANISH_ECUADOR" - - "SPANISH_EL_SALVADOR" - - "SPANISH_GUATEMALA" - - "SPANISH_HONDURAS" - - "SPANISH_MEXICO" - - "SPANISH_NICARAGUA" - - "SPANISH_PANAMA" - - "SPANISH_PARAGUAY" - - "SPANISH_PERU" - - "SPANISH_PUERTO_RICO" - - "SPANISH_TRADITIONAL_SORT" - - "SPANISH_INTERNATIONAL_SORT" - - "SPANISH_URUGUAY" - - "SPANISH_VENEZUELA" - - "SWAHILI" - - "SWEDISH" - - "SWEDISH_FINLAND" - - "SYRIAC" - - "TAMIL" - - "TATAR" - - "TELUGU" - - "THAI_THAILAND" - - "TURKISH" - - "TAJIK_CYRILLIC" - - "TURKMEN" - - "UKRAINIAN" - - "URDU" - - "UZBEK_CYRILIC" - - "UZBEK_LATIN" - - "VIETNAMESE" - - "CTC_SIMPLIFIED" - - "CTC_TRADITIONAL" - - "BENGALI_BANGLADESH" - - "BENGALI_INDIA" - - "ASSAMESE" - - "ORIYA" - - "MALAYALAM" - - "LAO" - - "SINDHI_INDIA" - - "AMHARIC" - - "KASHMIRI" - - "NEPALI" - - "PASHTO" - - "SINDHI" - - "ARABIC" - - "BANK_CARD_NUMBER" - - "BANK_CARD_EXPIRY_DATE" - - "BANK_CARD_NAME" - - "BANK_CARD" - - "BANK_CARD_CVV2" - - "ABKHAZIAN" - - "KARAKALPAK" - - "URDU_DETECTION" - x-enum-descriptions: - - "Latin" - - "Afrikaans" - - "Albanian" - - "Arabic (Algeria)" - - "Arabic (Bahrain)" - - "Arabic (Egypt)" - - "Arabic (Iraq)" - - "Arabic (Jordan)" - - "Arabic (Kuwait)" - - "Arabic (Lebanon)" - - "Arabic (Libya)" - - "Arabic (Morocco)" - - "Arabic (Oman)" - - "Arabic (Qatar)" - - "Arabic (Saudi Arabia)" - - "Arabic (Syria)" - - "Arabic (Tunisia)" - - "Arabic (U.A.E.)" - - "Arabic (Yemen)" - - "Armenian" - - "Azeri (Cyrillic)" - - "Azeri (Latin)" - - "Basque" - - "Belarusian" - - "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)" - - "English (Belize)" - - "English (Canada)" - - "English (Caribbean)" - - "English (Ireland)" - - "English (Jamaica)" - - "English (New Zealand)" - - "English (Philippines)" - - "English (South Africa)" - - "English (Trinidad)" - - "English (United Kingdom)" - - "English (United States)" - - "English (Zimbabwe)" - - "Estonian" - - "Faroese" - - "Farsi" - - "Finnish" - - "French (Belgium)" - - "French (Canada)" - - "French (France)" - - "French (Luxembourg)" - - "French (Monaco)" - - "French (Switzerland)" - - "FYRO Macedonian" - - "Galician" - - "Georgian" - - "German (Austria)" - - "German (Germany)" - - "German (Liechtenstein)" - - "German (Luxembourg)" - - "German (Switzerland)" - - "Greek" - - "Gujarati" - - "Hebrew" - - "Hindi (India)" - - "Hungarian" - - "Icelandic" - - "Indonesian" - - "Italian (Italy)" - - "Italian (Switzerland)" - - "Japanese" - - "Kannada" - - "Kazakh" - - "Khmer" - - "Konkani" - - "Korean" - - "Kyrgyz (Cyrillic)" - - "Latvian" - - "Lithuanian" - - "Malay (Malaysia)" - - "Malay (Brunei Darussalam)" - - "Maltese" - - "Marathi" - - "Mongolian (Cyrillic)" - - "Norwegian (Bokmal)" - - "Norwegian (Nynorsk)" - - "Polish" - - "Portuguese (Brazil)" - - "Portuguese (Portugal)" - - "Punjabi" - - "Rhaeto-Romanic" - - "Romanian" - - "Russian" - - "Sanskrit" - - "Serbian (Cyrillic)" - - "Serbian (Latin)" - - "Sinhala" - - "Slovak" - - "Slovenian" - - "Spanish (Argentina)" - - "Spanish (Bolivia)" - - "Spanish (Chile)" - - "Spanish (Colombia)" - - "Spanish (Costa Rica)" - - "Spanish (Dominican Republic)" - - "Spanish (Ecuador)" - - "Spanish (El Salvador)" - - "Spanish (Guatemala)" - - "Spanish (Honduras)" - - "Spanish (Mexico)" - - "Spanish (Nicaragua)" - - "Spanish (Panama)" - - "Spanish (Paraguay)" - - "Spanish (Peru)" - - "Spanish (Puerto Rico)" - - "Spanish (Traditional Sort)" - - "Spanish (International Sort)" - - "Spanish (Uruguay)" - - "Spanish (Venezuela)" - - "Swahili" - - "Swedish" - - "Swedish (Finland)" - - "Syriac" - - "Tamil" - - "Tatar" - - "Telugu" - - "Thai (Thailand)" - - "Turkish" - - "Tajik (Cyrillic)" - - "Turkmen" - - "Ukrainian" - - "Urdu" - - "Uzbek (Cyrillic)" - - "Uzbek (Latin)" - - "Vietnamese" - - "CTC Simplified" - - "CTC Traditional" - - "Bengali (Bangladesh)" - - "BengaliIndia" - - "Assamese" - - "Oriya" - - "Malayalam" - - "Lao" - - "Sindhi (India)" - - "Amharic" - - "Kashmiri" - - "Nepali" - - "Pashto" - - "Sindhi" - - "Arabic (World)" - - "Bank Card Number" - - "Bank Card Expiry Date" - - "Bank Card Name" - - "Bank Card" - - "Bank Card CVV2" - - "Abkhazian (Cyrillic)" - - "Karakalpak (Latin)" - - "Urdu Detection" diff --git a/e-parsing-error-codes.yml b/e-parsing-error-codes.yml deleted file mode 100644 index fef8cd09..00000000 --- a/e-parsing-error-codes.yml +++ /dev/null @@ -1,413 +0,0 @@ -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 - - 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" - - "ASN: Not enough data" - - "ASN: Contents unexpected data" - - "ASN Signed data: Incorrect data" - - "ASN Signed data: Encap contents incorrect data" - - "ASN Signed data: Version incorrect data" - - "ASN Signed data: Digest algorithms incorrect data" - - "ASN LDS object: Incorrect data" - - "ASN LDS object: Version incorrect data" - - "ASN LDS object: Digest algorithm incorrect data" - - "ASN LDS object: DG hashes incorrect data" - - "ASN LDS object: Version info incorrect data" - - "ASN Certificate: Incorrect data" - - "ASN Certificate: Version incorrect data" - - "ASN Certificate: SN incorrect data" - - "ASN Certificate: Signature incorrect data" - - "ASN Certificate: Issuer incorrect data" - - "ASN Certificate: Validity incorrect data" - - "ASN Certificate: Subject incorrect data" - - "ASN Certificate: Subject PK incorrect data" - - "ASN Certificate: Extensions incorrect data" - - "ASN Signer info: Incorrect data" - - "ASN Signer info: Version incorrect data" - - "ASN Signer info: SID incorrect data" - - "ASN Signer info: Digest algorithms incorrect data" - - "ASN Signer info: Signed attributes incorrect data" - - "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" - - "ICAO Signer info: Unsupported signature algorithm" - - "ICAO Signer info: Message digest error" - - "ICAO Signer info: Signed attributes missed" - - "Auth: Signer info cannot find certificate" - - "Auth: Error" - - "Auth: Unsupported signature algorithm" - - "Auth: Unsupported public key algorithm" - - "Auth: Messed algorithms" - - "Auth: Public key data invalid" - - "Auth: Algorithm parameters data invalid" - - "Auth: Signature data invalid" - - "Auth: Unsupported digest algorithm" - - "Auth: Signature data incorrect" - - "Auth: Algorithm parameters not defined" - - "Auth: Signature check failed" - - "DG: Wrong Tag" - - "DG: Contents unexpected data" - - "BAP: Symmetric Cypher Cannot Initialize" - - "PACE: Info Not Available" - - "PACE: Symmetric Cypher Cannot Initialize" - - "PACE: Key Agreement Cannot Initialize" - - "PACE: Ephemeral Keys Cannot Create" - - "PACE: Mapping Cannot Decode Nonce" - - "PACE: Shared Secret Cannot Create" - - "PACE: Domain Params Unsupported Format" - - "PACE: Ephemeral Keys Incorrect" - - "PACE: Mapping Ephemeral Keys Incorrect" - - "PACE: Mapping Cannot Perform" - - "PACE: Non-Matching Auth Tokens" - - "PACE: CAM data incorrect" - - "PACE: CAM data cannot verify" - - "PACE: CAM data non-matching" - - "PACE: IM scheme incorrect" - - "PACE: Random mapping failed" - - "CA: Cannot Find Public Key" - - "CA: Cannot Find Info" - - "CA: Incorrect Version" - - "CA: Cannot Find Domain Parameters" - - "CA: Key Agreement Cannot Initialize" - - "CA: Public Key Unsupported Algorithm" - - "CA: Ephemeral Keys Cannot Create" - - "CA: Shared Secret Cannot Create" - - "CA: Non-Matching Auth Tokens" - - "TA: Incorrect Version" - - "TA: Cannot Build Certificate Chain" - - "TA: Cannot Find IS Private Key" - - "TA: Public Key Unsupported Algorithm" - - "TA: Signature Building Error" - - "TA: Invalid Key Algorithm Parameters" - - "AA: Public Key Unsupported Algorithm" - - "AA: Public Key Incorrect Data" - - "AA: Public Key Incorrect Parameters" - - "AA: Public Key Undefined Parameters" - - "AA: Signature Incorrect Data" - - "AA: Unsupported recovery scheme" - - "AA: Incorrect Trailer" - - "AA: Unsupported Digest Algorithm" - - "RI: Sector Key Cannot Find" - - "RI: Sector Key Incorrect Data" - - "RI: Sector Key Incomplete Data" - - "CV Certificate: Missing mandatory data PK" - - "CV Certificate: Public key unsupported" - - "CV Certificate: CHAT unsupported terminal type" - - "CV Certificate: Private key unsupported" - - "CV Certificate: Private key invalid params" - - "CV Certificate: Incorrect data" - - "CV Certificate: CPI incorrect data" - - "CV Certificate: CAR incorrect data" - - "CV Certificate: Public key incorrect data" - - "CV Certificate: CHR incorrect data" - - "CV Certificate: CHAT incorrect data" - - "CV Certificate: Valid from incorrect data" - - "CV Certificate: Valid to incorrect data" - - "CV Certificate: Extensions incorrect data" - - "CV Certificate: Private key incorrect data" - - "CV Certificate: Private key missing" - - "VDS: Unsupported version" - - "VDS: Issuing country size" - - "VDS: Issuing country incorrect data" - - "VDS: Signature certificate size" - - "VDS: Signature certificate data" - - "VDS: Signature incorrect data" - - "VDS: Incorrect data" - - "VDS: Missing or incorrect data" - - "VDS: Missing or incorrect header" - - "VDS: Missing or incorrect type" - - "VDS: Missing or incorrect version" - - "VDS: Missing or incorrect issuing country" - - "VDS: Missing or incorrect message" - - "VDS: Missing or incorrect signature" - - "VDS: Missing or incorrect signature algorithm" - - "VDS: Missing or incorrect certificate" - - "VDS: Missing or incorrect signature value" - x-enum-varnames: - - "errLDS_Ok" - - "errLDS_ASN_IncorrectData" - - "errLDS_ASN_NotEnoughData" - - "errLDS_ASN_Contents_UnexpectedData" - - "errLDS_ASN_SignedData_IncorrectData" - - "errLDS_ASN_SignedData_EncapContents_IncorrectData" - - "errLDS_ASN_SignedData_Version_IncorrectData" - - "errLDS_ASN_SignedData_DigestAlgorithms_IncorrectData" - - "errLDS_ASN_LDSObject_IncorrectData" - - "errLDS_ASN_LDSObject_Version_IncorrectData" - - "errLDS_ASN_LDSObject_DigestAlgorithm_IncorrectData" - - "errLDS_ASN_LDSObject_DGHashes_IncorrectData" - - "errLDS_ASN_LDSObject_VersionInfo_IncorrectData" - - "errLDS_ASN_Certificate_IncorrectData" - - "errLDS_ASN_Certificate_Version_IncorrectData" - - "errLDS_ASN_Certificate_SN_IncorrectData" - - "errLDS_ASN_Certificate_Signature_IncorrectData" - - "errLDS_ASN_Certificate_Issuer_IncorrectData" - - "errLDS_ASN_Certificate_Validity_IncorrectData" - - "errLDS_ASN_Certificate_Subject_IncorrectData" - - "errLDS_ASN_Certificate_SubjectPK_IncorrectData" - - "errLDS_ASN_Certificate_Extensions_IncorrectData" - - "errLDS_ASN_SignerInfo_IncorrectData" - - "errLDS_ASN_SignerInfo_Version_IncorrectData" - - "errLDS_ASN_SignerInfo_SID_IncorrectData" - - "errLDS_ASN_SignerInfo_DigestAlg_IncorrectData" - - "errLDS_ASN_SignerInfo_SignedAttrs_IncorrectData" - - "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" - - "errLDS_ICAO_SignerInfo_UnsupportedSignatureAlgorithm" - - "errLDS_ICAO_SignerInfo_MessageDigestError" - - "errLDS_ICAO_SignerInfo_SignedAttrs_Missed" - - "errLDS_Auth_SignerInfo_CantFindCertificate" - - "errLDS_Auth_Error" - - "errLDS_Auth_UnsupportedSignatureAlgorithm" - - "errLDS_Auth_UnsupportedPublicKeyAlgorithm" - - "errLDS_Auth_MessedAlgorithms" - - "errLDS_Auth_PublicKeyDataInvalid" - - "errLDS_Auth_AlgorithmParametersDataInvalid" - - "errLDS_Auth_SignatureDataInvalid" - - "errLDS_Auth_UnsupportedDigestAlgorithm" - - "errLDS_Auth_SignatureDataIncorrect" - - "errLDS_Auth_AlgorithmParametersNotDefined" - - "errLDS_Auth_SignatureCheckFailed" - - "errLDS_DG_WrongTag" - - "errLDS_DG_Contents_UnexpectedData" - - "errLDS_BAP_SymmetricCypher_CantInitialize" - - "errLDS_PACE_Info_NotAvailable" - - "errLDS_PACE_SymmetricCypher_CantInitialize" - - "errLDS_PACE_KeyAgreement_CantInitialize" - - "errLDS_PACE_EphemeralKeys_CantCreate" - - "errLDS_PACE_Mapping_CantDecodeNonce" - - "errLDS_PACE_SharedSecret_CantCreate" - - "errLDS_PACE_DomainParams_UnsupportedFormat" - - "errLDS_PACE_EphemeralKeys_Incorrect" - - "errLDS_PACE_Mapping_EphemeralKeys_Incorrect" - - "errLDS_PACE_Mapping_CantPerform" - - "errLDS_PACE_NonMatchingAuthTokens" - - "errLDS_PACE_CAM_Data_Incorrect" - - "errLDS_PACE_CAM_Data_CantVerify" - - "errLDS_PACE_CAM_Data_NonMatching" - - "errLDS_PACE_IM_Scheme_Incorrect" - - "errLDS_PACE_IM_RandomMapping_Failed" - - "errLDS_CA_CantFindPublicKey" - - "errLDS_CA_CantFindInfo" - - "errLDS_CA_IncorrectVersion" - - "errLDS_CA_CantFindDomainParameters" - - "errLDS_CA_KeyAgreement_CantInitialize" - - "errLDS_CA_PublicKey_UnsupportedAlgorithm" - - "errLDS_CA_EphemeralKeys_CantCreate" - - "errLDS_CA_SharedSecret_CantCreate" - - "errLDS_CA_NonMatchingAuthTokens" - - "errLDS_TA_IncorrectVersion" - - "errLDS_TA_CantBuildCertificateChain" - - "errLDS_TA_CantFindISPrivateKey" - - "errLDS_TA_PublicKey_UnsupportedAlgorithm" - - "errLDS_TA_SignatureBuildingError" - - "errLDS_TA_InvalidKeyAlgorithmParameters" - - "errLDS_AA_PublicKey_UnsupportedAlgorithm" - - "errLDS_AA_PublicKey_IncorrectData" - - "errLDS_AA_PublicKey_IncorrectParameters" - - "errLDS_AA_PublicKey_UndefinedParameters" - - "errLDS_AA_Signature_IncorrectData" - - "errLDS_AA_UnsupportedRecoveryScheme" - - "errLDS_AA_IncorrectTrailer" - - "errLDS_AA_UnsupportedDigestAlgorithm" - - "errLDS_RI_SectorKey_CantFind" - - "errLDS_RI_SectorKey_IncorrectData" - - "errLDS_RI_SectorKey_IncompleteData" - - "errLDS_CV_Certificate_MissingMandatoryData_PK" - - "errLDS_CV_Certificate_PublicKey_Unsupported" - - "errLDS_CV_Certificate_CHAT_UnsupportedTerminalType" - - "errLDS_CV_Certificate_PrivateKey_Unsupported" - - "errLDS_CV_Certificate_PrivateKey_InvalidParams" - - "errLDS_CV_Certificate_IncorrectData" - - "errLDS_CV_Certificate_CPI_IncorrectData" - - "errLDS_CV_Certificate_CAR_IncorrectData" - - "errLDS_CV_Certificate_PublicKey_IncorrectData" - - "errLDS_CV_Certificate_CHR_IncorrectData" - - "errLDS_CV_Certificate_CHAT_IncorrectData" - - "errLDS_CV_Certificate_ValidFrom_IncorrectData" - - "errLDS_CV_Certificate_ValidTo_IncorrectData" - - "errLDS_CV_Certificate_Extensions_IncorrectData" - - "errLDS_CV_Certificate_PrivateKey_IncorrectData" - - "errLDS_CV_Certificate_PrivateKey_Missing" - - "errLDS_VDS_UnsupportedVersion" - - "errLDS_VDS_Issuing_Country_Size" - - "errLDS_VDS_Issuing_Country_IncorrectData" - - "errLDS_VDS_Signer_Certificate_Size" - - "errLDS_VDS_Signer_Certificate_Data" - - "errLDS_VDS_Signature_IncorrectData" - - "errLDS_VDS_NC_IncorrectData" - - "errLDS_VDS_NC_MissingOrIncorrect_Data" - - "errLDS_VDS_NC_MissingOrIncorrect_Header" - - "errLDS_VDS_NC_MissingOrIncorrect_Type" - - "errLDS_VDS_NC_MissingOrIncorrect_Version" - - "errLDS_VDS_NC_MissingOrIncorrect_IssuingCountry" - - "errLDS_VDS_NC_MissingOrIncorrect_Message" - - "errLDS_VDS_NC_MissingOrIncorrect_Signature" - - "errLDS_VDS_NC_MissingOrIncorrect_SigAlgorithm" - - "errLDS_VDS_NC_MissingOrIncorrect_Certificate" - - "errLDS_VDS_NC_MissingOrIncorrect_SigValue" diff --git a/e-parsing-notification-codes.yml b/e-parsing-notification-codes.yml deleted file mode 100644 index f5394398..00000000 --- a/e-parsing-notification-codes.yml +++ /dev/null @@ -1,980 +0,0 @@ -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: - - 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 - - 139277 - - 139278 - - 139279 - - 139280 - - 139281 - - 139282 - - 139283 - - 139284 - - 139285 - - 139286 - - 139287 - - 139288 - - 139289 - - 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" - - "ASN certificate: Incorrect time coding" - - "ASN certificate: Incorrect use of generalized time" - - "ASN certificate: Empty issuer" - - "ASN certificate: Empty subject" - - "ASN certificate: Unsupported critical extension" - - "ASN certificate: Forced default CSCA role" - - "ASN certificate: Forced default DS role" - - "ASN certificate: Incorrect issuer subject DS" - - "ASN certificate: Duplicating extensions" - - "ICAO certificate: Version missed" - - "ICAO certificate: Version incorrect" - - "ICAO certificate: Issuer country missed" - - "ICAO certificate: Issuer common name missed" - - "ICAO certificate: Issuer country non-compliant" - - "ICAO certificate: Subject country missed" - - "ICAO certificate: Subject common name missed" - - "ICAO certificate: Subject country non-compliant" - - "ICAO certificate: Using non-compliant data" - - "ICAO certificate: Unsupported signature algorithm" - - "ICAO certificate: Unsupported public key algorithm" - - "ICAO certificate: Missed extensions" - - "ICAO certificate: Validity" - - "ICAO certificate extension: Using non-compliant data" - - "ICAO certificate extension: Key usage missed" - - "ICAO certificate extension: Key usage not critical" - - "ICAO certificate extension: Key usage incorrect data" - - "ICAO certificate extension: Basic constraints missed" - - "ICAO certificate extension: Basic constraints incorrect usage 1" - - "ICAO certificate extension: Basic constraints incorrect usage 2" - - "ICAO certificate extension: Basic constraints not critical" - - "ICAO certificate extension: Basic constraints incorrect data" - - "ICAO certificate extension: Basic constraints path LenC missed" - - "ICAO certificate extension: Basic constraints path LenC incorrect" - - "ICAO certificate extension: Ext key usage not critical" - - "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: 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" - - "ICAO certificate extension: Private key UP incorrect data" - - "ICAO certificate extension: Private key UP empty" - - "ICAO certificate extension: Subject alt name missed" - - "ICAO certificate extension: Subject alt name incorrect data" - - "ICAO certificate extension: Subject alt name empty" - - "ICAO certificate extension: Subject alt name non-compliant" - - "ICAO certificate extension: Subject alt name critical" - - "ICAO certificate extension: Subject alt name DN empty" - - "ICAO certificate extension: Subject alt name DN incorrect" - - "ICAO certificate extension: Subject alt name DN non-compliant" - - "ICAO certificate extension: Issuer alt name missed" - - "ICAO certificate extension: Issuer alt name incorrect data" - - "ICAO certificate extension: Issuer alt name empty" - - "ICAO certificate extension: Issuer alt name non-compliant" - - "ICAO certificate extension: Issuer alt name critical" - - "ICAO certificate extension: Issuer alt name DN empty" - - "ICAO certificate extension: Issuer alt name DN incorrect" - - "ICAO certificate extension: Issuer alt name DN non-compliant" - - "ICAO certificate extension Doc type list: Missed" - - "ICAO certificate extension Doc type list: Incorrect data" - - "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: 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" - - "ICAO certificate extension: CRL dist point incorrect data" - - "ICAO certificate extension: CRL dist point empty" - - "ICAO certificate extension: CRL dist point point missed" - - "ICAO certificate: SN non-compliant" - - "ICAO certificate: Issuer SN non-compliant" - - "ICAO certificate: Subject SN non-compliant" - - "ICAO certificate: Issuer attribute non-compliant" - - "ICAO certificate: Subject attribute non-compliant" - - "ICAO certificate: Issuer subject country non-matching" - - "ICAO certificate extension: CSCA alt names non-matching" - - "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: 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" - - "ICAO COM: Unicode version missing" - - "ICAO COM: DGPM incorrect" - - "ICAO COM: DGPM missing" - - "ICAO COM: DGPM unexpected" - - "ICAO application: LDS version unsupported" - - "ICAO application: Unicode version unsupported" - - "ICAO application: LDS version inconsistent" - - "ICAO application: Unicode version inconsistent" - - "ASN signed data: OID incorrect" - - "ASN signed data: Version incorrect" - - "ASN signed data: Content OID incorrect" - - "ICAO signed data: Version incorrect" - - "ICAO signed data: Digest algorithms empty" - - "ICAO signed data: Digest algorithms unsupported" - - "ICAO signed data: Signer infos multiple entries" - - "ICAO signed data: Certificates missed" - - "ICAO signed data: Certificates empty" - - "ICAO signed data: CRLs incorrect usage" - - "ICAO LDS object: Incorrect content OID" - - "ICAO LDS object: DG number incorrect" - - "ICAO LDS object: DG hash missing" - - "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" - - "BSI: Black list version incorrect" - - "ASN signer info: Version incorrect" - - "ASN signer info: SID incorrect choice" - - "ASN signer info: SID digest algorithm not listed" - - "ASN signer info: Message digest attr missing" - - "ASN signer info: Message digest attr data" - - "ASN signer info: Message digest attr value" - - "ASN signer info: Content type attr missing" - - "ASN signer info: Content type attr data" - - "ASN signer info: Content type attr value" - - "ASN signer info: Signing time attr missing" - - "ASN signer info: Signing time attr data" - - "ASN signer info: Signing time attr value" - - "ASN signer info: List content description attr missing" - - "ASN signer info: List content description attr data" - - "Auth signer info: Certificate validity" - - "Auth signer info: Certificate root is not trusted" - - "Auth signer info: Certificate cannot find CSCA" - - "Auth signer info: Certificate revoked" - - "Auth signer info: Certificate signature invalid" - - "Notification: Unsupported image format" - - "MRZ: Document type unknown" - - "MRZ: Issuing state syntax error" - - "MRZ: Name is void" - - "MRZ: Number incorrect checksum" - - "MRZ: Nationality syntax error" - - "MRZ: DOB syntax error" - - "MRZ: DOB error" - - "MRZ: DOB incorrect checksum" - - "MRZ: Sex incorrect" - - "MRZ: DOE syntax error" - - "MRZ: DOE error" - - "MRZ: DOE incorrect checksum" - - "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" - - "Biometrics: Format type incorrect" - - "Biometrics: Type incorrect" - - "Biometrics: Subtype missing" - - "Biometrics: Subtype incorrect" - - "Biometrics: BDB image missing" - - "Biometrics: BDB format ID incorrect" - - "Biometrics: BDB version incorrect" - - "Biometrics: BDB data length incorrect" - - "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: 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 can't find CSCA" - - "Auth ML signer info: Certificate revoked" - - "Auth ML signer info: Certificate signature invalid" - x-enum-varnames: - - "ntfLDS_ASN_Certificate_IncorrectVersion" - - "ntfLDS_ASN_Certificate_NonMatchingSignatureAlgorithm" - - "ntfLDS_ASN_Certificate_IncorrectTimeCoding" - - "ntfLDS_ASN_Certificate_IncorrectUseOfGeneralizedTime" - - "ntfLDS_ASN_Certificate_EmptyIssuer" - - "ntfLDS_ASN_Certificate_EmptySubject" - - "ntfLDS_ASN_Certificate_UnsupportedCriticalExtension" - - "ntfLDS_ASN_Certificate_ForcedDefaultCSCARole" - - "ntfLDS_ASN_Certificate_ForcedDefaultDSRole" - - "ntfLDS_ASN_Certificate_IncorrectIssuerSubjectDS" - - "ntfLDS_ASN_Certificate_DuplicatingExtensions" - - "ntfLDS_ICAO_Certificate_Version_Missed" - - "ntfLDS_ICAO_Certificate_Version_Incorrect" - - "ntfLDS_ICAO_Certificate_Issuer_Country_Missed" - - "ntfLDS_ICAO_Certificate_Issuer_CommonName_Missed" - - "ntfLDS_ICAO_Certificate_Issuer_CountryNonCompliant" - - "ntfLDS_ICAO_Certificate_Subject_Country_Missed" - - "ntfLDS_ICAO_Certificate_Subject_CommonName_Missed" - - "ntfLDS_ICAO_Certificate_Subject_CountryNonCompliant" - - "ntfLDS_ICAO_Certificate_UsingNonCompliantData" - - "ntfLDS_ICAO_Certificate_UnsupportedSignatureAlgorithm" - - "ntfLDS_ICAO_Certificate_UnsupportedPublicKeyAlgorithm" - - "ntfLDS_ICAO_Certificate_MissedExtensions" - - "ntfLDS_ICAO_Certificate_Validity" - - "ntfLDS_ICAO_Certificate_Ext_UsingNonCompliantData" - - "ntfLDS_ICAO_Certificate_Ext_KeyUsage_Missed" - - "ntfLDS_ICAO_Certificate_Ext_KeyUsage_NotCritical" - - "ntfLDS_ICAO_Certificate_Ext_KeyUsage_IncorrectData" - - "ntfLDS_ICAO_Certificate_Ext_BasicC_Missed" - - "ntfLDS_ICAO_Certificate_Ext_BasicC_IncorrectUsage1" - - "ntfLDS_ICAO_Certificate_Ext_BasicC_IncorrectUsage2" - - "ntfLDS_ICAO_Certificate_Ext_BasicC_NotCritical" - - "ntfLDS_ICAO_Certificate_Ext_BasicC_IncorrectData" - - "ntfLDS_ICAO_Certificate_Ext_BasicC_PathLenC_Missed" - - "ntfLDS_ICAO_Certificate_Ext_BasicC_PathLenC_Incorrect" - - "ntfLDS_ICAO_Certificate_Ext_ExtKeyUsage_NotCritical" - - "ntfLDS_ICAO_Certificate_Ext_ExtKeyUsage_IncorrectUsage" - - "ntfLDS_ICAO_Certificate_Ext_ExtKeyUsage_IncorrectData" - - "ntfLDS_ICAO_Certificate_Ext_AuthKeyID_Missed" - - "ntfLDS_ICAO_Certificate_Ext_AuthKeyID_IncorrectData" - - "ntfLDS_ICAO_Certificate_Ext_AuthKeyID_KeyID_Missed" - - "ntfLDS_ICAO_Certificate_Ext_SubjectKeyID_Missed" - - "ntfLDS_ICAO_Certificate_Ext_SubjectKeyID_IncorrectData" - - "ntfLDS_ICAO_Certificate_Ext_PrivateKeyUP_Missed" - - "ntfLDS_ICAO_Certificate_Ext_PrivateKeyUP_IncorrectData" - - "ntfLDS_ICAO_Certificate_Ext_PrivateKeyUP_Empty" - - "ntfLDS_ICAO_Certificate_Ext_SubjectAltName_Missed" - - "ntfLDS_ICAO_Certificate_Ext_SubjectAltName_IncorrectData" - - "ntfLDS_ICAO_Certificate_Ext_SubjectAltName_Empty" - - "ntfLDS_ICAO_Certificate_Ext_SubjectAltName_NonCompliant" - - "ntfLDS_ICAO_Certificate_Ext_SubjectAltName_Critical" - - "ntfLDS_ICAO_Certificate_Ext_SubjectAltName_DN_Empty" - - "ntfLDS_ICAO_Certificate_Ext_SubjectAltName_DN_Incorrect" - - "ntfLDS_ICAO_Certificate_Ext_SubjectAltName_DN_NonCompliant" - - "ntfLDS_ICAO_Certificate_Ext_IssuerAltName_Missed" - - "ntfLDS_ICAO_Certificate_Ext_IssuerAltName_IncorrectData" - - "ntfLDS_ICAO_Certificate_Ext_IssuerAltName_Empty" - - "ntfLDS_ICAO_Certificate_Ext_IssuerAltName_NonCompliant" - - "ntfLDS_ICAO_Certificate_Ext_IssuerAltName_Critical" - - "ntfLDS_ICAO_Certificate_Ext_IssuerAltName_DN_Empty" - - "ntfLDS_ICAO_Certificate_Ext_IssuerAltName_DN_Incorrect" - - "ntfLDS_ICAO_Certificate_Ext_IssuerAltName_DN_NonCompliant" - - "ntfLDS_ICAO_Certificate_Ext_DocTypeList_Missed" - - "ntfLDS_ICAO_Certificate_Ext_DocTypeList_IncorrectData" - - "ntfLDS_ICAO_Certificate_Ext_DocTypeList_Version" - - "ntfLDS_ICAO_Certificate_Ext_DocTypeList_DocTypes" - - "ntfLDS_ICAO_Certificate_Ext_DocTypeList_DocTypes_Empty" - - "ntfLDS_ICAO_Certificate_Ext_CertPolicies_IncorrectData" - - "ntfLDS_ICAO_Certificate_Ext_CertPolicies_Empty" - - "ntfLDS_ICAO_Certificate_Ext_CertPolicies_PolicyID_Missed" - - "ntfLDS_ICAO_Certificate_Ext_CRLDistPoint_Missed" - - "ntfLDS_ICAO_Certificate_Ext_CRLDistPoint_IncorrectData" - - "ntfLDS_ICAO_Certificate_Ext_CRLDistPoint_Empty" - - "ntfLDS_ICAO_Certificate_Ext_CRLDistPoint_PointMissed" - - "ntfLDS_ICAO_Certificate_SN_NonCompliant" - - "ntfLDS_ICAO_Certificate_Issuer_SN_NonCompliant" - - "ntfLDS_ICAO_Certificate_Subject_SN_NonCompliant" - - "ntfLDS_ICAO_Certificate_Issuer_AttributeNonCompliant" - - "ntfLDS_ICAO_Certificate_Subject_AttributeNonCompliant" - - "ntfLDS_ICAO_Certificate_IssuerSubject_Country_NonMatching" - - "ntfLDS_ICAO_Certificate_Ext_CSCA_AltNames_NonMatching" - - "ntfLDS_ICAO_Certificate_Ext_NameChange_IncorrectData" - - "ntfLDS_ICAO_Certificate_Ext_NameChange_NonCompliant" - - "ntfLDS_ICAO_Certificate_Ext_NameChange_Critical" - - "ntfLDS_ICAO_Certificate_Ext_DocTypeList_NonCompliant" - - "ntfLDS_ICAO_Certificate_Ext_DocTypeList_Critical" - - "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" - - "ntfLDS_ICAO_COM_Unicode_Version_Missing" - - "ntfLDS_ICAO_COM_DGPM_Incorrect" - - "ntfLDS_ICAO_COM_DGPM_Missing" - - "ntfLDS_ICAO_COM_DGPM_Unexpected" - - "ntfLDS_ICAO_Application_LDSVersion_Unsupported" - - "ntfLDS_ICAO_Application_UnicodeVersion_Unsupported" - - "ntfLDS_ICAO_Application_LDSVersion_Inconsistent" - - "ntfLDS_ICAO_Application_UnicodeVersion_Inconsistent" - - "ntfLDS_ASN_SignedData_OID_Incorrect" - - "ntfLDS_ASN_SignedData_Version_Incorrect" - - "ntfLDS_ASN_SignedData_ContentOID_Incorrect" - - "ntfLDS_ICAO_SignedData_Version_Incorrect" - - "ntfLDS_ICAO_SignedData_DigestAlgorithms_Empty" - - "ntfLDS_ICAO_SignedData_DigestAlgorithms_Unsupported" - - "ntfLDS_ICAO_SignedData_SignerInfos_MultipleEntries" - - "ntfLDS_ICAO_SignedData_Certificates_Missed" - - "ntfLDS_ICAO_SignedData_Certificates_Empty" - - "ntfLDS_ICAO_SignedData_CRLs_IncorrectUsage" - - "ntfLDS_ICAO_LDSObject_IncorrectContentOID" - - "ntfLDS_ICAO_LDSObject_DGNumber_Incorrect" - - "ntfLDS_ICAO_LDSObject_DGHash_Missing" - - "ntfLDS_ICAO_LDSObject_DGHash_Extra" - - "ntfLDS_ICAO_LDSObject_Version_Incorrect" - - "ntfLDS_ICAO_MasterList_Version_Incorrect" - - "ntfLDS_ICAO_DeviationList_Version_Incorrect" - - "ntfLDS_BSI_DefectList_Version_Incorrect" - - "ntfLDS_BSI_BlackList_Version_Incorrect" - - "ntfLDS_ASN_SignerInfo_Version_Incorrect" - - "ntfLDS_ASN_SignerInfo_SID_IncorrectChoice" - - "ntfLDS_ASN_SignerInfo_SID_DigestAlgorithmNotListed" - - "ntfLDS_ASN_SignerInfo_MessageDigestAttr_Missing" - - "ntfLDS_ASN_SignerInfo_MessageDigestAttr_Data" - - "ntfLDS_ASN_SignerInfo_MessageDigestAttr_Value" - - "ntfLDS_ASN_SignerInfo_ContentTypeAttr_Missing" - - "ntfLDS_ASN_SignerInfo_ContentTypeAttr_Data" - - "ntfLDS_ASN_SignerInfo_ContentTypeAttr_Value" - - "ntfLDS_ASN_SignerInfo_SigningTimeAttr_Missing" - - "ntfLDS_ASN_SignerInfo_SigningTimeAttr_Data" - - "ntfLDS_ASN_SignerInfo_SigningTimeAttr_Value" - - "ntfLDS_ASN_SignerInfo_ListContentDescriptionAttr_Missing" - - "ntfLDS_ASN_SignerInfo_ListContentDescriptionAttr_Data" - - "ntfLDS_Auth_SignerInfo_Certificate_Validity" - - "ntfLDS_Auth_SignerInfo_Certificate_RootIsNotTrusted" - - "ntfLDS_Auth_SignerInfo_Certificate_CantFindCSCA" - - "ntfLDS_Auth_SignerInfo_Certificate_Revoked" - - "ntfLDS_Auth_SignerInfo_Certificate_SignatureInvalid" - - "ntfLDS_UnsupportedImageFormat" - - "ntfLDS_MRZ_DocumentType_Unknown" - - "ntfLDS_MRZ_IssuingState_SyntaxError" - - "ntfLDS_MRZ_Name_IsVoid" - - "ntfLDS_MRZ_Number_IncorrectChecksum" - - "ntfLDS_MRZ_Nationality_SyntaxError" - - "ntfLDS_MRZ_DOB_SyntaxError" - - "ntfLDS_MRZ_DOB_Error" - - "ntfLDS_MRZ_DOB_IncorrectChecksum" - - "ntfLDS_MRZ_Sex_Incorrect" - - "ntfLDS_MRZ_DOE_SyntaxError" - - "ntfLDS_MRZ_DOE_Error" - - "ntfLDS_MRZ_DOE_IncorrectChecksum" - - "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" - - "ntfLDS_Biometrics_FormatType_Incorrect" - - "ntfLDS_Biometrics_Type_Incorrect" - - "ntfLDS_Biometrics_SubType_Missing" - - "ntfLDS_Biometrics_SubType_Incorrect" - - "ntfLDS_Biometrics_BDB_Image_Missing" - - "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" - - "ntfLDS_Biometrics_BDB_Data_PoseAngle_Yaw" - - "ntfLDS_Biometrics_BDB_Data_PoseAngle_Pitch" - - "ntfLDS_Biometrics_BDB_Data_PoseAngle_Roll" - - "ntfLDS_Biometrics_BDB_Data_PoseAngleU_Yaw" - - "ntfLDS_Biometrics_BDB_Data_PoseAngleU_Pitch" - - "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" - - "ntfLDS_SI_PACE_DomainParams_UnsupportedAlgorithm" - - "ntfLDS_SI_CA_Info_IncorrectVersion" - - "ntfLDS_SI_CA_PublicKey_UnsupportedAlgorithm" - - "ntfLDS_SI_CA_DomainParams_UnsupportedAlgorithm" - - "ntfLDS_SI_TA_Info_IncorrectVersion" - - "ntfLDS_SI_TA_Info_FileIDForVersion2" - - "ntfLDS_SI_eIDSecurity_UnsupportedDigestAlgorithm" - - "ntfLDS_SI_RI_Info_IncorrectVersion" - - "ntfLDS_SI_RI_DomainParams_UnsupportedAlgorithm" - - "ntfLDS_SI_AA_Info_IncorrectVersion" - - "ntfLDS_SI_AA_Info_UnsupportedAlgorithm" - - "ntfLDS_SI_AA_Info_InconsistentAlgorithmReference" - - "ntfLDS_SI_Storage_PACE_Info_NotAvailable" - - "ntfLDS_SI_Storage_PACE_Info_NoStdParameters" - - "ntfLDS_SI_Storage_PACE_Info_NoMatchingDomainParams" - - "ntfLDS_SI_Storage_CA_Info_NotAvailable" - - "ntfLDS_SI_Storage_CA_DomainParams_NoRequiredOption" - - "ntfLDS_SI_Storage_CA_DomainParams_NotAvailable" - - "ntfLDS_SI_Storage_CA_AnonymousInfos" - - "ntfLDS_SI_Storage_CA_Info_NoMatchingDomainParams" - - "ntfLDS_SI_Storage_CA_Info_NoMatchingPublicKey" - - "ntfLDS_SI_Storage_CA_IncorrectInfosQuantity" - - "ntfLDS_SI_Storage_TA_Info_NotAvailable" - - "ntfLDS_SI_Storage_CardInfoLocator_MultipleEntries" - - "ntfLDS_SI_Storage_eIDSecurityInfo_MultipleEntries" - - "ntfLDS_SI_Storage_PrivilegedTI_MultipleEntries" - - "ntfLDS_SI_Storage_PrivilegedTI_IncorrectUsage" - - "ntfLDS_SI_Storage_RI_DomainParams_MultipleEntries" - - "ntfLDS_SI_Storage_PACEInfos_NonConsistant" - - "ntfLDS_CVCertificate_Profile_IncorrectVersion" - - "ntfLDS_CVCertificate_Validity" - - "ntfLDS_CVCertificate_NonCVCADomainParameters" - - "ntfLDS_CV_Certificate_PrivateKey_IncorrectVersion" - - "ntfLDS_TA_PACEStaticBindingUsed" - - "ntfLDS_Auth_MLSignerInfo_Certificate_Validity" - - "ntfLDS_Auth_MLSignerInfo_Certificate_RootIsNotTrusted" - - "ntfLDS_Auth_MLSignerInfo_Certificate_CantFindCSCA" - - "ntfLDS_Auth_MLSignerInfo_Certificate_Revoked" - - "ntfLDS_Auth_MLSignerInfo_Certificate_SignatureInvalid" diff --git a/e-rfid-data-file-type.yml b/e-rfid-data-file-type.yml deleted file mode 100644 index c9c19d81..00000000 --- a/e-rfid-data-file-type.yml +++ /dev/null @@ -1,210 +0,0 @@ -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-error-codes.yml b/e-rfid-error-codes.yml deleted file mode 100644 index e0ec272f..00000000 --- a/e-rfid-error-codes.yml +++ /dev/null @@ -1,359 +0,0 @@ -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: - - 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: - - "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: Busy" - - "RFID: Old firmware" - - "PCSC: Failed" - - "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" - - "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_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 deleted file mode 100644 index d6e542c9..00000000 --- a/e-rfid-pkd-resourcetype.yml +++ /dev/null @@ -1,40 +0,0 @@ -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: - - 0 - - 1 - - 2 - - 3 - - 4 - - 5 - - 6 - - 7 - - 8 - - 9 - x-enum-varnames: - - "CERTIFICATE_PA" - - "CERTIFICATE_TA" - - "LDIF" - - "CRL" - - "ML" - - "DEFL" - - "DEVL" - - "BL" - - "LDIF_TA" - - "ML_TA" - x-enum-descriptions: - - "Certificate file contents (.pem, .cer, .crt, .der)" - - "Certificate file contents (.cvcert) and private key file contents (.pkcs8)" - - "LDIF file contents (.ldif)" - - "CRL file contents (.crl)" - - "Master List (.ml, .mls)" - - "Defect List (.dl, .dls, .dfl)" - - "Deviance List (.dl, .dls, .dvl)" - - "Black List (.bl, .bls)" - - "LDIF file contents for TA" - - "Master List with CV certificates for TA" diff --git a/e-security-feature-type.yml b/e-security-feature-type.yml deleted file mode 100644 index 123fe690..00000000 --- a/e-security-feature-type.yml +++ /dev/null @@ -1,181 +0,0 @@ -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: - - 0 - - 1 - - 2 - - 3 - - 4 - - 5 - - 6 - - 7 - - 8 - - 9 - - 10 - - 11 - - 12 - - 13 - - 14 - - 15 - - 16 - - 17 - - 18 - - 19 - - 20 - - 21 - - 22 - - 23 - - 24 - - 25 - - 26 - - 27 - - 28 - - 29 - - 30 - - 31 - - 32 - - 33 - - 34 - - 35 - - 36 - - 38 - - 39 - - 40 - - 41 - - 42 - - 43 - - 44 - - 45 - - 46 - - 47 - - 48 - - 49 - - 50 - - 51 - - 52 - - 53 - - 54 - - 55 - - 56 - - 57 - x-enum-descriptions: - - "Blank element" - - "Personalization element" - - "Photo" - - "MRZ" - - "False luminescence" - - "Hologram (static)" - - "Hologram (static verify)" - - "Hologram (static verify multiple)" - - "Hologram (dynamic verify)" - - "Pattern (non-interrupted)" - - "Pattern (non-shifted)" - - "Pattern (same colors)" - - "Pattern (IR invisible)" - - "Photo size" - - "Main vs ghost portrait comparison" - - "Main vs RFID portrait comparison" - - "Main vs other page portrait comparison" - - "Barcode" - - "Pattern (different line thickness)" - - "Main vs live camera portrait comparison" - - "RFID vs live camera portrait comparison" - - "Ghost photo" - - "Clear ghost photo" - - "Invisible object" - - "Low contrast object" - - "Photo color check" - - "Photo squareness" - - "Photo corners shape" - - "OCR" - - "External vs main portrait comparison" - - "External vs RFID portrait comparison" - - "External vs live camera portrait comparison" - - "Portrait Depth" - - "Micro text" - - "Fluorescent Object" - - "Facial landmarks check" - - "Facial image presence" - - "Facial image absence" - - "Liveness screen capture. Deprecated. LIVENESS_ELECTRONIC_DEVICE is used instead." - - "Liveness electronic device" - - "Liveness OVI" - - "Barcode size check" - - "LASINK" - - "Liveness MLI" - - "Liveness barcode background" - - "Visual zone portrait image vs. image from barcode" - - "Image from barcode vs. image from RFID" - - "Image from barcode vs. external source image" - - "Image from barcode vs. photo from camera" - - "Digital signature check" - - "Contact chip check" - - "Head position check" - - "Black and white copy check" - - "Liveness dynaprint" - - "Liveness geometry check" - - "Age check" - - "Sex check" - x-enum-varnames: - - "BLANK" - - "FILL" - - "PHOTO" - - "MRZ" - - "FALSE_LUMINESCENCE" - - "HOLO_SIMPLE" - - "HOLO_VERIFY_STATIC" - - "HOLO_VERIFY_MULTI_STATIC" - - "HOLO_VERIFY_DYNAMIC" - - "PATTERN_NOT_INTERRUPTED" - - "PATTERN_NOT_SHIFTED" - - "PATTERN_SAME_COLORS" - - "PATTERN_IR_INVISIBLE" - - "PHOTO_SIZE_CHECK" - - "PORTRAIT_COMPARISON_VS_GHOST" - - "PORTRAIT_COMPARISON_VS_RFID" - - "PORTRAIT_COMPARISON_VS_VISUAL" - - "BARCODE" - - "PATTERN_DIFFERENT_LINES_THICKNESS" - - "PORTRAIT_COMPARISON_VS_CAMERA" - - "PORTRAIT_COMPARISON_RFID_VS_CAMERA" - - "GHOST_PHOTO" - - "CLEAR_GHOST_PHOTO" - - "INVISIBLE_OBJECT" - - "LOW_CONTRAST_OBJECT" - - "PHOTO_COLOR" - - "PHOTO_SHAPE" - - "PHOTO_CORNERS" - - "OCR" - - "PORTRAIT_COMPARISON_EXT_VS_VISUAL" - - "PORTRAIT_COMPARISON_EXT_VS_RFID" - - "PORTRAIT_COMPARISON_EXT_VS_CAMERA" - - "LIVENESS_DEPTH" - - "MICRO_TEXT" - - "FLUORESCENT_OBJECT" - - "LANDMARK_CHECK" - - "FACE_PRESENCE" - - "FACE_ABSENCE" - - "LIVENESS_SCREEN_CAPTURE" - - "LIVENESS_ELECTRONIC_DEVICE" - - "LIVENESS_OVI" - - "BARCODE_SIZE_CHECK" - - "LASINK" - - "LIVENESS_MLI" - - "LIVENESS_BARCODE_BACKGROUND" - - "PORTRAIT_COMPARISON_VS_BARCODE" - - "PORTRAIT_COMPARISON_RFID_VS_BARCODE" - - "PORTRAIT_COMPARISON_EXT_VS_BARCODE" - - "PORTRAIT_COMPARISON_BARCODE_VS_CAMERA" - - "CHECK_DIGITAL_SIGNATURE" - - "CONTACT_CHIP_CLASSIFICATION" - - "HEAD_POSITION_CHECK" - - "LIVENESS_BLACK_AND_WHITE_COPY_CHECK" - - "LIVENESS_DYNAPRINT" - - "LIVENESS_GEOMETRY_CHECK" - - "AGE_CHECK" - - "SEX_CHECK" diff --git a/e-text-field-type.yml b/e-text-field-type.yml deleted file mode 100644 index 944fda2e..00000000 --- a/e-text-field-type.yml +++ /dev/null @@ -1,1956 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - TextFieldType: - title: "TextFieldType" - type: integer - 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 - - 24 - - 25 - - 26 - - 27 - - 28 - - 29 - - 30 - - 31 - - 35 - - 36 - - 37 - - 38 - - 39 - - 40 - - 41 - - 42 - - 43 - - 44 - - 45 - - 46 - - 47 - - 48 - - 49 - - 50 - - 51 - - 52 - - 53 - - 54 - - 55 - - 56 - - 57 - - 58 - - 59 - - 60 - - 61 - - 62 - - 63 - - 64 - - 65 - - 66 - - 67 - - 68 - - 69 - - 70 - - 71 - - 72 - - 73 - - 74 - - 75 - - 76 - - 77 - - 78 - - 79 - - 80 - - 81 - - 82 - - 83 - - 84 - - 85 - - 86 - - 87 - - 88 - - 89 - - 90 - - 91 - - 92 - - 93 - - 94 - - 95 - - 96 - - 97 - - 98 - - 99 - - 100 - - 101 - - 102 - - 103 - - 104 - - 105 - - 106 - - 107 - - 108 - - 109 - - 110 - - 111 - - 112 - - 113 - - 114 - - 115 - - 116 - - 117 - - 118 - - 119 - - 120 - - 121 - - 122 - - 123 - - 124 - - 125 - - 126 - - 127 - - 128 - - 129 - - 130 - - 131 - - 132 - - 133 - - 134 - - 135 - - 136 - - 137 - - 138 - - 139 - - 140 - - 141 - - 142 - - 143 - - 144 - - 145 - - 146 - - 147 - - 148 - - 149 - - 150 - - 151 - - 152 - - 153 - - 154 - - 155 - - 156 - - 157 - - 158 - - 159 - - 160 - - 161 - - 162 - - 163 - - 164 - - 165 - - 166 - - 167 - - 168 - - 169 - - 170 - - 171 - - 172 - - 173 - - 174 - - 175 - - 176 - - 177 - - 178 - - 179 - - 180 - - 181 - - 182 - - 183 - - 184 - - 185 - - 186 - - 187 - - 188 - - 189 - - 190 - - 191 - - 192 - - 193 - - 194 - - 195 - - 196 - - 197 - - 198 - - 199 - - 200 - - 220 - - 221 - - 251 - - 252 - - 253 - - 254 - - 255 - - 256 - - 257 - - 258 - - 259 - - 260 - - 261 - - 262 - - 263 - - 264 - - 265 - - 266 - - 267 - - 268 - - 269 - - 270 - - 271 - - 272 - - 273 - - 274 - - 275 - - 276 - - 277 - - 278 - - 279 - - 280 - - 281 - - 282 - - 283 - - 284 - - 285 - - 286 - - 287 - - 288 - - 289 - - 290 - - 291 - - 292 - - 293 - - 294 - - 295 - - 296 - - 297 - - 298 - - 299 - - 300 - - 301 - - 302 - - 303 - - 304 - - 305 - - 306 - - 307 - - 308 - - 309 - - 310 - - 311 - - 312 - - 313 - - 314 - - 315 - - 316 - - 317 - - 318 - - 319 - - 320 - - 321 - - 322 - - 323 - - 324 - - 325 - - 326 - - 327 - - 328 - - 329 - - 330 - - 331 - - 332 - - 333 - - 334 - - 335 - - 336 - - 337 - - 338 - - 339 - - 340 - - 341 - - 342 - - 343 - - 344 - - 345 - - 346 - - 347 - - 348 - - 349 - - 350 - - 351 - - 352 - - 353 - - 354 - - 355 - - 356 - - 357 - - 358 - - 359 - - 360 - - 361 - - 362 - - 363 - - 364 - - 365 - - 366 - - 367 - - 368 - - 369 - - 370 - - 371 - - 372 - - 373 - - 374 - - 375 - - 376 - - 377 - - 378 - - 379 - - 380 - - 381 - - 382 - - 383 - - 384 - - 385 - - 386 - - 387 - - 388 - - 389 - - 390 - - 391 - - 392 - - 393 - - 394 - - 395 - - 396 - - 397 - - 398 - - 399 - - 400 - - 401 - - 402 - - 403 - - 404 - - 405 - - 406 - - 407 - - 408 - - 409 - - 410 - - 411 - - 412 - - 413 - - 414 - - 415 - - 416 - - 417 - - 418 - - 419 - - 420 - - 421 - - 422 - - 423 - - 424 - - 425 - - 426 - - 427 - - 428 - - 429 - - 430 - - 431 - - 432 - - 433 - - 434 - - 435 - - 436 - - 437 - - 438 - - 439 - - 440 - - 441 - - 442 - - 443 - - 444 - - 445 - - 446 - - 447 - - 448 - - 449 - - 450 - - 451 - - 452 - - 453 - - 454 - - 455 - - 456 - - 457 - - 458 - - 459 - - 460 - - 461 - - 462 - - 463 - - 464 - - 465 - - 466 - - 467 - - 468 - - 469 - - 470 - - 471 - - 472 - - 473 - - 474 - - 475 - - 476 - - 477 - - 478 - - 479 - - 480 - - 481 - - 482 - - 483 - - 484 - - 485 - - 486 - - 487 - - 488 - - 489 - - 490 - - 491 - - 492 - - 493 - - 494 - - 495 - - 496 - - 497 - - 498 - - 499 - - 500 - - 501 - - 502 - - 503 - - 504 - - 505 - - 506 - - 507 - - 508 - - 509 - - 510 - - 511 - - 512 - - 513 - - 514 - - 515 - - 516 - - 517 - - 518 - - 519 - - 520 - - 521 - - 522 - - 523 - - 524 - - 525 - - 526 - - 527 - - 528 - - 529 - - 530 - - 531 - - 532 - - 533 - - 534 - - 535 - - 536 - - 537 - - 538 - - 539 - - 540 - - 541 - - 542 - - 543 - - 544 - - 545 - - 546 - - 547 - - 548 - - 549 - - 550 - - 551 - - 552 - - 553 - - 554 - - 555 - - 556 - - 557 - - 558 - - 559 - - 560 - - 561 - - 562 - - 563 - - 564 - - 565 - - 566 - - 567 - - 568 - - 569 - - 570 - - 571 - - 572 - - 573 - - 574 - - 575 - - 576 - - 577 - - 578 - - 579 - - 580 - - 581 - - 582 - - 583 - - 584 - - 585 - - 586 - - 587 - - 588 - - 589 - - 590 - - 591 - - 592 - - 593 - - 594 - - 595 - - 596 - - 597 - - 598 - - 599 - - 600 - - 601 - - 602 - - 603 - - 604 - - 605 - - 606 - - 607 - - 608 - - 609 - - 610 - - 611 - - 612 - - 613 - - 614 - - 615 - - 616 - - 617 - - 618 - - 619 - - 620 - - 621 - - 622 - - 623 - - 624 - - 625 - - 626 - - 627 - - 628 - - 629 - - 630 - - 631 - - 632 - - 633 - - 634 - - 635 - - 636 - - 637 - - 638 - - 639 - - 640 - - 641 - - 642 - - 643 - - 644 - - 645 - - 646 - - 647 - - 648 - - 649 - - 650 - - 651 - - 652 - - 653 - - 654 - - 655 - - 656 - - 657 - - 658 - - 659 - - 660 - - 661 - - 662 - - 663 - - 664 - - 665 - - 666 - - 667 - - 668 - - 669 - - 670 - - 671 - - 672 - - 673 - - 674 - - 675 - - 676 - - 677 - - 678 - - 679 - - 680 - - 681 - - 682 - - 683 - - 684 - - 685 - - 686 - - 687 - - 688 - - 689 - - 690 - - 691 - - 692 - - 693 - - 694 - - 695 - - 696 - - 697 - - 698 - - 699 - x-enum-descriptions: - - "Document class code" - - "Issuing state code" - - "Document number" - - "Date of expiry" - - "Date of issue" - - "Date of birth" - - "Place of birth" - - "Personal number" - - "Surname" - - "Given name(s)" - - "Mother's name" - - "Nationality" - - "Sex" - - "Height" - - "Weight" - - "Eyes color" - - "Hair color" - - "Address" - - "Donor" - - "Social security number" - - "DL class" - - "DL endorsement code" - - "DL restriction code" - - "Date of 21st birthday" - - "Issuing authority" - - "Surname and given names" - - "Nationality code" - - "Passport number" - - "Invitation number" - - "Visa ID" - - "Visa class" - - "Visa subclass" - - "MRZ type" - - "Optional data" - - "Document class name" - - "Issuing state name" - - "Place of issue" - - "Document number checksum" - - "Date of birth checksum" - - "Date of expiry checksum" - - "Personal number checksum" - - "Final checksum" - - "Passport number checksum" - - "Invitation number checksum" - - "Visa ID checksum" - - "Surname and given names checksum" - - "Visa valid until checksum" - - "Other" - - "MRZ strings" - - "Name suffix" - - "Name prefix" - - "Date of issue checksum" - - "Date of issue check digit" - - "Document series" - - "Registration number" - - "Vehicle model" - - "Vehicle color" - - "Vehicle body number" - - "Vehicle type" - - "Max permissible weight" - - "Unladen mass" - - "Address: area" - - "Address: state" - - "Address: building" - - "Address: house" - - "Address: flat" - - "Place of registration" - - "Date of registration" - - "Resident from" - - "Resident until" - - "Issuing authority code" - - "Place of birth: area" - - "Place of birth: state code" - - "Address: street" - - "Address: city" - - "Address: jurisdiction code" - - "Address: postal code" - - "Document number check digit" - - "Date of birth check digit" - - "Date of expiry check digit" - - "Personal number check digit" - - "Final check digit" - - "Passport number check digit" - - "Invitation number check digit" - - "Visa ID check digit" - - "Surname and given names check digit" - - "Visa valid until check digit" - - "Permit class" - - "Permit expiry date" - - "Permit identifier" - - "Permit issue date" - - "Permit restriction code" - - "Permit endorsement code" - - "Issue timestamp" - - "Number of duplicates" - - "Medical indicator codes" - - "Non-resident indicator" - - "Visa type" - - "Visa valid from" - - "Visa valid until" - - "Duration of stay" - - "Number of entries" - - "Day" - - "Month" - - "Year" - - "Unique customer identifier" - - "Commercial vehicle code" - - "AKA: date of birth" - - "AKA: social insurance number" - - "AKA: surname" - - "AKA: given name(s)" - - "AKA: name suffix" - - "AKA: name prefix" - - "Mailing address: street" - - "Mailing address: city" - - "Mailing address: jurisdiction code" - - "Mailing address: postal code" - - "Number for validation" - - "Inventory number" - - "Race ethnicity" - - "Jurisdiction vehicle class" - - "Jurisdiction endorsement code" - - "Jurisdiction restriction code" - - "Family name" - - "Given name(s) (national)" - - "Visa ID (national)" - - "Father's name" - - "Father's name (national)" - - "Surname and given names (national)" - - "Place of birth (national)" - - "Issuing authority (national)" - - "Issuing state code (numeric)" - - "Nationality code (numeric)" - - "Engine power" - - "Engine volume" - - "Chassis number" - - "Engine number" - - "Engine model" - - "Vehicle category" - - "Identity card number" - - "Control number" - - "Parents' given names" - - "Second surname" - - "Middle name" - - "Vehicle identification number" - - "VIN check digit" - - "VIN checksum" - - "Line 1 check digit" - - "Line 2 check digit" - - "Line 3 check digit" - - "Line 1 checksum" - - "Line 2 checksum" - - "Line 3 checksum" - - "Registration number check digit" - - "Registration number checksum" - - "Vehicle ITS code" - - "Card access number" - - "Marital status" - - "Company name" - - "Special notes" - - "Spouse's surname" - - "Tracking number" - - "Booklet number" - - "Children" - - "Copy" - - "Serial number" - - "Dossier number" - - "AKA: surname and given names" - - "Territorial validity" - - "MRZ strings with correct checksums" - - "CDL restriction code" - - "Date of 18th birthday" - - "DL record created" - - "DL date of duplicate issue" - - "Card type" - - "Military ID number" - - "Destination" - - "Blood group" - - "Sequence number" - - "Body type" - - "Vehicle make" - - "Transaction number" - - "Age" - - "Folio number" - - "Voter key" - - "Address: municipality" - - "Address: location" - - "Section" - - "OCR number" - - "Federal elections" - - "Reference number" - - "Optional data checksum" - - "Optional data check digit" - - "Visa number" - - "Visa number checksum" - - "Visa number check digit" - - "Voter" - - "Type of the previous document" - - "Field from MRZ" - - "Current date" - - "Status date of expiry" - - "Banknote number" - - "CSC code" - - "Pseudonym" - - "Academic title" - - "Address country" - - "Address ZIP code" - - "eID residence permit 1" - - "eID residence permit 2" - - "eID place of birth: street" - - "eID place of birth: city" - - "eID place of birth: state" - - "eID place of birth: country" - - "eID place of birth: postal code" - - "CDL class" - - "Date of 19th birthday" - - "Weight (pound)" - - "Indicator of document limited duration" - - "Endorsement expiration date" - - "Revision date" - - "Compliance type" - - "Family name truncation" - - "First name truncation" - - "Middle name truncation" - - "Exam date" - - "Organization" - - "Department" - - "Pay grade" - - "Rank" - - "Benefits number" - - "Sponsor service" - - "Sponsor status" - - "Sponsor" - - "Relationship" - - "USCIS" - - "Category" - - "Conditions" - - "Identifier" - - "Configuration" - - "Discretionary data" - - "Line 1 optional data" - - "Line 2 optional data" - - "Line 3 optional data" - - "EQV code" - - "ALT code" - - "Binary code" - - "Pseudo code" - - "Fee" - - "Stamp number" - - "SBH security options" - - "SBH integrity options" - - "Date of creation" - - "Validity period" - - "Patron header version" - - "BDB type" - - "Biometric type" - - "Biometric subtype" - - "Biometric product ID" - - "Biometric format owner" - - "Biometric format type" - - "Phone" - - "Profession" - - "Position" - - "Personal data summary" - - "Other valid ID" - - "Custody info" - - "Other name" - - "Observations" - - "Tax" - - "Personalization date" - - "Personalization SN" - - "Other person name" - - "Notify person: date of record" - - "Notify person: name" - - "Notify person: phone" - - "Notify person: address" - - "DS certificate issuer" - - "DS certificate subject" - - "DS certificate valid from" - - "DS certificate valid to" - - "Vehicle data from the DG1 data group" - - "Type of approval number" - - "Administrative number" - - "Document discriminator" - - "Data discriminator" - - "ID number of ISO issuer" - - "DTC version" - - "DTC ID" - - "DTC date of expiry" - - "GNIB number" - - "Department number" - - "Telegraph code" - - "Allergies" - - "Special code" - - "Court code" - - "County" - - "Sponsor SSN" - - "DoD number" - - "Expiry date of Motorcycle Novice status" - - "DUF number" - - "AGY" - - "PNR code" - - "Code of the airport of departure" - - "Code of the airport of arrival" - - "Flight number" - - "Date of flight" - - "Seat number" - - "Date of boarding pass issue" - - "CCW until" - - "Reference number checksum" - - "Reference number check digit" - - "Room number" - - "Religion" - - "Months to expire" - - "Electronic ticket indicator" - - "Compartment code" - - "Check-in sequence number" - - "Airline designator of boarding pass issuer" - - "Airline numeric code" - - "Ticket number" - - "Frequent flyer airline designator" - - "Frequent flyer number" - - "Free baggage allowance" - - "PDF417 codec" - - "Identity card number checksum" - - "Identity card number check digit" - - "Veteran" - - "DL category A1 valid from" - - "DL category A1 valid to" - - "DL category A1 codes" - - "DL category A valid from" - - "DL category A valid to" - - "DL category A codes" - - "DL category B valid from" - - "DL category B valid to" - - "DL category B codes" - - "DL category C1 valid from" - - "DL category C1 valid to" - - "DL category C1 codes" - - "DL category C valid from" - - "DL category C valid to" - - "DL category C codes" - - "DL category D1 valid from" - - "DL category D1 valid to" - - "DL category D1 codes" - - "DL category D valid from" - - "DL category D valid to" - - "DL category D codes" - - "DL category BE valid from" - - "DL category BE valid to" - - "DL category BE codes" - - "DL category C1E valid from" - - "DL category C1E valid to" - - "DL category C1E codes" - - "DL category CE valid from" - - "DL category CE valid to" - - "DL category CE codes" - - "DL category D1E valid from" - - "DL category D1E valid to" - - "DL category D1E codes" - - "DL category DE valid from" - - "DL category DE valid to" - - "DL category DE codes" - - "DL category M valid from" - - "DL category M valid to" - - "DL category M codes" - - "DL category L valid from" - - "DL category L valid to" - - "DL category L codes" - - "DL category T valid from" - - "DL category T valid to" - - "DL category T codes" - - "DL category AM valid from" - - "DL category AM valid to" - - "DL category AM codes" - - "DL category A2 valid from" - - "DL category A2 valid to" - - "DL category A2 codes" - - "DL category B1 valid from" - - "DL category B1 valid to" - - "DL category B1 codes" - - "Surname at birth" - - "Civil status" - - "Number of seats" - - "Number of standing places" - - "Max speed" - - "Fuel type" - - "Vehicle environmental type" - - "Power-to-weight ratio" - - "Max mass of trailer (braked)" - - "Max mass of trailer (unbraked)" - - "Transmission type" - - "Trailer hitch" - - "Accompanied by" - - "Police district" - - "First issue date" - - "Payload capacity" - - "Number of axles" - - "Permissible axle load" - - "Precinct" - - "Invited by" - - "Purpose of entry" - - "Skin color" - - "Complexion" - - "Airport of departure" - - "Airport of arrival" - - "Airline name" - - "Airline loyalty program for frequent flyers" - - "License number" - - "In tanks" - - "Other than tanks" - - "Fast Track service" - - "Owner" - - "MRZ strings from ICAO RFID" - - "Number of card issuances" - - "Number of card issuances checksum" - - "Number of card issuances check digit" - - "Century of birth" - - "DL category A3 valid from" - - "DL category A3 valid to" - - "DL category A3 codes" - - "DL category C2 valid from" - - "DL category C2 valid to" - - "DL category C2 codes" - - "DL category B2 valid from" - - "DL category B2 valid to" - - "DL category B2 codes" - - "DL category D2 valid from" - - "DL category D2 valid to" - - "DL category D2 codes" - - "DL category B2E valid from" - - "DL category B2E valid to" - - "DL category B2E codes" - - "DL category G valid from" - - "DL category G valid to" - - "DL category G codes" - - "DL category J valid from" - - "DL category J valid to" - - "DL category J codes" - - "DL category LC valid from" - - "DL category LC valid to" - - "DL category LC codes" - - "Bank card number" - - "Bank card validity" - - "Tax number" - - "Health insurance number" - - "Grandfather's name" - - "Selectee indicator" - - "Mother's surname" - - "Mother's name" - - "Father's surname" - - "Father's name" - - "Mother's date of birth" - - "Father's date of birth" - - "Mother's personal number" - - "Father's personal number" - - "Mother's place of birth" - - "Father's place of birth" - - "Mother's country of birth" - - "Father's country of birth" - - "Date of first renewal" - - "Date of second renewal" - - "Place of examination" - - "Application number" - - "Voucher number" - - "Authorization number" - - "Faculty" - - "Form of education" - - "DNI number" - - "Retirement number" - - "Professional id number" - - "Age at issue" - - "Years since issue" - - "DL category BTP valid from" - - "DL category BTP codes" - - "DL category BTP valid to" - - "DL category C3 valid from" - - "DL category C3 codes" - - "DL category C3 valid to" - - "DL category E valid from" - - "DL category E codes" - - "DL category E valid to" - - "DL category F valid from" - - "DL category F codes" - - "DL category F valid to" - - "DL category FA valid from" - - "DL category FA codes" - - "DL category FA valid to" - - "DL category FA1 valid from" - - "DL category FA1 codes" - - "DL category FA1 valid to" - - "DL category FB valid from" - - "DL category FB codes" - - "DL category FB valid to" - - "DL category G1 valid from" - - "DL category G1 codes" - - "DL category G1 valid to" - - "DL category H valid from" - - "DL category H codes" - - "DL category H valid to" - - "DL category I valid from" - - "DL category I codes" - - "DL category I valid to" - - "DL category K valid from" - - "DL category K codes" - - "DL category K valid to" - - "DL category LK valid from" - - "DL category LK codes" - - "DL category LK valid to" - - "DL category N valid from" - - "DL category N codes" - - "DL category N valid to" - - "DL category S valid from" - - "DL category S codes" - - "DL category S valid to" - - "DL category TB valid from" - - "DL category TB codes" - - "DL category TB valid to" - - "DL category TM valid from" - - "DL category TM codes" - - "DL category TM valid to" - - "DL category TR valid from" - - "DL category TR codes" - - "DL category TR valid to" - - "DL category TV valid from" - - "DL category TV codes" - - "DL category TV valid to" - - "DL category V valid from" - - "DL category V codes" - - "DL category V valid to" - - "DL category W valid from" - - "DL category W codes" - - "DL category W valid to" - - "URL" - - "Caliber" - - "Model" - - "Make" - - "Number of cylinders" - - "Surname of husband after registration" - - "Surname of wife after registration" - - "Date of birth of wife" - - "Date of birth of husband" - - "Citizenship of first person" - - "Citizenship of second person" - - "CVV code" - - "Date of insurance expiry" - - "Mortgage by" - - "Old document number" - - "Old date of issue" - - "Old place of issue" - - "DL category LR valid from" - - "DL category LR valid to" - - "DL category LR codes" - - "DL category MR valid from" - - "DL category MR valid to" - - "DL category MR codes" - - "DL category HR valid from" - - "DL category HR valid to" - - "DL category HR codes" - - "DL category HC valid from" - - "DL category HC valid to" - - "DL category HC codes" - - "DL category MC valid from" - - "DL category MC valid to" - - "DL category MC codes" - - "DL category RE valid from" - - "DL category RE valid to" - - "DL category RE codes" - - "DL category R valid from" - - "DL category R valid to" - - "DL category R codes" - - "DL category CA valid from" - - "DL category CA valid to" - - "DL category CA codes" - - "Citizenship status" - - "Military service from" - - "Military service to" - - "DL category NT valid from" - - "DL category NT valid to" - - "DL category NT codes" - - "DL category TN valid from" - - "DL category TN valid to" - - "DL category TN codes" - - "DL category D3 valid from" - - "DL category D3 valid to" - - "DL category D3 codes" - - "Alternative date of expiry" - - "DL category CD valid from" - - "DL category CD valid to" - - "DL category CD codes" - - "Issuer identification number" - - "Payment period from" - - "Payment period to" - - "Vaccination certificate identifier" - - "First name" - - "Date of arrival" - - "Second name" - - "Third name" - - "Fourth name" - - "Last name" - - "DL category RM valid from" - - "DL category RM codes" - - "DL category RM valid to" - - "DL category PW valid from" - - "DL category PW codes" - - "DL category PW valid to" - - "DL category EB valid from" - - "DL category EB codes" - - "DL category EB valid to" - - "DL category EC valid from" - - "DL category EC codes" - - "DL category EC valid to" - - "DL category EC1 valid from" - - "DL category EC1 codes" - - "DL category EC1 valid to" - - "Place of birth city" - - "Year of birth" - - "Year of expiry" - - "Grandfather's name (maternal)" - - "First surname" - - "Month of birth" - - "Floor number" - - "Entrance number" - - "Block number" - - "Street number" - - "Street type" - - "City sector" - - "County type" - - "City type" - - "Building type" - - "Date of Retirement" - - "Document Status" - - "Signature" - - "Unique Certificate Identifier" - - "Email" - - "Date of Specimen Collection" - - "Type Of Testing" - - "Result Of Testing" - - "Method Of Testing" - - "Digital Travel Authorization Number" - - "Date of First Positive Test Result" - - "EF.CardAccess" - - "Short flight number" - - "Airline code" - - "MVC Agency" - - "Issuing state code (Alpha-2)" - - "Nationality code (Alpha-2)" - - "First issue date check digit" - - "First issue date checksum" - x-enum-varnames: - - "DOCUMENT_CLASS_CODE" - - "ISSUING_STATE_CODE" - - "DOCUMENT_NUMBER" - - "DATE_OF_EXPIRY" - - "DATE_OF_ISSUE" - - "DATE_OF_BIRTH" - - "PLACE_OF_BIRTH" - - "PERSONAL_NUMBER" - - "SURNAME" - - "GIVEN_NAMES" - - "MOTHERS_NAME" - - "NATIONALITY" - - "SEX" - - "HEIGHT" - - "WEIGHT" - - "EYES_COLOR" - - "HAIR_COLOR" - - "ADDRESS" - - "DONOR" - - "SOCIAL_SECURITY_NUMBER" - - "DL_CLASS" - - "DL_ENDORSED" - - "DL_RESTRICTION_CODE" - - "DL_UNDER_21_DATE" - - "AUTHORITY" - - "SURNAME_AND_GIVEN_NAMES" - - "NATIONALITY_CODE" - - "PASSPORT_NUMBER" - - "INVITATION_NUMBER" - - "VISA_ID" - - "VISA_CLASS" - - "VISA_SUBCLASS" - - "MRZ_TYPE" - - "OPTIONAL_DATA" - - "DOCUMENT_CLASS_NAME" - - "ISSUING_STATE_NAME" - - "PLACE_OF_ISSUE" - - "DOCUMENT_NUMBER_CHECKSUM" - - "DATE_OF_BIRTH_CHECKSUM" - - "DATE_OF_EXPIRY_CHECKSUM" - - "PERSONAL_NUMBER_CHECKSUM" - - "FINAL_CHECKSUM" - - "PASSPORT_NUMBER_CHECKSUM" - - "INVITATION_NUMBER_CHECKSUM" - - "VISA_ID_CHECKSUM" - - "SURNAME_AND_GIVEN_NAMES_CHECKSUM" - - "VISA_VALID_UNTIL_CHECKSUM" - - "OTHER" - - "MRZ_STRINGS" - - "NAME_SUFFIX" - - "NAME_PREFIX" - - "DATE_OF_ISSUE_CHECKSUM" - - "DATE_OF_ISSUE_CHECK_DIGIT" - - "DOCUMENT_SERIES" - - "REG_CERT_REG_NUMBER" - - "REG_CERT_CAR_MODEL" - - "REG_CERT_CAR_COLOR" - - "REG_CERT_BODY_NUMBER" - - "REG_CERT_CAR_TYPE" - - "REG_CERT_MAX_WEIGHT" - - "REG_CERT_WEIGHT" - - "ADDRESS_AREA" - - "ADDRESS_STATE" - - "ADDRESS_BUILDING" - - "ADDRESS_HOUSE" - - "ADDRESS_FLAT" - - "PLACE_OF_REGISTRATION" - - "DATE_OF_REGISTRATION" - - "RESIDENT_FROM" - - "RESIDENT_UNTIL" - - "AUTHORITY_CODE" - - "PLACE_OF_BIRTH_AREA" - - "PLACE_OF_BIRTH_STATE_CODE" - - "ADDRESS_STREET" - - "ADDRESS_CITY" - - "ADDRESS_JURISDICTION_CODE" - - "ADDRESS_POSTAL_CODE" - - "DOCUMENT_NUMBER_CHECK_DIGIT" - - "DATE_OF_BIRTH_CHECK_DIGIT" - - "DATE_OF_EXPIRY_CHECK_DIGIT" - - "PERSONAL_NUMBER_CHECK_DIGIT" - - "FINAL_CHECK_DIGIT" - - "PASSPORT_NUMBER_CHECK_DIGIT" - - "INVITATION_NUMBER_CHECK_DIGIT" - - "VISA_ID_CHECK_DIGIT" - - "SURNAME_AND_GIVEN_NAMES_CHECK_DIGIT" - - "VISA_VALID_UNTIL_CHECK_DIGIT" - - "PERMIT_DL_CLASS" - - "PERMIT_DATE_OF_EXPIRY" - - "PERMIT_IDENTIFIER" - - "PERMIT_DATE_OF_ISSUE" - - "PERMIT_RESTRICTION_CODE" - - "PERMIT_ENDORSED" - - "ISSUE_TIMESTAMP" - - "NUMBER_OF_DUPLICATES" - - "MEDICAL_INDICATOR_CODES" - - "NON_RESIDENT_INDICATOR" - - "VISA_TYPE" - - "VISA_VALID_FROM" - - "VISA_VALID_UNTIL" - - "DURATION_OF_STAY" - - "NUMBER_OF_ENTRIES" - - "DAY" - - "MONTH" - - "YEAR" - - "UNIQUE_CUSTOMER_IDENTIFIER" - - "COMMERCIAL_VEHICLE_CODES" - - "AKA_DATE_OF_BIRTH" - - "AKA_SOCIAL_SECURITY_NUMBER" - - "AKA_SURNAME" - - "AKA_GIVEN_NAMES" - - "AKA_NAME_SUFFIX" - - "AKA_NAME_PREFIX" - - "MAILING_ADDRESS_STREET" - - "MAILING_ADDRESS_CITY" - - "MAILING_ADDRESS_JURISDICTION_CODE" - - "MAILING_ADDRESS_POSTAL_CODE" - - "AUDIT_INFORMATION" - - "INVENTORY_NUMBER" - - "RACE_ETHNICITY" - - "JURISDICTION_VEHICLE_CLASS" - - "JURISDICTION_ENDORSEMENT_CODE" - - "JURISDICTION_RESTRICTION_CODE" - - "FAMILY_NAME" - - "GIVEN_NAMES_RUS" - - "VISA_ID_RUS" - - "FATHERS_NAME" - - "FATHERS_NAME_RUS" - - "SURNAME_AND_GIVEN_NAMES_RUS" - - "PLACE_OF_BIRTH_RUS" - - "AUTHORITY_RUS" - - "ISSUING_STATE_CODE_NUMERIC" - - "NATIONALITY_CODE_NUMERIC" - - "ENGINE_POWER" - - "ENGINE_VOLUME" - - "CHASSIS_NUMBER" - - "ENGINE_NUMBER" - - "ENGINE_MODEL" - - "VEHICLE_CATEGORY" - - "IDENTITY_CARD_NUMBER" - - "CONTROL_NUMBER" - - "PARENTS_GIVEN_NAMES" - - "SECOND_SURNAME" - - "MIDDLE_NAME" - - "REG_CERT_VIN" - - "REG_CERT_VIN_CHECK_DIGIT" - - "REG_CERT_VIN_CHECKSUM" - - "LINE_1_CHECK_DIGIT" - - "LINE_2_CHECK_DIGIT" - - "LINE_3_CHECK_DIGIT" - - "LINE_1_CHECKSUM" - - "LINE_2_CHECKSUM" - - "LINE_3_CHECKSUM" - - "REG_CERT_REG_NUMBER_CHECK_DIGIT" - - "REG_CERT_REG_NUMBER_CHECKSUM" - - "REG_CERT_VEHICLE_ITS_CODE" - - "CARD_ACCESS_NUMBER" - - "MARITAL_STATUS" - - "COMPANY_NAME" - - "SPECIAL_NOTES" - - "SURNAME_OF_SPOUSE" - - "TRACKING_NUMBER" - - "BOOKLET_NUMBER" - - "CHILDREN" - - "COPY" - - "SERIAL_NUMBER" - - "DOSSIER_NUMBER" - - "AKA_SURNAME_AND_GIVEN_NAMES" - - "TERRITORIAL_VALIDITY" - - "MRZ_STRINGS_WITH_CORRECT_CHECK_SUMS" - - "DL_CDL_RESTRICTION_CODE" - - "DL_UNDER_18_DATE" - - "DL_RECORD_CREATED" - - "DL_DUPLICATE_DATE" - - "DL_ISSUE_TYPE" - - "MILITARY_BOOK_NUMBER" - - "DESTINATION" - - "BLOOD_GROUP" - - "SEQUENCE_NUMBER" - - "REG_CERT_BODY_TYPE" - - "REG_CERT_CAR_MARK" - - "TRANSACTION_NUMBER" - - "AGE" - - "FOLIO_NUMBER" - - "VOTER_KEY" - - "ADDRESS_MUNICIPALITY" - - "ADDRESS_LOCATION" - - "SECTION" - - "OCR_NUMBER" - - "FEDERAL_ELECTIONS" - - "REFERENCE_NUMBER" - - "OPTIONAL_DATA_CHECKSUM" - - "OPTIONAL_DATA_CHECK_DIGIT" - - "VISA_NUMBER" - - "VISA_NUMBER_CHECKSUM" - - "VISA_NUMBER_CHECK_DIGIT" - - "VOTER" - - "PREVIOUS_TYPE" - - "FIELD_FROM_MRZ" - - "CURRENT_DATE" - - "STATUS_DATE_OF_EXPIRY" - - "BANKNOTE_NUMBER" - - "CSC_CODE" - - "ARTISTIC_NAME" - - "ACADEMIC_TITLE" - - "ADDRESS_COUNTRY" - - "ADDRESS_ZIP_CODE" - - "E_ID_RESIDENCE_PERMIT_1" - - "E_ID_RESIDENCE_PERMIT_2" - - "E_ID_PLACE_OF_BIRTH_STREET" - - "E_ID_PLACE_OF_BIRTH_CITY" - - "E_ID_PLACE_OF_BIRTH_STATE" - - "E_ID_PLACE_OF_BIRTH_COUNTRY" - - "E_ID_PLACE_OF_BIRTH_ZIP_CODE" - - "CDL_CLASS" - - "DL_UNDER_19_DATE" - - "WEIGHT_POUNDS" - - "LIMITED_DURATION_DOCUMENT_INDICATOR" - - "ENDORSEMENT_EXPIRATION_DATE" - - "REVISION_DATE" - - "COMPLIANCE_TYPE" - - "FAMILY_NAME_TRUNCATION" - - "FIRST_NAME_TRUNCATION" - - "MIDDLE_NAME_TRUNCATION" - - "EXAM_DATE" - - "ORGANIZATION" - - "DEPARTMENT" - - "PAY_GRADE" - - "RANK" - - "BENEFITS_NUMBER" - - "SPONSOR_SERVICE" - - "SPONSOR_STATUS" - - "SPONSOR" - - "RELATIONSHIP" - - "USCIS" - - "CATEGORY" - - "CONDITIONS" - - "IDENTIFIER" - - "CONFIGURATION" - - "DISCRETIONARY_DATA" - - "LINE_1_OPTIONAL_DATA" - - "LINE_2_OPTIONAL_DATA" - - "LINE_3_OPTIONAL_DATA" - - "EQV_CODE" - - "ALT_CODE" - - "BINARY_CODE" - - "PSEUDO_CODE" - - "FEE" - - "STAMP_NUMBER" - - "SBH_SECURITY_OPTIONS" - - "SBH_INTEGRITY_OPTIONS" - - "DATE_OF_CREATION" - - "VALIDITY_PERIOD" - - "PATRON_HEADER_VERSION" - - "BDB_TYPE" - - "BIOMETRIC_TYPE" - - "BIOMETRIC_SUBTYPE" - - "BIOMETRIC_PRODUCT_ID" - - "BIOMETRIC_FORMAT_OWNER" - - "BIOMETRIC_FORMAT_TYPE" - - "PHONE" - - "PROFESSION" - - "TITLE" - - "PERSONAL_SUMMARY" - - "OTHER_VALID_ID" - - "CUSTODY_INFO" - - "OTHER_NAME" - - "OBSERVATIONS" - - "TAX" - - "DATE_OF_PERSONALIZATION" - - "PERSONALIZATION_SN" - - "OTHER_PERSON_NAME" - - "PERSON_TO_NOTIFY_DATE_OF_RECORD" - - "PERSON_TO_NOTIFY_NAME" - - "PERSON_TO_NOTIFY_PHONE" - - "PERSON_TO_NOTIFY_ADDRESS" - - "DS_CERTIFICATE_ISSUER" - - "DS_CERTIFICATE_SUBJECT" - - "DS_CERTIFICATE_VALID_FROM" - - "DS_CERTIFICATE_VALID_TO" - - "VRC_DATA_OBJECT_ENTRY" - - "TYPE_APPROVAL_NUMBER" - - "ADMINISTRATIVE_NUMBER" - - "DOCUMENT_DISCRIMINATOR" - - "DATA_DISCRIMINATOR" - - "ISO_ISSUER_ID_NUMBER" - - "DTC_VERSION" - - "DTC_ID" - - "DTC_DATE_OF_EXPIRY" - - "GNIB_NUMBER" - - "DEPT_NUMBER" - - "TELEX_CODE" - - "ALLERGIES" - - "SP_CODE" - - "COURT_CODE" - - "CTY" - - "SPONSOR_SSN" - - "DOD_NUMBER" - - "MC_NOVICE_DATE" - - "DUF_NUMBER" - - "AGY" - - "PNR_CODE" - - "FROM_AIRPORT_CODE" - - "TO_AIRPORT_CODE" - - "FLIGHT_NUMBER" - - "DATE_OF_FLIGHT" - - "SEAT_NUMBER" - - "DATE_OF_ISSUE_BOARDING_PASS" - - "CCW_UNTIL" - - "REFERENCE_NUMBER_CHECKSUM" - - "REFERENCE_NUMBER_CHECK_DIGIT" - - "ROOM_NUMBER" - - "RELIGION" - - "REMAINDER_TERM" - - "ELECTRONIC_TICKET_INDICATOR" - - "COMPARTMENT_CODE" - - "CHECK_IN_SEQUENCE_NUMBER" - - "AIRLINE_DESIGNATOR_OF_BOARDING_PASS_ISSUER" - - "AIRLINE_NUMERIC_CODE" - - "TICKET_NUMBER" - - "FREQUENT_FLYER_AIRLINE_DESIGNATOR" - - "FREQUENT_FLYER_NUMBER" - - "FREE_BAGGAGE_ALLOWANCE" - - "PDF417_CODEC" - - "IDENTITY_CARD_NUMBER_CHECKSUM" - - "IDENTITY_CARD_NUMBER_CHECK_DIGIT" - - "VETERAN" - - "DL_CLASS_CODE_A1_FROM" - - "DL_CLASS_CODE_A1_TO" - - "DL_CLASS_CODE_A1_NOTES" - - "DL_CLASS_CODE_A_FROM" - - "DL_CLASS_CODE_A_TO" - - "DL_CLASS_CODE_A_NOTES" - - "DL_CLASS_CODE_B_FROM" - - "DL_CLASS_CODE_B_TO" - - "DL_CLASS_CODE_B_NOTES" - - "DL_CLASS_CODE_C1_FROM" - - "DL_CLASS_CODE_C1_TO" - - "DL_CLASS_CODE_C1_NOTES" - - "DL_CLASS_CODE_C_FROM" - - "DL_CLASS_CODE_C_TO" - - "DL_CLASS_CODE_C_NOTES" - - "DL_CLASS_CODE_D1_FROM" - - "DL_CLASS_CODE_D1_TO" - - "DL_CLASS_CODE_D1_NOTES" - - "DL_CLASS_CODE_D_FROM" - - "DL_CLASS_CODE_D_TO" - - "DL_CLASS_CODE_D_NOTES" - - "DL_CLASS_CODE_BE_FROM" - - "DL_CLASS_CODE_BE_TO" - - "DL_CLASS_CODE_BE_NOTES" - - "DL_CLASS_CODE_C1E_FROM" - - "DL_CLASS_CODE_C1E_TO" - - "DL_CLASS_CODE_C1E_NOTES" - - "DL_CLASS_CODE_CE_FROM" - - "DL_CLASS_CODE_CE_TO" - - "DL_CLASS_CODE_CE_NOTES" - - "DL_CLASS_CODE_D1E_FROM" - - "DL_CLASS_CODE_D1E_TO" - - "DL_CLASS_CODE_D1E_NOTES" - - "DL_CLASS_CODE_DE_FROM" - - "DL_CLASS_CODE_DE_TO" - - "DL_CLASS_CODE_DE_NOTES" - - "DL_CLASS_CODE_M_FROM" - - "DL_CLASS_CODE_M_TO" - - "DL_CLASS_CODE_M_NOTES" - - "DL_CLASS_CODE_L_FROM" - - "DL_CLASS_CODE_L_TO" - - "DL_CLASS_CODE_L_NOTES" - - "DL_CLASS_CODE_T_FROM" - - "DL_CLASS_CODE_T_TO" - - "DL_CLASS_CODE_T_NOTES" - - "DL_CLASS_CODE_AM_FROM" - - "DL_CLASS_CODE_AM_TO" - - "DL_CLASS_CODE_AM_NOTES" - - "DL_CLASS_CODE_A2_FROM" - - "DL_CLASS_CODE_A2_TO" - - "DL_CLASS_CODE_A2_NOTES" - - "DL_CLASS_CODE_B1_FROM" - - "DL_CLASS_CODE_B1_TO" - - "DL_CLASS_CODE_B1_NOTES" - - "SURNAME_AT_BIRTH" - - "CIVIL_STATUS" - - "NUMBER_OF_SEATS" - - "NUMBER_OF_STANDING_PLACES" - - "MAX_SPEED" - - "FUEL_TYPE" - - "EC_ENVIRONMENTAL_TYPE" - - "POWER_WEIGHT_RATIO" - - "MAX_MASS_OF_TRAILER_BRAKED" - - "MAX_MASS_OF_TRAILER_UNBRAKED" - - "TRANSMISSION_TYPE" - - "TRAILER_HITCH" - - "ACCOMPANIED_BY" - - "POLICE_DISTRICT" - - "FIRST_ISSUE_DATE" - - "PAYLOAD_CAPACITY" - - "NUMBER_OF_AXLES" - - "PERMISSIBLE_AXLE_LOAD" - - "PRECINCT" - - "INVITED_BY" - - "PURPOSE_OF_ENTRY" - - "SKIN_COLOR" - - "COMPLEXION" - - "AIRPORT_FROM" - - "AIRPORT_TO" - - "AIRLINE_NAME" - - "AIRLINE_NAME_FREQUENT_FLYER" - - "LICENSE_NUMBER" - - "IN_TANKS" - - "EXCEPT_IN_TANKS" - - "FAST_TRACK" - - "OWNER" - - "MRZ_STRINGS_ICAO_RFID" - - "NUMBER_OF_CARD_ISSUANCE" - - "NUMBER_OF_CARD_ISSUANCE_CHECKSUM" - - "NUMBER_OF_CARD_ISSUANCE_CHECK_DIGIT" - - "CENTURY_DATE_OF_BIRTH" - - "DL_CLASS_CODE_A3_FROM" - - "DL_CLASS_CODE_A3_TO" - - "DL_CLASS_CODE_A3_NOTES" - - "DL_CLASS_CODE_C2_FROM" - - "DL_CLASS_CODE_C2_TO" - - "DL_CLASS_CODE_C2_NOTES" - - "DL_CLASS_CODE_B2_FROM" - - "DL_CLASS_CODE_B2_TO" - - "DL_CLASS_CODE_B2_NOTES" - - "DL_CLASS_CODE_D2_FROM" - - "DL_CLASS_CODE_D2_TO" - - "DL_CLASS_CODE_D2_NOTES" - - "DL_CLASS_CODE_B2E_FROM" - - "DL_CLASS_CODE_B2E_TO" - - "DL_CLASS_CODE_B2E_NOTES" - - "DL_CLASS_CODE_G_FROM" - - "DL_CLASS_CODE_G_TO" - - "DL_CLASS_CODE_G_NOTES" - - "DL_CLASS_CODE_J_FROM" - - "DL_CLASS_CODE_J_TO" - - "DL_CLASS_CODE_J_NOTES" - - "DL_CLASS_CODE_LC_FROM" - - "DL_CLASS_CODE_LC_TO" - - "DL_CLASS_CODE_LC_NOTES" - - "BANK_CARD_NUMBER" - - "BANK_CARD_VALID_THRU" - - "TAX_NUMBER" - - "HEALTH_NUMBER" - - "GRANDFATHER_NAME" - - "SELECTEE_INDICATOR" - - "MOTHER_SURNAME" - - "MOTHER_GIVEN_NAME" - - "FATHER_SURNAME" - - "FATHER_GIVEN_NAME" - - "MOTHER_DATE_OF_BIRTH" - - "FATHER_DATE_OF_BIRTH" - - "MOTHER_PERSONAL_NUMBER" - - "FATHER_PERSONAL_NUMBER" - - "MOTHER_PLACE_OF_BIRTH" - - "FATHER_PLACE_OF_BIRTH" - - "MOTHER_COUNTRY_OF_BIRTH" - - "FATHER_COUNTRY_OF_BIRTH" - - "DATE_FIRST_RENEWAL" - - "DATE_SECOND_RENEWAL" - - "PLACE_OF_EXAMINATION" - - "APPLICATION_NUMBER" - - "VOUCHER_NUMBER" - - "AUTHORIZATION_NUMBER" - - "FACULTY" - - "FORM_OF_EDUCATION" - - "DNI_NUMBER" - - "RETIREMENT_NUMBER" - - "PROFESSIONAL_ID_NUMBER" - - "AGE_AT_ISSUE" - - "YEARS_SINCE_ISSUE" - - "DL_CLASS_CODE_BTP_FROM" - - "DL_CLASS_CODE_BTP_NOTES" - - "DL_CLASS_CODE_BTP_TO" - - "DL_CLASS_CODE_C3_FROM" - - "DL_CLASS_CODE_C3_NOTES" - - "DL_CLASS_CODE_C3_TO" - - "DL_CLASS_CODE_E_FROM" - - "DL_CLASS_CODE_E_NOTES" - - "DL_CLASS_CODE_E_TO" - - "DL_CLASS_CODE_F_FROM" - - "DL_CLASS_CODE_F_NOTES" - - "DL_CLASS_CODE_F_TO" - - "DL_CLASS_CODE_FA_FROM" - - "DL_CLASS_CODE_FA_NOTES" - - "DL_CLASS_CODE_FA_TO" - - "DL_CLASS_CODE_FA1_FROM" - - "DL_CLASS_CODE_FA1_NOTES" - - "DL_CLASS_CODE_FA1_TO" - - "DL_CLASS_CODE_FB_FROM" - - "DL_CLASS_CODE_FB_NOTES" - - "DL_CLASS_CODE_FB_TO" - - "DL_CLASS_CODE_G1_FROM" - - "DL_CLASS_CODE_G1_NOTES" - - "DL_CLASS_CODE_G1_TO" - - "DL_CLASS_CODE_H_FROM" - - "DL_CLASS_CODE_H_NOTES" - - "DL_CLASS_CODE_H_TO" - - "DL_CLASS_CODE_I_FROM" - - "DL_CLASS_CODE_I_NOTES" - - "DL_CLASS_CODE_I_TO" - - "DL_CLASS_CODE_K_FROM" - - "DL_CLASS_CODE_K_NOTES" - - "DL_CLASS_CODE_K_TO" - - "DL_CLASS_CODE_LK_FROM" - - "DL_CLASS_CODE_LK_NOTES" - - "DL_CLASS_CODE_LK_TO" - - "DL_CLASS_CODE_N_FROM" - - "DL_CLASS_CODE_N_NOTES" - - "DL_CLASS_CODE_N_TO" - - "DL_CLASS_CODE_S_FROM" - - "DL_CLASS_CODE_S_NOTES" - - "DL_CLASS_CODE_S_TO" - - "DL_CLASS_CODE_TB_FROM" - - "DL_CLASS_CODE_TB_NOTES" - - "DL_CLASS_CODE_TB_TO" - - "DL_CLASS_CODE_TM_FROM" - - "DL_CLASS_CODE_TM_NOTES" - - "DL_CLASS_CODE_TM_TO" - - "DL_CLASS_CODE_TR_FROM" - - "DL_CLASS_CODE_TR_NOTES" - - "DL_CLASS_CODE_TR_TO" - - "DL_CLASS_CODE_TV_FROM" - - "DL_CLASS_CODE_TV_NOTES" - - "DL_CLASS_CODE_TV_TO" - - "DL_CLASS_CODE_V_FROM" - - "DL_CLASS_CODE_V_NOTES" - - "DL_CLASS_CODE_V_TO" - - "DL_CLASS_CODE_W_FROM" - - "DL_CLASS_CODE_W_NOTES" - - "DL_CLASS_CODE_W_TO" - - "URL" - - "CALIBER" - - "MODEL" - - "MAKE" - - "NUMBER_OF_CYLINDERS" - - "SURNAME_OF_HUSBAND_AFTER_REGISTRATION" - - "SURNAME_OF_WIFE_AFTER_REGISTRATION" - - "DATE_OF_BIRTH_OF_WIFE" - - "DATE_OF_BIRTH_OF_HUSBAND" - - "CITIZENSHIP_OF_FIRST_PERSON" - - "CITIZENSHIP_OF_SECOND_PERSON" - - "CVV" - - "DATE_OF_INSURANCE_EXPIRY" - - "MORTGAGE_BY" - - "OLD_DOCUMENT_NUMBER" - - "OLD_DATE_OF_ISSUE" - - "OLD_PLACE_OF_ISSUE" - - "DL_CLASS_CODE_LR_FROM" - - "DL_CLASS_CODE_LR_TO" - - "DL_CLASS_CODE_LR_NOTES" - - "DL_CLASS_CODE_MR_FROM" - - "DL_CLASS_CODE_MR_TO" - - "DL_CLASS_CODE_MR_NOTES" - - "DL_CLASS_CODE_HR_FROM" - - "DL_CLASS_CODE_HR_TO" - - "DL_CLASS_CODE_HR_NOTES" - - "DL_CLASS_CODE_HC_FROM" - - "DL_CLASS_CODE_HC_TO" - - "DL_CLASS_CODE_HC_NOTES" - - "DL_CLASS_CODE_MC_FROM" - - "DL_CLASS_CODE_MC_TO" - - "DL_CLASS_CODE_MC_NOTES" - - "DL_CLASS_CODE_RE_FROM" - - "DL_CLASS_CODE_RE_TO" - - "DL_CLASS_CODE_RE_NOTES" - - "DL_CLASS_CODE_R_FROM" - - "DL_CLASS_CODE_R_TO" - - "DL_CLASS_CODE_R_NOTES" - - "DL_CLASS_CODE_CA_FROM" - - "DL_CLASS_CODE_CA_TO" - - "DL_CLASS_CODE_CA_NOTES" - - "CITIZENSHIP_STATUS" - - "MILITARY_SERVICE_FROM" - - "MILITARY_SERVICE_TO" - - "DL_CLASS_CODE_NT_FROM" - - "DL_CLASS_CODE_NT_TO" - - "DL_CLASS_CODE_NT_NOTES" - - "DL_CLASS_CODE_TN_FROM" - - "DL_CLASS_CODE_TN_TO" - - "DL_CLASS_CODE_TN_NOTES" - - "DL_CLASS_CODE_D3_FROM" - - "DL_CLASS_CODE_D3_TO" - - "DL_CLASS_CODE_D3_NOTES" - - "ALT_DATE_OF_EXPIRY" - - "DL_CLASS_CODE_CD_FROM" - - "DL_CLASS_CODE_CD_TO" - - "DL_CLASS_CODE_CD_NOTES" - - "ISSUER_IDENTIFICATION_NUMBER" - - "PAYMENT_PERIOD_FROM" - - "PAYMENT_PERIOD_TO" - - "VACCINATION_CERTIFICATE_IDENTIFIER" - - "FIRST_NAME" - - "DATE_OF_ARRIVAL" - - "SECOND_NAME" - - "THIRD_NAME" - - "FOURTH_NAME" - - "LAST_NAME" - - "DL_CLASS_CODE_RM_FROM" - - "DL_CLASS_CODE_RM_NOTES" - - "DL_CLASS_CODE_RM_TO" - - "DL_CLASS_CODE_PW_FROM" - - "DL_CLASS_CODE_PW_NOTES" - - "DL_CLASS_CODE_PW_TO" - - "DL_CLASS_CODE_EB_FROM" - - "DL_CLASS_CODE_EB_NOTES" - - "DL_CLASS_CODE_EB_TO" - - "DL_CLASS_CODE_EC_FROM" - - "DL_CLASS_CODE_EC_NOTES" - - "DL_CLASS_CODE_EC_TO" - - "DL_CLASS_CODE_EC1_FROM" - - "DL_CLASS_CODE_EC1_NOTES" - - "DL_CLASS_CODE_EC1_TO" - - "PLACE_OF_BIRTH_CITY" - - "YEAR_OF_BIRTH" - - "YEAR_OF_EXPIRY" - - "GRANDFATHER_NAME_MATERNAL" - - "FIRST_SURNAME" - - "MONTH_OF_BIRTH" - - "ADDRESS_FLOOR_NUMBER" - - "ADDRESS_ENTRANCE" - - "ADDRESS_BLOCK_NUMBER" - - "ADDRESS_STREET_NUMBER" - - "ADDRESS_STREET_TYPE" - - "ADDRESS_CITY_SECTOR" - - "ADDRESS_COUNTY_TYPE" - - "ADDRESS_CITY_TYPE" - - "ADDRESS_BUILDING_TYPE" - - "DATE_OF_RETIREMENT" - - "DOCUMENT_STATUS" - - "SIGNATURE" - - "FT_UNIQUE_CERTIFICATE_IDENTIFIER" - - "FT_EMAIL" - - "FT_DATE_OF_SPECIMEN_COLLECTION" - - "FT_TYPE_OF_TESTING" - - "FT_RESULT_OF_TESTING" - - "FT_METHOD_OF_TESTING" - - "FT_DIGITAL_TRAVEL_AUTHORIZATION_NUMBER" - - "FT_DATE_OF_FIRST_POSITIVE_TEST_RESULT" - - "EF_CARD_ACCESS" - - "SHORT_FLIGHT_NUMBER" - - "AIRLINE_CODE" - - "FT_MVC_AGENCY" - - "FT_ISSUING_STATE_CODE_ALPHA2" - - "FT_NATIONALITY_CODE_ALPHA2" - - "FT_FIRST_ISSUE_DATE_CHECK_DIGIT" - - "FT_FIRST_ISSUE_DATE_CHECKSUM" diff --git a/index.html b/index.html new file mode 100644 index 00000000..0b1d850c --- /dev/null +++ b/index.html @@ -0,0 +1,2384 @@ + + + + + + Regula Document Reader Web API + + + + + + + + + +
logo
API docs by Redocly

Regula Document Reader Web API (8.4.606)

Documents recognition as easy as reading two bytes.

+

Clients:

    +
  • JavaScript client for the browser and node.js based on axios
    • +
  • Java client compatible with jvm and android
    • +
  • Python 3.5+ client
    • +
  • C# client for .NET & .NET Core
    • +
+

process

Everything about performing request and parsing response

+

Process list of documents images and return extracted data

header Parameters
X-RequestID
string

It allows the client and server to correlate each HTTP request. HTTP requests with an identifier are sent from the client to the server and back again.

+
Request Body schema: application/json
required
object (ProcessParams)
Array of objects (ProcessRequestImage)
tag
string

Session ID

+
tenant
string

Customer name

+
env
string

Environment type

+
livePortrait
string <base64>

Live portrait photo

+
extPortrait
string <base64>

Portrait photo from an external source

+
object (ContainerList)

List with various objects, containing processing results

+
object (ProcessSystemInfo)
object

Free-form object to be included in response. Must be object, not list or simple value. Do not affect document processing. Use it freely to pass your app params. Stored in process logs.

+
dtc
string

Digital Travel Credential (DTC-VC) data in base64 format for processing

+
ImageUrls
Array of strings

URLs to the document images for processing.

+

Responses

Response Schema: application/json
ChipPage
required
integer (RfidLocation)
Enum: 0 1 2

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

+
CoreLibResultCode
integer
ProcessingFinished
required
integer (ProcessingStatus)
Enum: 0 1 2
required
object (ContainerList)

List with various objects, containing processing results

+
required
object (TransactionInfo)
log
string

Base64 encoded transaction processing log

+
object

Free-form object provided in request. See passBackObject property of ProcessRequest.

+
morePagesAvailable
required
integer
elapsedTime
required
integer

Time the document processing has taken, ms.

+
object

Request samples

Content type
application/json
{
  • "processParam": {
    • "generateDTCVC": true,
    • "lcidFilter": [
      • 0
      ],
    • "checkLiveness": true,
    • "lcidIgnoreFilter": [
      • 0
      ],
    • "oneShotIdentification": true,
    • "useFaceApi": true,
    • "faceApi": {
      • "url": "https://faceapi.regulaforensics.com",
      • "mode": "match",
      • "search": {
        • "limit": 0,
        • "threshold": 0,
        • "group_ids": [
          • "string"
          ]
        },
      • "threshold": 75,
      • "serviceTimeout": 3000,
      • "proxy": "http://localhost:8080",
      • "proxy_userpwd": "user:pass",
      • "proxy_type": 0,
      • "childAgeThreshold": 13,
      • "childDocValidityYears": 5
      },
    • "doDetectCan": true,
    • "imageOutputMaxHeight": 0,
    • "imageOutputMaxWidth": 0,
    • "scenario": "Mrz",
    • "resultTypeOutput": [
      • 1
      ],
    • "doublePageSpread": true,
    • "generateDoublePageSpreadImage": true,
    • "fieldTypesFilter": [
      • 0
      ],
    • "dateFormat": "MM/dd/yyyy",
    • "measureSystem": 0,
    • "imageDpiOutMax": 0,
    • "alreadyCropped": true,
    • "customParams": { },
    • "config": [
      • {
        • "docID": [
          • 0
          ],
        • "excludeAuthChecks": 2
        }
      ],
    • "log": true,
    • "logLevel": "FatalError",
    • "forceDocID": 0,
    • "matchTextFieldMask": true,
    • "fastDocDetect": true,
    • "updateOCRValidityByGlare": true,
    • "checkRequiredTextFields": true,
    • "returnCroppedBarcode": true,
    • "imageQa": {
      • "brightnessThreshold": 0,
      • "dpiThreshold": 0,
      • "angleThreshold": 0,
      • "focusCheck": true,
      • "glaresCheck": true,
      • "colornessCheck": true,
      • "moireCheck": true,
      • "documentPositionIndent": 0,
      • "expectedPass": [
        • "glaresCheck"
        ],
      • "glaresCheckParams": {
        • "imgMarginPart": 0.35,
        • "maxGlaringPart": 0
        }
      },
    • "strictImageQuality": true,
    • "respectImageQuality": true,
    • "forceDocFormat": -1,
    • "noGraphics": true,
    • "depersonalizeLog": true,
    • "multiDocOnImage": true,
    • "shiftExpiryDate": 0,
    • "minimalHolderAge": 0,
    • "returnUncroppedImage": true,
    • "mrzFormatsFilter": [
      • "1x30"
      ],
    • "forceReadMrzBeforeLocate": true,
    • "parseBarcodes": true,
    • "convertCase": 0,
    • "splitNames": true,
    • "disablePerforationOCR": true,
    • "documentGroupFilter": [
      • 0
      ],
    • "processAuth": 0,
    • "deviceId": 0,
    • "deviceType": 0,
    • "deviceTypeHex": "string",
    • "ignoreDeviceIdFromImage": true,
    • "documentIdList": [
      • 0
      ],
    • "rfid": {
      • "paIgnoreNotificationCodes": [
        • 2415919105
        ]
      },
    • "checkAuth": true,
    • "authParams": {
      • "checkLiveness": true,
      • "livenessParams": {
        • "checkOVI": true,
        • "checkMLI": true,
        • "checkHolo": true,
        • "checkED": true,
        • "checkBlackAndWhiteCopy": true,
        • "checkDynaprint": true,
        • "checkGeometry": true
        },
      • "checkUVLuminiscence": true,
      • "checkIRB900": true,
      • "checkImagePatterns": true,
      • "checkFibers": true,
      • "checkExtMRZ": true,
      • "checkExtOCR": true,
      • "checkAxial": true,
      • "checkBarcodeFormat": true,
      • "checkIRVisibility": true,
      • "checkIPI": true,
      • "checkPhotoEmbedding": true,
      • "checkPhotoComparison": true,
      • "checkLetterScreen": true,
      • "checkSecurityText": true
      },
    • "mrzDetectMode": 0,
    • "generateNumericCodes": true,
    • "strictBarcodeDigitalSignatureCheck": true,
    • "selectLongestNames": true,
    • "doBarcodes": [
      • "bct_unknown"
      ],
    • "strictDLCategoryExpiry": true,
    • "generateAlpha2Codes": true,
    • "pdfPagesLimit": 0,
    • "disableAuthResolutionFilter": true,
    • "strictSecurityChecks": true,
    • "returnTransliteratedFields": true
    },
  • "List": [
    • {
      • "light": 6,
      • "page_idx": 0,
      • "ImageData": {
        • "image": "<base64 image>"
        }
      }
    ],
  • "tag": "string",
  • "tenant": "string",
  • "env": "string",
  • "livePortrait": "Base64 encoded data",
  • "extPortrait": "Base64 encoded data",
  • "ContainerList": {
    • "Count": 0,
    • "List": [
      • {
        • "buf_length": 0,
        • "light": 0,
        • "list_idx": 0,
        • "page_idx": 0,
        • "result_type": 1,
        • "Status": {
          • "overallStatus": 0,
          • "optical": 0,
          • "portrait": 0,
          • "rfid": 0,
          • "stopList": 0,
          • "detailsRFID": {
            },
          • "detailsOptical": {
            }
          }
        }
      ]
    },
  • "systemInfo": {
    • "license": "string",
    • "recaptcha_token": "string"
    },
  • "passBackObject": { },
  • "dtc": "string",
  • "ImageUrls": [
    • "string"
    ]
}

Response samples

Content type
application/json
{
  • "ChipPage": 0,
  • "CoreLibResultCode": 0,
  • "ProcessingFinished": 0,
  • "ContainerList": {
    • "Count": 0,
    • "List": [
      • {
        • "buf_length": 0,
        • "light": 0,
        • "list_idx": 0,
        • "page_idx": 0,
        • "result_type": 1,
        • "Status": {
          • "overallStatus": 0,
          • "optical": 0,
          • "portrait": 0,
          • "rfid": 0,
          • "stopList": 0,
          • "detailsRFID": {
            },
          • "detailsOptical": {
            }
          }
        }
      ]
    },
  • "TransactionInfo": {
    • "ComputerName": "7cded6852d20",
    • "DateTime": "2020-05-27T08:17:03.247Z",
    • "TransactionID": "dc5eb444-ad6e-4ebc-8102-d62d5bb56a4e",
    • "UserName": "user"
    },
  • "log": "string",
  • "passBackObject": { },
  • "morePagesAvailable": 0,
  • "elapsedTime": 0,
  • "metadata": { }
}

transaction

Reprocess

path Parameters
transactionId
required
string <uuid>

Transaction id

+
query Parameters
useCache
boolean
Default: false

Get processed values from storage in case transaction has already processed.

+
Request Body schema: application/json
required
object (ProcessParams)
Array of objects (ProcessRequestImage)
tag
string

Session ID

+
tenant
string

Customer name

+
env
string

Environment type

+
livePortrait
string <base64>

Live portrait photo

+
extPortrait
string <base64>

Portrait photo from an external source

+
object (ContainerList)

List with various objects, containing processing results

+
object (ProcessSystemInfo)
object

Free-form object to be included in response. Must be object, not list or simple value. Do not affect document processing. Use it freely to pass your app params. Stored in process logs.

+
dtc
string

Digital Travel Credential (DTC-VC) data in base64 format for processing

+

Responses

Response Schema: application/json
object (OutData)
object (InData)
tag
string
transactionId
string <uuid>

Request samples

Content type
application/json
{
  • "processParam": {
    • "generateDTCVC": true,
    • "lcidFilter": [
      • 0
      ],
    • "checkLiveness": true,
    • "lcidIgnoreFilter": [
      • 0
      ],
    • "oneShotIdentification": true,
    • "useFaceApi": true,
    • "faceApi": {
      • "url": "https://faceapi.regulaforensics.com",
      • "mode": "match",
      • "search": {
        • "limit": 0,
        • "threshold": 0,
        • "group_ids": [
          • "string"
          ]
        },
      • "threshold": 75,
      • "serviceTimeout": 3000,
      • "proxy": "http://localhost:8080",
      • "proxy_userpwd": "user:pass",
      • "proxy_type": 0,
      • "childAgeThreshold": 13,
      • "childDocValidityYears": 5
      },
    • "doDetectCan": true,
    • "imageOutputMaxHeight": 0,
    • "imageOutputMaxWidth": 0,
    • "scenario": "Mrz",
    • "resultTypeOutput": [
      • 1
      ],
    • "doublePageSpread": true,
    • "generateDoublePageSpreadImage": true,
    • "fieldTypesFilter": [
      • 0
      ],
    • "dateFormat": "MM/dd/yyyy",
    • "measureSystem": 0,
    • "imageDpiOutMax": 0,
    • "alreadyCropped": true,
    • "customParams": { },
    • "config": [
      • {
        • "docID": [
          • 0
          ],
        • "excludeAuthChecks": 2
        }
      ],
    • "log": true,
    • "logLevel": "FatalError",
    • "forceDocID": 0,
    • "matchTextFieldMask": true,
    • "fastDocDetect": true,
    • "updateOCRValidityByGlare": true,
    • "checkRequiredTextFields": true,
    • "returnCroppedBarcode": true,
    • "imageQa": {
      • "brightnessThreshold": 0,
      • "dpiThreshold": 0,
      • "angleThreshold": 0,
      • "focusCheck": true,
      • "glaresCheck": true,
      • "colornessCheck": true,
      • "moireCheck": true,
      • "documentPositionIndent": 0,
      • "expectedPass": [
        • "glaresCheck"
        ],
      • "glaresCheckParams": {
        • "imgMarginPart": 0.35,
        • "maxGlaringPart": 0
        }
      },
    • "strictImageQuality": true,
    • "respectImageQuality": true,
    • "forceDocFormat": -1,
    • "noGraphics": true,
    • "depersonalizeLog": true,
    • "multiDocOnImage": true,
    • "shiftExpiryDate": 0,
    • "minimalHolderAge": 0,
    • "returnUncroppedImage": true,
    • "mrzFormatsFilter": [
      • "1x30"
      ],
    • "forceReadMrzBeforeLocate": true,
    • "parseBarcodes": true,
    • "convertCase": 0,
    • "splitNames": true,
    • "disablePerforationOCR": true,
    • "documentGroupFilter": [
      • 0
      ],
    • "processAuth": 0,
    • "deviceId": 0,
    • "deviceType": 0,
    • "deviceTypeHex": "string",
    • "ignoreDeviceIdFromImage": true,
    • "documentIdList": [
      • 0
      ],
    • "rfid": {
      • "paIgnoreNotificationCodes": [
        • 2415919105
        ]
      },
    • "checkAuth": true,
    • "authParams": {
      • "checkLiveness": true,
      • "livenessParams": {
        • "checkOVI": true,
        • "checkMLI": true,
        • "checkHolo": true,
        • "checkED": true,
        • "checkBlackAndWhiteCopy": true,
        • "checkDynaprint": true,
        • "checkGeometry": true
        },
      • "checkUVLuminiscence": true,
      • "checkIRB900": true,
      • "checkImagePatterns": true,
      • "checkFibers": true,
      • "checkExtMRZ": true,
      • "checkExtOCR": true,
      • "checkAxial": true,
      • "checkBarcodeFormat": true,
      • "checkIRVisibility": true,
      • "checkIPI": true,
      • "checkPhotoEmbedding": true,
      • "checkPhotoComparison": true,
      • "checkLetterScreen": true,
      • "checkSecurityText": true
      },
    • "mrzDetectMode": 0,
    • "generateNumericCodes": true,
    • "strictBarcodeDigitalSignatureCheck": true,
    • "selectLongestNames": true,
    • "doBarcodes": [
      • "bct_unknown"
      ],
    • "strictDLCategoryExpiry": true,
    • "generateAlpha2Codes": true,
    • "pdfPagesLimit": 0,
    • "disableAuthResolutionFilter": true,
    • "strictSecurityChecks": true,
    • "returnTransliteratedFields": true
    },
  • "List": [
    • {
      • "light": 6,
      • "page_idx": 0,
      • "ImageData": {
        • "image": "<base64 image>"
        }
      }
    ],
  • "tag": "string",
  • "tenant": "string",
  • "env": "string",
  • "livePortrait": "Base64 encoded data",
  • "extPortrait": "Base64 encoded data",
  • "ContainerList": {
    • "Count": 0,
    • "List": [
      • {
        • "buf_length": 0,
        • "light": 0,
        • "list_idx": 0,
        • "page_idx": 0,
        • "result_type": 1,
        • "Status": {
          • "overallStatus": 0,
          • "optical": 0,
          • "portrait": 0,
          • "rfid": 0,
          • "stopList": 0,
          • "detailsRFID": {
            },
          • "detailsOptical": {
            }
          }
        }
      ]
    },
  • "systemInfo": {
    • "license": "string",
    • "recaptcha_token": "string"
    },
  • "passBackObject": { },
  • "dtc": "string"
}

Response samples

Content type
application/json
{
  • "outData": {
    • "url": "string",
    • "images": [
      • {
        • "fieldType": 201,
        • "light": 0,
        • "listIdx": 0,
        • "pageIdx": 0,
        • "url": "string"
        }
      ]
    },
  • "inData": {
    • "video": {
      • "metadata": { },
      • "url": "string"
      },
    • "images": [
      • {
        • "light": 0,
        • "listIdx": 0,
        • "pageIdx": 0,
        • "url": "string"
        }
      ]
    },
  • "tag": "string",
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc"
}

Get Reprocess transaction data

path Parameters
transactionId
required
string <uuid>

Transaction id

+

Responses

Response Schema: application/json
transactionId
string <uuid>
tag
string
object (OutData)
object (InData)

Response samples

Content type
application/json
{
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  • "tag": "string",
  • "outData": {
    • "url": "string",
    • "images": [
      • {
        • "fieldType": 201,
        • "light": 0,
        • "listIdx": 0,
        • "pageIdx": 0,
        • "url": "string"
        }
      ]
    },
  • "inData": {
    • "video": {
      • "metadata": { },
      • "url": "string"
      },
    • "images": [
      • {
        • "light": 0,
        • "listIdx": 0,
        • "pageIdx": 0,
        • "url": "string"
        }
      ]
    }
}

Get Reprocess transaction result

path Parameters
transactionId
required
string <uuid>

Transaction id

+
query Parameters
withImages
boolean

With base64 images or url

+

Responses

Response Schema: application/json
ChipPage
required
integer (RfidLocation)
Enum: 0 1 2

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

+
CoreLibResultCode
integer
ProcessingFinished
required
integer (ProcessingStatus)
Enum: 0 1 2
required
object (ContainerList)

List with various objects, containing processing results

+
required
object (TransactionInfo)
log
string

Base64 encoded transaction processing log

+
object

Free-form object provided in request. See passBackObject property of ProcessRequest.

+
morePagesAvailable
required
integer
elapsedTime
required
integer

Time the document processing has taken, ms.

+
object

Response samples

Content type
application/json
{
  • "ChipPage": 0,
  • "CoreLibResultCode": 0,
  • "ProcessingFinished": 0,
  • "ContainerList": {
    • "Count": 0,
    • "List": [
      • {
        • "buf_length": 0,
        • "light": 0,
        • "list_idx": 0,
        • "page_idx": 0,
        • "result_type": 1,
        • "Status": {
          • "overallStatus": 0,
          • "optical": 0,
          • "portrait": 0,
          • "rfid": 0,
          • "stopList": 0,
          • "detailsRFID": {
            },
          • "detailsOptical": {
            }
          }
        }
      ]
    },
  • "TransactionInfo": {
    • "ComputerName": "7cded6852d20",
    • "DateTime": "2020-05-27T08:17:03.247Z",
    • "TransactionID": "dc5eb444-ad6e-4ebc-8102-d62d5bb56a4e",
    • "UserName": "user"
    },
  • "log": "string",
  • "passBackObject": { },
  • "morePagesAvailable": 0,
  • "elapsedTime": 0,
  • "metadata": { }
}

Get Reprocess transaction file

path Parameters
transactionId
required
string <uuid>

Transaction id

+
query Parameters
name
required
string

File name

+

Responses

Response Schema: application/octet-stream
string <binary>

Delete Reprocess transactions by tag

path Parameters
tagId
required
string <uuid>

Tag id

+

Responses

Response Schema: application/json
any

Response samples

Content type
application/json
null

Get transactions by tag

path Parameters
tagId
required
string

Tag id

+

Responses

Response Schema: application/json
Array of objects (GetTransactionsByTagResponse)
object

Response samples

Content type
application/json
{
  • "items": [
    • {
      • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      • "state": 0,
      • "updatedAt": "2019-08-24T14:15:22Z"
      }
    ],
  • "metadata": { }
}

healthcheck

Server health check Deprecated

header Parameters
X-RequestID
string

It allows the client and server to correlate each HTTP request. HTTP requests with an identifier are sent from the client to the server and back again.

+

Responses

Response Schema: application/json
app-name
string

Application name.

+
version
string

Product version.

+
license-id
string

Unique license identifier.

+
license-serial
string

License serial number.

+
license-type
string
valid-until
string <date-time>

License validity date.

+
server-time
string
supported-scenarios
Array of strings

List of supported scenarios.

+
object
object

Database information.

+

Response samples

Content type
application/json
{
  • "app-name": "Regula Process Manager Service",
  • "version": "5.3.104980.123",
  • "license-id": "4d43a2af-e321-496c-9a4e-5a8f3d26df0e",
  • "license-serial": "OL70786",
  • "valid-until": "9999-12-31T23:59:59Z",
  • "server-time": "2020-10-16 09:42:08.080713+00:00"
}

Server health check

header Parameters
X-RequestID
string

It allows the client and server to correlate each HTTP request. HTTP requests with an identifier are sent from the client to the server and back again.

+

Responses

Response Schema: application/json
app
required
string

Application name.

+
licenseId
required
string or null

Unique license identifier.

+
licenseType
required
string or null

License type.

+
licenseSerial
required
string or null

License serial number.

+
licenseValidUntil
required
string or null <date-time>

License validity date.

+
scenarios
required
Array of strings or null

List of supported scenarios.

+
version
required
string or null

Product version.

+
object
object

Database information.

+

Response samples

Content type
application/json
{
  • "app": "Regula Document Reader Web API",
  • "licenseId": "4D43A2AF-E321-496C-9A4E-5A8F3D26DF0E",
  • "licenseType": "Transactional",
  • "licenseSerial": "OL70786",
  • "licenseValidUntil": "9999-12-31T23:59:59Z",
  • "scenarios": [
    • "Mrz",
    • "Barcode",
    • "Locate"
    ],
  • "version": "7.5.297907.1721",
  • "documentsDatabase": {
    • "id": "FullAuth",
    • "version": "800111",
    • "exportDate": "2024-11-11",
    • "description": "FullAuth: All documents"
    }
}

License health check

header Parameters
X-RequestID
string

It allows the client and server to correlate each HTTP request. HTTP requests with an identifier are sent from the client to the server and back again.

+

Responses

resources

Returns the list of documents stored in the database that the Web Service API is running with.

Responses

Response Schema: application/json
required
Array of objects (DatabaseDocument)

The list of documents stored in the database.

+
Array
barcode_fields
required
boolean

Whether the document has a barcode.

+
country
required
string

Country name.

+
createad
required
string

Date when the document description was created in the database.

+
doc_type
required
integer (DocumentType)
Enum: 0 11 12 13 14 … 225 more

Possible values for document types

+
document
required
string

Document name.

+
graphic_fields
required
boolean

The presence of graphic fields in the document.

+
id
required
integer

Document code.

+
mrz
required
boolean

The document has an MRZ.

+
region
string

Country region.

+
rfid_chip
required
boolean

The document has an RFID chip.

+
text_fields
required
boolean

The presence of text fields in the document.

+
updated
required
string

Date when the document description was updated in the database.

+
year
string

The year when the document was issued.

+
sovereignty
string

Guardian country.

+
deprecated
boolean

Whether the document is no longer in circulation.

+

Response samples

Content type
application/json
{
  • "items": [
    • {
      • "barcode_fields": true,
      • "country": "string",
      • "createad": "string",
      • "doc_type": 0,
      • "document": "string",
      • "graphic_fields": true,
      • "id": 0,
      • "mrz": true,
      • "region": "string",
      • "rfid_chip": true,
      • "text_fields": true,
      • "updated": "string",
      • "year": "string",
      • "sovereignty": "string",
      • "deprecated": true
      }
    ]
}

Images Model

image
string <base64> (ImageBase64)

Base64 encoded image

+
format
string

Image format

+
{
  • "image": "Base64 encoded image",
  • "format": "string"
}

Document Model

Chosen Document model:

+
DocumentName
string

Document name

+
ID
required
integer

Unique document type template identifier (Regula's internal numeric code)

+
P
required
number [ 0 .. 1 ]

A measure of the likelihood of correct recognition in the analysis of this type of document

+
Rotated180
required
integer

Indicates if the document of the given type is rotated by 180 degrees

+
RFID_Presence
required
integer (RfidLocation)
Enum: 0 1 2

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

+
object (FDSIDList)

Extended document type info and Regula's 'Information Reference Systems' links

+
NecessaryLights
required
integer

Combination of lighting scheme identifiers (Light enum) required to conduct OCR for this type of document

+
CheckAuthenticity
required
integer

Set of authentication options provided for this type of document (combination of Authenticity enum)

+
UVExp
required
integer

The required exposure value of the camera when receiving images of a document of this type for a UV lighting scheme

+
AuthenticityNecessaryLights
required
integer

Combination of lighting scheme identifiers (combination of Light enum) needed to perform all authenticity checks specified in CheckAuthenticity

+
OVIExp
required
number

Camera exposure value necessary when obtaining document images of the given type for AXIAL lighting scheme

+
RotationAngle
integer
{
  • "DocumentName": "string",
  • "ID": 0,
  • "P": 0.9913095831871032,
  • "Rotated180": 0,
  • "RFID_Presence": 0,
  • "FDSIDList": {
    • "ICAOCode": "str",
    • "Count": 0,
    • "List": [
      • 0
      ],
    • "dType": 0,
    • "dFormat": -1,
    • "dMRZ": true,
    • "dDescription": "string",
    • "dYear": "string",
    • "dCountryName": "string",
    • "dStateCode": "string",
    • "dStateName": "string",
    • "isDeprecated": true
    },
  • "NecessaryLights": 0,
  • "CheckAuthenticity": 0,
  • "UVExp": 0,
  • "AuthenticityNecessaryLights": 0,
  • "OVIExp": 0,
  • "RotationAngle": 0
}

Candidates model:

+
RecResult
integer (DocumentTypeRecognitionResult)
Enum: 0 15 29
Array of objects (OneCandidate)
{
  • "RecResult": 0,
  • "Candidates": [
    • {
      • "DocumentName": "string",
      • "ID": 0,
      • "P": 0.9913095831871032,
      • "Rotated180": 0,
      • "RFID_Presence": 0,
      • "FDSIDList": {
        • "ICAOCode": "str",
        • "Count": 0,
        • "List": [
          • 0
          ],
        • "dType": 0,
        • "dFormat": -1,
        • "dMRZ": true,
        • "dDescription": "string",
        • "dYear": "string",
        • "dCountryName": "string",
        • "dStateCode": "string",
        • "dStateName": "string",
        • "isDeprecated": true
        },
      • "NecessaryLights": 0,
      • "CheckAuthenticity": 0,
      • "UVExp": 0,
      • "AuthenticityNecessaryLights": 0,
      • "OVIExp": 0,
      • "RotationAngle": 0
      }
    ]
}
+ + + + \ No newline at end of file diff --git a/index.yml b/index.yml deleted file mode 100644 index 38fc75bb..00000000 --- a/index.yml +++ /dev/null @@ -1,89 +0,0 @@ -openapi: 3.0.4 -info: - 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 - * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client - * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core - -servers: - - url: https://api.regulaforensics.com/ - description: Latest stable Regula Document Reader demo endpoint - - url: https://nightly-api.regulaforensics.com/ - description: Nightly Regula document reader demo endpoint - - url: http://localhost:8080/ - description: Local on-premise installation - -paths: - /api/process: - $ref: "./p-process.yml#/paths/~1process" - /api/v2/transaction/{transactionId}/process: - $ref: "./p-transaction.yml#/paths/~1transaction~1%7BtransactionId%7D~1process" - /api/v2/transaction/{transactionId}: - $ref: "./p-transaction.yml#/paths/~1transaction~1%7BtransactionId%7D" - /api/v2/transaction/{transactionId}/results: - $ref: "./p-transaction.yml#/paths/~1transaction~1%7BtransactionId%7D~1results" - /api/v2/transaction/{transactionId}/file: - $ref: "./p-transaction.yml#/paths/~1transaction~1%7BtransactionId%7D~1file" - /api/v2/tag/{tagId}: - $ref: "./p-transaction.yml#/paths/~1tag~1%7BtagId%7D" - /api/v2/tag/{tagId}/transactions: - $ref: "./p-transaction.yml#/paths/~1tag~1%7BtagId%7D~1transactions" - /api/ping: - $ref: "./p-ping.yml#/paths/~1ping" - /api/healthz: - $ref: "./p-healthcheck.yml#/paths/~1healthz" - /api/readyz: - $ref: "./p-healthcheck.yml#/paths/~1readyz" - /api/doclist: - $ref: "./p-doclist.yml#/paths/~1doclist" - -tags: - - name: process - description: Everything about performing request and parsing response - - name: images_model - x-displayName: Images Model - description: | - - - name: document_model - x-displayName: Document Model - description: | - **Chosen Document model:** - - **Candidates model:** - - -x-tagGroups: - - name: Requests - tags: - - process - - transaction - - healthcheck - - resources - - name: Models - tags: - - images_model - - document_model - -components: - schemas: - DocumentImage: - $ref: "./common.yml#/components/schemas/ImageData" - TransactionImage: - $ref: "./common.yml#/components/schemas/ImageTransactionData" - DocumentTypesCandidates: - $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesList" - ChosenDocumentType: - $ref: "./rt-doc-type-old.yml#/components/schemas/OneCandidate" - RFIDPKDResourceType: - $ref: "./e-rfid-pkd-resourcetype.yml#/components/schemas/RFIDPKDResourceType" - ParsingErrorCodes: - $ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes" diff --git a/new-client-checklist.md b/new-client-checklist.md deleted file mode 100644 index dda27206..00000000 --- a/new-client-checklist.md +++ /dev/null @@ -1,14 +0,0 @@ -Reference client - https://github.com/regulaforensics/DocumentReader-web-js-client/tree/master - -- [ ] [code] generate initial client version using default **openapi-generator** -- [ ] [code] add initial example, to check client can execute request and parse response(but with an ugly interface) -- [ ] [code] generate simple types instead of enums (int, str etc) -- [ ] [code] add addition methods and fields to Text, TextField, Images, ImageField models. [see commits](https://github.com/regulaforensics/DocumentReader-web-java-client/tree/master/client/src/main/java/com/regula/documentreader/webclient/model) -- [ ] [code] add unknown result type model(get raw json for non-described model in a client) [see](https://github.com/regulaforensics/DocumentReader-web-java-client/blob/master/client/src/main/java/com/regula/documentreader/webclient/RawResultItem.java) -- [ ] [code] all files and images should be passed/retrieved to/from lib as bytes -- [ ] [code] modify example to be exactly as reference client example (all fields and methods name should be matched) -- [ ] [ci] run example on every commit to master and PR -- [ ] [ci] auto-publish package on releases -- [ ] [doc] a main README.md file -- [ ] [doc] a example README.md file -- [ ] [doc][code] run example using regula SaaS \ No newline at end of file diff --git a/p-doclist.yml b/p-doclist.yml deleted file mode 100644 index c6e88518..00000000 --- a/p-doclist.yml +++ /dev/null @@ -1,90 +0,0 @@ -openapi: 3.0.4 -paths: - /doclist: - get: - summary: "Returns the list of documents stored in the database that the Web Service API is running with." - operationId: doclist - tags: - - resources - responses: - 200: - description: "The list of documents stored in the database." - content: - application/json: - schema: - $ref: "#/components/schemas/DatabaseDocumentList" - -components: - schemas: - DatabaseDocumentList: - title: "DatabaseDocumentList" - type: object - required: - - items - properties: - items: - description: "The list of documents stored in the database." - type: array - items: - $ref: "#/components/schemas/DatabaseDocument" - - DatabaseDocument: - title: "DatabaseDocument" - type: object - required: - - barcode_fields - - country - - createad - - doc_type - - document - - graphic_fields - - id - - mrz - - rfid_chip - - text_fields - - updated - properties: - barcode_fields: - description: "Whether the document has a barcode." - type: boolean - country: - description: "Country name." - type: string - createad: - description: "Date when the document description was created in the database." - type: string - doc_type: - $ref: "./e-document-type.yml#/components/schemas/DocumentType" - document: - description: "Document name." - type: string - graphic_fields: - description: "The presence of graphic fields in the document." - type: boolean - id: - description: "Document code." - type: integer - mrz: - description: "The document has an MRZ." - type: boolean - region: - description: "Country region." - type: string - rfid_chip: - description: "The document has an RFID chip." - type: boolean - text_fields: - description: "The presence of text fields in the document." - type: boolean - updated: - description: "Date when the document description was updated in the database." - type: string - year: - description: "The year when the document was issued." - type: string - sovereignty: - description: "Guardian country." - type: string - deprecated: - description: "Whether the document is no longer in circulation." - type: boolean diff --git a/p-healthcheck.yml b/p-healthcheck.yml deleted file mode 100644 index ad2d868a..00000000 --- a/p-healthcheck.yml +++ /dev/null @@ -1,116 +0,0 @@ -openapi: 3.0.4 -paths: - /healthz: - parameters: - - $ref: "./common.yml#/components/parameters/x-request" - get: - summary: "Server health check" - operationId: healthz - tags: - - healthcheck - responses: - 200: - description: "Device info." - content: - application/json: - schema: - $ref: "#/components/schemas/Healthcheck" - /readyz: - parameters: - - $ref: "./common.yml#/components/parameters/x-request" - get: - summary: "License health check" - operationId: readyz - tags: - - healthcheck - responses: - 200: - description: "The license is valid." - 400: - description: "The license is not valid." - -components: - schemas: - Healthcheck: - title: "Healthcheck" - type: object - required: - - app - - licenseId - - licenseType - - licenseSerial - - licenseValidUntil - - scenarios - - version - properties: - app: - description: Application name. - type: string - licenseId: - description: Unique license identifier. - type: string - nullable: true - licenseType: - description: License type. - type: string - nullable: true - licenseSerial: - description: License serial number. - type: string - nullable: true - licenseValidUntil: - description: License validity date. - type: string - format: date-time - nullable: true - scenarios: - description: List of supported scenarios. - type: array - nullable: true - items: - type: string - version: - description: Product version. - type: string - nullable: true - metadata: - type: object - additionalProperties: true - documentsDatabase: - description: Database information. - type: object - required: - - id - - version - - exportDate - - description - properties: - id: - description: Database identifier. - type: string - nullable: true - version: - description: Database version. - type: string - nullable: true - exportDate: - 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: "Regula Document Reader Web API" - licenseId: "4D43A2AF-E321-496C-9A4E-5A8F3D26DF0E" - licenseType: "Transactional" - licenseSerial: "OL70786" - licenseValidUntil: "9999-12-31T23:59:59Z" - scenarios: ["Mrz", "Barcode", "Locate"] - version: "7.5.297907.1721" - documentsDatabase: - id: "FullAuth" - version: "800111" - exportDate: "2024-11-11" - description: "FullAuth: All documents" diff --git a/p-ping.yml b/p-ping.yml deleted file mode 100644 index 27960511..00000000 --- a/p-ping.yml +++ /dev/null @@ -1,85 +0,0 @@ -openapi: 3.0.4 -paths: - /ping: - parameters: - - $ref: "./common.yml#/components/parameters/x-request" - get: - deprecated: true - summary: "Server health check" - operationId: ping - tags: - - healthcheck - responses: - 200: - description: "Device info" - content: - application/json: - schema: - $ref: "#/components/schemas/DeviceInfo" - -components: - schemas: - DeviceInfo: - title: "DeviceInfo" - 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 - 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" - license-id: "4d43a2af-e321-496c-9a4e-5a8f3d26df0e" - license-serial: "OL70786" - valid-until: "9999-12-31T23:59:59Z" - server-time: "2020-10-16 09:42:08.080713+00:00" \ No newline at end of file diff --git a/p-process.yml b/p-process.yml deleted file mode 100644 index 67cab046..00000000 --- a/p-process.yml +++ /dev/null @@ -1,869 +0,0 @@ -openapi: 3.0.4 -paths: - /process: - parameters: - - $ref: "./common.yml#/components/parameters/x-request" - post: - summary: Process list of documents images and return extracted data - operationId: api-process - tags: - - process - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ProcessRequest" - required: true - responses: - "200": - description: "Document reading result" - content: - application/json: - schema: - $ref: "#/components/schemas/ProcessResponse" - "400": - description: "Bad request. Check your input data." - "403": - description: "Bad license. Either server or request does not contain valid license." - x-codeSamples: - - lang: 'JavaScript' - source: | - import {DocumentReaderApi, FieldType, GraphicFieldType} from '@regulaforensics/document-reader-webclient/esm' - const {DOCUMENT_NUMBER, SURNAME_AND_GIVEN_NAMES, DATE_OF_BIRTH} = FieldType; - const {PORTRAIT, SIGNATURE} = GraphicFieldType; - - const imageAsBase64String = getDocImageAsBase64String() - const api = new DocumentReaderApi({basePath: "http://localhost:8080"}); - const result = await api.process(imageAsBase64String) - - // text fields - const docNumber = result.getTextField(DOCUMENT_NUMBER) - const fullName = result.getTextField(SURNAME_AND_GIVEN_NAMES) - const dateOfBirth = result.getTextField(DATE_OF_BIRTH) - - // graphics fields - const portraitAsBase64 = result.getGraphicsField(PORTRAIT) - const signatureAsBase64 = result.getGraphicsField(SIGNATURE) - - lang: 'Java' - source: | - byte[] imageBytes = readFile("australia_passport.jpg"); - var image = new ProcessRequestImage(imageBytes, Light.WHITE); - - var requestParams = new RecognitionParams() - .withScenario(Scenario.FULL_PROCESS) - .withResultTypeOutput(Result.STATUS, Result.TEXT, Result.IMAGES); - - RecognitionRequest request = new RecognitionRequest(requestParams, List.of(image)); - - var api = new DocumentReaderApi(); - RecognitionResponse response = api.process(request); - - var status = response.status(); - var docOverallStatus = status.getComplete() == CheckResult.OK ? "valid" : "not valid"; - var docOpticalTextStatus = status.getDetailsOptical().getText(); - - var docNumberField = response.text().getField(DOCUMENT_NUMBER); - var docNumberMrz = docNumberField.getValue(Source.MRZ); - var docNumberMrzValidity = docNumberField.sourceValidity(Source.MRZ); - var docNumberMrzVisualMatching = docNumberField.crossSourceComparison(Source.MRZ, Source.VISUAL); - - lang: 'Python' - source: | - from regula.documentreader.webclient import * - - with open("australia_passport.jpg", "rb") as f: - input_image = f.read() - - with DocumentReaderApi(host='http://localhost:8080') as api: - params = ProcessParams( - scenario=Scenario.FULL_PROCESS, - result_type_output=[Result.DOCUMENT_IMAGE, Result.STATUS, Result.TEXT, Result.IMAGES] - ) - request = RecognitionRequest(process_params=params, images=[input_image]) - response = api.process(request) - - # status examples - response_status = response.status - doc_overall_status = "valid" if response_status.overall_status == CheckResult.OK else "not valid" - - # text fields example - doc_number_field = response.text.get_field(TextFieldType.DOCUMENT_NUMBER) - doc_number_mrz = doc_number_field.get_value() - doc_number_visual = doc_number_field.get_value(Source.VISUAL) - doc_number_visual_validity = doc_number_field.source_validity(Source.VISUAL) - doc_number_mrz_validity = doc_number_field.source_validity(Source.MRZ) - doc_number_mrz_visual_matching = doc_number_field.cross_source_comparison(Source.MRZ, Source.VISUAL) - - # images fields example - normalized_input_image = response.images.document_image() - portrait_field = response.images.get_field(GraphicFieldType.PORTRAIT) - portrait_from_visual = portrait_field.get_value(Source.VISUAL) - portrait_from_rfid = portrait_field.get_value(Source.RFID, original=True) - - lang: 'C#' - source: | - var imageBytes = File.ReadAllBytes("australia_passport.jpg"); - var image = new ProcessRequestImage(new ImageData(imageBytes), Light.WHITE); - - var requestParams = new RecognitionParams() - .WithScenario(Scenario.FULL_PROCESS) - .WithResultTypeOutput(new List { Result.STATUS, Result.TEXT, Result.IMAGES, Result.DOCUMENT_TYPE }); - var request = new RecognitionRequest(requestParams, image); - - var api = licenseFromEnv != null - ? new DocumentReaderApi(apiBaseUrl).WithLicense(licenseFromEnv) - : new DocumentReaderApi(apiBaseUrl).WithLicense(licenseFromFile); - var response = api.Process(request); - - // status examples - var status = response.Status(); - string docOverallStatus = status.OverallStatus == CheckResult.OK ? "valid" : "not valid"; - string docOpticalTextStatus = status.DetailsOptical.Text == CheckResult.OK ? "valid" : "not valid"; - - // text fields examples - var docNumberField = response.Text().GetField(TextFieldType.DOCUMENT_NUMBER); - string docNumberVisual = docNumberField.GetValue(Source.VISUAL); - string docNumberMrz = docNumberField.GetValue(Source.MRZ); - int docNumberVisualValidity = docNumberField.SourceValidity(Source.VISUAL); - int docNumberMrzValidity = docNumberField.SourceValidity(Source.MRZ); - int docNumberMrzVisualMatching = docNumberField.CrossSourceComparison(Source.MRZ, Source.VISUAL); - - // images fields examples - var documentImage = response.Images().GetField(GraphicFieldType.DOCUMENT_FRONT).GetValue(); - var portraitField = response.Images().GetField(GraphicFieldType.PORTRAIT); - var portraitFromVisual = portraitField.GetValue(Source.VISUAL); - - -components: - schemas: - ############################# - ############################# Requests objects - ProcessRequest: - title: "ProcessRequest" - type: object - required: - - processParam - properties: - processParam: - $ref: "#/components/schemas/ProcessParams" - List: - type: array - items: - $ref: "#/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 - example: "Base64 encoded data" - description: "Live portrait photo" - extPortrait: - type: string - format: base64 - example: "Base64 encoded data" - description: "Portrait photo from an external source" - ContainerList: - $ref: "./rt.yml#/components/schemas/ContainerList" - systemInfo: - $ref: "#/components/schemas/ProcessSystemInfo" - passBackObject: - type: object - description: "Free-form object to be included in response. Must be object, not list or simple value. - Do not affect document processing. Use it freely to pass your app params. Stored in process logs." - additionalProperties: true - dtc: - type: string - description: "Digital Travel Credential (DTC-VC) data in base64 format for processing" - ImageUrls: - type: array - description: "URLs to the document images for processing." - items: - type: string - - ProcessParams: - title: "ProcessParams" - type: object - required: - - scenario - properties: - generateDTCVC: - type: boolean - description: "This parameter is used to generate separate DTC-VC data container from RFID session data." - lcidFilter: - description: "The list of LCID types to recognize. If empty, values with all LCID types will be extracted. Empty by default." - type: array - items: - $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: - $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" - useFaceApi: - type: boolean - description: "This parameter allows comparing faces on Regula Face Web Service" - faceApi: - $ref: "./common.yml#/components/schemas/FaceApi" - doDetectCan: - type: boolean - description: "This parameter allows enabling the CAN (Card Access Number) detection and recognition when using scenarios with document location and MRZ reading, such as the MrzAndLocate scenario." - imageOutputMaxHeight: - type: integer - description: "This parameter allows setting maximum height in pixels of output images and thus reducing image size to desired. Does not change the aspect ratio. Changes disabled if equals to 0. Default 0." - imageOutputMaxWidth: - type: integer - description: "This parameter allows setting maximum width in pixels of output images and thus reducing image size to desired. Does not change the aspect ratio. Changes disabled if equals to 0. Default 0." - scenario: - $ref: "./common.yml#/components/schemas/Scenario" - resultTypeOutput: - description: "Types of results to return in response. See 'Result' enum for available options" - type: array - items: - $ref: "./rt.yml#/components/schemas/Result" - doublePageSpread: - description: "Enable this option if the image you provide contains double page spread - of the passport and you want to process both pages in one go. It makes sense to use it for documents - that have meaningful information on both pages, like Russian domestic passport, or some others. - Disabled by default." - type: boolean - deprecated: true - # default false - generateDoublePageSpreadImage: - description: 'When enabled together with "doublePageSpread" and there is a passport with two pages - spread in the image, pages will be cropped, straightened and aligned together, as if the document was captured - on a flatbed scanner. Disabled by default.' - type: boolean - # default false - fieldTypesFilter: - description: "If a document contains Visual zone, you can set the list of field types to extract. - In this case, other fields are skipped during the processing, i.e. document recognition becomes faster. - This filter is not applicable to the MRZ, barcode or RFID. If the fieldTypesFilter is empty, all fields are extracted. Empty by default. - If fieldTypesFilter and fieldTypesIgnoreFilter are used simultaneously, fieldTypesFilter takes priority." - type: array - items: - $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" - fieldTypesIgnoreFilter: - description: "If a document contains a Visual zone, you can specify a list of field types that should be excluded from extraction. - All field types listed in this array are skipped during processing, while the remaining fields are recognized. - This filter is not applicable to the MRZ, barcode or RFID. If the fieldTypesIgnoreFilter is empty, all fields are extracted. Empty by default. - If fieldTypesFilter and fieldTypesIgnoreFilter are used simultaneously, fieldTypesFilter takes priority." - type: array - items: - $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" - dateFormat: - description: "This option allows you to set dates format so that solution will return dates in this format. - For example, if you supply 'MM/dd/yyyy', and document have printed date '09 JUL 2020' for the date os issue, - you will get '07/09/2020' as a result. - By default it is set to system locale default (where the service is running)." - type: string - example: "MM/dd/yyyy" - 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. - Resolution will remain original in case 0 is supplied. By default is set to return images in response with - resolution not greater than 300 dpi for all scenarios except FullAuth. In FullAuth scenario this limit is 1000 dpi by default." - type: integer - alreadyCropped: - description: "This option can be enabled if you know for sure that the image you provide contains - already cropped document by its edges. This was designed to process on the - server side images captured and cropped on mobile. Disabled by default." - type: boolean - # default false - customParams: - description: "This option allows passing custom processing parameters that can be implemented in future without - changing API." - type: object - additionalProperties: true - config: - description: "This option allows setting additional custom configuration per document type. - If recognized document has ID specified in config, processing adjusts according to designated configuration." - type: array - items: - $ref: "#/components/schemas/PerDocumentConfig" - log: - description: "When enabled, results will contain transaction processing log. Disabled by default" - type: boolean - # default false - logLevel: # When used together with 'log' parameter enabled, sets the level of logs detalization. 'INFO' by default. - $ref: "#/components/schemas/LogLevel" - # default: "INFO" - forceDocID: - description: "Force use of specific template ID and skip document type identification step." - type: integer - matchTextFieldMask: - description: "When disabled, text field OCR will be done as is and then the recognized value will be - matched to the field mask for validity. If enabled, we are trying to read a field value with maximum efforts - to match the mask and provide a correctly formatted value, making assumptions based on the provided field mask - in the template. Enabled by default." - type: boolean - # default: true - fastDocDetect: - description: "When enabled, shorten the list of candidates to process during document detection in a - single image process mode. Reduces processing time for specific backgrounds. Enabled by default." - type: boolean - deprecated: true - # default: true - updateOCRValidityByGlare: - description: "When enabled, fail OCR field validity, if there is a glare over the text field on the image. Disabled by default." - type: boolean - # default: false - checkRequiredTextFields: - description: "When enabled, each field in template will be checked for value presence and if the field - is marked as required, but has no value, it will have 'error' in validity status. Disabled by default." - type: boolean - # default: false - returnCroppedBarcode: - description: "When enabled, returns cropped barcode images for unknown documents. Disabled by default." - type: boolean - # default: false - imageQa: - $ref: "#/components/schemas/ImageQA" - strictImageQuality: - description: "When enabled, the image quality check status affects the document optical and overall status. Disabled by default." - type: boolean - # default: false - respectImageQuality: - description: "Deprecated. Please use strictImageQuality instead. When enabled, image quality checks status affects document optical and overall status. Disabled by default." - type: boolean - deprecated: true - # default: false - 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." - type: boolean - # default: false - depersonalizeLog: - description: "When enabled, all personal data will be forcibly removed from the logs. Disabled by default." - type: boolean - # default: false - multiDocOnImage: - description: "This option allows locating and cropping multiple documents from one image if enabled. Disabled by default." - type: boolean - # default false - shiftExpiryDate: - description: "This option allows shifting the date of expiry into the future or past for number of months specified. - This is useful, for example, in some cases when document might be still valid for some period - after original expiration date to prevent negative validity status for such documents. - Or by shifting the date to the past will set negative validity for the documents - that is about to expire in a specified number of months. 0 by default" - type: integer - #default 0 - minimalHolderAge: - description: "This options allows specifying the minimal age in years of the document holder - for the document to be considered valid." - type: integer - returnUncroppedImage: - description: "When enabled, returns input images in output. Disabled by default." - type: boolean - # default false - mrzFormatsFilter: - description: "This option allows limiting MRZ formats to be recognized by specifying them in array." - type: array - items: - $ref: "#/components/schemas/MRZFormat" - forceReadMrzBeforeLocate: - description: "When enabled, make sure that in series processing MRZ is located fully inside the result document image, - if present on the document. Enabling this option may add extra processing time, by disabling optimizations, - but allows more stability in output image quality. Disabled by default." - type: boolean - # default false - parseBarcodes: - description: "This option can be disabled to stop parsing after barcode is read. Enabled by default." - type: boolean - # default true - 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 - ft_First_Name, ft_Second_Name, ft_Third_Name, ft_Fourth_Name, ft_Last_Name fields. Disabled by default." - type: boolean - # default false - disablePerforationOCR: - description: "When enabled, OCR of perforated fields in the document template will not be performed. Disabled by default." - type: boolean - # default false - documentGroupFilter: - description: "List of specific eligible document types from DocumentType enum to recognize from. - You may, for example, specify only passports to be recognized by setting this property. Empty by default." - type: array - 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." - type: integer - format: int64 - deviceId: - description: "This parameter is used to specify the document reader device type from which input images were captured. Default 0." - type: integer - # default: 0 - deviceType: - description: "This parameter is used to specify the document reader device type from which input images were captured. Default 0." - type: integer - # default: 0 - deviceTypeHex: - type: string - description: "This parameter is used to specify the document reader device type from which input images were captured" - ignoreDeviceIdFromImage: - type: boolean - description: "This parameter is used to tell the processing engine to ignore any parameters saved in the image when scanned from the document reader device. Default false" - # default: false - documentIdList: - type: array - description: "List of the document ID's to process. All documents will be processed, if empty." - items: - type: integer - # default [] - rfid: - type: object - description: "Params for the RFID chip data reprocessing" - properties: - paIgnoreNotificationCodes: - description: "A list of notification codes that should be ignored during passive authentication (PA)" - type: array - items: - $ref: "./e-parsing-notification-codes.yml#/components/schemas/ParsingNotificationCodes" - checkAuth: - type: boolean - description: "This parameter is used to enable authenticity checks" - # default: true - authParams: - $ref: '#/components/schemas/AuthParams' - mrzDetectMode: - $ref: '#/components/schemas/mrzDetectModeEnum' - generateNumericCodes: - type: boolean - description: "This parameter is used to generate numeric representation for issuing state and nationality codes" - # 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 - 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 - doBarcodes: - description: "Set the types of barcodes to process." - type: array - items: - $ref: "./e-input-barcode-type.yml#/components/schemas/InputBarcodeType" - 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: true - 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 - disableAuthResolutionFilter: - description: "This parameter if enabled will ignore the minimum barcode resolution needed to start processing." - type: boolean - # default: false - strictSecurityChecks: - description: "When enabled, this parameter marks security checks that don’t meet minimum requirements as 'Failed' (instead of 'WasNotDone'), which causes the overall security status to be 'Failed'." - type: boolean - returnTransliteratedFields: - description: "Allows transliteration to be turned on or off; by default, it is enabled." - type: boolean - - MRZFormat: - title: "MRZFormat" - type: string - enum: - - "1x30" - - "3x30" - - "2x36" - - "2x44" - - "1x6" - - "2x30" - x-enum-varnames: - - "IDL" - - "ID1" - - "ID2" - - "ID3" - - "CAN" - - "ID1_2_30" - x-enum-descriptions: - - "1x30" - - "3x30" - - "2x36" - - "2x44" - - "1x6" - - "2x30" - - TextPostProcessing: - title: "TextPostProcessing" - type: integer - enum: - - 0 - - 1 - - 2 - - 3 - x-enum-varnames: - - "NO_CHANGE" - - "UPPERCASE" - - "LOWERCASE" - - "CAPITAL" - x-enum-descriptions: - - "Do not change" - - "Uppercase" - - "Lowercase" - - "Capital" - - mrzDetectModeEnum: - title: "mrzDetectModeEnum" - type: integer - description: "Make better MRZ detection on complex noisy backgrounds, like BW photocopy of some documents." - enum: - - 0 - - 1 - - 2 - x-enum-varnames: - - "eMDM_Default" - - "eMDM_ResizeBinarizeWindow" - - "eMDM_BlurBeforeBinarization" - - AuthParams: - title: "AuthParams" - type: object - properties: - checkLiveness: - type: boolean - description: "This parameter is used to enable document liveness check" - # 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 - checkIRB900: - type: boolean - description: "This parameter is used to enable B900 ink MRZ contrast check in IR light" - # default: true - checkImagePatterns: - type: boolean - description: "This parameter is used to enable Image patterns presence/absence check (position, shape, color)" - # default: true - checkFibers: - type: boolean - description: "This parameter is used to enable Fibers detection" - # default: true - checkExtMRZ: - type: boolean - description: "This parameter is used to enable Extended MRZ Check" - # default: true - checkExtOCR: - type: boolean - description: "This parameter is used to enable Extended OCR Check" - # default: true - checkAxial: - type: boolean - description: "This parameter is used to enable laminate integrity check in axial light" - # default: true - checkBarcodeFormat: - type: boolean - description: "This parameter is used to enable Barcode format check (code metadata, data format, contents format, etc.)" - # default: true - checkIRVisibility: - type: boolean - description: "This parameter is used to enable Document elements visibility check in IR light" - # default: true - checkIPI: - type: boolean - description: "This parameter is used to enable Invisible Personal Information (IPI) check" - # default: true - checkPhotoEmbedding: - type: boolean - description: "This parameter is used to enable Owner's photo embedding check (is photo printed or sticked)" - # default: true - checkPhotoComparison: - type: boolean - description: "This parameter is used to enable Portrait comparison check" - # default: true - checkLetterScreen: - type: boolean - description: "This parameter is used to enable LetterScreen check" - # 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 - checkMLI: - type: boolean - description: "This parameter is used to enable MLI check" - # default: true - checkHolo: - type: boolean - description: "This parameter is used to enable Hologram detection" - # default: true - checkED: - type: boolean - description: "This parameter is used to enable Electronic device detection" - # default: true - checkBlackAndWhiteCopy: - type: boolean - description: "This parameter is used to enable Black and white copy check" - # default: true - checkDynaprint: - 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: - - 0 - - 1 - x-enum-descriptions: - - "Metric system of measurement, where things are measured in meters and grams" - - "Imperial System of Measurement, where things are measured in feet, inches and pounds" - x-enum-varnames: - - "METRIC" - - "IMPERIAL" - - LogLevel: - title: "LogLevel" - type: string - enum: - - FatalError - - Error - - Warning - - Info - - Debug - x-enum-varnames: - - "FATAL_ERROR" - - "ERROR" - - "WARNING" - - "INFO" - - "DEBUG" - x-enum-descriptions: - - "Fatal error" - - "Error" - - "Warning" - - "Info" - - "Debug" - - PerDocumentConfig: - title: "PerDocumentConfig" - type: object - properties: - docID: - description: "Specific template IDs, for which apply current custom configuration" - type: array - items: - type: integer - excludeAuthChecks: - description: "Contains items from AuthenticityResultType as sum via OR operation" - type: integer - example: 2 - - ImageQA: - title: "ImageQA" - type: object - properties: - brightnessThreshold: - description: "Set the threshold for an actual document brightness below which the check fails" - type: number - format: double - dpiThreshold: - description: "This parameter sets threshold for Image QA check of the presented document physical dpi. If - actual document dpi is below this threshold, check will fail." - type: integer - # default: 150 - angleThreshold: - description: "This parameter sets threshold for Image QA check of the presented document perspective angle in - degrees. If actual document perspective angle is above this threshold, check will fail." - type: integer - # default: 5 - focusCheck: - description: "This option enables focus check while performing image quality validation." - type: boolean - # default: false - glaresCheck: - description: "This option enables glares check while performing image quality validation." - type: boolean - # default: true - colornessCheck: - 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 - # default: 0 - expectedPass: - description: "This parameter controls the quality checks that the image should pass to be considered a valid input during the scanning process." - type: array - items: - $ref: "./rt-image-quality.yml#/components/schemas/InputImageQualityChecks" - glaresCheckParams: - $ref: "./common.yml#/components/schemas/GlaresCheckParams" - - ProcessRequestImage: - title: "ProcessRequestImage" - type: object - properties: - ImageData: - $ref: "./common.yml#/components/schemas/ImageData" - light: - $ref: "./common.yml#/components/schemas/Light" - page_idx: - description: "page/image number" - type: integer - # default: 0 - example: - light: 6 - page_idx: 0 - ImageData: - image: "" - - ProcessSystemInfo: - title: "ProcessSystemInfo" - type: object - properties: - license: - description: "Base64 encoded license file" - type: string - recaptcha_token: - description: "For internal use. Demo-sites recaptcha token." - type: string - - ############################# - ############################# 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: - $ref: "./rt.yml#/components/schemas/ContainerList" - TransactionInfo: - $ref: "#/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." - metadata: - type: object - additionalProperties: true - - ProcessingStatus: - title: "ProcessingStatus" - type: integer - enum: - - 0 - - 1 - - 2 - x-enum-descriptions: - - "Processing was not finished" - - "Processing finished" - - "Processing finished by timeout" - x-enum-varnames: - - "NOT_FINISHED" - - "FINISHED" - - "TIMEOUT" - - TransactionInfo: - title: "TransactionInfo" - type: object - properties: - ComputerName: - description: "Computer name" - type: string - DateTime: - description: "Date and time" - type: string - DocumentsDatabase: - $ref: "#/components/schemas/DocumentsDatabase" - SystemInfo: - description: "System information" - type: string - Tag: - description: "Transaction tag" - type: string - TransactionID: - description: "Transaction identifier" - type: string - UserName: - description: "User name" - type: string - Version: - description: "SDK version" - type: string - example: - "ComputerName": "7cded6852d20" - "DateTime": "2020-05-27T08:17:03.247Z" - "TransactionID": "dc5eb444-ad6e-4ebc-8102-d62d5bb56a4e" - "UserName": "user" - - DocumentsDatabase: - title: "DocumentsDatabase" - type: object - description: "Document database information" - properties: - Description: - description: "Document database description" - type: string - ExportDate: - description: "Date the document database was created" - type: string - ID: - description: "Document database identifier" - type: string - Version: - description: "Document database version" - type: string diff --git a/p-transaction.yml b/p-transaction.yml deleted file mode 100644 index 8244aa5f..00000000 --- a/p-transaction.yml +++ /dev/null @@ -1,342 +0,0 @@ -openapi: 3.0.4 -paths: - /transaction/{transactionId}/process: - post: - parameters: - - in: path - name: transactionId - schema: - type: string - format: uuid - required: true - description: Transaction id - - in: query - name: useCache - schema: - type: boolean - default: false - description: Get processed values from storage in case transaction has already processed. - summary: Reprocess - tags: - - transaction - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/TransactionProcessRequest" - required: true - responses: - "200": - description: "Transaction Process result" - content: - application/json: - schema: - $ref: '#/components/schemas/TransactionProcessResult' - "400": - description: "Bad request. Check your input data." - "403": - description: "Bad license. Either server or request does not contain valid license." - - /transaction/{transactionId}: - get: - parameters: - - in: path - name: transactionId - schema: - type: string - format: uuid - required: true - description: Transaction id - summary: Get Reprocess transaction data - tags: - - transaction - responses: - "200": - description: "Reprocess transaction data" - content: - application/json: - schema: - $ref: '#/components/schemas/TransactionProcessGetResponse' - "400": - description: "Bad request. Check your input data." - "403": - description: "Bad license. Either server or request does not contain valid license." - - /transaction/{transactionId}/results: - get: - parameters: - - in: path - name: transactionId - schema: - type: string - format: uuid - required: true - description: Transaction id - - in: query - name: withImages - schema: - type: boolean - description: With base64 images or url - summary: Get Reprocess transaction result - tags: - - transaction - responses: - "200": - description: "Transaction data" - content: - application/json: - schema: - $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: - - in: path - name: transactionId - schema: - type: string - format: uuid - required: true - description: Transaction id - - in: query - name: name - schema: - type: string - required: true - description: "File name" - summary: "Get Reprocess transaction file" - tags: - - transaction - responses: - "200": - description: "Binary file" - content: - application/octet-stream: - schema: - type: string - format: binary - "404": - description: "File not found" - - /tag/{tagId}: - delete: - parameters: - - in: path - name: tagId - schema: - type: string - format: uuid - required: true - description: Tag id - summary: Delete Reprocess transactions by tag - tags: - - transaction - responses: - "204": - description: "Transactions deleted" - content: - application/json: - schema: {} - "400": - 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: - - in: path - name: tagId - schema: - type: string - required: true - description: Tag id - summary: Get transactions by tag - tags: - - transaction - responses: - "200": - description: "Transactions list by tag" - content: - application/json: - schema: - $ref: '#/components/schemas/ListTransactionsByTagResponse' - "400": - description: "Bad request. Check your input data." - "403": - description: "Bad license. Either server or request does not contain valid license." - -components: - schemas: - ListTransactionsByTagResponse: - title: "ListTransactionsByTagResponse" - type: object - properties: - items: - type: array - items: - $ref: '#/components/schemas/GetTransactionsByTagResponse' - metadata: - type: object - additionalProperties: true - - GetTransactionsByTagResponse: - title: "GetTransactionsByTagResponse" - type: object - properties: - id: - type: string - format: uuid - description: "Transaction id" - state: - type: integer - description: "Transaction status" - updatedAt: - 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: - type: string - format: uuid - tag: - type: string - outData: - $ref: '#/components/schemas/OutData' - inData: - $ref: '#/components/schemas/InData' - - OutData: - title: "OutData" - type: object - properties: - url: - description: "Response url" - type: string - images: - type: array - items: - $ref: "#/components/schemas/OutDataTransactionImagesFieldValue" - - InData: - title: "InData" - type: object - properties: - video: - description: "Video" - type: object - properties: - metadata: - type: object - additionalProperties: true - description: "A free-form object containing video's extended attributes." - url: - description: "Video url" - type: string - images: - type: array - items: - $ref: "#/components/schemas/InDataTransactionImagesFieldValue" - - TransactionProcessRequest: - title: "TransactionProcessRequest" - type: object - required: - - processParam - properties: - processParam: - $ref: "./p-process.yml#/components/schemas/ProcessParams" - List: - 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 - example: "Base64 encoded data" - description: "Live portrait photo" - extPortrait: - type: string - format: base64 - example: "Base64 encoded data" - description: "Portrait photo from an external source" - ContainerList: - $ref: "./rt.yml#/components/schemas/ContainerList" - systemInfo: - $ref: "./p-process.yml#/components/schemas/ProcessSystemInfo" - passBackObject: - type: object - description: "Free-form object to be included in response. Must be object, not list or simple value. - Do not affect document processing. Use it freely to pass your app params. Stored in process logs." - additionalProperties: true - dtc: - type: string - description: "Digital Travel Credential (DTC-VC) data in base64 format for processing" - - InDataTransactionImagesFieldValue: - title: "InDataTransactionImagesFieldValue" - type: object - properties: - light: - $ref: "./common.yml#/components/schemas/Light" - listIdx: - type: integer - pageIdx: - $ref: "./common.yml#/components/schemas/PageIndex" - url: - type: string - description: "Image url" - - OutDataTransactionImagesFieldValue: - title: "OutDataTransactionImagesFieldValue" - type: object - properties: - fieldType: - $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldType" - light: - $ref: "./common.yml#/components/schemas/Light" - listIdx: - type: integer - pageIdx: - $ref: "./common.yml#/components/schemas/PageIndex" - url: - type: string - description: "Image url" - - TransactionScenarioRequest: - title: "TransactionScenarioRequest" - type: object - properties: - scenario: - $ref: "./common.yml#/components/schemas/Scenario" diff --git a/redocly.yml b/redocly.yml deleted file mode 100644 index 7050b653..00000000 --- a/redocly.yml +++ /dev/null @@ -1,12 +0,0 @@ -openapi: - hideDownloadButton: true - maxDisplayedEnumValues: 5 - expandResponses: 'all' - expandSingleSchemaField: true - jsonSampleExpandLevel: 6 - theme: - logo: - gutter: '20px' - colors: - primary: - main: '#8a53cb' diff --git a/rt-authenticity.yml b/rt-authenticity.yml deleted file mode 100644 index c1c25aef..00000000 --- a/rt-authenticity.yml +++ /dev/null @@ -1,157 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - AuthenticityCheckListItem: - title: "AuthenticityCheckListItem" - type: object - required: - - AuthenticityCheckList - properties: - AuthenticityCheckList: - $ref: "#/components/schemas/AuthenticityCheckList" - - AuthenticityCheckList: - title: "AuthenticityCheckList" - type: object - required: - - Count - - List - properties: - Count: - type: integer - description: "Count of items in List" - List: - type: array - description: "Authenticity Check" - items: - $ref: "#/components/schemas/AuthenticityCheckResult" - - AuthenticityCheckResult: - title: "AuthenticityCheckResult" - type: object - required: - - Type - - Result - - List - properties: - Type: - $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: - oneOf: - - $ref: "#/components/schemas/SecurityFeatureResult" - - $ref: "#/components/schemas/IdentResult" - - $ref: "#/components/schemas/FiberResult" - - $ref: "#/components/schemas/OCRSecurityTextResult" - - $ref: "#/components/schemas/PhotoIdentResult" - - 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: "./authenticity/e-result-type.yml#/components/schemas/AuthenticityResultType" - ElementResult: - $ref: "./common.yml#/components/schemas/CheckResult" - ElementDiagnose: - $ref: "./authenticity/e-check-diagnose.yml#/components/schemas/CheckDiagnose" - PercentValue: - type: integer - format: double - discriminator: - propertyName: Type - mapping: - 1: "SecurityFeatureResult" - 2: "SecurityFeatureResult" - 4: "IdentResult" - 8: "SecurityFeatureResult" - 16: "FiberResult" - 32: "IdentResult" - 64: "OCRSecurityTextResult" - 128: "PhotoIdentResult" - 512: "SecurityFeatureResult" - 1024: "IdentResult" - 4096: "SecurityFeatureResult" - 8192: "SecurityFeatureResult" - 32768: "IdentResult" - 65536: "SecurityFeatureResult" - 131072: "IdentResult" - 262144: "IdentResult" - 524288: "IdentResult" - 1048576: "IdentResult" - 2097152: "IdentResult" - 4194304: "SecurityFeatureResult" - 8388608: "SecurityFeatureResult" - 16777216: "OCRSecurityTextResult" - - AreaContainer: - title: "AreaContainer" - description: "Checked fragment coordinates" - type: object - required: - - Count - - List - - Points - properties: - Count: - type: integer - List: - type: array - items: - $ref: "./common.yml#/components/schemas/RectangleCoordinates" - Points: - type: array - items: - $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" diff --git a/rt-barcode-position.yml b/rt-barcode-position.yml deleted file mode 100644 index eaf70498..00000000 --- a/rt-barcode-position.yml +++ /dev/null @@ -1,11 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - BarcodePositionItem: - title: "BarcodePositionItem" - type: object - required: - - BarcodePosition - properties: - BarcodePosition: - $ref: "./common.yml#/components/schemas/DocumentPosition" diff --git a/rt-barcodes.yml b/rt-barcodes.yml deleted file mode 100644 index 739e6372..00000000 --- a/rt-barcodes.yml +++ /dev/null @@ -1,149 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - 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 - description: "Count of array fields" - pArrayFields: - type: array - description: "Data from barcode" - items: - $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: number - format: float - bcCodeResult: - type: integer - bcCountModule: - type: integer - bcDataModule: - type: array - items: - $ref: "#/components/schemas/DataModule" - bcPDF417INFO: - $ref: "#/components/schemas/bcPDF417INFO" - bcROI_DETECT: - $ref: "#/components/schemas/bcROI_DETECT" - bcTextDecoderTypes: - type: integer - bcTextFieldType: - $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" - bcType_DECODE: - $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: number - format: float - bcColumn: - type: integer - bcErrorLevel: - type: integer - bcRow: - type: integer - minX: - type: number - format: float - minY: - type: number - format: float - - bcROI_DETECT: - title: "bcROI_DETECT" - type: object - required: - - bottom - - left - - right - - top - properties: - bottom: - type: integer - left: - type: integer - right: - type: integer - top: - type: integer - - DataModule: - title: "DataModule" - type: object - required: - - mData - - mLength - - mType - properties: - mData: - type: string - mLength: - type: integer - mReserved1: - type: integer - mReserver2: - type: integer - mType: - $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 deleted file mode 100644 index c74bd74d..00000000 --- a/rt-byte-array-data.yml +++ /dev/null @@ -1,12 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - 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 deleted file mode 100644 index f71dbc6a..00000000 --- a/rt-doc-type-old.yml +++ /dev/null @@ -1,205 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - CandidatesListItem: - title: "CandidatesListItem" - type: object - properties: - CandidatesList: - $ref: "#/components/schemas/DocumentTypesCandidatesList" - - 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: # Overall recognition result - $ref: "#/components/schemas/DocumentTypeRecognitionResult" - Candidates: - type: array - items: - $ref: "#/components/schemas/OneCandidate" - - DocumentTypeRecognitionResult: - title: "DocumentTypeRecognitionResult" - type: integer - enum: - - 0 - - 15 - - 29 - x-enum-descriptions: - - "Document type determined. The first element in candidates array is recognition result" - - "Document type was not determined. Ongoing processing is not possible" - - "To determine document type user should provide more images with different light sources (UV, for example)" - x-enum-varnames: - - "OK" - - "UNKNOWN" - - "NEED_MORE_IMAGES" - - - 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 - description: "Document name" - ID: - type: integer - description: "Unique document type template identifier (Regula's internal numeric code)" - P: - type: number - description: "A measure of the likelihood of correct recognition in the analysis of this type of document" - 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) - $ref: "./common.yml#/components/schemas/RfidLocation" - FDSIDList: - $ref: "#/components/schemas/FDSIDList" - NecessaryLights: - type: integer - description: "Combination of lighting scheme identifiers (Light enum) required to conduct OCR for this type of document" - CheckAuthenticity: - type: integer - description: "Set of authentication options provided for this type of document (combination of Authenticity enum)" - UVExp: - type: integer - description: "The required exposure value of the camera when receiving images of a document - of this type for a UV lighting scheme" - AuthenticityNecessaryLights: - 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 - - dType - - dFormat - - dMRZ - - 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: - type: integer - description: "Document identifiers in 'Information Reference Systems'" - dType: - $ref: "./e-document-type.yml#/components/schemas/DocumentType" - dFormat: - $ref: "#/components/schemas/DocumentFormat" - dMRZ: - type: boolean - description: "Flag indicating the presence of MRZ on the document" - dDescription: - type: string - description: "Document description" - dYear: - type: string - description: "Year of publication of the document" - dCountryName: - type: string - description: "Issuing country name" - dStateCode: - type: string - description: "Issuing state code" - dStateName: - type: string - description: "Issuing state name" - isDeprecated: - type: boolean - 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 - - 3 - - 4 - - 5 - - 10 - - 11 - - 12 - - 13 - - 14 - - 1000 - - 1002 - x-enum-descriptions: - - "Unknown document format" - - "ID1 document format" - - "ID2 document format" - - "ID3 document format" - - "Undefined document format" - - "A4 document format" - - "ID3 double document format" - - "ID1 format document rotated 90 °" - - "ID1 format document rotated 180 °" - - "ID1 format document rotated 270 °" - - "ID2 format document rotated 90 °" - - "ID3 format document rotated 180 °" - - "Arbitrary format" - - "Flexible format. Standard formats can be resized during cropping, depending on various factors: light, background..." - x-enum-varnames: - - "UNKNOWN" - - "ID1" - - "ID2" - - "ID3" - - "NON" - - "A4" - - "ID3_X2" - - "ID1_90" - - "ID1_180" - - "ID1_270" - - "ID2_180" - - "ID3_180" - - "CUSTOM" - - "FLEXIBLE" diff --git a/rt-document-position.yml b/rt-document-position.yml deleted file mode 100644 index 25c00439..00000000 --- a/rt-document-position.yml +++ /dev/null @@ -1,11 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - DocumentPositionItem: - title: "DocumentPositionItem" - type: object - required: - - DocumentPosition - properties: - DocumentPosition: - $ref: "./common.yml#/components/schemas/DocumentPosition" diff --git a/rt-encrypted-rcl.yml b/rt-encrypted-rcl.yml deleted file mode 100644 index 592f61a6..00000000 --- a/rt-encrypted-rcl.yml +++ /dev/null @@ -1,11 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - 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 deleted file mode 100644 index 6b7d79b4..00000000 --- a/rt-face-detection.yml +++ /dev/null @@ -1,62 +0,0 @@ -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 deleted file mode 100644 index 81b80886..00000000 --- a/rt-image-data.yml +++ /dev/null @@ -1,46 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - DocGraphicsInfoItem: - title: "DocGraphicsInfoItem" - type: object - required: - - DocGraphicsInfo - 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" diff --git a/rt-image-quality.yml b/rt-image-quality.yml deleted file mode 100644 index 0c81f62c..00000000 --- a/rt-image-quality.yml +++ /dev/null @@ -1,164 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - ImageQualityCheckListItem: - title: "ImageQualityCheckListItem" - type: object - required: - - ImageQualityCheckList - properties: - ImageQualityCheckList: - $ref: "#/components/schemas/ImageQualityCheckList" - - ImageQualityCheckList: - title: "ImageQualityCheckList" - type: object - required: - - result - - List - - Count - properties: - 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: - - 0 - - 1 - - 2 - - 3 - - 4 - - 5 - - 7 - - 8 - - 9 - - 10 - x-enum-varnames: - - "ImageGlares" - - "ImageFocus" - - "ImageResolution" - - "ImageColorness" - - "Perspective" - - "Bounds" - - "Portrait" - - "Handwritten" - - "Brightness" - - "Occlusion" - x-enum-descriptions: - - "Signals glare presence on the image" - - "Signals whether image is in focus" - - "Signals if image resolution is below threshold" - - "Signals if image is colorless" - - "Signals if document in the image has prespective distortion above threshold" - - "Signals if document is not fully present in the image" - - "Signals if the portrait is present" - - "Signals if the document contains handwritten text in the scanned fields" - - "Signals if the document image is bright enough" - - "Signals if the document image has occlusion" - - InputImageQualityChecks: - title: "InputImageQualityChecks" - type: string - description: "Input image quality checks for the document processing" - enum: - - "glaresCheck" - - "focusCheck" - - "dpiThreshold" - - "colornessCheck" - - "perspectiveCheck" - - "documentPosition" - - "portraitCheck" - - "brightnessCheck" - - "occlusionCheck" - x-enum-varnames: - - "Glares" - - "Focus" - - "Resolution" - - "Colorness" - - "Perspective" - - "Bounds" - - "Portrait" - - "Brightness" - - "Occlusion" - x-enum-descriptions: - - "Signals glare presence on the image" - - "Signals whether image is in focus" - - "Signals if image resolution is below threshold" - - "Signals if image is colorless" - - "Signals if document in the image has prespective distortion above threshold" - - "Signals if document is not fully present in the image" - - "Signals if the portrait is present" - - "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: - $ref: "./common.yml#/components/schemas/RectangleCoordinates" - Points: - type: array - items: - $ref: "#/components/schemas/PointArray" - - PointArray: - title: "PointArray" - type: object - required: - - PointsList - properties: - PointsList: - type: array - items: - $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" - result: - $ref: "./common.yml#/components/schemas/CheckResult" - featureType: - $ref: "./e-security-feature-type.yml#/components/schemas/SecurityFeatureType" - 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 deleted file mode 100644 index 8b8eb78f..00000000 --- a/rt-images.yml +++ /dev/null @@ -1,95 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - 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: - $ref: "#/components/schemas/ImagesAvailableSource" - fieldList: - type: array - items: - $ref: "#/components/schemas/ImagesField" - - ImagesAvailableSource: - title: "ImagesAvailableSource" - type: object - required: - - containerType - - source - properties: - containerType: - $ref: "./rt.yml#/components/schemas/ContainerType" - source: - $ref: "./common.yml#/components/schemas/Source" - - ImagesField: - title: "ImagesField" - type: object - required: - - fieldName - - fieldType - - valueList - properties: - fieldName: - $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldName" - fieldType: - $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldType" - valueList: - type: array - items: - $ref: "#/components/schemas/ImagesFieldValue" - valueCount: - description: "Field value count" - type: number - - ImagesFieldValue: - title: "ImagesFieldValue" - type: object - required: - - containerType - - lightIndex - - pageIndex - - source - properties: - source: - $ref: "./common.yml#/components/schemas/Source" - value: - $ref: "./common.yml#/components/schemas/ImageBase64" - 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" - type: integer - pageIndex: - $ref: "./common.yml#/components/schemas/PageIndex" - lightIndex: - $ref: "./common.yml#/components/schemas/Light" - containerType: - $ref: "./rt.yml#/components/schemas/ContainerType" - 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" diff --git a/rt-license.yml b/rt-license.yml deleted file mode 100644 index 2bb89bec..00000000 --- a/rt-license.yml +++ /dev/null @@ -1,11 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - 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 deleted file mode 100644 index 9c0241a9..00000000 --- a/rt-mrz-detector.yml +++ /dev/null @@ -1,61 +0,0 @@ -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 deleted file mode 100644 index a4770951..00000000 --- a/rt-mrz-position.yml +++ /dev/null @@ -1,11 +0,0 @@ -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 deleted file mode 100644 index 21c0f827..00000000 --- a/rt-mrz-test-quality.yml +++ /dev/null @@ -1,209 +0,0 @@ -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-analysis.yml b/rt-ocr-lexical-analysis.yml deleted file mode 100644 index 0647b1f1..00000000 --- a/rt-ocr-lexical-analysis.yml +++ /dev/null @@ -1,103 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - 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" - wLCID: - $ref: "./e-lcid.yml#/components/schemas/LCID" - Field_MRZ: - description: "Field data extracted from mrz(machine readable zone)" - type: string - Field_Visual: - description: "Field data extracted from visual zone" - type: string - Field_Barcode: - description: "Field data extracted from barcode" - type: string - Field_RFID: - description: "Field data extracted from rfid chip" - 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 - description: "results comparison matrix. - Elements of the matrix with indices 0, 1, 2, 3 take one of the values Disabled(0), Verified(1) or Not_Verified(2), - elements with indices 4, 5, 6, 7, 8 are one of the values Disabled(0), Compare_Match(3) or Compare_Not_Match(4). - Elements of the Matrix matrix have the following semantic meaning: - - - element with index 0 –– the result of verification of data from the MRZ; - - 1 –– the result of verification of data from the RFID microcircuit; - - 2 –– the result of verification of data from text areas of the document; - - 3 –– the result of verification data from barcodes; - - 4 - the result of comparing MRZ data and RFID microcircuits; - - 5 - the result of comparing MRZ data and text areas of document filling; - - 6 - the result of comparing MRZ data and bar codes; - - 7 - the result of comparing the data of text areas of the document and the RFID chip; - - 8 - the result of comparing the data of the text areas of the document and barcodes; - - 9 - the result of comparing the data of the RFID chip and barcodes." - items: - $ref: "#/components/schemas/VerificationResult" - example: [1,0,0,0,0,3,0,0,0,0] - - VerificationResult: - title: "VerificationResult" - type: integer - enum: - - 0 - - 1 - - 2 - - 3 - - 4 - x-enum-descriptions: - - "Comparison result unknown" - - "Verification passed" - - "Verification failed" - - "Positive comparison result" - - "Negative comparison result" - x-enum-varnames: - - "DISABLED" - - "VERIFIED" - - "NOT_VERIFIED" - - "COMPARE_MATCH" - - "COMPARE_NOT_MATCH" diff --git a/rt-raw-image.yml b/rt-raw-image.yml deleted file mode 100644 index 99c8f616..00000000 --- a/rt-raw-image.yml +++ /dev/null @@ -1,11 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - 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 deleted file mode 100644 index 05943dc3..00000000 --- a/rt-rfid-binary-data.yml +++ /dev/null @@ -1,1203 +0,0 @@ -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: - type: integer - 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_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: boolean - 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. Can be ParsingErrorCodes or ParsingNotificationCodes enum." - type: array - items: - type: integer - 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: - description: "Can be ParsingErrorCodes or ParsingNotificationCodes enum." - type: array - items: - type: integer - - 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. Can be ParsingErrorCodes or ParsingNotificationCodes enum." - type: array - items: - type: integer - 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 - x-enum-descriptions: - - "Root files" - - "ePassport application" - - "eID application" - - "eSign application" - - "eDL application" - - "TravelRecords application" - - "VisaRecords application" - - "AddBiometrics application" - - "Digital Travel Credentials" - - "Master File" - x-enum-varnames: - - "ROOT_FILES" - - "E_PASSPORT" - - "E_ID" - - "E_SIGN" - - "E_DL" - - "LDS2_TravelRecords" - - "LDS2_VisaRecords" - - "LDS2_AddBiometrics" - - "eDTC_PC" - - 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. - Can be ParsingErrorCodes or ParsingNotificationCodes enum." - type: array - items: - type: integer - 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: - $ref: "./e-parsing-notification-codes.yml#/components/schemas/ParsingNotificationCodes" - - 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. Can be ParsingErrorCodes or ParsingNotificationCodes enum." - type: array - items: - type: integer - 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 deleted file mode 100644 index c8a55272..00000000 --- a/rt-rfid-graphics-info.yml +++ /dev/null @@ -1,61 +0,0 @@ -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 deleted file mode 100644 index 10551d09..00000000 --- a/rt-rfid-text-data.yml +++ /dev/null @@ -1,50 +0,0 @@ -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 deleted file mode 100644 index b0cd7ed4..00000000 --- a/rt-status.yml +++ /dev/null @@ -1,99 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - StatusItem: - title: "StatusItem" - type: object - required: - - Status - properties: - Status: - $ref: "#/components/schemas/Status" - - Status: - title: "Status" - type: object - required: - - overallStatus - - optical - - portrait - - rfid - - stopList - - detailsOptical - properties: - overallStatus: # Overall checks status. Rootx status - $ref: "./common.yml#/components/schemas/CheckResult" - optical: # Overall optical checks combined status - $ref: "./common.yml#/components/schemas/CheckResult" - portrait: # Portrait comparison status - $ref: "./common.yml#/components/schemas/CheckResult" - rfid: # Overall RFID checks combined status - $ref: "./common.yml#/components/schemas/CheckResult" - stopList: # Stop list check status - $ref: "./common.yml#/components/schemas/CheckResult" - detailsRFID: - $ref: "#/components/schemas/detailsRFID" - detailsOptical: - $ref: "#/components/schemas/detailsOptical" - - detailsOptical: - title: "detailsOptical" - description: "Details on performed optical checks" - type: object - required: - - overallStatus - - docType - - expiry - - imageQA - - mrz - - pagesCount - - security - - text - properties: - overallStatus: # Overall optical checks combined status - $ref: "./common.yml#/components/schemas/CheckResult" - docType: # Status of document type recognition - $ref: "./common.yml#/components/schemas/CheckResult" - expiry: # Status of document expiration - $ref: "./common.yml#/components/schemas/CheckResult" - imageQA: # Status of document image quality check - $ref: "./common.yml#/components/schemas/CheckResult" - mrz: # Status of document MRZ - $ref: "./common.yml#/components/schemas/CheckResult" - pagesCount: - description: "Number of processed pages in the document" - type: integer - security: # Authenticity verification status - $ref: "./common.yml#/components/schemas/CheckResult" - 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 - - AA - - BAC - - CA - - PA - - PACE - - TA - properties: - overallStatus: # Overall RFID checks combined status - $ref: "./common.yml#/components/schemas/CheckResult" - AA: # Active Authentication status - $ref: "./common.yml#/components/schemas/CheckResult" - BAC: # Basic Access Control (BAC) status - $ref: "./common.yml#/components/schemas/CheckResult" - CA: # Chip Authentication status - $ref: "./common.yml#/components/schemas/CheckResult" - PA: # Passive Authentication status - $ref: "./common.yml#/components/schemas/CheckResult" - PACE: # Password Authenticated Connection Establishment (PACE) status - $ref: "./common.yml#/components/schemas/CheckResult" - TA: # Terminal Authentication status - $ref: "./common.yml#/components/schemas/CheckResult" diff --git a/rt-text-data.yml b/rt-text-data.yml deleted file mode 100644 index f3fb5ce5..00000000 --- a/rt-text-data.yml +++ /dev/null @@ -1,43 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - 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 - allOf: - - $ref: "./common.yml#/components/schemas/VisualExtendedFieldItem" - - $ref: "#/components/schemas/DocVisualExtendedFieldItem" - - DocVisualExtendedFieldItem: - title: "DocVisualExtendedFieldItem" - type: object - required: - - FieldRect - properties: - 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" diff --git a/rt-text.yml b/rt-text.yml deleted file mode 100644 index 5752f6e0..00000000 --- a/rt-text.yml +++ /dev/null @@ -1,190 +0,0 @@ -openapi: 3.0.4 -components: - schemas: - 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: # Overall status of all checks from all text fields - $ref: "./common.yml#/components/schemas/CheckResult" - validityStatus: # Overall status of validity from all text fields from all sources - $ref: "./common.yml#/components/schemas/CheckResult" - 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: - $ref: "#/components/schemas/TextField" - availableSourceList: - type: array - items: - $ref: "#/components/schemas/TextAvailableSource" - - TextField: - title: "TextField" - type: object - required: - - fieldType - - fieldName - - lcid - - status - - validityStatus - - comparisonStatus - - value - - valueList - - validityList - - comparisonList - properties: - fieldType: - $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 fieldType for lookup." - type: string - lcid: - $ref: "./e-lcid.yml#/components/schemas/LCID" - lcidName: - description: "LCID name" - type: string - status: # Overall status of all checks from all values - $ref: "./common.yml#/components/schemas/CheckResult" - validityStatus: # Overall status of validity from all values - $ref: "./common.yml#/components/schemas/CheckResult" - comparisonStatus: # Overall status of data comparison from different sources - $ref: "./common.yml#/components/schemas/CheckResult" - value: - description: "The most confidence value, selected from valueList" - type: string - valueList: - type: array - items: - $ref: "#/components/schemas/TextFieldValue" - validityList: - description: "Validity of all field values for given source. - If there are two values on different pages for one field-source pair, - then validity also will include logical match checking. - If such values do not match, validity will return error." - type: array - items: - $ref: "#/components/schemas/SourceValidity" - comparisonList: - type: array - items: - $ref: "#/components/schemas/CrossSourceValueComparison" - - TextFieldValue: - title: "TextFieldValue" - type: object - required: - - value - - pageIndex - - source - - originalValidity - - probability - properties: - source: - $ref: "./common.yml#/components/schemas/Source" - value: - description: "Parsed/processed value. Date format converted for output, delimiters removed" - type: string - originalValue: - description: "Original value as seen in the document" - type: string - originalValidity: - $ref: "./common.yml#/components/schemas/CheckResult" - originalSymbols: - type: array - items: - $ref: "#/components/schemas/OriginalSymbol" - pageIndex: - $ref: "./common.yml#/components/schemas/PageIndex" - probability: - description: "Min recognition probability. Combined minimum probability from single characters probabilities" - type: integer - minimum: 0 - maximum: 100 - 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: # 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" - type: integer - format: int64 - probability: - description: "Probability of correctness reading of a single character" - type: integer - minimum: 0 - maximum: 100 - rect: - $ref: "./common.yml#/components/schemas/RectangleCoordinates" - - SourceValidity: - title: "SourceValidity" - type: object - required: - - source - - status - properties: - source: - $ref: "./common.yml#/components/schemas/Source" - status: - $ref: "./common.yml#/components/schemas/CheckResult" - - CrossSourceValueComparison: - title: "CrossSourceValueComparison" - type: object - required: - - sourceLeft - - sourceRight - - status - properties: - sourceLeft: - $ref: "./common.yml#/components/schemas/Source" - sourceRight: - $ref: "./common.yml#/components/schemas/Source" - status: - $ref: "./common.yml#/components/schemas/CheckResult" - - TextAvailableSource: - title: "TextAvailableSource" - type: object - required: - - source - - validityStatus - properties: - source: - $ref: "./common.yml#/components/schemas/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 deleted file mode 100644 index 3752c531..00000000 --- a/rt.yml +++ /dev/null @@ -1,382 +0,0 @@ -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 - - 16 - - 17 - - 18 - - 19 - - 20 - - 26 - - 30 - - 32 - - 33 - - 34 - - 35 - - 36 - - 37 - - 38 - - 39 - - 49 - - 50 - - 61 - - 62 - - 85 - - 87 - - 97 - - 101 - - 102 - - 103 - - 104 - - 105 - - 109 - x-enum-descriptions: - - "Contains cropped and rotated with perspective compensation image of document. Single input image can contain multiple document side/pages, which will be returned as separated results. Most of coordinates in other types defined on that image" - - "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)" - - "Contains raw uncropped images" - - "Contains Visual zone OCR results" - - "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" - - "Contains RFID binary data" - - "Contains RFID original graphics data" - - "Digital Travel Credential data" - x-enum-varnames: - - "DOCUMENT_IMAGE" - - "MRZ_TEXT" - - "BARCODES" - - "VISUAL_GRAPHICS" - - "MRZ_TEST_QUALITY" - - "DOCUMENT_TYPE_CANDIDATES" - - "DOCUMENT_TYPE" - - "LEXICAL_ANALYSIS" - - "RAW_UNCROPPED_IMAGE" - - "VISUAL_TEXT" - - "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" - - "RFID_BINARY_DATA" - - "RFID_ORIGINAL_GRAPHICS" - - "DTC_VC" - - ResultItem: - title: "ResultItem" - type: object - description: "Common fields for all result objects" - required: - - result_type - properties: - buf_length: - type: integer - light: - type: integer - list_idx: - type: integer - page_idx: - type: integer - result_type: - $ref: "#/components/schemas/Result" - discriminator: - propertyName: result_type - mapping: - 1: "DocumentImageResult" - 3: "TextDataResult" - 5: "DocBarCodeInfo" - 6: "GraphicsResult" - 7: "MRZTestQualityResult" - 8: "DocumentTypesCandidatesResult" - 9: "ChosenDocumentTypeResult" - 15: "LexicalAnalysisResult" - 16: "DocumentImageResult" - 17: "TextDataResult" - 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: "BarcodePositionResult" - 85: "DocumentPositionResult" - 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: - - List - properties: - Count: - type: integer - description: "Length of list (Count for items)" - List: - type: array - items: - oneOf: - - $ref: "#/components/schemas/StatusResult" - - $ref: "#/components/schemas/TextResult" - - $ref: "#/components/schemas/DocumentImageResult" - - $ref: "#/components/schemas/ImagesResult" - - $ref: "#/components/schemas/ChosenDocumentTypeResult" - - $ref: "#/components/schemas/DocumentTypesCandidatesResult" - - $ref: "#/components/schemas/TextDataResult" - - $ref: "#/components/schemas/GraphicsResult" - - $ref: "#/components/schemas/LexicalAnalysisResult" - - $ref: "#/components/schemas/AuthenticityResult" - - $ref: "#/components/schemas/ImageQualityResult" - - $ref: "#/components/schemas/BarcodePositionResult" - - $ref: "#/components/schemas/DocumentPositionResult" - - $ref: "#/components/schemas/DocBarCodeInfo" - - $ref: "#/components/schemas/LicenseResult" - - $ref: "#/components/schemas/EncryptedRCLResult" - - $ref: "#/components/schemas/DocumentBinaryInfoResult" - - $ref: "#/components/schemas/ByteArrayResult" - - $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: - title: "StatusResult" - allOf: - - $ref: "#/components/schemas/ResultItem" - - $ref: "./rt-status.yml#/components/schemas/StatusItem" - - 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: - title: "ImagesResult" - allOf: - - $ref: "#/components/schemas/ResultItem" - - $ref: "./rt-images.yml#/components/schemas/ImagesItem" - - 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: - 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: - 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: - title: "ByteArrayResult" - allOf: - - $ref: "#/components/schemas/ResultItem" - - $ref: "./rt-byte-array-data.yml#/components/schemas/ByteArrayItem" - - 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: - title: "AuthenticityResult" - allOf: - - $ref: "#/components/schemas/ResultItem" - - $ref: "./rt-authenticity.yml#/components/schemas/AuthenticityCheckListItem" - - ImageQualityResult: - title: "ImageQualityResult" - allOf: - - $ref: "#/components/schemas/ResultItem" - - $ref: "./rt-image-quality.yml#/components/schemas/ImageQualityCheckListItem" - - BarcodePositionResult: - title: "BarcodePositionResult" - description: "Contains information about barcode position on the input image, its center, angle, etc" - allOf: - - $ref: "#/components/schemas/ResultItem" - - $ref: "./rt-barcode-position.yml#/components/schemas/BarcodePositionItem" - - 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: - title: "DocBarCodeInfo" - description: "Raw data from BarCodes" - allOf: - - $ref: "#/components/schemas/ResultItem" - - $ref: "./rt-barcodes.yml#/components/schemas/DocBarCodeInfoItem" - - LicenseResult: - title: "LicenseResult" - description: "Contains license" - allOf: - - $ref: "#/components/schemas/ResultItem" - - $ref: "./rt-license.yml#/components/schemas/LicenseItem" - - 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"