Skip to main content

Metadata

Here is a more polished, professional version of that section, with clearer wording and better flow, while staying concise and documentation-friendly:

Metadata​

Metadata allows you to provide additional contextual information that helps the analysis engine interpret and process transactions more accurately.

Each analysis engine may define its own engine-specific metadata requirements. These requirements are documented on the individual engine pages.

In addition to engine-specific metadata, the platform supports a set of generic metadata fields. These fields are not tied to any specific engine and can be provided when creating an analysis job, regardless of the engine being used.

Below is an overview of the available generic metadata fields and their purpose.

Key
Type
Required
Description
navigator_assigned_users
Array of assigned user objects
No
An array containing a list of objects to allow specific access to this analyisis from the Navigator.

Example​

// POST cfa/analysis-jobs
{
    "reference" : "Client A Analysis",
    "engine" : "z2",
    "profile" : "corporate",
    "input" : { 
      "consentIds" : [ "fb84a3ed-812f-42fb-a5d9-d92fde641dfd" ] 
    },
    "metadata": {
        "navigator_assigned_users": [
        { "type": "navigatoruser", "id": "user-12345" },
        { "type": "externalid", "id": "user-xyz" }
        ]
    }
}

By default, all analyses are visible to all users in the Navigator. To support more granular access control, the Navigator provides a specific user role: “Member (Assigned Only)”.

Users with this role can only access analyses that are explicitly assigned to them via a reference.

Access Model​

  • Assignments are made at reference level, not at individual analysis level.
  • If a user is assigned to a reference, they will have access to:
    • All existing (historic) analyses for that reference
    • All future analyses created for that reference
  • It is not possible to restrict access to a single analysis while allowing access to others under the same reference.

Managing Assignments in the Navigator​

  • Admin users can add or remove user assignments directly in the Navigator.

  • Admin users can view:

    • Which users have access to a specific reference
    • The total number of users assigned to a reference

  • Users can be identified and assigned using:

    • Their Navigator user ID
    • A custom External ID, for instance a User ID from your own systems.

External IDs are managed by Admin users in the Navigator under: Manage → External Users Settings

This screen shows existing Navigator user IDs and allows Admins to configure or update External IDs per user.

Assigning Users Programmatically via the API​

When creating an analysis through the API, you can programmatically assign users by including the navigator_assigned_users field in the metadata object.

Each assignment object must include:

  • type: Indicates how the user is identified
    • navigatoruser – Assign using the Navigator user ID
    • externalid – Assign using a configured External ID
  • id: The corresponding identifier value