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 via API, and applying customizations to workflows. For what users see on each screen, branding guidelines and examples, see User Experience: End User Screen Management.

API-Only Implementation

This feature currently has API-only support. No Control Center user interface is available yet. All configuration must be done through API calls.

General Branding

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

Prerequisites

• HYPR Control Center access with Affirm administration permissions
• API access credentials for content customization endpoints
• Content customization feature enabled (contact HYPR support)
• Understanding of REST API concepts and JSON formatting
• HYPR 10.3.0 or later

Implementation Status

The End User Screen Management System is currently in Beta status with the following characteristics:

• API-Only Support: No Control Center user interface available
• Programmatic Configuration: All setup must be done through API calls
• Version Control: Includes robust change tracking and rollback capabilities
• Future UI: User interface implementation is planned for future releases

Creating Content Customizations

Since this feature has API-only support, all configuration must be done through the REST API endpoints.

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

Content customizations are applied to Affirm workflows through the contentCustomizationId configuration:

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"
      }
    }
  }
}

Version Control

The system includes robust version control capabilities:

Change Tracking

• History: View all changes made to content customizations
• User Attribution: See who made specific changes
• Timestamps: Track when changes were made

Rollback Support

• Previous Versions: Access to all previous versions
• Selective Rollback: Restore specific screens or complete configurations
• Audit Trail: Complete tracking of all modifications

Troubleshooting

Common Issues

API Authentication Errors

• Verify your API credentials are correct
• Check that your account has the necessary permissions
• Ensure the API endpoint is accessible

Content Not Displaying

• Verify the content customization is properly configured
• Check that the workflow is using the correct contentCustomizationId
• Ensure all required fields are populated

Version Control Issues

• Check that you have permission to view change history
• Verify that the content customization ID is correct
• Ensure you're using the correct API endpoint

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

Related Documentation

• End User Screen Management System
• Affirm Content Customization API
• Affirm Installation and Configuration
• Control Center Branding Customization