Onboarding configuration
esc
Country
Forms
↑↓ navigate↵ open40 results
Countries/TZ/confirm

confirm

Base v1 · src/Modules/FormEngine/OmniDos.FormEngine.Infra/SeedData/Forms/confirm_base_v1_schema.json

Scope
Prefill from journey data

The service uses the first non-empty source. Use a dot path beginning with the source step id.

Options (enum)
Validation
Error message keys (i18n)
Prefill from journey data

The service uses the first non-empty source. Use a dot path beginning with the source step id.

Options (enum)
Validationrequired
Error message keys (i18n)
Prefill from journey data

The service uses the first non-empty source. Use a dot path beginning with the source step id.

Options (enum)
Validationrequired
Error message keys (i18n)
Prefill from journey data

The service uses the first non-empty source. Use a dot path beginning with the source step id.

Options (enum)
Validationrequired
Error message keys (i18n)
Prefill from journey data

The service uses the first non-empty source. Use a dot path beginning with the source step id.

Options (enum)
Validationrequired
Error message keys (i18n)
Prefill from journey data

The service uses the first non-empty source. Use a dot path beginning with the source step id.

Options (enum)
EMPLOYMENToccupation.sourceOfIncome.employment
BUSINESSoccupation.sourceOfIncome.business
REMITTANCEoccupation.sourceOfIncome.remittance
OTHERoccupation.sourceOfIncome.other
Validationrequired
Error message keys (i18n)
Prefill from journey data

The service uses the first non-empty source. Use a dot path beginning with the source step id.

Options (enum)
YEScommon.answer.yes
NOcommon.answer.no
Validation
Error message keys (i18n)
Prefill from journey data

The service uses the first non-empty source. Use a dot path beginning with the source step id.

Conditional display

The preview reads this rule as you enter answers. The service can project it before returning the form when the dependency comes from an earlier step.

Options (enum)
Validation
Error message keys (i18n)
Prefill from journey data

The service uses the first non-empty source. Use a dot path beginning with the source step id.

Conditional display

The preview reads this rule as you enter answers. The service can project it before returning the form when the dependency comes from an earlier step.

Options (enum)
Validation
Error message keys (i18n)
Prefill from journey data

The service uses the first non-empty source. Use a dot path beginning with the source step id.

Conditional display

The preview reads this rule as you enter answers. The service can project it before returning the form when the dependency comes from an earlier step.

Options (enum)
Validation
Error message keys (i18n)
Prefill from journey data

The service uses the first non-empty source. Use a dot path beginning with the source step id.

Conditional display

The preview reads this rule as you enter answers. The service can project it before returning the form when the dependency comes from an earlier step.

Validation
Only “Required” applies to array fields.
Error message keys (i18n)
Prefill from journey data

The service uses the first non-empty source. Use a dot path beginning with the source step id.

Linked consent content

Stored in this form's x-linkedContent. Publishing emits the country schema patch DigitalOnboardingSvc already seeds.

Validationrequired
Only “Required” applies to boolean fields.
Error message keys (i18n)
Prefill from journey data

The service uses the first non-empty source. Use a dot path beginning with the source step id.

Options (enum)
EMPLOYEDoccupation.employmentStatus.employed
SELF_EMPLOYEDoccupation.employmentStatus.selfEmployed
UNEMPLOYEDoccupation.employmentStatus.unemployed
Validationrequired
Error message keys (i18n)
Prefill from journey data

The service uses the first non-empty source. Use a dot path beginning with the source step id.

Options (enum)
Validationrequired
Error message keys (i18n)
Prefill from journey data

The service uses the first non-empty source. Use a dot path beginning with the source step id.

Validation
Only “Required” applies to boolean fields.
Error message keys (i18n)
Live preview

Renders as the web app would. Interactive — pick values to exercise visibility rules and validation.

EQUITY
confirm

Confirmation

State / region
Address
ZIP / postal code
City
Primary source of income

4 options

Employment status

3 options

Profession
Taxpayer identification number (TIN) (Optional)

2 options

