Skip to main content

Screening

The screening node carries the customer's answers to your bank's pre‑screening questionnaire. It exists only on bank reports whose type is SCREENING — the periodic screening flow that asks the customer to confirm whether anything has changed since the previous screening.

Module‑gated​

The screening field is only available when your bank has the HasPrescreeningModule feature enabled. If the field returns an authorization error, the module is off for your bank.

Shape​

bankReportScreening exposes:

  • id
  • hasAdministratorsChanges — the customer's pre‑screening declaration: administrators have changed since the last screening.
  • hasBankAccountsChanges — the customer's pre‑screening declaration: bank accounts have changed.
  • hasStatutesChanges — the customer's pre‑screening declaration: the statute has changed.
  • signedFile — the signed screening document. Only generated and signed when all three change flags are false (see below).

How the answers drive the rest of the package​

The three has…Changes flags are the customer's answers to the pre‑screening questions. They modulate the parent bankReport to surface only the sections that are relevant to what the customer actually changed — the exact mapping from a true flag to which bank‑report sections become required is configured per bank.

There are two outcomes:

  • All three flags are false — the customer is declaring nothing has changed. No further sections are required on the bank report, the screening's signedFile is generated, and the customer signs it. The screening itself is the deliverable.
  • At least one flag is true — the customer is declaring real changes. The bank report transitions into a full package that collects the affected sections (statute, administrator changes, bank accounts, …) according to your bank's configuration. The screening's signedFile is not generated in this case — the customer is going to sign the full package instead.

The flags don't carry the change details themselves; they only drive which other components on the bank report come into play.

Where to query​

See Querying screening.