Skip to main content
A Relative Identity Collection (RIC) is the configuration that governs a sequence of Relative Identities (RIs). It has four main components:
  1. key: A unique key to identify the RIC
  2. config: The configuration for identifiers generated for the RI sequence. It contains a:
    1. type: Type of identifier generated. Supported type is SEQUENCE
    2. offset: Offset at the start of the sequence.
  3. status: The status of the RIC. Can be ACTIVE or ARCHIVED
  4. differentiators: The differentiator properties and mappings to source properties for the RIC, grouped by MDM collections.
JSON
{
  "key": "<ric-key>",
  "config": { "type": "SEQUENCE", "offset": <integer> },
  "differentiators": {
    "<collection-key-1>": {
      "properties": {
        "<property-1>": { "type": "code" },
        "<property-2>": { "type": "symbol" },
        "<property-3>": { "type": "boolean" }
      },
      "mappings": [
        {
          "source": "<source-key-1>",
          "type": "<profile-key>",
          "paths": {
            "<property-1>": "<source-path-1>",
            "<property-2>": "<source-path-2>",
            "<property-3>": "<source-path-3>"
          }
        },
        {
          "source": "<source-key-2>",
          "type": "<profile-key>",
          "paths": {
            "<property-1>": "<source-path-1>",
            "<property-2>": "<source-path-2>",
            "<property-3>": "<source-path-3>"
          }
        }
      ]
    },
    "<collection-key-2>": {
      "properties": {
        "<property-1>": { "type": "code" },
        "<property-2>": { "type": "symbol" },
        "<property-3>": { "type": "boolean" }
      },
      "mappings": [
        {
          "source": "<source-key-1>",
          "type": "<profile-key>",
          "paths": {
            "<property-1>": "<source-path-1>",
            "<property-2>": "<source-path-2>",
            "<property-3>": "<source-path-3>"
          }
        },
        {
          "source": "<source-key-2>",
          "type": "<profile-key>",
          "paths": {
            "<property-1>": "<source-path-1>",
            "<property-2>": "<source-path-2>",
            "<property-3>": "<source-path-3>"
          }
        }
      ]
    }
  }
}