unlinkIdentities

  • Web Services
  • UMPI
  • API Documentation

The unlinkIdentities web service is used to force apart two customer source records (each identified by its Source + Native ID) that had been matched into the same Link ID.

This service can be used to do one of the following: 

  • Reverse the outcome of a linkIdentities operation; or
  • Split apart two source records that were matched together into a single Link ID  

The unlinkIdentities operation forces apart two customer source records, where one of the customer source records is split out into a new Link ID by itself while the other customer source record remains in its existing Link ID. The operation is only valid for cases where the two source records in question have already been linked together into the same Link ID.

When the unlinkIdentities operation is complete, the Universal MPI instance retains a history of the ‘do not link’ assertion and continues to prevent the two source records from ever linking again even if they receive data updates in the future that make them appear to be the same identity. The ‘do not link’ assertion would only be removed and ignored if a subsequent linkIdentities web service call were made to force the source records back together.

unlinkIdentities JSON request

    • A tracking ID (an optional identifier that the client can supply to track the response)
    • The Source+Native ID of the customer record that should remain in its existing Link ID – this is the “Unlink From” Source+Native ID
    • The Source+Native ID of the second customer record that should be split out and put into its own new Link ID
  • {
      "trackingId": "string", 
      "content": {
        "unlinkFromSource": { 
          "name": "string",
          "id": "string"
        },
        "source": { 
          "name": "string",
          "id": "string"
        }
      }
    }

unlinkIdentities JSON response

    • An ‘echo’ of the same tracking ID from the request
    • Several Boolean and string values with more information about the success/failure of the service 
    • The Link ID of the existing Universal MPI entity, which was referred to as the “Unlink From” identity in the request (as well as the list of Source+Native ID values that are associated with this Link ID)
    • The “Unlinked” Link ID that represents the new entity created to store the Source+Native ID that was split out.
  • {
      "trackingId": "string", 
      "auditId": UUID, 
      "success": true, 
      "retryableError": true, 
      "message": "string", 
      "errors": [
        "string"
      ],
      "content": { 
        "unlinkId": "string",
        "unlinkedSource": {
          "name": "string",
          "id": "string"
        },
            "unlinkedFromId": "string",
            "unlinkedFromSource": {
              "name": "string",
              "id": "string"
        }
      }
    }