Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

When Match At Registry is used, the Match Reference Identifier will be available in the Org Identity Source Record (Org IdentityView Organizational Identity Source Record), but not in the Org Identity itself. It will also be available in the CO Person Record.

Match Attributes

Currently, Registry will look for the following attributes in the Org Identity record and pass those found to the Match server during a match operation:

  • Primary Name (sent as type official)
  • Date of Birth (must be YYYY-MM-DD format)
  • National ID (Identifier of type national)

In addition, the Organizational Identity Source Backend's unique ID (key) will be used as the SOR ID.

Support for additional attributes is expected in a future release.

System of Record Labels

The Match API operates with the concept of a System of Record Label, which is used to identify the calling system making the request to the ID Match server. Registry supports two models for OIS based matching:

...

  • Server URL: The URL prefix for Match request. This should look something like https://match.university.edu/match/api/3/v1.
  • Username and Password: As configured.
  • SOR Label: As defined on the Match server, and in accordance with the model selected above. If the SOR per OIS model is chosen, then a Match Server will need to be defined for each SOR Label.

Match Attributes

After the Match Server is defined, Match Server Attributes can be added to the configuration to define which attributes Registry will send when making a match request. This configuration should align with the Match Server's attribute configuration. Attributes are pulled from the Org Identity, since the point of the Match operation is to determine which CO Person record to connect the Org Identity to.

The following attributes are supported:

  • Date of Birth, which must be YYYY-MM-DD format
  • Email Address
  • Identifier
  • Name

Attributes other than Date of Birth may be specified multiple times using different types. For example, a National ID number and an ID Card number can be configured by adding two Identifiers, one of type national and the other of type badge.

Attributes configured as Required must be present in the Org Identity. If any Required attribute is not found, the Match request will not be submitted. The record must be corrected before trying again.

Info
The Organizational Identity Source Backend's unique ID (key) will be used as the SOR ID, and should not be explicitly configured.

Pipeline Configuration

Configure the Pipeline to have a Match Strategy of External, and select the appropriate Match Server, defined above.

...