Class SemanticsVerificationReport

constructor

• new SemanticsVerificationReport(source?): SemanticsVerificationReport

• Parameters

  • Optional source: DeepPartial<SemanticsVerificationReport>

  Returns SemanticsVerificationReport

Readonly birthDateBeforeExpiryDate

Readonly birthDateBeforeIssueDate

Readonly birthDateSemantics

Readonly expiryDateSemantics

Readonly issueDateBeforeExpiryDate

Readonly issueDateSemantics

Readonly overallInvalidSemantics

serialize

• serialize(config?): {
      birthDateBeforeExpiryDate?: ValueSemantics;
      birthDateBeforeIssueDate?: ValueSemantics;
      birthDateSemantics?: {
          fieldDetails?: (undefined | {
              fieldFullName?: string;
              invalidSemantics?: boolean;
              serialize?: any;
          })[];
          overallFieldValueSemantics?: ValueSemantics;
          serialize?: any;
      };
      expiryDateSemantics?: {
          fieldDetails?: (undefined | {
              fieldFullName?: string;
              invalidSemantics?: boolean;
              serialize?: any;
          })[];
          overallFieldValueSemantics?: ValueSemantics;
          serialize?: any;
      };
      issueDateBeforeExpiryDate?: ValueSemantics;
      issueDateSemantics?: {
          fieldDetails?: (undefined | {
              fieldFullName?: string;
              invalidSemantics?: boolean;
              serialize?: any;
          })[];
          overallFieldValueSemantics?: ValueSemantics;
          serialize?: any;
      };
      overallInvalidSemantics?: boolean;
      serialize?: any;
  }

• Parameters

  • Optional config: ToJsonConfiguration

  Returns {
      birthDateBeforeExpiryDate?: ValueSemantics;
      birthDateBeforeIssueDate?: ValueSemantics;
      birthDateSemantics?: {
          fieldDetails?: (undefined | {
              fieldFullName?: string;
              invalidSemantics?: boolean;
              serialize?: any;
          })[];
          overallFieldValueSemantics?: ValueSemantics;
          serialize?: any;
      };
      expiryDateSemantics?: {
          fieldDetails?: (undefined | {
              fieldFullName?: string;
              invalidSemantics?: boolean;
              serialize?: any;
          })[];
          overallFieldValueSemantics?: ValueSemantics;
          serialize?: any;
      };
      issueDateBeforeExpiryDate?: ValueSemantics;
      issueDateSemantics?: {
          fieldDetails?: (undefined | {
              fieldFullName?: string;
              invalidSemantics?: boolean;
              serialize?: any;
          })[];
          overallFieldValueSemantics?: ValueSemantics;
          serialize?: any;
      };
      overallInvalidSemantics?: boolean;
      serialize?: any;
  }

  • Optional Readonly birthDateBeforeExpiryDate?: ValueSemantics

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

  • Optional Readonly birthDateBeforeIssueDate?: ValueSemantics

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

  • Optional Readonly birthDateSemantics?: {
        fieldDetails?: (undefined | {
            fieldFullName?: string;
            invalidSemantics?: boolean;
            serialize?: any;
        })[];
        overallFieldValueSemantics?: ValueSemantics;
        serialize?: any;
    }

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

    • Optional Readonly fieldDetails?: (undefined | {
          fieldFullName?: string;
          invalidSemantics?: boolean;
          serialize?: any;
      })[]

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

    • Optional Readonly overallFieldValueSemantics?: 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.

  • Optional Readonly expiryDateSemantics?: {
        fieldDetails?: (undefined | {
            fieldFullName?: string;
            invalidSemantics?: boolean;
            serialize?: any;
        })[];
        overallFieldValueSemantics?: ValueSemantics;
        serialize?: any;
    }

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

    • Optional Readonly fieldDetails?: (undefined | {
          fieldFullName?: string;
          invalidSemantics?: boolean;
          serialize?: any;
      })[]

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

    • Optional Readonly overallFieldValueSemantics?: 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.

  • Optional Readonly issueDateBeforeExpiryDate?: ValueSemantics

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

  • Optional Readonly issueDateSemantics?: {
        fieldDetails?: (undefined | {
            fieldFullName?: string;
            invalidSemantics?: boolean;
            serialize?: any;
        })[];
        overallFieldValueSemantics?: ValueSemantics;
        serialize?: any;
    }

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

    • Optional Readonly fieldDetails?: (undefined | {
          fieldFullName?: string;
          invalidSemantics?: boolean;
          serialize?: any;
      })[]

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

    • Optional Readonly overallFieldValueSemantics?: 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.

  • Optional Readonly overallInvalidSemantics?: 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.