Skip to main content
Version: 10.7.0

Configuring End User Screen Management

This guide provides administrators with instructions for setting up and configuring the End User Screen Management System for HYPR Affirm.

Scope

This article focuses on enabling the feature, managing content through Control Center or API, and applying customizations to workflows. For what users see on each screen, branding guidelines and examples, see User Experience: Affirm Studio.

General Branding

For general branding customization (logos, backgrounds, colors), see Custom Branding.

Prerequisites​

  • HYPR Control Center access with Affirm administration permissions
  • HYPR 10.7.0 or later (for Control Center UI)
  • HYPR 10.3.0 or later (for API-only configuration)
  • API access credentials (if using API-based configuration)
Permissions

Only Control Center administrators can create, edit, and manage content customizations.

Creating Content Customizations​

Content customizations can be created and managed through the Control Center user interface (HYPR 10.7.0 and later) or via the REST API.

Using Control Center Interface​

Navigation:

  1. Log into HYPR Control Center
  2. In the left navigation menu, click HYPR Affirm
  3. Click the Affirm Studio tab in the top navigation bar

Key Features:

  • Kit Management: Create, edit, and delete workflow customization kits
  • Step-Based Editing: Edit content for each verification flow step (Instructions, Consent, Login Identifier, OTP, Location, Identity Verification, Outcome, Error)
  • Content Editor: Edit Card Header, Card Footer, Button Labels, Error Messages, and Screen Specific Content
  • Screen Preview: Review how customized screens will appear to end users (preview functionality)

Workflow:

  1. From the Welcome screen or Kit Management screen, click + Create Your First Kit or + Create New Kit
  2. Enter a Kit Name and optional Description in the Create New Kit modal
  3. Click Create Kit to create the kit
  1. From the Kit Management screen, click Open Kit on the kit you want to edit
  1. In the Kit Editing screen, select a step from the verification flow in the left panel
  2. Use the Content Editor in the right panel to configure content for each screen type
  3. Use the Preview feature in the center panel to review changes before applying them
  4. The changes are saved automatically
Content Validation

The system validates content input and blocks invalid content (such as invalid HTML). If unsupported content is detected, an "Invalid Content Input" error is triggered.

Using the API​

For programmatic configuration, use the REST API endpoints. See Affirm Content Customization API for complete API documentation.

Step 1: Prepare Your Content​

Before creating content customizations, plan your content strategy:

  1. Identify Target Screens: Determine which verification screens need customization
  2. Define Content: Prepare titles, descriptions, instructions, and button labels
  3. Consider Localization: Plan for multiple languages if needed
  4. Branding Guidelines: Ensure content aligns with corporate branding

Step 2: Create Content Customization​

Use the API to create your first content customization:

POST /content-customization
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN

{
  "displayName": "Company Branding",
  "description": "Standard company branding for all verification screens",
  "contentMap": {
    "consentScreen": {
      "cardHeader": {
        "title": "Welcome to [Company Name] Verification",
        "description": "Please review and accept our terms of service"
      },
      "cardContent": {
        "mainContent": "By proceeding, you agree to our verification process and privacy policy.",
        "extraContent": "This process helps us verify your identity securely and efficiently."
      },
      "cardFooter": {
        "caption1": "Secure verification process",
        "caption2": "Powered by HYPR"
      },
      "buttonLabels": {
        "accept": "I Accept",
        "decline": "Decline"
      }
    }
  }
}

Step 3: Test Your Configuration​

After creating content customizations, test them in your development environment:

  1. Retrieve Configuration: Use the GET endpoint to verify your setup
  2. Test Workflows: Run sample verification workflows to see the customizations
  3. Validate Content: Ensure all text displays correctly and buttons function properly
  4. Check Localization: If using multiple languages, test each variant

Screen Configuration​

Each customizable screen supports the following configuration elements:

Header Content​

  • Title: Main screen title
  • Description: Screen description

Main Content​

  • Primary Content: Main instructional text
  • Extra Content: Additional information

Footer Content​

  • Caption 1: Primary footer text
  • Caption 2: Secondary footer text

Button Labels​

  • Customize all button text for the screen

Applying to Workflows​

Once you have set up a customization, you need to apply it to your workflow in one of two ways.

