capacitor-plugin-scanbot-sdk
    Preparing search index...

    Class DocumentVerificationReport

    Report of the document verification.

    Index

    Constructors

    Properties

    consistencyVerificationReport: ConsistencyVerificationReport

    Report of the document consistency verification. Shows whether information in the fields that correspond to the same logical field and is present in different parts of the document is consistent.

    invalidDataVerificationReport: InvalidDataVerificationReport

    Some fields in the documents allow validation, for example, MRZ contains check digits to verify the data. This report shows whether there are any invalid fields in the document.

    overallVerificationStatus: DocumentVerificationStatus

    Overall status of the document verification.

    semanticsVerificationReport: SemanticsVerificationReport

    Report of the semantics verification. Shows whether the values in the fields are semantically correct.

    suspiciousDataVerificationReport: SuspiciousDataVerificationReport

    Shows whether the data in the document is suspicious, e.g. contains word "Sample" in the name.

    Methods

    • Parameters

      Returns {
          consistencyVerificationReport?: {
              fieldDetails?: {
                  consistency?: ValueConsistency;
                  fieldFullNames?: string[];
                  fieldType?: CommonFieldType;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => { readonly fieldType?: CommonFieldType | undefined; readonly consistency?: ValueConsistency | undefined; readonly fieldFullNames?: string[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
              }[];
              overallConsistency?: ValueConsistency;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => { readonly overallConsistency?: ValueConsistency | undefined; readonly fieldDetails?: { readonly fieldType?: CommonFieldType | undefined; readonly consistency?: ValueConsistency | undefined; readonly fieldFullNames?: string[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }...;
          };
          invalidDataVerificationReport?: {
              fieldDetails?: {
                  fieldFullName?: string;
                  isInvalid?: boolean;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => { readonly fieldFullName?: string | undefined; readonly isInvalid?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
              }[];
              overallIsInvalid?: boolean;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => { readonly overallIsInvalid?: boolean | undefined; readonly fieldDetails?: { readonly fieldFullName?: string | undefined; readonly isInvalid?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...;
          };
          overallVerificationStatus?: DocumentVerificationStatus;
          semanticsVerificationReport?: {
              birthDateBeforeExpiryDate?: ValueSemantics;
              birthDateBeforeIssueDate?: ValueSemantics;
              birthDateSemantics?: {
                  fieldDetails?: {
                      fieldFullName?: string;
                      invalidSemantics?: boolean;
                      serialize?: (
                          config?: (...) | (...),
                      ) => { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                  }[];
                  overallFieldValueSemantics?: ValueSemantics;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => { readonly overallFieldValueSemantics?: ValueSemantics | undefined; readonly fieldDetails?: { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; serialize?: ((config?: ToJsonConfig...;
              };
              expiryDateSemantics?: {
                  fieldDetails?: {
                      fieldFullName?: string;
                      invalidSemantics?: boolean;
                      serialize?: (
                          config?: (...) | (...),
                      ) => { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                  }[];
                  overallFieldValueSemantics?: ValueSemantics;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => { readonly overallFieldValueSemantics?: ValueSemantics | undefined; readonly fieldDetails?: { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; serialize?: ((config?: ToJsonConfig...;
              };
              issueDateBeforeExpiryDate?: ValueSemantics;
              issueDateSemantics?: {
                  fieldDetails?: {
                      fieldFullName?: string;
                      invalidSemantics?: boolean;
                      serialize?: (
                          config?: (...) | (...),
                      ) => { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                  }[];
                  overallFieldValueSemantics?: ValueSemantics;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => { readonly overallFieldValueSemantics?: ValueSemantics | undefined; readonly fieldDetails?: { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; serialize?: ((config?: ToJsonConfig...;
              };
              overallInvalidSemantics?: boolean;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => { readonly overallInvalidSemantics?: boolean | undefined; readonly expiryDateSemantics?: { readonly overallFieldValueSemantics?: ValueSemantics | undefined; readonly fieldDetails?: { ...; }[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefined; ... 5 more ...; seri...;
          };
          serialize?: (
              config?: ToJsonConfiguration,
          ) => { readonly overallVerificationStatus?: DocumentVerificationStatus | undefined; readonly consistencyVerificationReport?: { readonly overallConsistency?: ValueConsistency | undefined; readonly fieldDetails?: { ...; }[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefi...;
          suspiciousDataVerificationReport?: {
              fieldDetails?: {
                  fieldFullName?: string;
                  isSuspicious?: boolean;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => { readonly fieldFullName?: string | undefined; readonly isSuspicious?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
              }[];
              overallSuspiciousData?: boolean;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => { readonly overallSuspiciousData?: boolean | undefined; readonly fieldDetails?: { readonly fieldFullName?: string | undefined; readonly isSuspicious?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefi...;
          };
      }

      • Optional ReadonlyconsistencyVerificationReport?: {
            fieldDetails?: {
                consistency?: ValueConsistency;
                fieldFullNames?: string[];
                fieldType?: CommonFieldType;
                serialize?: (
                    config?: ToJsonConfiguration,
                ) => { readonly fieldType?: CommonFieldType | undefined; readonly consistency?: ValueConsistency | undefined; readonly fieldFullNames?: string[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
            }[];
            overallConsistency?: ValueConsistency;
            serialize?: (
                config?: ToJsonConfiguration,
            ) => { readonly overallConsistency?: ValueConsistency | undefined; readonly fieldDetails?: { readonly fieldType?: CommonFieldType | undefined; readonly consistency?: ValueConsistency | undefined; readonly fieldFullNames?: string[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }...;
        }

        Report of the document consistency verification. Shows whether information in the fields that correspond to the same logical field and is present in different parts of the document is consistent.

        • Optional ReadonlyfieldDetails?: {
              consistency?: ValueConsistency;
              fieldFullNames?: string[];
              fieldType?: CommonFieldType;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => { readonly fieldType?: CommonFieldType | undefined; readonly consistency?: ValueConsistency | undefined; readonly fieldFullNames?: string[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
          }[]

          List of reports for each field that was verified.

        • Optional ReadonlyoverallConsistency?: ValueConsistency

          Overall status of the consistency verification. Corresponds to the most severe status of all fields.

        • Optionalserialize?: (
              config?: ToJsonConfiguration,
          ) => { readonly overallConsistency?: ValueConsistency | undefined; readonly fieldDetails?: { readonly fieldType?: CommonFieldType | undefined; readonly consistency?: ValueConsistency | undefined; readonly fieldFullNames?: string[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }...
      • Optional ReadonlyinvalidDataVerificationReport?: {
            fieldDetails?: {
                fieldFullName?: string;
                isInvalid?: boolean;
                serialize?: (
                    config?: ToJsonConfiguration,
                ) => { readonly fieldFullName?: string | undefined; readonly isInvalid?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
            }[];
            overallIsInvalid?: boolean;
            serialize?: (
                config?: ToJsonConfiguration,
            ) => { readonly overallIsInvalid?: boolean | undefined; readonly fieldDetails?: { readonly fieldFullName?: string | undefined; readonly isInvalid?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...;
        }

        Some fields in the documents allow validation, for example, MRZ contains check digits to verify the data. This report shows whether there are any invalid fields in the document.

        • Optional ReadonlyfieldDetails?: {
              fieldFullName?: string;
              isInvalid?: boolean;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => { readonly fieldFullName?: string | undefined; readonly isInvalid?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
          }[]

          List of reports for each field that was verified.

        • Optional ReadonlyoverallIsInvalid?: boolean

          Overall status of the document verification. Corresponds to the most severe status of all fields, i.e. if at least one field is invalid, the overall status is invalid.

        • Optionalserialize?: (
              config?: ToJsonConfiguration,
          ) => { readonly overallIsInvalid?: boolean | undefined; readonly fieldDetails?: { readonly fieldFullName?: string | undefined; readonly isInvalid?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...
      • Optional ReadonlyoverallVerificationStatus?: DocumentVerificationStatus

        Overall status of the document verification.

      • Optional ReadonlysemanticsVerificationReport?: {
            birthDateBeforeExpiryDate?: ValueSemantics;
            birthDateBeforeIssueDate?: ValueSemantics;
            birthDateSemantics?: {
                fieldDetails?: {
                    fieldFullName?: string;
                    invalidSemantics?: boolean;
                    serialize?: (
                        config?: (...) | (...),
                    ) => { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                }[];
                overallFieldValueSemantics?: ValueSemantics;
                serialize?: (
                    config?: ToJsonConfiguration,
                ) => { readonly overallFieldValueSemantics?: ValueSemantics | undefined; readonly fieldDetails?: { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; serialize?: ((config?: ToJsonConfig...;
            };
            expiryDateSemantics?: {
                fieldDetails?: {
                    fieldFullName?: string;
                    invalidSemantics?: boolean;
                    serialize?: (
                        config?: (...) | (...),
                    ) => { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                }[];
                overallFieldValueSemantics?: ValueSemantics;
                serialize?: (
                    config?: ToJsonConfiguration,
                ) => { readonly overallFieldValueSemantics?: ValueSemantics | undefined; readonly fieldDetails?: { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; serialize?: ((config?: ToJsonConfig...;
            };
            issueDateBeforeExpiryDate?: ValueSemantics;
            issueDateSemantics?: {
                fieldDetails?: {
                    fieldFullName?: string;
                    invalidSemantics?: boolean;
                    serialize?: (
                        config?: (...) | (...),
                    ) => { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                }[];
                overallFieldValueSemantics?: ValueSemantics;
                serialize?: (
                    config?: ToJsonConfiguration,
                ) => { readonly overallFieldValueSemantics?: ValueSemantics | undefined; readonly fieldDetails?: { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; serialize?: ((config?: ToJsonConfig...;
            };
            overallInvalidSemantics?: boolean;
            serialize?: (
                config?: ToJsonConfiguration,
            ) => { readonly overallInvalidSemantics?: boolean | undefined; readonly expiryDateSemantics?: { readonly overallFieldValueSemantics?: ValueSemantics | undefined; readonly fieldDetails?: { ...; }[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefined; ... 5 more ...; seri...;
        }

        Report of the semantics verification. Shows whether the values in the fields are semantically correct.

        • Optional ReadonlybirthDateBeforeExpiryDate?: ValueSemantics

          Result of verification whether the birth date is before the expiry date.

        • Optional ReadonlybirthDateBeforeIssueDate?: ValueSemantics

          Result of verification whether the birth date is before the issue date.

        • Optional ReadonlybirthDateSemantics?: {
              fieldDetails?: {
                  fieldFullName?: string;
                  invalidSemantics?: boolean;
                  serialize?: (
                      config?: (...) | (...),
                  ) => { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
              }[];
              overallFieldValueSemantics?: ValueSemantics;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => { readonly overallFieldValueSemantics?: ValueSemantics | undefined; readonly fieldDetails?: { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; serialize?: ((config?: ToJsonConfig...;
          }

          Status of the birth date semantics verification. Shows whether the birth date in the document is in the past.

          • Optional ReadonlyfieldDetails?: {
                fieldFullName?: string;
                invalidSemantics?: boolean;
                serialize?: (
                    config?: (...) | (...),
                ) => { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
            }[]

            List of value semantics for each field corresponding to the same logical field.

          • Optional ReadonlyoverallFieldValueSemantics?: ValueSemantics

            Overall status of the logical value semantics verification. Corresponds to the most severe status of all fields, i.e. if at least one field is semantically incorrect, the overall status is semantically incorrect. If no fields are present, the overall status is SKIPPED.

          • Optionalserialize?: (
                config?: ToJsonConfiguration,
            ) => { readonly overallFieldValueSemantics?: ValueSemantics | undefined; readonly fieldDetails?: { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; serialize?: ((config?: ToJsonConfig...
        • Optional ReadonlyexpiryDateSemantics?: {
              fieldDetails?: {
                  fieldFullName?: string;
                  invalidSemantics?: boolean;
                  serialize?: (
                      config?: (...) | (...),
                  ) => { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
              }[];
              overallFieldValueSemantics?: ValueSemantics;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => { readonly overallFieldValueSemantics?: ValueSemantics | undefined; readonly fieldDetails?: { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; serialize?: ((config?: ToJsonConfig...;
          }

          Status of the expiry date semantics verification. Shows whether the expiry date in the document is in the future.

          • Optional ReadonlyfieldDetails?: {
                fieldFullName?: string;
                invalidSemantics?: boolean;
                serialize?: (
                    config?: (...) | (...),
                ) => { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
            }[]

            List of value semantics for each field corresponding to the same logical field.

          • Optional ReadonlyoverallFieldValueSemantics?: ValueSemantics

            Overall status of the logical value semantics verification. Corresponds to the most severe status of all fields, i.e. if at least one field is semantically incorrect, the overall status is semantically incorrect. If no fields are present, the overall status is SKIPPED.

          • Optionalserialize?: (
                config?: ToJsonConfiguration,
            ) => { readonly overallFieldValueSemantics?: ValueSemantics | undefined; readonly fieldDetails?: { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; serialize?: ((config?: ToJsonConfig...
        • Optional ReadonlyissueDateBeforeExpiryDate?: ValueSemantics

          Result of verification whether the issue date is before the expiry date.

        • Optional ReadonlyissueDateSemantics?: {
              fieldDetails?: {
                  fieldFullName?: string;
                  invalidSemantics?: boolean;
                  serialize?: (
                      config?: (...) | (...),
                  ) => { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
              }[];
              overallFieldValueSemantics?: ValueSemantics;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => { readonly overallFieldValueSemantics?: ValueSemantics | undefined; readonly fieldDetails?: { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; serialize?: ((config?: ToJsonConfig...;
          }

          Status of the issue date semantics verification. Shows whether the issue date in the document is in the past.

          • Optional ReadonlyfieldDetails?: {
                fieldFullName?: string;
                invalidSemantics?: boolean;
                serialize?: (
                    config?: (...) | (...),
                ) => { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
            }[]

            List of value semantics for each field corresponding to the same logical field.

          • Optional ReadonlyoverallFieldValueSemantics?: ValueSemantics

            Overall status of the logical value semantics verification. Corresponds to the most severe status of all fields, i.e. if at least one field is semantically incorrect, the overall status is semantically incorrect. If no fields are present, the overall status is SKIPPED.

          • Optionalserialize?: (
                config?: ToJsonConfiguration,
            ) => { readonly overallFieldValueSemantics?: ValueSemantics | undefined; readonly fieldDetails?: { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; serialize?: ((config?: ToJsonConfig...
        • Optional ReadonlyoverallInvalidSemantics?: boolean

          Overall status of the value semantics verification. Corresponds to the most severe status of all fields, i.e. if at least one field is semantically incorrect, the overall status is semantically incorrect. If some verifications are skipped, they do not impact the overall status.

        • Optionalserialize?: (
              config?: ToJsonConfiguration,
          ) => { readonly overallInvalidSemantics?: boolean | undefined; readonly expiryDateSemantics?: { readonly overallFieldValueSemantics?: ValueSemantics | undefined; readonly fieldDetails?: { ...; }[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefined; ... 5 more ...; seri...
      • Optionalserialize?: (
            config?: ToJsonConfiguration,
        ) => { readonly overallVerificationStatus?: DocumentVerificationStatus | undefined; readonly consistencyVerificationReport?: { readonly overallConsistency?: ValueConsistency | undefined; readonly fieldDetails?: { ...; }[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefi...
      • Optional ReadonlysuspiciousDataVerificationReport?: {
            fieldDetails?: {
                fieldFullName?: string;
                isSuspicious?: boolean;
                serialize?: (
                    config?: ToJsonConfiguration,
                ) => { readonly fieldFullName?: string | undefined; readonly isSuspicious?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
            }[];
            overallSuspiciousData?: boolean;
            serialize?: (
                config?: ToJsonConfiguration,
            ) => { readonly overallSuspiciousData?: boolean | undefined; readonly fieldDetails?: { readonly fieldFullName?: string | undefined; readonly isSuspicious?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefi...;
        }

        Shows whether the data in the document is suspicious, e.g. contains word "Sample" in the name.

        • Optional ReadonlyfieldDetails?: {
              fieldFullName?: string;
              isSuspicious?: boolean;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => { readonly fieldFullName?: string | undefined; readonly isSuspicious?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
          }[]

          List of reports for each field that was verified.

        • Optional ReadonlyoverallSuspiciousData?: boolean

          Overall status of the suspicious data verification. Corresponds to the most severe status of all fields, i.e. if at least one field is suspicious, the overall status is suspicious.

        • Optionalserialize?: (
              config?: ToJsonConfiguration,
          ) => { readonly overallSuspiciousData?: boolean | undefined; readonly fieldDetails?: { readonly fieldFullName?: string | undefined; readonly isSuspicious?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefi...