Versions Compared

Version Old Version 1 New Version Current
Changes made by

Mercedes Rothwell

Mercedes Rothwell

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titleVersion History

Date

Change

October 2024

Initial Version

Table of Contents

Table of Contents
stylenone

Prerequisites

  • Application Preference NFS Authentication Method

    • Memo Value: JWTToken

    • Boolean Value: [blank]

  • Application Preference NFSOpaqueIDsEnabled

    • Memo Value: [blank]

    • Boolean Value: Yes

  • DocuCapture configured to process Opaque ID logic

  • Core Version 24.19+ and the newest version of the nfs profile

Overview

After a user logs in, Fidelity’s server generates a signed JSON Web Token (JWT), which Docupace stores and sends with future requests. Fidelity verifies the token’s authenticity with each request, allowing access to their Wealthscape resource without storing session data. JWTs are stateless, scalable, and secure, making them ideal for modern web applications.

Prerequisites

  • Application Preference NFS Authentication Method

    • Memo Value: JWTToken

    • Boolean Value: [blank]

  • Application Preference NFSOpaqueIDsEnabled

    • Memo Value: [blank]

    • Boolean Value: Yes

  • DocuCapture configured to process Opaque ID logic

    • Core Version 24.19+ and the newest version of the nfs profile

    How to Generate NFS Credentials

    Rw ui steps macro
    Rw step

    Load a standard ACL file. DocuCapture generates and provisions an Opaque ID. This value allows users to open accounts via NFS.

    Rw step

    The system stores this information for each user as their API Credentials for NFS under Settings > Account Profile.

    01.png02.png
    Rw step

    To view or edit these credentials, click on the Pencil icon.

    03.png

    How to Import Docupace NFS Credentials into Wealthscape

    To authenticate each account, you must link their Docupace User ID to their Wealthscape User ID. To get started, you’ll need to run the NFS Federation Report. Mainly, it is used for linking all your users with Docupace’s existing users to Wealthscape for the first time, but it can be used for updating existing lists.

    Note: The NFS Federation Report will always pull a list of all Docupace users with an Opaque ID. However, you can modify it to remove all previously authenticated users from the system.

    Rw ui steps macro
    Rw step

    Go to Administration and click on the Reports tile.

    Rw step

    Locate the NFS Federation Report. The report can be located in different report groups on the site, such as Back Office Reports, ePACS Reports, or General Reports. You may add it to any other groups as needed.

    Tip

    Tip: We recommend placing it under Back Office Reports. Back or Home Office users interact with this type of report most often.

    04.png
    Rw step

    Select the NFS Federation User report.

    05.png
    Rw step

    The system generates the NFS Federation User Report. It contains four columns.

    • User ID: Docupace user ID

    • Opaque ID: ID in the user profile (Please refer to the section above.)

    • TID Method (Transaction ID Method): It tracks transactions across distributed federated systems like Wealthscape. When we try to open an account, it will read the authenticated user ID.

    • Federation Flag: a flag showing the authentication status.

      • F - API authentication is turned on

      • D - API authentication is turned off

    06.png
    Rw step

    Export the report in CSV format.

    07.png
    Rw step

    Replace the Docupace user ID with the 10-digit Wealthscape user ID. Save the edited version as a separate file.

    Warning

    Warning: In this example, we kept both columns to show the comparison. Please remove the Docupace User IDs before importing.

    08.png
    Rw step

    Log into the Wealthscape site.

    Note

    Attention: You must have the following rights in Wealthscape to complete this task.

    • Import Professional ID Federation Admin

    • Import Professional ID Federation View

    09.png
    Rw step

    On the Home page, click Menu.

    10.png
    Rw step

    Locate the ID & Profile Maintenance in the Service section and click on Bulk Import.

    Note: Your view in Wealthscape may be different, depending on your access rights.

    b6c68a5e-3a5a-4835-8f96-18ec8f9640ec.png
    Rw step

    To initiate a new import, click the New Import button.

    1e3c62ee-999e-42e0-b023-e29b957e8afe.png
    Rw step

    Drag and drop the CSV file on the New Import screen. Then click Import.

    15.png
    Tip

    Tip: We recommend keeping the imported file to reference it later if necessary.

    Rw step

    You will get a confirmation message. Copy the Import ID and then click Done.

    Note

    Important: This is just confirmation that the file format was correct. It doesn’t necessarily mean that it was processed successfully.

    edb4dae0-27b6-406d-be8e-2ac043354e71.png
    Rw step

    Paste the Import ID into the corresponding field and click Search.

    90af54fb-d26b-4c53-ade3-1d10678eeb0f.png

    The system will generate a list of matching imports. Completed imports will have a Processed status.

    Note: If you see the Waiting status, click the Refresh icon. Imports can take up to one minute to process.

    2db72be9-b201-4b1d-865d-7f356c895dfc.png
    Rw step

    Optional: To test if it works, go to Docupace and try to open an account.

    If you receive the error message Expected exactly 1 opaqueID, review your User Profile to ensure you have an NFS token.

    • If you do not have an NFS token, you have not successfully linked your Docupace User ID with your Wealthscape User ID in Wealthscape. You will need to repeat the process.

    • If you have a token, review the import in Wealthscape to see if an error occurred.

    How to Review Previous Wealthscape Imports

    Rw ui steps macro
    Rw step

    While logged into Wealthscape, navigate to Menu > Bulk Imports. The Results page displays a list of recent imports. Click an Import ID to view more information.

    1e3c62ee-999e-42e0-b023-e29b957e8afe (1).png
    Rw step

    Here, you can see each user's status and compare it to the CSV file you imported.

    13.png

    Audience: Home/Back Office User.

    Info

    Functionality: This guide describes how to authenticate a user for our Fidelity NFS integration using the AccountCreate API.