Skip to main content
Version: 11.3.0

Customizable Consent Screen

HYPR Affirm shows a consent screen at the start of every verification flow. The requester sees it after the instructions screen and before entering a login identifier. No verification step runs and no image is captured until the requester accepts.

Customizable Consent Screen lets administrators add their own consent language per verification flow. HYPR's own consent notice is always shown alongside it, and so is the identity verification provider's notice when the flow includes Document and Biometric Verification.

Available in 11.3

Customizable Consent Screen is new in HYPR 11.3. Contact your HYPR representative to enable it for your tenant.

For how biometric data is captured, compared and retained after consent, see Biometric Data and the Privacy Notice.

Consent is a fixed step. In the verification flow editor, the Consent step is always selected and cannot be turned off. Its description reads "Requester must give their consent in order to meet with all the compliance standards in the verification process."

Every flow runs in the following order:

  1. The instructions screen lists the steps the requester completes.
  2. The consent screen shows the consent notices.
  3. The login identifier screen asks for the requester's username or email.
  4. The verification steps configured for the flow run, including any document, selfie or liveness capture.

The default footer text on the instructions screen tells the requester that consent follows: "By selecting continue, you understand that the following actions will need to be performed. In subsequent steps, additional information is provided for your review and consent. For additional information or if you are unable to proceed, please contact your company representative or help desk team." Administrators can change this text in Affirm Studio.

The consent screen assembles its text from the blocks in the following table, top to bottom, above the Accept button.

BlockShown whenSourceEditable by administrators
Custom consent languageThe flow's content customization kit sets Consent LanguageYour organizationYes
HYPR Affirm Biometric Data Policy and ConsentThe flow includes Document and Biometric Verification or Photo ID and Liveness CaptureHYPRNo
HYPR Affirm Non-Biometric Data Policy and ConsentThe flow includes neither of those stepsHYPRNo
Identity verification provider's consent noticeThe flow includes Document and Biometric VerificationThe identity verification providerNo

Only one of the two HYPR policies appears on a given flow. The wording follows the versions HYPR and the provider publish, not a copy stored in your tenant.

The linked HYPR policies are the authoritative text of the notice the requester accepts. The biometric policy covers how biometric data is collected, used, processed and retained, including the role of the third-party provider. The phone or email step's one-time-code disclaimer links the non-biometric policy and the HYPR Privacy Policy.

Consent screen for a flow with Document and Biometric Verification, opening on the HYPR Affirm Biometric Data Policy and Consent with Accept not yet available

What Stays Fixed​

The HYPR notice and the provider's notice cannot be removed or edited. Custom consent language is added above them and does not replace them.

Your custom content can follow your organization's communication standards while the notices that HYPR and the identity verification provider require stay in place.

The requester reads the notices and clicks Accept. The screen behaves as follows:

  • Accept stays disabled until the requester scrolls to the end of the consent text. When all of the text fits on screen, Accept is enabled straight away.
  • Clicking Accept records the requester's consent and opens the login identifier screen.
  • The consent screen has no decline button. A requester who does not accept cannot continue. The flow stops at the consent screen, so Affirm collects no login identifier and runs no verification step.

Links inside the consent text open in a new browser tab.

The consent screen's text belongs to the flow's content customization kit. You edit it on the Consent Screen in Affirm Studio. The following table lists the editable fields and their defaults.

SectionFieldDefault
Card HeaderTitleEmpty
Card HeaderDescriptionEmpty
Card FooterCaption 1 and Caption 2Empty
Button LabelsContinue Button"Accept"
Error MessagesUnknown Error MessageAn error has occurred.<br />Please contact your helpdesk for further support.
Text AssetsConsent LanguageEmpty

Consent Language appears only when Customizable Consent Screen is enabled on your tenant. Its value is a text asset: a named block of formatted text that the kit references.

To add consent language to a flow:

  1. In Control Center, click HYPR Affirm in the left navigation menu.
  2. Click the Affirm Studio tab.
  3. Open the kit applied to the flow, then open the Consent Screen.
  4. Under Text Assets, click Override beside Consent Language.
  5. Click the Consent Language box. The asset editor opens.
  6. Choose an existing asset from Asset. To create one instead, choose Add new asset, enter a Name and Content, and click Create.
  7. Click Select. The asset is applied to the field.
  8. Save the kit.
  9. Apply the kit to the verification flow, as described in Applying to Workflows.

To remove the custom block, click Use Default beside Consent Language and save the kit. Each flow can use its own kit, so each flow can carry its own consent language.

Links in consent language

Write every link in your consent language as a full https:// URL. Relative links are not resolved against your own website.

Configuration via API​

You can also configure consent content with the Affirm Content Customization API. The API uses the same content-customization schema as other Affirm Studio screen overrides: the consentScreen object, with the custom block referenced from textAssets.consentLanguage. Use the API for programmatic provisioning across many workflows, or for multi-language content management where a content management system (CMS) owns the source content.

Audit and Observability​

When the requester clicks Accept, Affirm records an AFFIRM_WORKFLOW_CONSENT event in the Audit Trail with the message "Requester has provided consent to proceed through the workflow". The event carries the verification flow, the workflow instance and, when known, the requester.