Using Control Center Interface​

  1. Navigate to HYPR Affirm in the left navigation menu
  2. Click the Verification Flows tab
  3. Click the workflow you want to customize
  4. In the workflow configuration menu pane on the right, scroll down to the Content Customization section and click the + Customizations button
  1. Scroll down to the Content section
  2. Select the kit you want to apply from the Content Customization Kit drop-down menu
  3. Click Save to apply the kit to the workflow

Using the API​

  1. Retrieve Workflow Configuration: Get the current workflow settings
  2. Update Configuration: Add the contentCustomizationId to the workflow
  3. Save Changes: Apply the updated configuration
  4. Test Workflow: Verify the customizations appear correctly

API Configuration Examples​

Basic Company Branding​

{
  "displayName": "Company Branding",
  "description": "Standard company branding for all verification screens",
  "contentMap": {
    "consentScreen": {
      "cardHeader": {
        "title": "Welcome to [Company Name] Verification",
        "description": "Please review and accept our terms of service"
      },
      "cardContent": {
        "mainContent": "By proceeding, you agree to our verification process and privacy policy.",
        "extraContent": "This process helps us verify your identity securely and efficiently."
      },
      "cardFooter": {
        "caption1": "Secure verification process",
        "caption2": "Powered by HYPR"
      },
      "buttonLabels": {
        "accept": "I Accept",
        "decline": "Decline"
      }
    }
  }
}

Localized Content (Spanish)​

{
  "displayName": "Spanish Localization",
  "description": "Spanish language content for global teams",
  "contentMap": {
    "consentScreen": {
      "cardHeader": {
        "title": "Bienvenido a la Verificación de [Company Name]",
        "description": "Por favor revise y acepte nuestros términos de servicio"
      },
      "cardContent": {
        "mainContent": "Al continuar, usted acepta nuestro proceso de verificación y política de privacidad.",
        "extraContent": "Este proceso nos ayuda a verificar su identidad de manera segura y eficiente."
      },
      "cardFooter": {
        "caption1": "Proceso de verificación seguro",
        "caption2": "Desarrollado por HYPR"
      },
      "buttonLabels": {
        "accept": "Acepto",
        "decline": "Rechazar"
      }
    }
  }
}

Multi-Screen Configuration​

{
  "displayName": "Complete Workflow Branding",
  "description": "Comprehensive branding for all verification steps",
  "contentMap": {
    "consentScreen": {
      "cardHeader": {
        "title": "Welcome to Company Verification",
        "description": "Please review and accept our terms"
      },
      "cardContent": {
        "mainContent": "By proceeding, you agree to our verification process",
        "extraContent": "This process helps us verify your identity securely"
      },
      "cardFooter": {
        "caption1": "Secure verification process",
        "caption2": "Powered by HYPR"
      },
      "buttonLabels": {
        "accept": "I Accept",
        "decline": "Decline"
      }
    },
    "instructionsScreen": {
      "cardHeader": {
        "title": "Verification Instructions",
        "description": "Follow these steps to complete verification"
      },
      "cardContent": {
        "mainContent": "Please follow the instructions carefully to complete your verification",
        "extraContent": "Ensure you have a valid government-issued ID ready"
      },
      "cardFooter": {
        "caption1": "Secure verification process",
        "caption2": "Powered by HYPR"
      },
      "buttonLabels": {
        "continue": "Continue",
        "back": "Back"
      }
    },
    "outcomeScreen": {
      "cardHeader": {
        "title": "Verification Complete",
        "description": "Your verification has been processed"
      },
      "cardContent": {
        "mainContent": "Thank you for completing the verification process",
        "extraContent": "You will receive confirmation of your verification status"
      },
      "cardFooter": {
        "caption1": "Verification complete",
        "caption2": "Powered by HYPR"
      },
      "buttonLabels": {
        "finish": "Finish",
        "contact": "Contact Support"
      }
    }
  }
}

Getting Help​

If you encounter issues:

  1. Check API Documentation: Review the Affirm Content Customization API
  2. Contact Support: Reach out to HYPR support for assistance
  3. Review Logs: Check system logs for error details
  4. Test in Development: Verify configurations in a test environment