I accept the CRS declaration
I accept the terms and conditions

Blocking the CTA (8)

  • state — State / region is required
  • address — Address is required
  • zipCode — ZIP / postal code is required
  • city — City is required
  • primarySourceOfIncome — Primary source of income is required
  • confirmTermsAccepted — I accept the terms and conditions is required.
  • employmentStatus — Employment status is required.
  • profession — Profession is required

Not shown to the customer

  • countryOfResidence — in the schema, but no layout row places it
  • crsTaxIdentificationNumber — hidden until crsHasTaxpayerIdentificationNumber = YES
  • crsTinUnavailableReason — hidden until crsHasTaxpayerIdentificationNumber = NO
  • fatcaSocialSecurityNumber — hidden until fatcaSocialSecurityNumber has a value
  • fatcaProofOfAddressDocument — hidden until fatcaProofOfAddressDocument has a value
Generated change (2 files)
src/Modules/FormEngine/OmniDos.FormEngine.Infra/SeedData/Patches/TZ/confirm_tz_v1_schema_patch.json
[
  {
    "op": "remove",
    "path": "/x-crossFieldRules/secondarySourceOfIncome"
  },
  {
    "op": "remove",
    "path": "/x-crossFieldRules/secondaryMonthlyIncome"
  },
  {
    "op": "remove",
    "path": "/required/13"
  },
  {
    "op": "remove",
    "path": "/required/12"
  },
  {
    "op": "remove",
    "path": "/required/11"
  },
  {
    "op": "remove",
    "path": "/required/10"
  },
  {
    "op": "remove",
    "path": "/required/9"
  },
  {
    "op": "remove",
    "path": "/required/8"
  },
  {
    "op": "replace",
    "path": "/required/7",
    "value": "confirmTermsAccepted"
  },
  {
    "op": "replace",
    "path": "/required/6",
    "value": "profession"
  },
  {
    "op": "replace",
    "path": "/required/5",
    "value": "employmentStatus"
  },
  {
    "op": "replace",
    "path": "/required/4",
    "value": "primarySourceOfIncome"
  },
  {
    "op": "replace",
    "path": "/required/3",
    "value": "city"
  },
  {
    "op": "replace",
    "path": "/required/2",
    "value": "zipCode"
  },
  {
    "op": "replace",
    "path": "/required/1",
    "value": "address"
  },
  {
    "op": "replace",
    "path": "/required/0",
    "value": "state"
  },
  {
    "op": "remove",
    "path": "/properties/crsTinReasonUnavailableOption"
  },
  {
    "op": "remove",
    "path": "/properties/email"
  },
  {
    "op": "remove",
    "path": "/properties/documentNumber"
  },
  {
    "op": "remove",
    "path": "/properties/documentType"
  },
  {
    "op": "remove",
    "path": "/properties/phoneNumber"
  },
  {
    "op": "remove",
    "path": "/properties/relationship"
  },
  {
    "op": "remove",
    "path": "/properties/lastName"
  },
  {
    "op": "remove",
    "path": "/properties/middleName"
  },
  {
    "op": "remove",
    "path": "/properties/firstName"
  },
  {
    "op": "remove",
    "path": "/properties/secondaryMonthlyIncome"
  },
  {
    "op": "remove",
    "path": "/properties/secondarySourceOfIncome"
  },
  {
    "op": "remove",
    "path": "/properties/primaryMonthlyIncome"
  },
  {
    "op": "remove",
    "path": "/properties/primarySourceOfIncome/x-enumLabels/NONE"
  },
  {
    "op": "remove",
    "path": "/properties/primarySourceOfIncome/x-enumLabels/SELF_EMPLOYED"
  },
  {
    "op": "remove",
    "path": "/properties/primarySourceOfIncome/x-enumLabels/EMPLOYED_SALARIED"
  },
  {
    "op": "add",
    "path": "/properties/primarySourceOfIncome/x-enumLabels/EMPLOYMENT",
    "value": "occupation.sourceOfIncome.employment"
  },
  {
    "op": "add",
    "path": "/properties/primarySourceOfIncome/x-enumLabels/BUSINESS",
    "value": "occupation.sourceOfIncome.business"
  },
  {
    "op": "add",
    "path": "/properties/primarySourceOfIncome/x-enumLabels/REMITTANCE",
    "value": "occupation.sourceOfIncome.remittance"
  },
  {
    "op": "add",
    "path": "/properties/primarySourceOfIncome/x-enumLabels/OTHER",
    "value": "occupation.sourceOfIncome.other"
  },
  {
    "op": "replace",
    "path": "/properties/primarySourceOfIncome/enum/2",
    "value": "REMITTANCE"
  },
  {
    "op": "replace",
    "path": "/properties/primarySourceOfIncome/enum/1",
    "value": "BUSINESS"
  },
  {
    "op": "replace",
    "path": "/properties/primarySourceOfIncome/enum/0",
    "value": "EMPLOYMENT"
  },
  {
    "op": "add",
    "path": "/properties/primarySourceOfIncome/enum/3",
    "value": "OTHER"
  },
  {
    "op": "add",
    "path": "/properties/employmentStatus",
    "value": {
      "type": "string",
      "enum": [
        "EMPLOYED",
        "SELF_EMPLOYED",
        "UNEMPLOYED"
      ],
      "x-labelKey": "confirm.employmentStatus.label",
      "x-placeholderKey": "confirm.employmentStatus.placeholder",
      "x-popoverTitleKey": "confirm.employmentStatus.popoverTitle.label",
      "x-source": "occupation.employmentStatus",
      "x-enumLabels": {
        "EMPLOYED": "occupation.employmentStatus.employed",
        "SELF_EMPLOYED": "occupation.employmentStatus.selfEmployed",
        "UNEMPLOYED": "occupation.employmentStatus.unemployed"
      },
      "x-errorMessages": {
        "type": "confirm.error.employmentStatus.type",
        "enum": "confirm.error.employmentStatus.enum"
      }
    }
  },
  {
    "op": "add",
    "path": "/properties/profession",
    "value": {
      "type": "string",
      "minLength": 2,
      "maxLength": 100,
      "x-labelKey": "confirm.profession.label",
      "x-placeholderKey": "confirm.profession.placeholder",
      "x-source": "occupation.profession",
      "x-errorMessages": {
        "type": "confirm.error.profession.type",
        "required": "confirm.error.profession.required",
        "minLength": "confirm.error.profession.minLength",
        "maxLength": "confirm.error.profession.maxLength"
      }
    }
  },
  {
    "op": "add",
    "path": "/properties/crsDeclarationAccepted",
    "value": {
      "type": "boolean",
      "x-labelKey": "crsTaxDetails.declarationAccepted.label",
      "x-source": "crs_tax_details.declarationAccepted",
      "x-errorMessages": {
        "type": "crsTaxDetails.error.declarationAccepted.type"
      }
    }
  }
]
src/Modules/FormEngine/OmniDos.FormEngine.Infra/SeedData/Patches/TZ/confirm_tz_v1_ui_patch.json
[
  {
    "op": "remove",
    "path": "/widgets/crsTinReasonUnavailableOption"
  },
  {
    "op": "remove",
    "path": "/widgets/email"
  },
  {
    "op": "remove",
    "path": "/widgets/documentNumber"
  },
  {
    "op": "remove",
    "path": "/widgets/documentType"
  },
  {
    "op": "remove",
    "path": "/widgets/phoneNumber"
  },
  {
    "op": "remove",
    "path": "/widgets/relationship"
  },
  {
    "op": "remove",
    "path": "/widgets/lastName"
  },
  {
    "op": "remove",
    "path": "/widgets/middleName"
  },
  {
    "op": "remove",
    "path": "/widgets/firstName"
  },
  {
    "op": "remove",
    "path": "/widgets/secondaryMonthlyIncome"
  },
  {
    "op": "remove",
    "path": "/widgets/secondarySourceOfIncome"
  },
  {
    "op": "remove",
    "path": "/widgets/primaryMonthlyIncome"
  },
  {
    "op": "remove",
    "path": "/widgets/countryOfResidence"
  },
  {
    "op": "add",
    "path": "/widgets/employmentStatus",
    "value": "selector"
  },
  {
    "op": "add",
    "path": "/widgets/profession",
    "value": "text"
  },
  {
    "op": "add",
    "path": "/widgets/crsDeclarationAccepted",
    "value": "checkbox"
  },
  {
    "op": "remove",
    "path": "/visibilityRules/crsTinReasonUnavailableOption"
  },
  {
    "op": "remove",
    "path": "/layout/6"
  },
  {
    "op": "replace",
    "path": "/layout/5/fields/0/0",
    "value": "confirmTermsAccepted"
  },
  {
    "op": "remove",
    "path": "/layout/5/x-editTargetStepId"
  },
  {
    "op": "remove",
    "path": "/layout/5/x-sectionTitle"
  },
  {
    "op": "replace",
    "path": "/layout/4/fields/0/0",
    "value": "fatcaProofOfAddressDocument"
  },
  {
    "op": "replace",
    "path": "/layout/4/x-editTargetStepId",
    "value": "fatca_documents"
  },
  {
    "op": "replace",
    "path": "/layout/4/x-sectionTitle",
    "value": "confirm.fatcaDocumentsSection.title"
  },
  {
    "op": "remove",
    "path": "/layout/3/fields/3"
  },
  {
    "op": "remove",
    "path": "/layout/3/fields/2"
  },
  {
    "op": "remove",
    "path": "/layout/3/fields/1"
  },
  {
    "op": "replace",
    "path": "/layout/3/fields/0/0",
    "value": "fatcaSocialSecurityNumber"
  },
  {
    "op": "replace",
    "path": "/layout/3/x-editTargetStepId",
    "value": "fatca_tax_details"
  },
  {
    "op": "replace",
    "path": "/layout/3/x-sectionTitle",
    "value": "confirm.fatcaTaxDetailsSection.title"
  },
  {
    "op": "remove",
    "path": "/layout/2/fields/7"
  },
  {
    "op": "remove",
    "path": "/layout/2/fields/6"
  },
  {
    "op": "remove",
    "path": "/layout/2/fields/5"
  },
  {
    "op": "remove",
    "path": "/layout/2/fields/4"
  },
  {
    "op": "replace",
    "path": "/layout/2/fields/3/0",
    "value": "crsDeclarationAccepted"
  },
  {
    "op": "replace",
    "path": "/layout/2/fields/2/0",
    "value": "crsTinUnavailableReason"
  },
  {
    "op": "replace",
    "path": "/layout/2/fields/1/0",
    "value": "crsTaxIdentificationNumber"
  },
  {
    "op": "replace",
    "path": "/layout/2/fields/0/0",
    "value": "crsHasTaxpayerIdentificationNumber"
  },
  {
    "op": "replace",
    "path": "/layout/2/x-editTargetStepId",
    "value": "crs_tax_details"
  },
  {
    "op": "replace",
    "path": "/layout/2/x-sectionTitle",
    "value": "confirm.crsTaxDetailsSection.title"
  },
  {
    "op": "remove",
    "path": "/layout/1/fields/3"
  },
  {
    "op": "replace",
    "path": "/layout/1/fields/2/0",
    "value": "profession"
  },
  {
    "op": "replace",
    "path": "/layout/1/fields/1/0",
    "value": "employmentStatus"
  },
  {
    "op": "remove",
    "path": "/layout/0/fields/4"
  },
  {
    "op": "replace",
    "path": "/layout/0/fields/3/0",
    "value": "city"
  },
  {
    "op": "replace",
    "path": "/layout/0/fields/2/0",
    "value": "zipCode"
  },
  {
    "op": "replace",
    "path": "/layout/0/fields/1/0",
    "value": "address"
  },
  {
    "op": "replace",
    "path": "/layout/0/fields/0/0",
    "value": "state"
  }
]
Downloads a zip to apply to a clone and raise as a PR.